Skip to main content

economy

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

  Economy chain commands

╭─ Options ───────────────────────────────────────────────────────────────────╮
│  -h, --help  Show this message and exit                                     │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ──────────────────────────────────────────────────────────────────╮
│  list-tags                List all existing tags                            │
│  add-tag                  Add a new tag                                     │
│  update-tag               Update an existing tag                            │
│  remove-tag               Remove tag                                        │
│  add-cluster              Add a new cluster                                 │
│  list-clusters            List all clusters that are tracked by economy     │
│                           chain                                             │
│  change-cluster-tag       Change the tag of a cluster                       │
│  cluster-creation-status  Get cluster creation status                       │
│  version                  Shows economy chain version                       │
│  metrics                  Economy metrics for a provider                    │
│  get-constants            Get economy chain constants                       │
│  update-system-provider-constants                                           │
│                           Update system provider economy chain constants    │
│  update-constants         Update economy chain constants                    │
│  mint                     Manage voter set and proposals for minting        │
│  proposal                 Interact with existing proposals                  │
╰─────────────────────────────────────────────────────────────────────────────╯

The economy command (pmc economy) consists of sub-commands to interact with the economy chain. For example, create tags and clusters and manage proposals.

economy list tags​

Usage: pmc economy list-tags [OPTIONS]

  List all existing tags

╭─ 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                             │
│  --network=TEXT           Target network to make requests to (if chromia.yml│
│                           is configured)                                    │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│  -h, --help  Show this message and exit                                     │
╰─────────────────────────────────────────────────────────────────────────────╯

The tag list command (pmc economy list-tags) lists all tags.

economy add tag​

Usage: pmc economy add-tag [OPTIONS]

  Add a new tag

╭─ 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                             │
│  --network=TEXT           Target network to make requests to (if chromia.yml│
│                           is configured)                                    │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│* -n, --name=TEXT                  Name of the new tag                       │
│* -scup, --scu-price=INT           SCU price for the new tag                 │
│* -esp, --extra-storage-price=INT  Extra storage price for the new tag       │
│  -h, --help                       Show this message and exit                │
╰─────────────────────────────────────────────────────────────────────────────╯

The add tag command (pmc economy add-tag) proposes creating a new tag containing information about SCU price and extra storage price.

To add a tag, you must provide:

  • The name of the tag
  • The SCU price
  • The extra storage price

economy update tag​

Usage: pmc economy update-tag [OPTIONS]

  Update an existing tag

╭─ 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                             │
│  --network=TEXT           Target network to make requests to (if chromia.yml│
│                           is configured)                                    │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│* -n, --name=TEXT                  Name of the tag                           │
│  -scup, --scu-price=INT           Updated SCU price for the tag             │
│  -esp, --extra-storage-price=INT  Updated extra storage price for the tag   │
│  -h, --help                       Show this message and exit                │
╰─────────────────────────────────────────────────────────────────────────────╯

The update tag command (pmc economy update-tag) proposes a tag update. To change a tag of an existing cluster, see the change cluster tag command (pmc economy change-cluster-tag).

economy remove tag​

Usage: pmc economy remove-tag [OPTIONS]

  Remove tag

╭─ 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                             │
│  --network=TEXT           Target network to make requests to (if chromia.yml│
│                           is configured)                                    │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│* -n, --name=TEXT  Name of the tag to be removed                             │
│  -h, --help       Show this message and exit                                │
╰─────────────────────────────────────────────────────────────────────────────╯

The remove tag command (pmc economy remove-tag) proposes the removal of a tag.

economy add cluster​

Usage: pmc economy add-cluster [OPTIONS]

  Add a new cluster

╭─ 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                             │
│  --network=TEXT           Target network to make requests to (if chromia.yml│
│                           is configured)                                    │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│* -n, --name=TEXT            Name of the new cluster                         │
│* -vs, --voter-set=TEXT      Cluster voter set                               │
│  -clu, --cluster-units=INT  Cluster Units (minimum 1) (default: 1)          │
│  -es, --extra-storage=INT   Extra Storage (MiB) (default: 0)                │
│* -g, --governor=TEXT        Name of another voter set which can update this │
│                             cluster.                                        │
│* -t, --tag=TEXT             Cluster tag                                     │
│  -h, --help                 Show this message and exit                      │
╰─────────────────────────────────────────────────────────────────────────────╯

The add cluster command (pmc economy add-cluster) propose creating a new cluster that can hold nodes with containers holding blockchains.

To add a cluster, you must provide:

  • The name of the cluster
  • The name of the voter set
  • The pubkeys of the providers to be included in the cluster
  • The name of the governor
  • The tag to use for reward calculations
  • The cluster units
  • The extra storage

economy list clusters​

Usage: pmc economy list-clusters [OPTIONS]

  List all clusters that are tracked by economy chain

╭─ 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                             │
│  --network=TEXT           Target network to make requests to (if chromia.yml│
│                           is configured)                                    │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│  -i, --interactive  Prompt for item to show details for                     │
│  -h, --help         Show this message and exit                              │
╰─────────────────────────────────────────────────────────────────────────────╯

The cluster list command (pmc economy list-clusters) lists all the clusters that are managed through economy chain.

economy change cluster tag​

Usage: pmc economy change-cluster-tag [OPTIONS]

  Change the tag of a cluster

╭─ 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                             │
│  --network=TEXT           Target network to make requests to (if chromia.yml│
│                           is configured)                                    │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│* -cn, --cluster-name=TEXT  Name of the cluster                              │
│* -tn, --tag-name=TEXT      Name of the tag                                  │
│  -h, --help                Show this message and exit                       │
╰─────────────────────────────────────────────────────────────────────────────╯

The change cluster tag command (pmc economy change-cluster-tag) proposes the system to change the tag for a cluster.

economy cluster creations status​

Usage: pmc economy cluster-creation-status [OPTIONS]

  Get cluster creation status

╭─ 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                             │
│  --network=TEXT           Target network to make requests to (if chromia.yml│
│                           is configured)                                    │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│* -n, --name=TEXT  Name of the cluster to get creation status                │
│  -h, --help       Show this message and exit                                │
╰─────────────────────────────────────────────────────────────────────────────╯

The cluster creation status command (pmc economy cluster-creation-status) shows the status of a cluster's creation progress.

economy version​

Usage: pmc economy version [OPTIONS]

  Shows economy chain version

╭─ 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                             │
│  --network=TEXT           Target network to make requests to (if chromia.yml│
│                           is configured)                                    │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│  -h, --help  Show this message and exit                                     │
╰─────────────────────────────────────────────────────────────────────────────╯

The version command (pmc economy version) shows the version of the economy chain running on a network.

economy metrics​

Usage: pmc economy metrics [OPTIONS]

  Economy metrics for a provider

╭─ 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                             │
│  --network=TEXT           Target network to make requests to (if chromia.yml│
│                           is configured)                                    │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│* -pk, --pubkey=VALUE  Public key                                            │
│  -h, --help           Show this message and exit                            │
╰─────────────────────────────────────────────────────────────────────────────╯

The metrics command (pmc economy metrics) gets metrics for a provider.

economy get constants​

Usage: pmc economy get-constants [OPTIONS]

  Get economy chain constants

╭─ 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                             │
│  --network=TEXT           Target network to make requests to (if chromia.yml│
│                           is configured)                                    │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│  -h, --help  Show this message and exit                                     │
╰─────────────────────────────────────────────────────────────────────────────╯

The constants command (pmc economy constants) gets information about constants used for reward calculations.

economy update system provider constants​

Usage: pmc economy update-system-provider-constants [OPTIONS]

  Update system provider economy chain constants

╭─ 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                             │
│  --network=TEXT           Target network to make requests to (if chromia.yml│
│                           is configured)                                    │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│  --total-cost-system-providers=TEXT  Total cost system providers            │
│  --system-provider-fee-share=TEXT    System provider fee share              │
│  --system-provider-risk-share=TEXT   System provider risk share             │
│  -h, --help                          Show this message and exit             │
╰─────────────────────────────────────────────────────────────────────────────╯

The update system provider constants command (pmc economy update-system-provider-constants) updates constants managed by the system providers.

economy update constants​

Usage: pmc economy update-constants [OPTIONS]

  Update economy chain constants

╭─ 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                             │
│  --network=TEXT           Target network to make requests to (if chromia.yml│
│                           is configured)                                    │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│  --min-lease-time=INT                 Number of weeks as minimum for a lease│
│  --max-lease-time=INT                 Number of weeks as maximum for a lease│
│  --staking-reward-fee-share=TEXT      Staking reward fee share              │
│  --chromia-foundation-fee-share=TEXT  Chromia foundation fee share          │
│  --resource-pool-margin-fee-share=TEXT                                      │
│                                       Resource pool margin fee share        │
│  --dapp-provider-risk-share=TEXT      Dapp provider risk share              │
│  -h, --help                           Show this message and exit            │
╰─────────────────────────────────────────────────────────────────────────────╯

The update constants command (pmc economy update-constants) proposes an update of one or more constants.

economy mint​

Usage: pmc economy mint [OPTIONS] COMMAND [ARGS]...

  Manage voter set and proposals for minting

╭─ Options ───────────────────────────────────────────────────────────────────╮
│  -h, --help  Show this message and exit                                     │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ──────────────────────────────────────────────────────────────────╮
│  voter-set-create  Creates the voter set with members to manage minting     │
│                    proposals. Operation can only be run once and adds the   │
│                    signer as first member.                                  │
│  voter-set-info    Show information of voter set                            │
│  voter-set-update  Propose an update of the chromia foundation voter set    │
│  propose           Create a minting proposal                                │
╰─────────────────────────────────────────────────────────────────────────────╯

The economy mint command (pmc economy mint) consists of the sub-commands to manage voter set and proposals for minting.

economy voter-set-create​

Usage: pmc economy mint voter-set-create [OPTIONS]

  Creates the voter set with members to manage minting proposals. Operation can
  only be run once and adds the signer as first member.

╭─ 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                             │
│  --network=TEXT           Target network to make requests to (if chromia.yml│
│                           is configured)                                    │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│  -h, --help  Show this message and exit                                     │
╰─────────────────────────────────────────────────────────────────────────────╯

The voter set create command (pmc economy voter-set-create) creates a voter set with members to manage minting proposals. Operation can only be run once and adds the signer as first member.

economy voter-set-info​

Usage: pmc economy mint voter-set-info [OPTIONS]

  Show information of voter set

╭─ 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                             │
│  --network=TEXT           Target network to make requests to (if chromia.yml│
│                           is configured)                                    │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│  -h, --help  Show this message and exit                                     │
╰─────────────────────────────────────────────────────────────────────────────╯

The voter set info command (pmc economy voter-set-info) gets information about a voter set.

economy voter-set-update​

Usage: pmc economy mint voter-set-update [OPTIONS]

  Propose an update of the chromia foundation voter set

╭─ 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                             │
│  --network=TEXT           Target network to make requests to (if chromia.yml│
│                           is configured)                                    │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│  --threshold=INT        New threshold                                       │
│  --add-member=VALUE     Members pubkey(s) to add to voter set (default: []) │
│  --remove-member=VALUE  Members pubkey(s) to remove from voter set (default:│
│                         [])                                                 │
│  -h, --help             Show this message and exit                          │
╰─────────────────────────────────────────────────────────────────────────────╯

The voter set update command (pmc economy voter-set-update) proposes an update of the Chromia foundation voter set.

economy propose​

Usage: pmc economy mint propose [OPTIONS]

  Create a minting 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                             │
│  --network=TEXT           Target network to make requests to (if chromia.yml│
│                           is configured)                                    │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│* --amount=INT       Amount to min                                           │
│* --account-id=TEXT  Destination account id                                  │
│  -h, --help         Show this message and exit                              │
╰─────────────────────────────────────────────────────────────────────────────╯

The propose command (pmc economy propose) creates a minting proposal.

economy proposal​

Usage: pmc economy 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.                          │
╰─────────────────────────────────────────────────────────────────────────────╯

The economy proposal command (pmc economy proposal) consists of the sub-commands to interact with proposals.

economy proposal info​

Usage: pmc economy 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                             │
│  --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 proposal info command (pmc economy proposal info) gets information about a given proposal.

economy proposal list​

Usage: pmc economy 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                             │
│  --network=TEXT           Target network to make requests to (if chromia.yml│
│                           is configured)                                    │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│  --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 proposal list command (pmc economy proposal list) lists all proposals.

economy proposal revoke​

Usage: pmc economy 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                             │
│  --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 proposal revoke command (pmc economy proposal revoke) lets you withdraw your proposal.

economy proposal vote​

Usage: pmc economy 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                             │
│  --network=TEXT           Target network to make requests to (if chromia.yml│
│                           is configured)                                    │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│* --id=INT                     Id of the proposal                            │
│  -y, --accept / -n, --reject  Accept or reject this proposal                │
│  -h, --help                   Show this message and exit                    │
╰─────────────────────────────────────────────────────────────────────────────╯

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