Skip to main content

provider

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

  Provider commands

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

Commands:
  info                    Show provider information
  quotas                  List provider quotas
  quota                   Propose provider quota
  nodes                   List nodes by provider
  list                    List all providers
  register                Register new provider with given pubkey. There are
                          three tiers of providers:
  enable                  Propose enabling an existing provider
  promote                 Gives a provider access to add signer nodes to
                          clusters
  disable                 Propose disabling an existing provider
  remove                  Propose removal of provider. Provider must be
                          disabled. Command is irreversible
  transfer-action-points  transfer some of your action points to another
                          provider
  update                  update provider information

The provider command (pmc provider) consists of sub-commands used to manage providers.

info​

Usage: pmc provider info [OPTIONS]

  Show provider information

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

The info command (pmc provider info) shows a provider's name, pubkey, provider tier, action points and nodes. It also indicates whether the provider is a system provider, is active, and the cluster it belongs to.

quotas​

Usage: pmc provider quotas [OPTIONS]

  List provider quotas

Options:
  -cfg, --config VALUE  Configuration file for PMC (overrides system
                        configuration)
  -h, --help            Show this message and exit

The quotas command (pmc provider quotas) shows the provider's capacity. For example, it shows the maximum number of daily actions, nodes, and containers.

nodes​

Usage: pmc provider nodes [OPTIONS]

  List nodes by provider

Options:
  -cfg, --config VALUE  Configuration file for PMC (overrides system
                        configuration)
  -pk, --pubkey VALUE
  -h, --help            Show this message and exit

The nodes command (pmc provider nodes) lists all the nodes a provider is hosting.

list​

Usage: pmc provider list [OPTIONS]

  List all providers

Options:
  -cfg, --config VALUE  Configuration file for PMC (overrides system
                        configuration)
  -h, --help            Show this message and exit

The list command (pmc provider list) lists all providers in a network.

register​

Usage: pmc provider register [OPTIONS]

  Register new provider with given pubkey. There are three tiers of providers:

  - Community Node Provider: Basic provider, can deploy dapps and add nodes that replicates blockchains (replica) (default)
  - Node Provider:           Can add block builder nodes
  - System Provider:         System level permissions and can add node to the system cluster

  Examples:

  (1): pmc provider register -cnp --enable --pubkey aa...

  (2): pmc provider register --batch -cnp --enable --provider '{pubkey=x"aa...",name="foo",url="http://foo/api"}' --provider '{pubkey=x"bb...",name="bar"}'

  (3): pmc provider register --batch -cnp --enable, where providers will be load from `providers.properties` file:
          provider={pubkey=x"aa...",name="foo",url="http://foo/api"};{pubkey=x"bb...",name="bar",url="http://bar/api"}
          provider={pubkey=x"cc...",url="http://foobar/api"}

Provider tier:
  -cnp  community node provider
  -np   node provider
  -sp   system provider

Provider state:
  -e, --enable   enable provider
  -d, --disable  disable provider

Options:
  -cfg, --config VALUE  Configuration file for PMC (overrides system
                        configuration)
  -pk, --pubkey VALUE   Public key to register as provider
  --batch               Allows to add a batch of providers with --provider
                        (see examples)
  --provider VALUE      Multiple objects to register as providers in --batch
                        mode (comma delimited list of objects, see examples)
  --description TEXT    Proposal description
  -h, --help            Show this message and exit

With the register command (pmc provider register), you can add a provider to the network. There are three different kinds of provider tiers. A community node provider is the most basic and default option if no provider tier is specified.

The community node provider can deploy dapps and add nodes that replicate blockchains, and the nodes aren't able to build blocks for blockchains.

The second kind of provider is the node provider. A node provider can add block-building nodes. Node providers have to be enabled by letting other providers vote, the proposal can be created by using the option --enable.

The last tier is system provider, which is providers with system-level permissions. System-level permissions mean participation in voting for updates to management chains. A system provider can, for instance, add proposals to add nodes to the system cluster.

Example usage:

  • Add a provider as a node provider, which also creates a proposal to enable this provider.
pmc provider register --pubkey <pub-key> -np --enable

enable​

Usage: pmc provider enable [OPTIONS]

  Propose enabling an existing provider

Options:
  -cfg, --config VALUE  Configuration file for PMC (overrides system
                        configuration)
  -pk, --pubkey VALUE   Public key
  --description TEXT    Proposal description
  -h, --help            Show this message and exit

With the enable command (pmc provider enable), it's possible to enable an existing provider. Enables means that a proposal of accepting the node provider is created for other providers to vote on. When the provider is enabled, it's able to add block-building nodes.

promote​

Usage: pmc provider promote [OPTIONS]

  Gives a provider access to add signer nodes to clusters

Options:
  -cfg, --config VALUE  Configuration file for PMC (overrides system
                        configuration)
  -pk, --pubkey VALUE   Public key of provider to promote
  --system              Proposes this provider as a system provider
  --description TEXT    Proposal description
  -h, --help            Show this message and exit

The promote command (pmc provider promote) promotes a provider to a higher provider tier.

disable​

Usage: pmc provider disable [OPTIONS]

  Propose disabling an existing provider

Options:
  -cfg, --config VALUE  Configuration file for PMC (overrides system
                        configuration)
  -pk, --pubkey VALUE   Public key
  --description TEXT    Proposal description
  -h, --help            Show this message and exit

The disable command (pmc provider disable) proposes that another provider should be disabled in the network.

transfer-action-points​

Usage: pmc provider transfer-action-points [OPTIONS]

  transfer some of your action points to another provider

Options:
  -cfg, --config VALUE  Configuration file for PMC (overrides system
                        configuration)
  -pk, --pubkey VALUE   Public key
  -a, --amount INT      number of points to transfer
  -h, --help            Show this message and exit

The command (pmc provider transfer-action-points) transfers some of your action points to another provider.

update​

Usage: pmc provider update [OPTIONS]

  update provider information

Options:
  -cfg, --config VALUE  Configuration file for PMC (overrides system
                        configuration)
  -n, --name TEXT       Provider name
  --url TEXT            Provider url
  -h, --help            Show this message and exit

The command (pmc provider update) updates information about a provider.