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 │
│ import Propose importing a blockchain in a specific │
│ container │
│ finish-import Propose finishing import of a blockchain │
│ import-foreign-configurations │
│ Propose importing a foreign blockchain │
│ configurations in a specific container │
│ import-foreign-blocks Propose importing a foreign blockchain blocks │
│ update Propose a new configuration to blockchain │
│ force-update Propose a new forced configuration to a │
│ blockchain │
│ get-proposed-forced-configuration │
│ Get proposed forced configuration │
│ approve-force-update Approve a forced configuration to a blockchain│
│ restore-configuration Propose restoring blockchain configuration to │
│ what was used in anchored block, either by │
│ removal or replacement │
│ stop Propose stopping a blockchain from building │
│ blocks │
│ start Propose starting a blockchain that has │
│ previously been stopped │
│ remove Propose removal of blockchain. Command is │
│ irreversible │
│ rename Propose renaming a blockchain. │
│ replicas List blockchain replicas │
│ signers List blockchain signers │
│ list List blockchains │
│ list-delayed-configurations List delayed configuration proposals for a │
│ blockchain │
│ info Get blockchain info │
│ get-all-configurations List all blockchain configuration heights or │
│ download and save all configurations to the │
│ specified directory │
│ get-configuration Get blockchain configuration │
│ get Get blockchain configuration. Deprecated: Use │
│ get-configuration command. │
│ get-forced-configurations Get forced configurations │
│ configuration-diff Blockchain configuration diff │
│ get-proposed-blockchain-rid Get proposed blockchain rid │
│ replica Blockchain replica commands │
│ move Propose moving a blockchain to a specific │
│ container │
│ cancel-move Propose canceling the blockchain move │
│ finish-move Propose finishing the blockchain move │
│ archive Propose archiving of blockchain. Command is │
│ irreversible │
│ unarchive Propose unarchiving of blockchain. Command is │
│ irreversible │
│ link-evm-eoa-account This command links an EVM Externally Owned │
│ Account (EOA) to a Chromia account on the │
│ specified blockchain │
╰─────────────────────────────────────────────────────────────────────────────╯
The blockchain command (pmc blockchain) consists of sub-commands to interact with blockchains. For example, list
existing blockchains, create new blockchains, and remove blockchains.
blockchain 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.
╭─ Configuration Properties ──────────────────────────────────────────────────╮
│ -cfg, --config=CONFIG Alternate path for client configuration file │
│ -s, --settings=SETTINGS Alternate path for project settings file │
│ --lookup-brid Ignore any 'brid' property in configuration file, │
│ always perform lookup │
│ --lookup-nodes / --no-lookup-nodes │
│ Lookup system cluster signer nodes for sending │
│ transactions to (default: yes) │
│ --network=TEXT Target network to make requests to (if chromia.yml│
│ is configured) │
│ --secret=PATH Path to secret file (pubkey/privkey) │
│ --key-id=KEY_ID Key ID of the keypair to use │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Signers, leave out this option to send transaction directly ───────────────╮
│ --signer=VALUE Public keys of signer (can be repeated) │
│ --signers=VALUE Comma separated list of keys of signers │
│ --signers-file=PATH Path to file containing public keys of signers, one │
│ per line │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│ --timeb-at=VALUE Add timeb operation to make transaction fail if │
│ applied after the given time (UTC). Supported │
│ formats: yyyy-MM-dd HH:mm, yyyy-MM-dd'T'HH:mm and │
│ milliseconds since 1970 (unix/epoch time) │
│ --timeb-after=VALUE Add timeb operation to make transaction fail if │
│ applied after the given number of seconds from now. │
│ --save-tx Always save transaction to file, even if it is fully │
│ signed │
│ --target=PATH Path where transaction file should be saved (default:│
│ /opt/chromaway/postchain) │
│* -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 Print only 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>
blockchain import
Usage: pmc blockchain import [OPTIONS]
Propose importing a blockchain in a specific container
Change will be applied after voting within the deployer voter set of the
cluster that the container belongs to.
╭─ Configuration Properties ──────────────────────────────────────────────────╮
│ -cfg, --config=CONFIG Alternate path for client configuration file │
│ -s, --settings=SETTINGS Alternate path for project settings file │
│ --lookup-brid Ignore any 'brid' property in configuration file, │
│ always perform lookup │
│ --lookup-nodes / --no-lookup-nodes │
│ Lookup system cluster signer nodes for sending │
│ transactions to (default: yes) │
│ --network=TEXT Target network to make requests to (if chromia.yml│
│ is configured) │
│ --secret=PATH Path to secret file (pubkey/privkey) │
│ --key-id=KEY_ID Key ID of the keypair to use │
╰───────────────────────────────────────────────── ────────────────────────────╯
╭─ Signers, leave out this option to send transaction directly ───────────────╮
│ --signer=VALUE Public keys of signer (can be repeated) │
│ --signers=VALUE Comma separated list of keys of signers │
│ --signers-file=PATH Path to file containing public keys of signers, one │
│ per line │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│ --timeb-at=VALUE Add timeb operation to make transaction fail if│
│ applied after the given time (UTC). Supported │
│ formats: yyyy-MM-dd HH:mm, yyyy-MM-dd'T'HH:mm │
│ and milliseconds since 1970 (unix/epoch time) │
│ --timeb-after=VALUE Add timeb operation to make transaction fail if│
│ applied after the given number of seconds from │
│ now. │
│ --save-tx Always save transaction to file, even if it is │
│ fully signed │
│ --target=PATH Path where transaction file should be saved │
│ (default: /opt/chromaway/postchain) │
│* --configurations-file=PATH File to import blockchain configurations from │
│* -c, --container=TEXT Name of container to run in │
│* -n, --name=TEXT Name of blockchain │
│ --description=TEXT Proposal description │
│ -h, --help Show this message and exit │
╰─────────────────────────────────────────────────────────────────────────────╯
The import command (pmc blockchain import) proposes importing a blockchain into a specific container.
blockchain finish-import
Usage: pmc blockchain finish-import [OPTIONS]
Propose finishing import of a blockchain
Change will be applied after voting within the deployer voter set of the
cluster that the container belongs to.
╭─ Configuration Properties ──────────────────────────────────────────────────╮
│ -cfg, --config=CONFIG Alternate path for client configuration file │
│ -s, --settings=SETTINGS Alternate path for project settings file │
│ --lookup-brid Ignore any 'brid' property in configuration file, │
│ always perform lookup │
│ --lookup-nodes / --no-lookup-nodes │
│ Lookup system cluster signer nodes for sending │
│ transactions to (default: yes) │
│ --network=TEXT Target network to make requests to (if chromia.yml│
│ is configured) │
│ --secret=PATH Path to secret file (pubkey/privkey) │
│ --key-id=KEY_ID Key ID of the keypair to use │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Signers, leave out this option to send transaction directly ───────────────╮
│ --signer=VALUE Public keys of signer (can be repeated) │
│ --signers=VALUE Comma separated list of keys of signers │
│ --signers-file=PATH Path to file containing public keys of signers, one │
│ per line │
╰──────────────────────────────────────────────────────────────────────────── ─╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│ --timeb-at=VALUE Add timeb operation to make transaction fail if│
│ applied after the given time (UTC). Supported │
│ formats: yyyy-MM-dd HH:mm, yyyy-MM-dd'T'HH:mm │
│ and milliseconds since 1970 (unix/epoch time) │
│ --timeb-after=VALUE Add timeb operation to make transaction fail if│
│ applied after the given number of seconds from │
│ now. │
│ --save-tx Always save transaction to file, even if it is │
│ fully signed │
│ --target=PATH Path where transaction file should be saved │
│ (default: /opt/chromaway/postchain) │
│* --configurations-file=PATH File to import blockchain configurations from │
│ --finish-at-height=TEXT Finish blockchain import at height (required │
│ for API version 18 and later) (deprecated) │
│* --final-height=INT Finish blockchain import at height (required │
│ for API version 33 and later) │
│ --description=TEXT Proposal description │
│ -h, --help Show this message and exit │
╰─────────────────────────────────────────────────────────────────────────────╯
The finish-import command (pmc blockchain finish-import) proposes finishing the import of a blockchain.
blockchain import-foreign-configurations
Usage: pmc blockchain import-foreign-configurations [OPTIONS]
Propose importing a foreign blockchain configurations in a specific container
Change will be applied after voting within the deployer voter set of the
cluster that the container belongs to.
╭─ Configuration Properties ──────────────────────────────────────────────────╮
│ -cfg, --config=CONFIG Alternate path for client configuration file │
│ -s, --settings=SETTINGS Alternate path for project settings file │
│ --lookup-brid Ignore any 'brid' property in configuration file, │
│ always perform lookup │
│ --lookup-nodes / --no-lookup-nodes │
│ Lookup system cluster signer nodes for sending │
│ transactions to (default: yes) │
│ --network=TEXT Target network to make requests to (if chromia.yml│
│ is configured) │
│ --secret=PATH Path to secret file (pubkey/privkey) │
│ --key-id=KEY_ID Key ID of the keypair to use │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Signers, leave out this option to send transaction directly ───────────────╮
│ --signer=VALUE Public keys of signer (can be repeated) │
│ --signers=VALUE Comma separated list of keys of signers │
│ --signers-file=PATH Path to file containing public keys of signers, one │
│ per line │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│ --timeb-at=VALUE Add timeb operation to make transaction fail │
│ if applied after the given time (UTC). │
│ Supported formats: yyyy-MM-dd HH:mm, │
│ yyyy-MM-dd'T'HH:mm and milliseconds since 1970│
│ (unix/epoch time) │
│ --timeb-after=VALUE Add timeb operation to make transaction fail │
│ if applied after the given number of seconds │
│ from now. │
│ --save-tx Always save transaction to file, even if it is│
│ fully signed │
│ --target=PATH Path where transaction file should be saved │
│ (default: /opt/chromaway/postchain) │
│* -pk, --pubkey=PUBKEY Node pubkey │
│* --host=TEXT Host │
│* -p, --port=INT Port │
│* -a, --api-url=TEXT api url │
│* --chain0-blockchain-rid=VALUE │
│ Chain0 blockchain RID │
│* -brid, --blockchain-rid=RID Blockchain RID │
│* -n, --name=TEXT Name of blockchain │
│ --from-height=INT Only import configurations from and including │
│ this height (default is 0) (default: 0) │
│* --up-to-height=INT Import configurations up to and including this│
│ height │
│* -c, --container=TEXT Name of container to run in │
│ --description=TEXT Proposal description │
│ -h, --help Show this message and exit │
╰─────────────────────────────────────────────────────────────────────────────╯
The import-foreign-configurations command (pmc blockchain import-foreign-configurations) proposes importing a foreign
blockchain configuration into a specific container.
blockchain import-foreign-blocks
Usage: pmc blockchain import-foreign-blocks [OPTIONS]
Propose importing a foreign blockchain blocks
Change will be applied after voting within the deployer voter set of the
cluster that the container belongs to.
╭─ Configuration Properties ──────────────────────────────────────────────────╮
│ -cfg, --config=CONFIG Alternate path for client configuration file │
│ -s, --settings=SETTINGS Alternate path for project settings file │
│ --lookup-brid Ignore any 'brid' property in configuration file, │
│ always perform lookup │
│ --lookup-nodes / --no-lookup-nodes │
│ Lookup system cluster signer nodes for sending │
│ transactions to (default: yes) │
│ --network=TEXT Target network to make requests to (if chromia.yml│
│ is configured) │
│ --secret=PATH Path to secret file (pubkey/privkey) │
│ --key-id=KEY_ID Key ID of the keypair to use │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Signers, leave out this option to send transaction directly ───────────────╮
│ --signer=VALUE Public keys of signer (can be repeated) │
│ --signers=VALUE Comma separated list of keys of signers │
│ --signers-file=PATH Path to file containing public keys of signers, one │
│ per line │
╰─────────────────────────────────────────────────────────────────────── ──────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│ --timeb-at=VALUE Add timeb operation to make transaction fail │
│ if applied after the given time (UTC). │
│ Supported formats: yyyy-MM-dd HH:mm, │
│ yyyy-MM-dd'T'HH:mm and milliseconds since 1970│
│ (unix/epoch time) │
│ --timeb-after=VALUE Add timeb operation to make transaction fail │
│ if applied after the given number of seconds │
│ from now. │
│ --save-tx Always save transaction to file, even if it is│
│ fully signed │
│ --target=PATH Path where transaction file should be saved │
│ (default: /opt/chromaway/postchain) │
│* -brid, --blockchain-rid=RID Blockchain RID │
│ --up-to-height=TEXT Import blocks up to and including this height │
│ (deprecated) │
│* --final-height=INT Import blocks up to and including this height │
│ --description=TEXT Proposal description │
│ -h, --help Show this message and exit │
╰─────────────────────────────────────────────────────────────────────────────╯
The import-foreign-blocks command (pmc blockchain import-foreign-blocks) proposes importing foreign blockchain blocks.
blockchain update
Usage: pmc blockchain update [OPTIONS]
Propose a new configuration to blockchain
In the case of chain0 additional height argument can be specified. 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.
╭─ Configuration Properties ──────── ──────────────────────────────────────────╮
│ -cfg, --config=CONFIG Alternate path for client configuration file │
│ -s, --settings=SETTINGS Alternate path for project settings file │
│ --lookup-brid Ignore any 'brid' property in configuration file, │
│ always perform lookup │
│ --lookup-nodes / --no-lookup-nodes │
│ Lookup system cluster signer nodes for sending │
│ transactions to (default: yes) │
│ --network=TEXT Target network to make requests to (if chromia.yml│
│ is configured) │
│ --secret=PATH Path to secret file (pubkey/privkey) │
│ --key-id=KEY_ID Key ID of the keypair to use │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Signers, leave out this option to send transaction directly ───────────────╮
│ --signer=VALUE Public keys of signer (can be repeated) │
│ --signers=VALUE Comma separated list of keys of signers │
│ --signers-file=PATH Path to file containing public keys of signers, one │
│ per line │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│ --timeb-at=VALUE Add timeb operation to make transaction fail │
│ if applied after the given time (UTC). │
│ Supported formats: yyyy-MM-dd HH:mm, │
│ yyyy-MM-dd'T'HH:mm and milliseconds since 1970│
│ (unix/epoch time) │
│ --timeb-after=VALUE Add timeb operation to make transaction fail │
│ if applied after the given number of seconds │
│ from now. │
│ --save-tx Always save transaction to file, even if it is│
│ fully signed │
│ --target=PATH Path where transaction file should be saved │
│ (default: /opt/chromaway/postchain) │