| Github Actions | |
|
|
Integration of the ledger, consensus, networking and node shell repositories.
Logging is provided as a feature by the node shell to the other packages.
- The bcc-node is the top level for the node and aggregates the other components from other packages: consensus, ledger and networking, with configuration, CLI, logging and monitoring.
- The node no longer incorporates wallet or explorer functionality. The wallet backend and explorer backend are separate components that run in separate external processes that communicate with the node via local IPC.
The latest supported networks can be found at https://hydra.tbco.io/job/Bcc/bcc-node/bcc-deployment/latest-finished/download/1/index.html
Documentation for building the node can be found here.
You can download the latest version of bcc-node and bcc-cli:
You can download here.
The download includes bcc-node.exe and a .dll. To run the node with bcc-node run you need to reference a few files and directories as arguments. These can be copied from the bcc-node repo into the executables directory. The command to run the node on mainnet looks like this:
bcc-node.exe run --topology ./mainnet-topology.json --database-path ./state --port 3001 --config ./configuration-mainnet.yaml --socket-path \\.\pipe\bcc-nodeYou can pull the docker image with the latest version of bcc-node from here.
docker pull tbco/bcc-nodeThis refers to the client that is used for running a node.
The general synopsis is as follows:
Usage: bcc-node run [--topology FILEPATH] [--database-path FILEPATH]
[--socket-path FILEPATH]
[--cole-delegation-certificate FILEPATH]
[--cole-signing-key FILEPATH]
[--sophie-kes-key FILEPATH]
[--sophie-vrf-key FILEPATH]
[--sophie-operational-certificate FILEPATH]
[--host-addr IPV4-ADDRESS]
[--host-ipv6-addr IPV6-ADDRESS]
[--port PORT]
[--config NODE-CONFIGURATION] [--validate-db]
Run the node.--topology- Filepath to a topology file describing which peers the node should connect to.--database-path- Path to the blockchain database.--cole-delegation-certificate- Optional path to the Cole delegation certificate. The delegation certificate allows the delegator (the issuer of said certificate) to give his/her own block signing rights to somebody else (the delegatee). The delegatee can then sign blocks on behalf of the delegator.--cole-signing-key- Optional path to the Cole signing key.--sophie-signing-key- Optional path to the Sophie signing key.--sophie-kes-key- Optional path to the Sophie KES signing key.--sophie-vrf-key- Optional path to the Sophie VRF signing key.--sophie-operational-certificate- Optional path to the Sophie operational certificate.--socket-path- Path to the socket file.--host-addr- Optionally specify your node's IPv4 address.--host-ipv6-addr- Optionally specify your node's IPv6 address.--port- Specify which port to assign to the node.--config- Specify the filepath to the config.yamlfile. This file is responsible for all the other node's required settings. See examples inconfiguration(e.g. config-0.yaml).--validate-db- Flag to revalidate all on-disk database files
The --config flag points to a .yaml file that is responsible to configuring the logging & other important settings for the node. E.g. see the Cole mainnet configuration in this
configuration.yaml.
Some of the more important settings are as follows:
Protocol: RealPBFT-- Protocol the node will executeRequiresNetworkMagic: RequiresNoMagic -- Used to distinguish between mainnet (RequiresNoMagic) and testnets (RequiresMagic)
Logs are output to the logs/ dir.
Profiling data and RTS run stats are stored in the profile/ dir.
Please see scripts/README.md for how to obtain profiling information using the scripts.
Please see scripts/README.md for information on the various scripts.
A CLI utility to support a variety of key material operations (genesis, migration, pretty-printing..) for different system generations.
Usage documentation can be found at bcc-cli/README.md.
The general synopsis is as follows:
Usage: bcc-cli (Era based commands | Cole specific commands | Miscellaneous commands)> NOTE: the exact invocation command depends on the environment. If you have only built bcc-cli, without installing it, then you have to prepend cabal run -- ``
before ``bcc-cli. We henceforth assume that the necessary environment-specific adjustment has been made, so we only mention bcc-cli.
The subcommands are subdivided in groups, and their full list can be seen in the output of bcc-cli --help.
All subcommands have help available. For example:
cabal run -- bcc-cli -- cole key migrate-delegate-key-from --help
bcc-cli -- cole key migrate-delegate-key-from
Usage: bcc-cli cole key migrate-delegate-key-from --from FILEPATH
--to FILEPATH
Migrate a delegate key from an older version.
Available options:
--cole-legacy-formats Cole/bcc-sl formats and compatibility
--cole-formats Cole era formats and compatibility
--from FILEPATH Signing key file to migrate.
--to FILEPATH Non-existent file to write the signing key to.
-h,--help Show this help textThe Cole genesis generation operations will create a directory that contains:
genesis.json: The genesis JSON file itself.avvm-seed.*.seed: Bcc Voucher Vending Machine seeds (secret). Affected by--avvm-entry-countand--avvm-entry-balance.delegate-keys.*.key: Delegate private keys. Affected by:--n-delegate-addresses.delegation-cert.*.json: Delegation certificates. Affected by:--n-delegate-addresses.genesis-keys.*.key: Genesis stake private keys. Affected by:--n-delegate-addresses,--total-balance.poor-keys.*.key: Non-delegate private keys with genesis UTxO. Affected by:--n-poor-addresses,--total-balance.
More details on the Cole Genesis JSON file can be found in docs/reference/cole-genesis.md
Cole genesis delegation and related concepts are described in detail in:
https://hydra.tbco.io/job/Bcc/bcc-ledger-specs/coleLedgerSpec/latest/download-by-type/doc-pdf/ledger-spec
The canned scripts/benchmarking/genesis.sh example provides a nice set of defaults and
illustrates available options.
Note that key operations do not support password-protected keys.
Signing keys can be generated using the keygen subcommand.
Extracting a verification key out of the signing key is performed by the to-verification subcommand.
In order to continue using a delegate key from the Cole Legacy era in the new implementation,
it needs to be migrated over, which is done by the migrate-delegate-key-from subcommand:
$ cabal v2-run -- bcc-cli cole key migrate-delegate-key-from
--from key0.sk --to key0Converted.skOne can gather information about a signing key's properties through the signing-key-public
and signing-key-address subcommands (the latter requires the network magic):
$ cabal v2-run -- bcc-cli cole key signing-key-public --cole-formats --secret key0.sk
public key hash: a2b1af0df8ca764876a45608fae36cf04400ed9f413de2e37d92ce04
public key: sc4pa1pAriXO7IzMpByKo4cG90HCFD465Iad284uDYz06dHCqBwMHRukReQ90+TA/vQpj4L1YNaLHI7DS0Z2Vg==
$ cabal v2-run -- bcc-cli signing-key-address --cole-formats --secret key0.pbft --testnet-magic 42
2cWKMJemoBakxhXgZSsMteLP9TUvz7owHyEYbUDwKRLsw2UGDrG93gPqmpv1D9ohWNddx
VerKey address with root e5a3807d99a1807c3f161a1558bcbc45de8392e049682df01809c488, attributes: AddrAttributes { derivation path: {} }Transactions can be created via the issue-genesis-utxo-expenditure & issue-utxo-expenditure commands.
The easiest way to create a transaction is via the scripts/benchmarking/issue-genesis-utxo-expenditure.sh script as follows:
./scripts/benchmarking/issue-genesis-utxo-expenditure.sh transaction_file
NB: This by default creates a transaction based on configuration/defaults/liveview/config-0.yaml
If you do not have a genesis_file you can run scripts/benchmarking/genesis.sh which will create an example genesis_file for you.
The script scripts/benchmarking/issue-genesis-utxo-expenditure.sh has defaults for all the requirements of the issue-genesis-utxo-expenditure command.
The submit-tx subcommand provides the option of submitting a pre-signed
transaction, in its raw wire format (see GenTx for Cole transactions).
The canned scripts/benchmarking/submit-tx.sh script will submit the supplied transaction to a testnet
launched by scripts/benchmarking/sophie-testnet-liveview.sh script.
To make a transaction spending UTxO, you can either use the:
issue-genesis-utxo-expenditure, for genesis UTxOissue-utxo-expenditure, for normal UTxO
subcommands directly, or, again use canned scripts that will make transactions tailored for the aforementioned testnet cluster:
scripts/benchmarking/issue-genesis-utxo-expenditure.sh.scripts/benchmarking/issue-utxo-expenditure.sh.
The script requires the target file name to write the transaction to, input TxId (for normal UTxO), and optionally allows specifying the source txin output index, source and target signing keys and entropic value to send.
The target address defaults to the 1-st richman key (configuration/delegate-keys.001.key)
of the testnet, and entropic amount is almost the entirety of its funds.
You can query the tip of your local node via the get-tip command as follows
- Open tmux
- Run
cabal build bcc-node - Run
./scripts/lite/sophie-testnet.sh example
4. Run export BCC_NODE_SOCKET_PATH=/bcc-node/example/socket/node-1-socket
4. ``cabal exec bcc-cli -- get-tip --testnet-magic 42
You will see output from stdout in this format:
Current tip:
Block hash: 4ab21a10e1b25e39
Slot: 6
Block number: 5A Cole update proposal can be created as follows:
bcc-cli -- cole governance
create-update-proposal
(--mainnet | --testnet-magic NATURAL)
--signing-key FILEPATH
--protocol-version-major WORD16
--protocol-version-minor WORD16
--protocol-version-alt WORD8
--application-name STRING
--software-version-num WORD32
--system-tag STRING
--installer-hash HASH
--filepath FILEPATH
..The mandatory arguments are --mainnet | --testnet-magic, signing-key, protocol-version-major, protocol-version-minor, protocol-version-alt, application-name, software-version-num, system-tag, installer-hash and filepath.
The remaining arguments are optional parameters you want to update in your update proposal.
You can also check your proposal's validity using the validate-cbor command. See: Validate CBOR files.
See the Cole specification for more details on update proposals.
You can submit your proposal using the submit-update-proposal command.
Example:
bcc-cli -- cole governance
submit-update-proposal
--config configuration/defaults/mainnet/configuration.yaml
(--mainnet | --testnet-magic NATURAL)
--filepath my-update-proposalSee the Cole specification for more deatils on update proposals.
You can create and submit cole update proposal votes with the create-proposal-vote & submit-proposal-vote commands. The following are two example commands:
Cole vote creation:
cabal exec bcc-cli -- cole governance create-proposal-vote
(--mainnet | --testnet-magic NATURAL)
--signing-key configuration/defaults/liveview/genesis/delegate-keys.000.key
--proposal-filepath ProtocolUpdateProposalFile
--vote-yes
--output-filepath UpdateProposalVoteFileCole vote submission:
cabal exec bcc-cli -- cole governance submit-proposal-vote
(--mainnet | --testnet-magic NATURAL)
--filepath UpdateProposalVoteFilerun ghcid with: ghcid -c "cabal repl exe:bcc-node --reorder-goals"
When using Haskell Langague Server with Visual Studio Code, you may find that HLINT annotations are ignored<haskell/haskell-language-server#638>.
To work around this, you may run the script ./scripts/reconfigure-hlint.sh to generate a .hlint.yaml file with HLINT ignore rules derived from the source code.
bcc-node is essentially a container which implements several components such networking, consensus, and storage. These components have individual test coverage. The node goes through integration and release testing by Devops/QA while automated CLI tests are ongoing alongside development.
Developers on bcc-node can launch their own testnets or run the chairman tests locally.
It may be useful to print the on chain representations of blocks, delegation certificates, txs and update proposals. There are two commands that do this (for any cbor encoded file):
To pretty print as CBOR:
cabal exec bcc-cli -- pretty-print-cbor --filepath CBOREncodedFile
You can validate Cole era blocks, delegation certificates, txs and update proposals with the validate-cbor command.
cabal exec bcc-cli -- validate-cbor --cole-block 21600 --filepath CBOREncodedColeBlockFile
Native tokens is a new feature that enables the transacting of multi-assets on Bcc. Native tokens are now supported on mainnet and users can transact with bcc, and an unlimited number of user-defined (custom) tokens natively.
To help you get started we have compiled a handy list of resources:
Documentation for native tokens
You can also read more about native tokens and how they compare to bcc and ERC20. Browse native tokens created on the Bcc blockchain and see their transactions in an interactive dashboard that allows filtering and searching: nativetokens.da.iogservices.io.
The API documentation is published here.
The documentation is built with each push, but is only published from master branch. In order to test if the documentation is working, build the documentation locally with ./scripts/haddocs.sh and open haddocks/index.html in the browser.