mirror of
https://github.com/bitcoin-s/bitcoin-s.git
synced 2025-02-22 22:36:34 +01:00
Order website sidebar by project, fix capitalization (#1226)
This commit is contained in:
Ben Carman
GitHub
parent
90c39adbb8
commit
54f90f5fad
18 changed files with 73 additions and 47 deletions
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: cli
|
||||
title: cli
|
||||
title: CLI
|
||||
---
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: configuration
|
||||
title: Application configuration
|
||||
title: Application Configuration
|
||||
---
|
||||
|
||||
Bitcoin-S uses [HOCON](https://github.com/lightbend/config/blob/master/HOCON.md)
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: Light client
|
||||
id: node
|
||||
title: Light Client
|
||||
---
|
||||
|
||||
Bitcoin-S comes bundled with a light client Bitcoin node. this client
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: server
|
||||
title: application server
|
||||
title: Application Server
|
||||
---
|
||||
|
||||
|
||||
|
|
@ -8,8 +8,8 @@ title: application server
|
|||
|
||||
The [server](../../app/server) project is the aggregation of these three sub projects
|
||||
|
||||
1. [Wallet](wallet.md)
|
||||
2. [Chain](chain.md)
|
||||
1. [Wallet](../wallet/wallet.md)
|
||||
2. [Chain](../chain/chain.md)
|
||||
3. [Node](node.md)
|
||||
|
||||
The server project provides a away to access information from these three projects via a JSON RPC.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: addresses
|
||||
title: Generating addresses
|
||||
title: Generating Addresses
|
||||
---
|
||||
|
||||
Almost all Bitcoin applications need to generate addresses
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: core-intro
|
||||
title: Core module
|
||||
title: Core Module
|
||||
---
|
||||
|
||||
The `core` module is the core (duh!) functionality of Bitcoin-S. The goal is to provide basic
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: hd-keys
|
||||
title: HD key generation
|
||||
title: HD Key Generation
|
||||
---
|
||||
|
||||
In modern Bitcoin wallets, users only need to write down
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: sign
|
||||
title: Sign api
|
||||
title: Sign API
|
||||
---
|
||||
|
||||
### The [`Sign` API](org/bitcoins/core/crypto/Sign.scala)
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: txbuilder
|
||||
title: TxBuilder example
|
||||
title: TxBuilder Example
|
||||
---
|
||||
|
||||
Bitcoin-S features a transaction builder that constructs and signs Bitcoin
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ title: Key Manager
|
|||
|
||||
### Key Manager
|
||||
|
||||
The key manager module's goal is to encapusulate all private key interactions with the [wallet](../applications/wallet.md) project.
|
||||
The key manager module's goal is to encapusulate all private key interactions with the [wallet](../wallet/wallet.md) project.
|
||||
|
||||
As of this writing, there is only one type of `KeyManager` - [`BIP39KeyManager`](../../key-manager/src/main/scala/org/bitcoins/keymanager/bip39/BIP39KeyManager.scala).
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: chain-query-api
|
||||
title: chain-query-api
|
||||
title: Chain Query API
|
||||
---
|
||||
|
||||
```scala mdoc:invisible
|
||||
|
|
@ -25,7 +25,7 @@ import org.bitcoins.wallet.config.WalletAppConfig
|
|||
import scala.concurrent.{ExecutionContextExecutor, Future}
|
||||
```
|
||||
|
||||
### ChainQueryApi
|
||||
### ChainQueryAPI
|
||||
|
||||
The ChainQueryApi is how the wallet project stays aware of the current best chain.
|
||||
This allows the wallet for example to calculate the number of confirmations for a transaction,
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: node-api
|
||||
title: node-api
|
||||
title: Node API
|
||||
---
|
||||
|
||||
```scala mdoc:invisible
|
||||
|
|
@ -21,7 +21,7 @@ import org.bitcoins.wallet.config.WalletAppConfig
|
|||
import scala.concurrent.{ExecutionContextExecutor, Future}
|
||||
```
|
||||
|
||||
### NodeApi
|
||||
### NodeAPI
|
||||
|
||||
The NodeApi is how the wallet project retrieves relevant node data like blocks.
|
||||
This allows the wallet for example to retrieve blocks for finding its relevant transactions.
|
||||
|
|
|
|||
|
|
@ -9,10 +9,10 @@
|
|||
"title": "Blockchain Verification"
|
||||
},
|
||||
"applications/cli": {
|
||||
"title": "cli"
|
||||
"title": "CLI"
|
||||
},
|
||||
"applications/configuration": {
|
||||
"title": "Application configuration"
|
||||
"title": "Application Configuration"
|
||||
},
|
||||
"applications/dlc": {
|
||||
"title": "Executing A DLC with Bitcoin-S"
|
||||
|
|
@ -21,14 +21,20 @@
|
|||
"title": "Syncing Blockfilters"
|
||||
},
|
||||
"applications/node": {
|
||||
"title": "Light client"
|
||||
"title": "Light Client"
|
||||
},
|
||||
"applications/server": {
|
||||
"title": "application server"
|
||||
"title": "Application Server"
|
||||
},
|
||||
"applications/wallet": {
|
||||
"title": "Wallet"
|
||||
},
|
||||
"chain/chain": {
|
||||
"title": "Blockchain Verification"
|
||||
},
|
||||
"chain/filter-sync": {
|
||||
"title": "Syncing Blockfilters"
|
||||
},
|
||||
"contributing-website": {
|
||||
"title": "Contributing to the website"
|
||||
},
|
||||
|
|
@ -39,25 +45,25 @@
|
|||
"title": "Adding New Script Types"
|
||||
},
|
||||
"core/addresses": {
|
||||
"title": "Generating addresses"
|
||||
"title": "Generating Addresses"
|
||||
},
|
||||
"core/core-intro": {
|
||||
"title": "Core module"
|
||||
"title": "Core Module"
|
||||
},
|
||||
"core/hd-keys": {
|
||||
"title": "HD key generation"
|
||||
"title": "HD Key Generation"
|
||||
},
|
||||
"core/psbts": {
|
||||
"title": "Partially Signed Bitcoin Transactions"
|
||||
},
|
||||
"core/sign": {
|
||||
"title": "Sign api"
|
||||
"title": "Sign API"
|
||||
},
|
||||
"core/spending-info": {
|
||||
"title": "Signing Transactions"
|
||||
},
|
||||
"core/txbuilder": {
|
||||
"title": "TxBuilder example"
|
||||
"title": "TxBuilder Example"
|
||||
},
|
||||
"getting-setup": {
|
||||
"title": "Getting Bitcoin-S installed on your machine"
|
||||
|
|
@ -80,6 +86,18 @@
|
|||
"security": {
|
||||
"title": "Security"
|
||||
},
|
||||
"wallet/chain-query-api": {
|
||||
"title": "Chain Query Api"
|
||||
},
|
||||
"wallet/dlc": {
|
||||
"title": "Executing A DLC with Bitcoin-S"
|
||||
},
|
||||
"wallet/node-api": {
|
||||
"title": "Node Api"
|
||||
},
|
||||
"wallet/wallet": {
|
||||
"title": "Wallet"
|
||||
},
|
||||
"windows-users": {
|
||||
"title": "windows-users"
|
||||
},
|
||||
|
|
@ -174,14 +192,19 @@
|
|||
"Help": "Help"
|
||||
},
|
||||
"categories": {
|
||||
"Getting started": "Getting started",
|
||||
"Getting setup": "Getting setup",
|
||||
"Core module": "Core module",
|
||||
"Key manager": "Key manager",
|
||||
"RPC clients": "RPC clients",
|
||||
"Getting Started": "Getting Started",
|
||||
"Getting Setup": "Getting Setup",
|
||||
"Applications": "Applications",
|
||||
"Chain": "Chain",
|
||||
"Core Module": "Core Module",
|
||||
"Key Manager": "Key Manager",
|
||||
"Wallet": "Wallet",
|
||||
"RPC Clients": "RPC Clients",
|
||||
"Contributing": "Contributing",
|
||||
"Security": "Security"
|
||||
"Security": "Security",
|
||||
"Getting started": "Getting started",
|
||||
"Core module": "Core module",
|
||||
"RPC clients": "RPC clients"
|
||||
}
|
||||
},
|
||||
"pages-strings": {
|
||||
|
|
|
|||
|
|
@ -1,8 +1,18 @@
|
|||
{
|
||||
"docs": {
|
||||
"Getting started": ["getting-started"],
|
||||
"Getting setup": ["getting-setup"],
|
||||
"Core module": [
|
||||
"Getting Started": ["getting-started"],
|
||||
"Getting Setup": ["getting-setup"],
|
||||
"Applications": [
|
||||
"applications/cli",
|
||||
"applications/configuration",
|
||||
"applications/node",
|
||||
"applications/server"
|
||||
],
|
||||
"Chain": [
|
||||
"chain/chain",
|
||||
"chain/filter-sync"
|
||||
],
|
||||
"Core Module": [
|
||||
"core/core-intro",
|
||||
"core/addresses",
|
||||
"core/hd-keys",
|
||||
|
|
@ -12,28 +22,21 @@
|
|||
"core/psbts",
|
||||
"core/txbuilder"
|
||||
],
|
||||
"Key manager": [
|
||||
"Key Manager": [
|
||||
"key-manager/key-manager"
|
||||
],
|
||||
"Wallet": [
|
||||
"wallet/wallet",
|
||||
"wallet/chain-query-api",
|
||||
"wallet/node-api"
|
||||
"wallet/node-api",
|
||||
"wallet/dlc"
|
||||
],
|
||||
"RPC clients": [
|
||||
"RPC Clients": [
|
||||
"rpc/rpc-clients-intro",
|
||||
"rpc/rpc-eclair",
|
||||
"rpc/rpc-bitcoind"
|
||||
],
|
||||
"Applications": [
|
||||
"applications/chain",
|
||||
"applications/filter-sync",
|
||||
"applications/cli",
|
||||
"applications/configuration",
|
||||
"applications/dlc",
|
||||
"applications/node",
|
||||
"applications/server",
|
||||
"applications/wallet"
|
||||
],
|
||||
|
||||
"Contributing": ["contributing", "contributing-website"],
|
||||
"Security": ["security"]
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue