Docs
chromia.com

proposal

On this page
Help output
Usage: pmc proposal [OPTIONS] COMMAND [ARGS]...

  Interact with existing proposals

╭─ Options ───────────────────────────────────────────────────────────────────╮
│  -h, --help  Show this message and exit                                     │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ──────────────────────────────────────────────────────────────────╮
│  info          Gets information of a given proposal                         │
│  list          List all proposals that you can vote on                      │
│  revoke        Revoke/remove a proposal submitted by you                    │
│  vote          Providers decide if proposed changes should be applied. Use  │
│                this function to vote yes or no to a proposal.               │
│  retract-vote  Use this command to retract a previously casted vote on a    │
│                proposal.                                                    │
│  download-jar  Download a proposed subnode JAR extension                    │
╰─────────────────────────────────────────────────────────────────────────────╯

The command (pmc proposal) has sub-commands to see and vote on existing proposals in the network.

proposal info

Help output
Usage: pmc proposal info [OPTIONS]

  Gets information of a given proposal

╭─ 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)                                    │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│  --id=INT    Id of the proposal                                             │
│  -h, --help  Show this message and exit                                     │
╰─────────────────────────────────────────────────────────────────────────────╯

The info command (pmc proposal info) gets information about a given proposal specified by its id. You can add the -v flag to see the entire proposal content.

Example usage:

Terminal
pmc proposal info --id 123456

proposal list

Help output
Usage: pmc proposal list [OPTIONS]

  List all proposals that you can vote on

╭─ 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)                             │
│  --from=VALUE         List proposals from date (YYYY-MM-DD) (default:       │
│                       1970-01-01)                                           │
│  --to=VALUE           List proposals to date (YYYY-MM-DD) (default:         │
│                       9999-12-31)                                           │
│  --all                Include all proposals, including ones you can not vote│
│                       on                                                    │
│  --pending            Only include proposals that are still pending         │
│  -i, --interactive    Prompt for item to show details for                   │
│  -h, --help           Show this message and exit                            │
╰─────────────────────────────────────────────────────────────────────────────╯

The list command (pmc proposal list) lists all the active proposals since a given index.

proposal revoke

Help output
Usage: pmc proposal revoke [OPTIONS]

  Revoke/remove a proposal submitted by you

╭─ 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)                             │
│* --id=INT             Id of the proposal                                    │
│  -h, --help           Show this message and exit                            │
╰─────────────────────────────────────────────────────────────────────────────╯

The revoke command (pmc proposal revoke) removes your proposal.

proposal vote

Help output
Usage: pmc proposal vote [OPTIONS]

  Providers decide if proposed changes should be applied. Use this function to
  vote yes or no to a proposal.

╭─ 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)           │
│  --id=INT                     Id of the proposal                            │
│  --ids=VALUE                  Comma-separated list of proposal IDs to vote  │
│                               on                                            │
│  -y, --accept / -n, --reject  Accept or reject this proposal                │
│  -h, --help                   Show this message and exit                    │
╰─────────────────────────────────────────────────────────────────────────────╯

The vote command (pmc provider vote) enables providers to vote on whether the proposed configuration changes suggested by another provider should be applied.

Example usage:

Terminal
pmc proposal vote --id 12345 --accept

proposal retract-vote

Help output
Usage: pmc proposal retract-vote [OPTIONS]

  Use this command to retract a previously casted vote on a proposal.

╭─ 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)                             │
│* --id=INT             Id of the proposal                                    │
│  -h, --help           Show this message and exit                            │
╰─────────────────────────────────────────────────────────────────────────────╯

The retract vote command enables providers to retract a previously cast vote on a proposal that is still pending.

Example usage:

Terminal
pmc proposal retract-vote --id 12345

proposal download-jar

Help output
Usage: pmc proposal download-jar [OPTIONS]

  Download a proposed subnode JAR extension

╭─ 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)                             │
│* --id=INT             Id of the proposal                                    │
│* --save=PATH          Where to save JAR file                                │
│  --update             Use this flag if proposal is to update the extension  │
│  -h, --help           Show this message and exit                            │
╰─────────────────────────────────────────────────────────────────────────────╯

The download-jar command (pmc proposal download-jar) downloads the JAR file for a proposal.