bazo-miner

README

bazo-miner

bazo-miner is the the command line interface for running a full Bazo blockchain node implemented in Go.

Setup Instructions

⚠ BAZO was moved to Docker

1. Install Go (developed and tested with version >= 1.14)
2. Set $GOROOT and $GOPATH. For more information, please check out the official documentation.
3. run ./scripts/fix-imports.sh

Getting Started

The Bazo miner provides an intuitive and beginner-friendly command line interface.

bazo-miner [global options] command [command options] [arguments...]

Options

• --help, -h: Show help
• --version, -v: Print the version

Start the miner

Start the miner with a breeze.

bazo-miner start [command options] [arguments...]

Options

• --database: (default store.db) Specify where to load database of the disk-based key/value store from. The database is created if it does not exist yet.
• --address: (default: localhost:8000) Specify starting address and port, in format IP:PORT
• --bootstrap: (default: localhost:8000) Specify the address and port of the boostrapping node. Note that when this option is not specified, the miner connects to itself.
• --wallet: (default: wallet.txt) Load the public key from this file. A new private key is generated if it does not exist yet. Note that only the public key is required.
• --multisig: (optional) The file to load the multisig's private key from.
• --commitment: The file to load the validator's commitment key from (will be created if it does not exist)
• --rootkey: (default: key.txt) The file to load root's public key from this file. A new public private key is generated if it does not exist yet. Note that only the public key is required.
• --rootcommitment: The file to load root's commitment key from. A new commitment key is generated if it does not exist yet.
• --root-chparams: The file to load root's chameleon hash parameters from. A new set of parameters is generated if it does not exist yet.
• --confirm: In order to review the miner startup options, the user must press Enter before the miner starts.

Example

Using a sample scenario, the use of the command line should become clear.

Let's assume we want to start two miners, miner A and miner B, whereas miner A acts as the bootstrap node. Further assume that we start from scratch and no key files have been created yet.

Miner A (Root)

• Database: StoreA.db
• Address: 127.0.0.1:8000
• Bootstrap Address: 127.0.0.1:8000
• Wallet: WalletA.txt
• Commitment: CommitmentA.txt
• Root Wallet: WalletA.txt
• Root Commitment: CommitmentA.txt
• Chameleon Hash Parameters: ChParamsA.txt

Miner B

• Database: StoreB.db
• Address: 127.0.0.1:8001
• Bootstrap Address: 127.0.0.1:8000
• Wallet: WalletB.txt
• Commitment: CommitmentB.txt
• Chameleon Hash Parameters: ChParamsB.txt

Commands

./bazo-miner start --database StoreA.db --address 127.0.0.1:8000 --bootstrap 127.0.0.1:8000 --wallet WalletA.txt --commitment CommitmentA.txt --multisig WalletA.txt --rootwallet WalletA.txt --rootcommitment CommitmentA.txt --root-chparams ChParamsA.txt

We start miner A at address and port 127.0.0.1:8000 and connect to itself by setting the bootstrap address to the same address. Note that we could have omitted these two options since they are passed by default with these values. Wallet and commitment keys are automatically created. Using this command, we define miner A as the root.

Starting miner B requires more work since new accounts have to be registered by a root account. In our case, we can use miner's A WalletA.txt and ChParamsA.txt (e.g. copy the files to the Bazo client directory) to create and add a new account to the network. Using the Bazo client, we create a new account:

./bazo-client account create --rootwallet WalletA.txt --wallet WalletB.txt --chparams ChParamsB.txt --data "John Doe"

The minimum amount of coins required for staking is defined in the configuration of Bazo. Thus, miner B first needs Bazo coins to start mining and we must first send coins to miner B's account.

./bazo-client funds --from WalletA.txt --to WalletB.txt --txcount 0 --amount 2000 --multisig WalletA.txt --chparams ChParamsA.txt --data "X"

(Optional) The client can update the data field of the previous funds transaction.

./bazo-client update --tx-hash <hash-of-the-funds-tx-goes-here> --tx-issuer WalletA.txt --update-data "Y" --chparams ChParamsA.txt --data "Fixed a typo in the payment purpose"

Then, miner B has to join the pool of validators (enable staking):

./bazo-client staking enable --wallet WalletB.txt --commitment CommitmentB.txt

Start miner B, using the generated WalletB.txt and CommitmentB.txt (e.g. copy the files to the Bazo miner directory):

./bazo-miner start --database StoreB.db --address 127.0.0.1:8001 --bootstrap 127.0.0.1:8000 --wallet WalletB.txt --commitment CommitmentB.txt --rootwallet WalletA.txt --rootcommitment CommitmentA.txt --root-chparams ChParamsA.txt

Note that both files specified for --rootwallet and --rootcommitment only require to contain the wallet and commitemt public key respectively.

We start miner B at address and port 127.0.0.1:8001 and connect to miner A (which is the boostrap node). Wallet and commitment keys are automatically created.

Generate a wallet

Generate a new public and private wallet keypair.

bazo-miner generate-wallet [command options] [arguments...]

Options

• --file: Save the public private wallet keypair to this file.

Example

./bazo-miner generate-wallet --file wallet.txt

Generate a commitment

Generate a new public and private commitment keypair.

bazo-miner generate-commitment [command options] [arguments...]

Options

• --file: Save the public private commitment keypair to this file.

Example

./bazo-miner generate-commitment --file commitment.txt

Update a transaction

A client can update the content of the data field of specific transactions. He does so by purposely generating a hash collision between the hash with the old and new data.

The following transactions can be updated:

• Account-Tx
• Funds-Tx
• Update-Tx

Arguments

• --tx-hash Hash of the transaction to be updated
• --tx-issuer Wallet file of the client. Ensures clients are only allowed to update their own transactions.
• --update-data Data that shall be updated on the tx
• --chparams Chameleon hash parameters of the client

Example

./bazo-client update --tx-hash d07a963769a3a23eec6c25cc81612cf3269399cb2db84e38040951131c7e6200 --tx-issuer WalletA.txt --update-data "New data goes here." --chparams ChParamsA.txt