Docs
chromia.com

lease

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

  Lease commands

╭─ Options ───────────────────────────────────────────────────────────────────╮
│  -h, --help  Show this message and exit                                     │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ──────────────────────────────────────────────────────────────────╮
│  list                        List leases                                    │
│  info                        Get lease info                                 │
│  upgrade-container           Upgrade a container                            │
│  assign-subnode-image        Assign a custom subnode image to an existing   │
│                              container                                      │
│  create-container            Create a container                             │
│  remove-container            Remove a container and its associated lease    │
│                              without refund                                 │
│  list-pending-tickets        List pending lease tickets                     │
│  add-subnode-jar-extensions  Add subnode JAR extensions to an existing      │
│                              container                                      │
╰─────────────────────────────────────────────────────────────────────────────╯

The lease command (pmc lease) has sub-commands for container lease.

lease list

Help output
Usage: pmc lease list [OPTIONS]

  List leases

╭─ 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)                 │
│  --account-id=ID        Account id                                          │
│  --evm-address=ADDRESS  EVM address                                         │
│  -i, --interactive      Prompt for item to show details for                 │
│  -h, --help             Show this message and exit                          │
╰─────────────────────────────────────────────────────────────────────────────╯

The list command (pmc lease list) lists all the active leases.

lease info

Help output
Usage: pmc lease info [OPTIONS]

  Get lease info

╭─ 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)                             │
│* -n, --name=NAME      Container name                                        │
│  -h, --help           Show this message and exit                            │
╰─────────────────────────────────────────────────────────────────────────────╯

The info command (pmc lease info) shows information about a given lease.

lease upgrade-container

Help output
Usage: pmc lease upgrade-container [OPTIONS]

  Upgrade a container

╭─ 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)            │
│  --account-id=ID             Account id                                     │
│  --evm-address=ADDRESS       EVM address                                    │
│* -n, --name=NAME             Container name                                 │
│* --scus=SCUS                 Number of SCUs                                 │
│* --duration=WEEKS                                                           │
│  --extraStorage=GIB          (default: 0)                                   │
│  --extraComputeRequests=INT                                                 │
│* -cn, --cluster-name=TEXT    Name of the cluster                            │
│  -h, --help                  Show this message and exit                     │
╰─────────────────────────────────────────────────────────────────────────────╯

The upgrade-container command (pmc lease upgrade-container) upgrades a container.

lease assign-subnode-image

Help output
Usage: pmc lease assign-subnode-image [OPTIONS]

  Assign a custom subnode image to an existing container

╭─ 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)                 │
│  --account-id=ID        Account id                                          │
│  --evm-address=ADDRESS  EVM address                                         │
│* -n, --name=NAME        Container name                                      │
│  -sin, --subnode-image-name=TEXT                                            │
│                         Subnode image name                                  │
│  -h, --help             Show this message and exit                          │
╰─────────────────────────────────────────────────────────────────────────────╯

The assign-subnode-image command (pmc lease assign-subnode-image) assigns a custom subnode image to an existing container.

lease create-container

Help output
Usage: pmc lease create-container [OPTIONS]

  Create a container

╭─ 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)            │
│  --account-id=ID             Account id                                     │
│  --evm-address=ADDRESS       EVM address                                    │
│* -cn, --cluster-name=TEXT    Name of the cluster                            │
│* --scus=SCUS                 Number of SCUs                                 │
│* --duration=WEEKS                                                           │
│  --extraStorage=GIB          (default: 0)                                   │
│  --extraComputeRequests=INT                                                 │
│  -sin, --subnode-image-name=TEXT                                            │
│                              Subnode image name                             │
│  -sje, --subnode-jar-extension-names=TEXT                                   │
│                              Comma separated list of subnode JAR extension  │
│                              names (default: [])                            │
│  --auto-renew                Auto renew                                     │
│  -h, --help                  Show this message and exit                     │
╰─────────────────────────────────────────────────────────────────────────────╯

The create-container command (pmc lease create-container) creates a container.

lease remove-container

Help output
Usage: pmc lease remove-container [OPTIONS]

  Remove a container and its associated lease without refund

╭─ 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)                 │
│  --account-id=ID        Account id                                          │
│  --evm-address=ADDRESS  EVM address                                         │
│* -n, --name=NAME        Container name                                      │
│  -h, --help             Show this message and exit                          │
╰─────────────────────────────────────────────────────────────────────────────╯

The remove-container command (pmc lease remove-container) removes a container and its associated lease without a refund.

lease list-pending-tickets

Help output
Usage: pmc lease list-pending-tickets [OPTIONS]

  List pending lease tickets

╭─ 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)                 │
│  --account-id=ID        Account id                                          │
│  --evm-address=ADDRESS  EVM address                                         │
│  -h, --help             Show this message and exit                          │
╰─────────────────────────────────────────────────────────────────────────────╯

The list-pending-tickets command (pmc lease list-pending-tickets) lists pending lease tickets.

lease add-subnode-jar-extensions

Help output
Usage: pmc lease add-subnode-jar-extensions [OPTIONS]

  Add subnode JAR extensions to an existing container

╭─ 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)                 │
│  --account-id=ID        Account id                                          │
│  --evm-address=ADDRESS  EVM address                                         │
│* -n, --name=NAME        Container name                                      │
│  -sje, --subnode-jar-extension-names=TEXT                                   │
│                         Comma separated list of subnode JAR extension names │
│                         (default: [])                                       │
│  -h, --help             Show this message and exit                          │
╰─────────────────────────────────────────────────────────────────────────────╯

The add-subnode-jar-extensions command (pmc lease add-subnode-jar-extensions) adds JAR extensions to a subnode.