bitcoin-s/website/sidebars.json

{
  "docs": {
    "Getting Started": [
      "getting-started",
      "bips"
    ],
    "Getting Setup": [
      "getting-setup",
      "ui-setup"
    ],
    "Applications": [
      "applications/cli",
      "applications/server",
      "applications/gui",
      "applications/server-systemd"
    ],
    "Chain": [
      "chain/chain",
      "chain/filter-sync",
      "chain/chain-query-api"
    ],
    "Configuration": [
      "config/configuration"
    ],
    "Core Module": [
      "core/core-intro",
      "core/addresses",
      "core/hd-keys",
      "core/adding-spks",
      "core/spending-info",
      "core/psbts",
      "core/dlc",
      "core/txbuilder",
      "core/lightning-network"
    ],
    "Crypto Module": [
      "crypto/crypto-intro",
      "crypto/sign",
      "crypto/adaptor-signatures",
      "crypto/musig"
    ],
    "Fee Provider": [
      "fee-provider/fee-provider"
    ],
    "Key Manager": [
      "key-manager/server-key-manager",
      "key-manager/key-manager"
    ],
    "Node": [
      "node/node",
      "node/node-api"
    ],
    "Wallet": [
      "wallet/wallet",
      "wallet/wallet-callbacks",
      "wallet/wallet-get-address",
      "wallet/address-tagging",
      "wallet/dlc",
      "wallet/wallet-rescan",
      "wallet/wallet-sync",
      "wallet/wallet-rpc",
      "wallet/backups",
      "wallet/wallet-election-example",
      "wallet/wallet-price-example",
      "wallet/wallet-sports-betting-example"
    ],
    "Tor": [
      "tor/tor"
    ],
    "RPC Clients": [
      "rpc/rpc-clients-intro",
      "rpc/rpc-eclair",
      "rpc/rpc-bitcoind",
      "rpc/lnd-rpc"
    ],
    "Secp256k1": [
      "secp256k1/secp256k1",
      "secp256k1/jni-modify"
    ],
    "Testkit": [
      "testkit/testkit",
      "testkit/testkit-core"
    ],
    "DLC Oracle": [
      "oracle/build-oracle-server",
      "oracle/oracle-server",
      "oracle/oracle-election-example",
      "oracle/oracle-price-example",
      "oracle/oracle-sports-betting-example"
    ],
    "Oracle Explorer Client": [
      "oracle-explorer-client/oracle-explorer-client"
    ],
    "Contributing": [
      "contributing",
      "contributing-website"
    ],
    "Security": [
      "security"
    ]
  }
}
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-15 01:05:14 +02:00			`{`
			`"docs": {`
docs: Fix broken links in Docs + minor touchups (#1908) 2020-08-27 14:11:24 -05:00			`"Getting Started": [`
Add supported Bips docs (#2427) 2020-12-24 07:16:46 -06:00			`"getting-started",`
			`"bips"`
docs: Fix broken links in Docs + minor touchups (#1908) 2020-08-27 14:11:24 -05:00			`],`
			`"Getting Setup": [`
Add web UI build tutorial (#4183) 2022-03-11 12:16:59 -06:00			`"getting-setup",`
			`"ui-setup"`
docs: Fix broken links in Docs + minor touchups (#1908) 2020-08-27 14:11:24 -05:00			`],`
Order website sidebar by project, fix capitalization (#1226) 2020-03-13 09:54:07 -05:00			`"Applications": [`
			`"applications/cli",`
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 13:30:24 -06:00			`"applications/server",`
2021 02 10 Website fixes (#2643) 2021-02-11 09:53:45 -06:00			`"applications/gui",`
			`"applications/server-systemd"`
Order website sidebar by project, fix capitalization (#1226) 2020-03-13 09:54:07 -05:00			`],`
			`"Chain": [`
			`"chain/chain",`
docs: Fix broken links in Docs + minor touchups (#1908) 2020-08-27 14:11:24 -05:00			`"chain/filter-sync",`
			`"chain/chain-query-api"`
Order website sidebar by project, fix capitalization (#1226) 2020-03-13 09:54:07 -05:00			`],`
Add headings for both Node and cofiguration on the sidebar (#1241) 2020-03-15 15:52:58 -05:00			`"Configuration": [`
			`"config/configuration"`
			`],`
Order website sidebar by project, fix capitalization (#1226) 2020-03-13 09:54:07 -05:00			`"Core Module": [`
Add sections on generating addresses and expand HD section in website 2019-06-11 14:55:59 +02:00			`"core/core-intro",`
			`"core/addresses",`
			`"core/hd-keys",`
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 13:30:16 -06:00			`"core/adding-spks",`
			`"core/spending-info",`
Add PSBTs to Docs Sidebar (#1172) 2020-02-26 16:06:57 -06:00			`"core/psbts",`
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			`"core/dlc",`
Document LN Data types (#1504) * Document LN Data types * change to to-string 2020-06-08 15:20:40 -05:00			`"core/txbuilder",`
			`"core/lightning-network"`
Add sections on generating addresses and expand HD section in website 2019-06-11 14:55:59 +02:00			`],`
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 11:34:53 -06:00			`"Crypto Module": [`
			`"crypto/crypto-intro",`
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			`"crypto/sign",`
Musig2 Implementation (#4418) * An initial (not yet working) implementation with test * Added custom (non-bip-340) verification for now * Made KeySet a case class * Got MuSig2 working with BIP340 verification passing * Responds to Ben's review * Fixed hash tags and added parital signature verification * Added point multiplication that allows infinity and did some refactoring * Refactored type defs into case classes * Added tests for more signers and fixed single-party bug * Added key aggregation test vectors from BIP * Added nonce generation test vectors from BIP * Added nonce aggregation test vectors from BIP * Made nonce aggregation test vectors pass by having MultiNoncePub wrap SecpPoints * Added remaining static test vectors from BIP * Implements tweaking support and adds tests, including all of the remaining BIP tests * Added factory objects for nonce types * Refactored things into multiple files with renaming and restructuring * Some minor renaming * Introduced ParityMultiplier ADT to remove unneccesary computations * Added scaladocs * Added messages to invariants * Fixed a typo * Nonce generation now takes a SchnorrPublicKey instead of raw bytes * Made point multiplication more robust * Responded to Ben nits * Added musig.md 2022-07-06 12:59:13 -05:00			`"crypto/adaptor-signatures",`
			`"crypto/musig"`
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 11:34:53 -06:00			`],`
Fee Provider Docs (#1641) 2020-07-08 10:22:59 -05:00			`"Fee Provider": [`
			`"fee-provider/fee-provider"`
			`],`
Order website sidebar by project, fix capitalization (#1226) 2020-03-13 09:54:07 -05:00			`"Key Manager": [`
KeyManager Docs (#2426) * KeyManager Docs * Add to sidebar * Respond to review 2020-12-29 14:39:41 -06:00			`"key-manager/server-key-manager",`
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			`"key-manager/key-manager"`
			`],`
Add headings for both Node and cofiguration on the sidebar (#1241) 2020-03-15 15:52:58 -05:00			`"Node": [`
docs: Fix broken links in Docs + minor touchups (#1908) 2020-08-27 14:11:24 -05:00			`"node/node",`
			`"node/node-api"`
Add headings for both Node and cofiguration on the sidebar (#1241) 2020-03-15 15:52:58 -05:00			`],`
ChainQueryApi doc (#1204) * ChainQueryApi doc * Add example * make imports invis, add example * Fix invis imports 2020-03-11 08:56:37 -05:00			`"Wallet": [`
Order website sidebar by project, fix capitalization (#1226) 2020-03-13 09:54:07 -05:00			`"wallet/wallet",`
Add wallet callbacks docs to sidebar (#1636) 2020-07-08 05:34:59 -05:00			`"wallet/wallet-callbacks",`
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			`"wallet/wallet-get-address",`
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			`"wallet/address-tagging",`
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			`"wallet/dlc",`
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			`"wallet/wallet-rescan",`
Fix lockunspent RPC (#2984) * Fix lockunspent RPC * Fix test 2021-04-29 07:57:14 -05:00			`"wallet/wallet-sync",`
Add docs for backing up the wallet (#3351) * Add docs for backing up the wallet * Add image, fix github artifacts img 2021-07-06 10:54:38 -05:00			`"wallet/wallet-rpc",`
Add wallet election example to docs (#3716) Write intro and requirements section start contractinfo section Finish offer section Finish first draft of the wallet election example writeup Add page to sidebar 2021-10-05 06:55:14 -05:00			`"wallet/backups",`
2021 10 15 wallet numeric example (#3759) * Implement payout function reader and tlv points reader/writer * Add support for numeric contract infos in the createcontractinfo rpc * Adjust logging level * Remove unused endpoint * Add new format to site * WIP * Add contract info/offer section * Start accept section * Add example to sidebar * Adjust locktimes on the exmaples to 0 2021-10-15 19:57:01 -05:00			`"wallet/wallet-election-example",`
sports betting example (#4397) * added sports betting exercise * added sports betting exercise * added sports betting exercise 2022-06-16 14:55:47 -04:00			`"wallet/wallet-price-example",`
			`"wallet/wallet-sports-betting-example"`
ChainQueryApi doc (#1204) * ChainQueryApi doc * Add example * make imports invis, add example * Fix invis imports 2020-03-11 08:56:37 -05:00			`],`
DLC P2P in AppServer and GUI (#3462) 2021-08-04 07:06:19 -05:00			`"Tor": [`
			`"tor/tor"`
			`],`
Order website sidebar by project, fix capitalization (#1226) 2020-03-13 09:54:07 -05:00			`"RPC Clients": [`
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-15 01:05:14 +02:00			`"rpc/rpc-clients-intro",`
			`"rpc/rpc-eclair",`
Lnd rpc docs (#2896) 2021-04-12 19:09:59 -05:00			`"rpc/rpc-bitcoind",`
			`"rpc/lnd-rpc"`
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-15 01:05:14 +02:00			`],`
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			`"Secp256k1": [`
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 14:42:58 -06:00			`"secp256k1/secp256k1",`
			`"secp256k1/jni-modify"`
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			`],`
Add testkit md (#1234) * Add testkit md * Address ben's code review * Fix links 2020-03-15 12:39:43 -05:00			`"Testkit": [`
Add testkit-core.md (#2881) 2021-04-08 10:11:01 -05:00			`"testkit/testkit",`
			`"testkit/testkit-core"`
Add testkit md (#1234) * Add testkit md * Address ben's code review * Fix links 2020-03-15 12:39:43 -05:00			`],`
docs: DLC Oracle Server (#2125) * docs: DLC Oracle Server * docs: Add sign event example 2020-10-05 17:05:06 -05:00			`"DLC Oracle": [`
Update Oracle Server docs, fix oracle server bugs (#2581) 2021-01-29 08:14:28 -06:00			`"oracle/build-oracle-server",`
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			`"oracle/oracle-server",`
Oracle price example documentation (#2618) * Oracle price example documentation * Remove --rpcport, add precision description 2021-02-03 16:08:51 -06:00			`"oracle/oracle-election-example",`
sports betting example (#4397) * added sports betting exercise * added sports betting exercise * added sports betting exercise 2022-06-16 14:55:47 -04:00			`"oracle/oracle-price-example",`
			`"oracle/oracle-sports-betting-example"`
docs: DLC Oracle Server (#2125) * docs: DLC Oracle Server * docs: Add sign event example 2020-10-05 17:05:06 -05:00			`],`
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			`"Oracle Explorer Client": [`
			`"oracle-explorer-client/oracle-explorer-client"`
			`],`
docs: Fix broken links in Docs + minor touchups (#1908) 2020-08-27 14:11:24 -05:00			`"Contributing": [`
			`"contributing",`
			`"contributing-website"`
			`],`
			`"Security": [`
			`"security"`
			`]`
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-15 01:05:14 +02:00			`}`
			`}`