blockchain

Usage: pmc blockchain [OPTIONS] COMMAND [ARGS]...

  Interactions with blockchains

Options:
  -h, --help  Show this message and exit

Commands:
  add       propose a new blockchain in a specific container. Change will be
            applied after voting within the deployer voter set of the cluster
            that the container belongs to.
  update    Propose new configuration to blockchain at specific height.
  remove    Propose removal of blockchain. Command is irreversible
  stop      Propose stopping a blockchain from building blocks
  start     Propose starting a chain that has previously been stopped.
  replicas  List blockchain replicas
  signers   List blockchain signers
  list      List blockchains
  get       Get blockchain configuration
  replica   Blockchain replica commands

The blockchain command (pmc blockchain) consists of sub-commands to interact with blockchains. For example, list existing blockchains, create new blockchains, and remove blockchains.

add

Usage: pmc blockchain add [OPTIONS]

  propose a new blockchain in a specific container. Change will be applied
  after voting within the deployer voter set of the cluster that the container
  belongs to.

Options:
  -cfg, --config VALUE           Configuration file for PMC (overrides system
                                 configuration)
  -bc, --blockchain-config PATH  Configuration file of blockchain (GtvML
                                 (*.xml) or Gtv (*.gtv))
  -c, --container TEXT           Name of container to run in
  -n, --name TEXT                Name of blockchain
  -q, --quiet                    Only prints Blockchain RID if succeeds
  --description TEXT             Proposal description
  -h, --help                     Show this message and exit

The add command (pmc blockchain add) proposes a new blockchain in a specific container.

Example usage:

Pmc blockchain add --blockchain-config ‘./config.xml’ --container <container-name> --name <blockchain-name>

update

Usage: pmc blockchain update [OPTIONS]

  Propose new configuration to blockchain at specific height. Height must be >
  current height and > all previously approved configuration heights. Use
  force flag -f to override previously added configs or to squeeze in a
  configuration at a height < previously approved config heights. Change will
  be applied after voting.

Options:
  -cfg, --config VALUE           Configuration file for PMC (overrides system
                                 configuration)
  -bc, --blockchain-config PATH  Blockchain config to propose
  -brid, --blockchain-rid VALUE  Blockchain RID
  -h, --height INT
  -f, --force
  --description TEXT             Proposal description
  --help                         Show this message and exit

The update command (pmc blockchain update) proposes a new configuration for a running blockchain. You can only apply the new configurations at a block height higher than the current height and the block height specified in all previously approved configuration updates.

This can be overseen by using the force flag (-f), which overrides previously added configuration updates. Changes are applied after voting.

remove

Usage: pmc blockchain remove [OPTIONS]

  Propose removal of blockchain. Command is irreversible

Options:
  -cfg, --config VALUE           Configuration file for PMC (overrides system
                                 configuration)
  -brid, --blockchain-rid VALUE  Blockchain RID
  --description TEXT             Proposal description
  -h, --help                     Show this message and exit

The remove command (pmc blockchain remove) proposes the removal of a blockchain.

stop

Usage: pmc blockchain stop [OPTIONS]

  Propose stopping a blockchain from building blocks

Options:
  -cfg, --config VALUE           Configuration file for PMC (overrides system
                                 configuration)
  -brid, --blockchain-rid VALUE  Blockchain RID
  --description TEXT             Proposal description
  -h, --help                     Show this message and exit

The stop command (pmc blockchain stop) proposes to stop a blockchain from building blocks.

start

Usage: pmc blockchain start [OPTIONS]

  Propose starting a chain that has previously been stopped.

Options:
  -cfg, --config VALUE           Configuration file for PMC (overrides system
                                 configuration)
  -brid, --blockchain-rid VALUE  Blockchain RID
  --description TEXT             Proposal description
  -h, --help                     Show this message and exit

The start command (pmc blockchain start) proposes to start a blockchain that has previously been stopped.

replicas

Usage: pmc blockchain replicas [OPTIONS]

  List blockchain replicas

Options:
  -cfg, --config VALUE           Configuration file for PMC (overrides system
                                 configuration)
  -brid, --blockchain-rid VALUE  Blockchain RID
  -i, --includeinactive          Include disabled/removed clusters (not
                                 implemented yet)
  -h, --help                     Show this message and exit

The replicas command (pmc blockchain replicas) lists all the blockchain replicas.

signers

Usage: pmc blockchain signers [OPTIONS]

  List blockchain signers

Options:
  -cfg, --config VALUE           Configuration file for PMC (overrides system
                                 configuration)
  -brid, --blockchain-rid VALUE  Blockchain RID
  -i, --includeinactive          Include disabled/removed clusters (not
                                 implemented yet)
  -h, --help                     Show this message and exit

The signers command (pmc blockchain signers) lists all the blockchain signers.

list

Usage: pmc blockchain list [OPTIONS]

  List blockchains

Options:
  -cfg, --config VALUE   Configuration file for PMC (overrides system
                         configuration)
  -i, --includeinactive  Include disabled/removed clusters (not implemented
                         yet)
  -h, --help             Show this message and exit

The list command (pmc blockchain list) lists all blockchains.

get

Usage: pmc blockchain get [OPTIONS]

  Get blockchain configuration

Options:
  -cfg, --config VALUE           Configuration file for PMC (overrides system
                                 configuration)
  -brid, --blockchain-rid VALUE  Blockchain RID
  -h, --height INT
  --save PATH                    where to save configuration XML
  --help                         Show this message and exit

The get command (pmc blockchain get) receives the configuration of a given blockchain. The configuration can be saved to a desired path. It's possible to get the blockchain config at a specific block height using the -h flag.

Example usage:

pmc blockchain get --brid <blockchain-rid> --height 200 --save <path-on-local-machine>

replica

Usage: pmc blockchain replica [OPTIONS] COMMAND [ARGS]...

  Blockchain replica commands

Options:
  -h, --help  Show this message and exit

Commands:
  add     add replica of a blockchain. The node is verifying but not building
          blocks.
  remove  remove replica of a blockchain

• Use the (pmc blockchain replica add) command to add a replica to the blockchain.

Usage: pmc blockchain replica add [OPTIONS]

  add replica of a blockchain. The node is verifying but not building blocks.

Options:
  -cfg, --config VALUE           Configuration file for PMC (overrides system
                                 configuration)
  -brid, --blockchain-rid VALUE  Blockchain RID
  -pk, --pubkey VALUE            Public key
  -h, --help                     Show this message and exit

• Use the (pmc blockchain replica remove) command to remove a blockchain replica.

Usage: pmc blockchain replica remove [OPTIONS]

  remove replica of a blockchain

Options:
  -cfg, --config VALUE           Configuration file for PMC (overrides system
                                 configuration)
  -brid, --blockchain-rid VALUE  Blockchain RID
  -pk, --pubkey VALUE            Public key
  -h, --help                     Show this message and exit