Commit graph

40 commits

Author SHA1 Message Date
benthecarman
bf831ae32e Fix lockunspent RPC (#2984)
* Fix lockunspent RPC

* Fix test
2021-04-29 07:57:14 -05:00
benthecarman
b80b039457 Lnd rpc docs (#2896) 2021-04-12 19:09:59 -05:00
Chris Stewart
3916a0b58e 2021 04 07 issue 2875 (#2879)
* Rework explorer client to use announcement in method names rather than event

* Add to sidebar.json
2021-04-08 10:15:56 -05:00
Chris Stewart
89c2e6c9a9 Add testkit-core.md (#2881) 2021-04-08 10:11:01 -05:00
Chris Stewart
f4d0f369ec 2021 02 10 Website fixes (#2643) 2021-02-11 09:53:45 -06:00
Chris Stewart
5e7ca2aaca Oracle price example documentation (#2618)
* Oracle price example documentation

* Remove --rpcport, add precision description
2021-02-03 16:08:51 -06:00
Nadav Kohen
bb14254d65 DLC + Adaptor Docs (#2552)
* Wrote dlc docs (pending links to files that haven't been merged yet)

Added adaptor signature docs

Responded to review

Added code examples

* Added links
2021-02-02 13:33:46 -06:00
Chris Stewart
b3a8d31090 Add enum oracle example (#2601)
* Add enum oracle example

* Fix sidebar

* Address code review

* One last comment
2021-02-01 17:07:26 -06:00
benthecarman
beac2be195 Update Oracle Server docs, fix oracle server bugs (#2581) 2021-01-29 08:14:28 -06:00
Chris Stewart
092b5b2cab Add wallet sync documentation (#2565)
* Add wallet sync documentation

* Put bitcoin-s-cli call in the right place

* Add wallet.getSyncDescriptorOpt and heading for bitcoin-s-cli walletinfo

* Add walletinfo informations
2021-01-28 08:27:11 -06:00
benthecarman
b44aedacca KeyManager Docs (#2426)
* KeyManager Docs

* Add to sidebar

* Respond to review
2020-12-29 14:39:41 -06:00
Ben Carman
af89c04d15 Add supported Bips docs (#2427) 2020-12-24 07:16:46 -06:00
Ben Carman
81a5719450 docs: DLC Oracle Server (#2125)
* docs: DLC Oracle Server

* docs: Add sign event example
2020-10-05 17:05:06 -05:00
Ben Carman
57c92b9e34 docs: Fix broken links in Docs + minor touchups (#1908) 2020-08-27 14:11:24 -05:00
Ben Carman
ecd3449100 Address Tagging Attempt 2 (#1320)
* Address & UTXO tagging

* Fix docs

* Remove useless function, improve docs

* Fix rebase errors

* Rebase fixes

* Fix docs

* Fix small test errors

* Fix Postgres migration

* Fix postgres
2020-07-08 14:38:39 -05:00
Ben Carman
18fe4da989 Fee Provider Docs (#1641) 2020-07-08 10:22:59 -05:00
Ben Carman
c18357f188 Add wallet callbacks docs to sidebar (#1636) 2020-07-08 05:34:59 -05:00
Ben Carman
1d9c748abf Document LN Data types (#1504)
* Document LN Data types

* change to to-string
2020-06-08 15:20:40 -05:00
Nadav Kohen
a503441619 Crypto Project Refactor (#1380)
* Added crypto project and decoupled BitcoinSLogger from NetworkElement

Decoupled BitcoinSLogger from Factory

Moved NetworkElement into crypto project

Moved Factory and BitcoinSUtil (renamed to BytesUtil) to crypto project

Moved MaskedToString to crypto project

Added BytesUtil to imports and cleaned up CryptoUtil.recoverPoint

Moved the rest of crypto stuff to the crypto project

Moved crypto tests to crypto-test project

* Added documentation for crypto project
2020-04-30 12:34:53 -05:00
Nadav Kohen
c46a96b6e7 Update Secp256k1 (#1310)
* Rebased secp onto bitcoin-core's master (see https://github.com/bitcoin-s/secp256k1/pull/3) and built linux binaries

* Wrote a doc on adding to jni

* Built for website

* Added build instructions for other OSs

* Added table of contents using doctoc

* Edited .gitmodules

* Added windows binaries

* Updated secp branch

* Added osx binaries

* Added make check-java to doc

* Fixed typo
2020-04-14 15:42:58 -05:00
Ben Carman
891e6da11d GetAddress Wallet API call (#1287)
* GetAddress Wallet API call

* Add ability to get unfunded address

* Generate new address if no unfunded addresses

* Add test

* Add wallet get address documentation
2020-04-09 15:33:11 -05:00
Nadav Kohen
c31a4a3f8a Constructed simple Bitcoin-S wallet GUI (#1285)
* Constructed simple Bitcoin-S wallet GUI

* Added note about bitcoin-s server in doc

* Removed wallet dep from gui

* Replaced lambdas with constructors for compatibility with scala 2.11

* Fixed after rebase
2020-03-31 14:30:24 -05:00
Chris Stewart
a06bf3a22b 2020 03 17 secp256k1jni md (#1248)
* First draft secp256k1.md

Fix imports/names

Fix nits

* Address nadav's code review
2020-03-18 05:51:54 -05:00
Chris Stewart
3e618ec1f6 Add headings for both Node and cofiguration on the sidebar (#1241) 2020-03-15 15:52:58 -05:00
Chris Stewart
c30efd4919 Add testkit md (#1234)
* Add testkit md

* Address ben's code review

* Fix links
2020-03-15 12:39:43 -05:00
Chris Stewart
cd84e3483d 2020 03 06 wallet rescan test (#1218)
* Add wallet rescan tests

* Create FilterSync, which gives us an API inside of the chain project to sync filters with

Add another unit test to filter sync

Add more unit tests for ChainSync and FilterSync

Clean up some docs, remove some extra lines of code

Run scalafmt

Add filter-sync.md

Cleanup some nits

Add more information of how FilterSync.syncFilters() works

Add 'FilterWithHeaderHash' type so that we can actually validate/verify block headers that are being fed into the chain project

Run scalafmt, hide imports in filter-sync.md so code appears cleaner

Move implicits out of invisible block as it seems to cause errors

Make it so FilterSync processes filters in batches rather than fetching them all at once

Fix compile error

* WIP bitcoind implement ChainQueryApi

* rework fixtures to be able to support injecting ChainQueryApi implemented by bitcoind into our fixture infrastructure for creating wallets

* Fix rebase problem

* Implement getFiltersBetweenHeight() with ben's solution

* WIP Start implementing NodeApi against bitcoind

* Actually inject the bitcoind backed nodeApi into our fixture

* Get first rescan test working for rescanning the entire blockchain

* Implement test case for rescanning from a specific height

* Fix NeutrinoNodeWalletTest test case that uses a experimental version of bitcoind, for now i believe our experimental binary is on v18

* Add wallet-rescan.md, add helper method to WalletApi that allows you to clear out the wallet's utxos/addresses

* Add another log to try to debug CI

* Address code review

* Fix wrong ordering of deletion of tables in clearUtxosAndAddresses()

* reset logging level
2020-03-13 16:11:02 -05:00
Ben Carman
54f90f5fad Order website sidebar by project, fix capitalization (#1226) 2020-03-13 09:54:07 -05:00
Ben Carman
381251b687 NodeApi doc (#1205)
* NodeApi doc

* Add example

* make imports invis, add example

* Fix invis imports
2020-03-11 11:07:30 -05:00
Ben Carman
a70b03d08a ChainQueryApi doc (#1204)
* ChainQueryApi doc

* Add example

* make imports invis, add example

* Fix invis imports
2020-03-11 08:56:37 -05:00
Chris Stewart
4c9a22f1e1 2020 03 08 filter sync (#1209)
* Create FilterSync, which gives us an API inside of the chain project to sync filters with

Add another unit test to filter sync

Add more unit tests for ChainSync and FilterSync

Clean up some docs, remove some extra lines of code

Run scalafmt

Add filter-sync.md

Cleanup some nits

Add more information of how FilterSync.syncFilters() works

Add 'FilterWithHeaderHash' type so that we can actually validate/verify block headers that are being fed into the chain project

Run scalafmt, hide imports in filter-sync.md so code appears cleaner

Move implicits out of invisible block as it seems to cause errors

Make it so FilterSync processes filters in batches rather than fetching them all at once

Fix compile error

* Add comment about trust model

* Run scalafmt
2020-03-10 18:01:14 -05:00
Nadav Kohen
6ed12884ac Adding new SPK doc (#1208)
* Added a document explaining how to add new script types.

* built website

* Added a doc explaining the differences between full and single signing

* Added design philosophy section

* Responded to review

* mdoc now compiles the code within adding-spks.md, with some caveats surrounding sealed traits

* Added explanitory comment
2020-03-10 14:30:16 -05:00
Ben Carman
6a5700ffef Add PSBTs to Docs Sidebar (#1172) 2020-02-26 15:06:57 -07:00
Nadav Kohen
cbefe389f5 Added a getting-setup markdown doc for the website (#1167)
* Added a getting-setup markdown doc for the website

* Responded to Ben's review

* Added testnet section

* Added DLC doc

* Got the website working locally

* Fixed linking

* Responded to review
2020-02-26 13:09:44 -07:00
Chris Stewart
24ff908240 Move initialization of wallet entropy into the key manager (#966)
* Move initialization of wallet entropy into the key manager

* Enable key-manager in ci, add coverage minimum

* Add coverage minimum for key manager, add KeyManagerParams, start adding KeyManager test harness

* Remove success cases on ADTs, start using Either

* fix import

* Get test coverage to 90%

* Add documentation for key-manager.md, add side bar for key-manager

* Fix wallet.md

* Make seedPath default to baseDatadir, so we don't have a unique seed for every network. Add more documentation

* Address code review

* Address code review from Ben

* Add missing import

* Add more tests for coverage
2019-12-26 19:12:08 -06:00
Chris Stewart
67eb7df235 2019 12 17 sign ext key (#959)
* Create ExtSign, use it on ExtPrivateKey

* Add documentation on how to Sign things with ExtSign

* Add ExtSign.sign for a bip32 path

* Make sign(bytes,path) not return a Future, add documentation

* Address nadav's code review

* Fix mdoc sign.md
2019-12-20 12:47:10 -06:00
Chris Stewart
d9dcacf2da Add version 0.2.0 of the website (#948) 2019-12-16 05:57:14 -06:00
Torkel Rogstad
de39caf174 Add rudimentary docs for node, chain and wallet (#726) 2019-09-02 08:16:44 -05:00
Torkel Rogstad
c2f37335b8 Bump Scala versions (#697)
* Bump Scala versions

Support Scala 2.12.9
and 2.13.0.

To make this easier, we delete the `scripts` project. Everything
that was in here was covered by content on the website. We also
delete the `doc` folder, as that was a remnant from when `scripts`
was called `doc`.

* Crib uPickle akka-http support while we wait for publish

* Fix compiler warnings

* Add note on test logging to contribution guide

* Reduce duplication in Blockchain implementation

* Use Scala 2.12 for website

* Introduce compat package object for collections converters

* Fix Either compiler warnings

* Add sync-chain and create-wallet docs from deleted scripts

* Fix rebase goofup
2019-08-23 13:53:00 -05:00
Torkel Rogstad
6e5ca0eeeb Add sections on generating addresses and expand HD section in website 2019-06-11 18:01:44 +02:00
Torkel Rogstad
6bc6378f96 WIP: Docusaurus website (#465)
* Docs: Introduce new Docusaurus-based website

This commit is the result of running
npx docusaurus-init, and nothing more.
Further changes will happen on top of
this, to make it easier to review changes
and update to newer versions of Docusaurus
in the future.

* WIP: Add Bitcoin-S website

Change the default Docusaurus template to a custom website. Goes
off of existing documentation, and moves it into the new docs and
website directories. Deletes some unused files, such as
BUILD_README.md

* Initial mdoc support

* Add Scaladoc to website

* Add SVG assets

* Change colors, flesh out pages, correct Scaladoc links

* Rename doc project to scripts, move security doc to website

* Add copy buttons to website code snippets

* Add doc and tasks for publishing website

* Refactor how paths get copied after generating Scaladocs

* Add Get Started button

* Replace bitcoin-s logo with white text

* Add Montserrat font for headers

* flesh out user showcase and landing page

* Change Scaladoc URL to bitcoins package
2019-05-14 18:05:14 -05:00