lukechilds
/
docs
mirror of https://github.com/lukechilds/docs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

docs: fix headings

build/deps-updates
CharlieC3 5 years ago
committed by Charlie
parent
e767c99794
commit
5d45db78bc
1 changed files with 35 additions and 35 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 70
      src/pages/stacks-blockchain/configurations.md

70
src/pages/stacks-blockchain/configurations.md
View File

@ -7,185 +7,185 @@ images:
sm: /images/pages/testnet-sm.svg sm: /images/pages/testnet-sm.svg
--- ---
# Command-line Subcommands and Options ## Command-line Subcommands and Options
## mocknet ### mocknet
Start a node based on a fast local setup emulating a burnchain. Ideal for smart contract development. Start a node based on a fast local setup emulating a burnchain. Ideal for smart contract development.
## krypton (deprecated) ### krypton (deprecated)
Start a node that will join and stream blocks from the public krypton testnet, powered by Blockstack via (Proof of Transfer). Start a node that will join and stream blocks from the public krypton testnet, powered by Blockstack via (Proof of Transfer).
## xenon ### xenon
Start a node that will join and stream blocks from the public xenon testnet, decentralized. Start a node that will join and stream blocks from the public xenon testnet, decentralized.
## start ### start
Start a node with a config of your own. Can be used for joining a network, starting new chain, etc. Start a node with a config of your own. Can be used for joining a network, starting new chain, etc.
### Arguments: #### Arguments:
#### --config: relative or absolute path to the TOML config file ##### --config: relative or absolute path to the TOML config file
Example: Example:
stacks-node start --config=/path/to/config.toml stacks-node start --config=/path/to/config.toml
See [Configuration File Options](link to anchor) for more information. See [Configuration File Options](link to anchor) for more information.
### version #### version
Displays information about the current version and the release cycle. Displays information about the current version and the release cycle.
### help #### help
Displays a help message. Displays a help message.
# Configuration File Options ## Configuration File Options
The TOML configuration file has multiple sections under which an option may be placed. The TOML configuration file has multiple sections under which an option may be placed.
## Section: node ### Section: node
This section contains configuration options pertaining to the stacks-node. This section contains configuration options pertaining to the stacks-node.
### rpc_bind #### rpc_bind
Address and port stacks-node should use for RPC connections. Address and port stacks-node should use for RPC connections.
Example: `"0.0.0.0:20443"` Example: `"0.0.0.0:20443"`
### p2p_bind #### p2p_bind
Address and port stacks-node should use for P2P connections. Address and port stacks-node should use for P2P connections.
Example: `"0.0.0.0:20444"` Example: `"0.0.0.0:20444"`
### bootstrap_node (optional) #### bootstrap_node (optional)
Public key, address, and port stacks-node should use to pull transaction data from when starting. Public key, address, and port stacks-node should use to pull transaction data from when starting.
Example: `"048dd4f26101715853533dee005f0915375854fd5be73405f679c1917a5d4d16aaaf3c4c0d7a9c132a36b8c5fe1287f07dad8c910174d789eb24bdfb5ae26f5f27@krypton.blockstack.org:20444"` Example: `"048dd4f26101715853533dee005f0915375854fd5be73405f679c1917a5d4d16aaaf3c4c0d7a9c132a36b8c5fe1287f07dad8c910174d789eb24bdfb5ae26f5f27@krypton.blockstack.org:20444"`
### seed (optional) #### seed (optional)
The private key to use for mining. Only needed if `miner` is set to `true`. The private key to use for mining. Only needed if `miner` is set to `true`.
[See this page for information on how to generate a private key.](https://docs.blockstack.org/mining) [See this page for information on how to generate a private key.](https://docs.blockstack.org/mining)
Example: `"replace-with-your-private-key"` Example: `"replace-with-your-private-key"`
### local_peer_seed (optional) #### local_peer_seed (optional)
The private key to use for mining. The private key to use for mining.
[See this page for information on how to generate a private key.](https://docs.blockstack.org/mining) [See this page for information on how to generate a private key.](https://docs.blockstack.org/mining)
Example: `"replace-with-your-private-key"` Example: `"replace-with-your-private-key"`
### miner #### miner
Determines whether the stacks-node is running a follower (`false`) or a miner (`true`). Determines whether the stacks-node is running a follower (`false`) or a miner (`true`).
[See this page for information on how to run a miner.](https://docs.blockstack.org/mining) [See this page for information on how to run a miner.](https://docs.blockstack.org/mining)
Example: `true` Example: `true`
### prometheus_bind (optional) #### prometheus_bind (optional)
Address and port stacks-node should open for Prometheus metrics collection. Address and port stacks-node should open for Prometheus metrics collection.
Example: `"0.0.0.0:9153"` Example: `"0.0.0.0:9153"`
## Section: events_observer ### Section: events_observer
### endpoint #### endpoint
Address and port to a stacks-node-api to watch for events. Address and port to a stacks-node-api to watch for events.
Example: `"address-to-my-local.stacks-node-api.com:3700"` Example: `"address-to-my-local.stacks-node-api.com:3700"`
### retry_count #### retry_count
Number of times to retry before failing. Number of times to retry before failing.
Example: `255` Example: `255`
### events_keys #### events_keys
Event keys for which to watch. Event keys for which to watch.
Example: `["*"]` Example: `["*"]`
## Section: burnchain ### Section: burnchain
This section contains configuration options pertaining to the blockchain the stacks-node binds to on the backend for proof-of-transfer (BTC). This section contains configuration options pertaining to the blockchain the stacks-node binds to on the backend for proof-of-transfer (BTC).
### chain #### chain
The blockchain stacks-node binds to on the backend for proof-of-transfer. The blockchain stacks-node binds to on the backend for proof-of-transfer.
Example: `"bitcoin"` Example: `"bitcoin"`
### mode #### mode
The profile of which to run stacks-node. The profile of which to run stacks-node.
Example: `"krypton"` Example: `"krypton"`
### peer_host #### peer_host
Host running the BTC blockchain. Host running the BTC blockchain.
Example: `"bitcoind.krypton.blockstack.org"` Example: `"bitcoind.krypton.blockstack.org"`
### rpc_port #### rpc_port
peer_host's port stacks-node will connect to for RPC connections. peer_host's port stacks-node will connect to for RPC connections.
Example: `18443` Example: `18443`
### peer_port #### peer_port
peer_host's port stacks-node will connect to for P2P connections. peer_host's port stacks-node will connect to for P2P connections.
Example: `18444` Example: `18444`
### process_exit_at_block_height #### process_exit_at_block_height
Block height of the burnchain at which the stacks-node will self-terminate. Used during the testnet phases for various testing cycles. Block height of the burnchain at which the stacks-node will self-terminate. Used during the testnet phases for various testing cycles.
Example: `5340` Example: `5340`
### burnchain_op_tx_fee #### burnchain_op_tx_fee
Transaction fee per each burnchain operation. Transaction fee per each burnchain operation.
Example: `5500` Example: `5500`
### burn_fee_cap #### burn_fee_cap
Max burn fee for a transaction. Max burn fee for a transaction.
Example: `30000` Example: `30000`
### commit_anchor_block_within #### commit_anchor_block_within
TODO TODO
Example: `10000` Example: `10000`
## Section: mstx_balance ### Section: mstx_balance
This section contains configuration options pertaining to the micro-STX balanaces for various addresses. This section contains configuration options pertaining to the micro-STX balanaces for various addresses.
-> This section can be repeated multiple times. -> This section can be repeated multiple times.
### address #### address
Address which maintains a micro-STX balance. Address which maintains a micro-STX balance.
Example: `"STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6"` Example: `"STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6"`
### amount #### amount
The balance of micro-STX given to the address. The balance of micro-STX given to the address.
Example: `10000000000000000` Example: `10000000000000000`

Write Preview
Loading…
Cancel
Save