Building with SettleMint/SettleMint CLI/Commands/Platform
Create
Usage: settlemint platform create|c [options] [command]
Create a resource in the SettleMint platform
Options:
-h, --help display help for command
Commands:
application-access-token|aat [options] <name> Create a new application access token in the SettleMint platform.
application|a [options] <name> Create a new application in the SettleMint platform.
blockchain-network|bnw Create a blockchain network in the SettleMint platform
blockchain-node|bn Create a blockchain node in the SettleMint platform
insights|in Create a new insights
integration-tool|it Create a new integration tool
load-balancer|lb Create a load balancer in the SettleMint platform
middleware|mw Create a middleware service in the SettleMint platform
private-key|pk Create a private key in the SettleMint platform
storage|st Create a storage service in the SettleMint platform
workspace|w [options] <name> Create a new workspace in the SettleMint platform.
help [command] display help for command
Application access token
Usage: settlemint platform create application-access-token|aat
Examples:
# Create an application access token and save as default
$ settlemint platform create application-access-token my-token --accept-defaults -d
# Create an application access token with custom validity period
$ settlemint platform create application-access-token my-token --validity-period ONE_DAY -a -d
# Create an application access token (shorthand)
$ settlemint platform create aat my-token
Create a new application access token in the SettleMint platform.
Arguments:
name The application access token name
Options:
-a, --accept-defaults Accept the default values
-d, --default Save as default application access token
--prod Connect to production environment
--app, --application <application> The application unique name to create the
application access token for (defaults to
application from env)
-v, --validity-period <period> The validity period for the token
(choices: "DAYS_7", "DAYS_30", "DAYS_60",
"DAYS_90", "NONE", default: "DAYS_7")
-h, --help display help for command
Application
Usage: settlemint platform create application|a
Examples:
# Create an application in a workspace
$ settlemint platform create application my-app --accept-defaults
# Create an application and save as default
$ settlemint platform create application my-app -d
# Create an application in a specific workspace
$ settlemint platform create application my-app --workspace my-workspace
Create a new application in the SettleMint platform.
Arguments:
name The application name
Options:
-a, --accept-defaults Accept the default values
-d, --default Save as default application
--prod Connect to production environment
-w, --workspace <workspace> The workspace unique name to create the
application in (defaults to workspace from env)
-h, --help display help for command
Blockchain network
Usage: settlemint platform create blockchain-network|bnw [options] [command]
Create a blockchain network in the SettleMint platform
Options:
-h, --help display help for command
Commands:
besu|b [options] <name> Create a new Besu blockchain network in the
SettleMint platform.
help [command] display help for command
Besu
Usage: settlemint platform create blockchain-network besu|b
Examples:
# Create a Besu blockchain network and save as default
$ settlemint platform create blockchain-network besu my-network --node-name validator-1 --accept-defaults -d
# Create a Besu blockchain network in a different application
$ settlemint platform create blockchain-network besu my-network --application app-123 --node-name validator-1 --chain-id 12345 --gas-limit 10000000 --seconds-per-block 5
Create a new Besu blockchain network in the SettleMint platform.
Arguments:
name The Besu blockchain network name
Options:
-a, --accept-defaults Accept the default values
-d, --default Save as default blockchain network
--prod Connect to production environment
-w, --wait Wait until deployed
-r, --restart-if-timeout Restart if wait time is exceeded
--provider <provider> Network provider (run `settlemint
platform config` to see available
providers)
--region <region> Deployment region (run `settlemint
platform config` to see available
regions)
--size <size> Network size (choices: "LARGE", "MEDIUM",
"SMALL", default: "SMALL")
--type <type> Network type (choices: "DEDICATED",
"SHARED", default: "SHARED")
--app, --application <application> The unique name of the application to
create the network in (defaults to
application from env)
--node-name <name> Name of the node
--chain-id <chainId> The chain ID for the network
--contract-size-limit <limit> Maximum contract size limit
--evm-stack-size <size> EVM stack size
--gas-limit <limit> Block gas limit
--gas-price <price> Gas price in wei
--seconds-per-block <seconds> Block time in seconds
-h, --help display help for command
Blockchain node
Usage: settlemint platform create blockchain-node|bn [options] [command]
Create a blockchain node in the SettleMint platform
Options:
-h, --help display help for command
Commands:
besu|b [options] <name> Create a new Besu blockchain node in the SettleMint
platform.
help [command] display help for command
Besu
Usage: settlemint platform create blockchain-node besu|b
Examples:
# Create a Besu blockchain node and save as default
$ settlemint platform create blockchain-node besu my-node --node-type VALIDATOR --accept-defaults -d
# Create a Besu blockchain node in a different network
$ settlemint platform create blockchain-node besu my-node --blockchain-network-id 12345 --node-type NON_VALIDATOR --accept-defaults
# Create a Besu blockchain node in a different application
$ settlemint platform create blockchain-node besu my-node --application-id 123456789 --node-type NON_VALIDATOR --accept-defaults
Create a new Besu blockchain node in the SettleMint platform.
Arguments:
name The Besu blockchain node name
Options:
-a, --accept-defaults Accept the default values
-d, --default Save as default blockchain node
--prod Connect to production environment
-w, --wait Wait until deployed
-r, --restart-if-timeout Restart if wait time is exceeded
--provider <provider> Network provider (run `settlemint platform config` to see available providers)
--region <region> Deployment region (run `settlemint platform config` to see available regions)
--size <size> Network size (choices: "LARGE", "MEDIUM", "SMALL", default: "SMALL")
--type <type> Network type (choices: "DEDICATED", "SHARED", default: "SHARED")
--app, --application <application> The application unique name to create the node in (defaults to application from env)
--blockchain-network <blockchainNetwork> Blockchain network unique name to add this node to
--node-identity <nodeIdentity> EC DSA P256 private key to use as the node identity
--node-type <nodeType> Type of the node (choices: "VALIDATOR", "NON_VALIDATOR")
-h, --help display help for command
Insights
Usage: settlemint platform create insights|in [options] [command]
Create a new insights
Options:
-h, --help display help for command
Commands:
blockscout|bs [options] <name> Create a new Blockscout insights in the
SettleMint platform.
help [command] display help for command
Blockscout
Usage: settlemint platform create insights blockscout|bs
Examples:
# Create a Blockscout insights service and save as default
$ settlemint platform create insights blockscout my-blockscout --accept-defaults -d
# Create a Blockscout insights service in a different application
$ settlemint platform create insights blockscout my-blockscout --application app-123
# Create a Blockscout insights service and connect to a specific load balancer
$ settlemint platform create insights blockscout my-blockscout --load-balancer my-load-balancer
# Create a Blockscout insights service and connect to a specific blockchain node
$ settlemint platform create insights blockscout my-blockscout --blockchain-node my-blockchain-node
Create a new Blockscout insights in the SettleMint platform.
Arguments:
name The Blockscout insights name
Options:
-a, --accept-defaults Accept the default values
-d, --default Save as default insights
--prod Connect to production environment
-w, --wait Wait until deployed
-r, --restart-if-timeout Restart if wait time is exceeded
--provider <provider> Network provider (run `settlemint
platform config` to see available
providers)
--region <region> Deployment region (run `settlemint
platform config` to see available
regions)
--size <size> Network size (choices: "LARGE", "MEDIUM",
"SMALL", default: "SMALL")
--type <type> Network type (choices: "DEDICATED",
"SHARED", default: "SHARED")
--application <application> Application unique name
--load-balancer <loadBalancer> Load Balancer unique name (mutually
exclusive with blockchain-node)
--blockchain-node <blockchainNode> Blockchain Node unique name (mutually
exclusive with load-balancer)
-h, --help display help for command
Integration tool
Usage: settlemint platform create integration-tool|it [options] [command]
Create a new integration tool
Options:
-h, --help display help for command
Commands:
hasura|ha [options] <name> Create a new Hasura integration tool in the
SettleMint platform.
help [command] display help for command
Hasura
Usage: settlemint platform create integration-tool hasura|ha
Examples:
# Create a Hasura integration and save as default
$ settlemint platform create integration-tool hasura my-hasura --accept-defaults -d
# Create a Hasura integration in a different application
$ settlemint platform create integration-tool hasura my-hasura --application app-123
Create a new Hasura integration tool in the SettleMint platform.
Arguments:
name The Hasura integration tool name
Options:
-a, --accept-defaults Accept the default values
-d, --default Save as default integration tool
--prod Connect to production environment
-w, --wait Wait until deployed
-r, --restart-if-timeout Restart if wait time is exceeded
--provider <provider> Network provider (run `settlemint platform
config` to see available providers)
--region <region> Deployment region (run `settlemint platform
config` to see available regions)
--size <size> Network size (choices: "LARGE", "MEDIUM",
"SMALL", default: "SMALL")
--type <type> Network type (choices: "DEDICATED", "SHARED",
default: "SHARED")
--application <application> Application unique name
-h, --help display help for command
Load balancer
Usage: settlemint platform create load-balancer|lb [options] [command]
Create a load balancer in the SettleMint platform
Options:
-h, --help display help for command
Commands:
evm [options] <name> Create a new EVM load balancer in the SettleMint
platform.
help [command] display help for command
Evm
Usage: settlemint platform create load-balancer evm
Examples:
# Create an EVM load balancer and save as default
$ settlemint platform create load-balancer evm my-lb --accept-defaults -d
# Create an EVM load balancer and connect to specific blockchain nodes
$ settlemint platform create load-balancer evm my-lb --blockchain-network my-network --accept-defaults
# Create an EVM load balancer in a different application
$ settlemint platform create load-balancer evm my-lb --application my-app --accept-defaults
Create a new EVM load balancer in the SettleMint platform.
Arguments:
name The EVM load balancer name
Options:
-a, --accept-defaults Accept the default values
-d, --default Save as default load balancer
--prod Connect to production environment
-w, --wait Wait until deployed
-r, --restart-if-timeout Restart if wait time is exceeded
--provider <provider> Network provider (run `settlemint platform config` to see available providers)
--region <region> Deployment region (run `settlemint platform config` to see available regions)
--size <size> Network size (choices: "LARGE", "MEDIUM", "SMALL", default: "SMALL")
--type <type> Network type (choices: "DEDICATED", "SHARED", default: "SHARED")
--app, --application <application> The application unique name to create the load balancer in (defaults to application from env)
--blockchain-nodes <blockchainNodes...> Blockchain node unique names where the load balancer connects to (must be from the same network)
--blockchain-network <blockchainNetwork> Blockchain network unique name where the load balancer connects to, can be skipped if the --blockchain-nodes option is used (defaults to network from env)
-h, --help display help for command
Middleware
Usage: settlemint platform create middleware|mw [options] [command]
Create a middleware service in the SettleMint platform
Options:
-h, --help display help for command
Commands:
graph|gr [options] <name> Create a new The Graph middleware in the SettleMint platform.
smart-contract-portal|scp [options] <name> Create a new Smart Contract Portal middleware in the SettleMint platform.
help [command] display help for command
Graph
Usage: settlemint platform create middleware graph|gr
Examples:
# Create a graph middleware and save as default
$ settlemint platform create middleware graph my-graph --accept-defaults -d
# Create a graph middleware in a different application
$ settlemint platform create middleware graph my-graph --application my-app --blockchain-node node-123
# Create a graph middleware and connect to a specific load balancer
$ settlemint platform create middleware graph my-graph --load-balancer my-load-balancer
# Create a graph middleware and connect to a specific blockchain node
$ settlemint platform create middleware graph my-graph --blockchain-node my-blockchain-node
Create a new The Graph middleware in the SettleMint platform.
Arguments:
name The The Graph middleware name
Options:
-a, --accept-defaults Accept the default values
-d, --default Save as default middleware
--prod Connect to production environment
-w, --wait Wait until deployed
-r, --restart-if-timeout Restart if wait time is exceeded
--provider <provider> Network provider (run `settlemint
platform config` to see available
providers)
--region <region> Deployment region (run `settlemint
platform config` to see available
regions)
--size <size> Network size (choices: "LARGE", "MEDIUM",
"SMALL", default: "SMALL")
--type <type> Network type (choices: "DEDICATED",
"SHARED", default: "SHARED")
--application <application> Application unique name
--blockchain-node <blockchainNode> Blockchain Node unique name (mutually
exclusive with load-balancer)
--load-balancer <loadBalancer> Load Balancer unique name (mutually
exclusive with blockchain-node)
-h, --help display help for command
Smart contract portal
Usage: settlemint platform create middleware smart-contract-portal|scp
Examples:
# Create a smart contract portal middleware and save as default
$ settlemint platform create middleware smart-contract-portal my-portal --accept-defaults -d
# Create a smart contract portal middleware in a different application
$ settlemint platform create middleware smart-contract-portal my-portal --application my-app --blockchain-node node-123
# Create a smart contract portal middleware and connect to a specific blockchain node
$ settlemint platform create middleware smart-contract-portal my-portal --blockchain-node my-blockchain-node
# Create a smart contract portal middleware and connect to a specific load balancer
$ settlemint platform create middleware smart-contract-portal my-portal --load-balancer my-load-balancer
Create a new Smart Contract Portal middleware in the SettleMint platform.
Arguments:
name The Smart Contract Portal middleware name
Options:
-a, --accept-defaults Accept the default values
-d, --default Save as default middleware
--prod Connect to production environment
-w, --wait Wait until deployed
-r, --restart-if-timeout Restart if wait time is exceeded
--provider <provider> Network provider (run `settlemint platform config` to see available providers)
--region <region> Deployment region (run `settlemint platform config` to see available regions)
--size <size> Network size (choices: "LARGE", "MEDIUM", "SMALL", default: "SMALL")
--type <type> Network type (choices: "DEDICATED", "SHARED", default: "SHARED")
--application <application> Application unique name
--load-balancer <loadBalancer> Load Balancer unique name (mutually exclusive with blockchain-node)
--blockchain-node <blockchainNode> Blockchain Node unique name (mutually exclusive with load-balancer)
--abis <abis...> Path to abi file(s)
--include-predeployed-abis <includePredeployedAbis...> Include pre-deployed abis (run `settlemint platform config` to see available pre-deployed abis)
-h, --help display help for command
Private key
Usage: settlemint platform create private-key|pk [options] [command]
Create a private key in the SettleMint platform
Options:
-h, --help display help for command
Commands:
hd-ecdsa-p256|hd [options] <name> Create a new HD-ECDSA-P256 private key in the SettleMint platform.
hsm-ecdsa-p256|hsm [options] <name> Create a new HSM-ECDSA-P256 private key in the SettleMint platform.
accessible-ecdsa-p256|acc [options] <name> Create a new ACCESSIBLE-ECDSA-P256 private key in the SettleMint platform.
help [command] display help for command
Hd ecdsa p256
Usage: settlemint platform create private-key hd-ecdsa-p256|hd
Examples:
# Create a private key and save as default
$ settlemint platform create private-key hd-ecdsa-p256 my-key --accept-defaults -d
# Create a private key in a different application
$ settlemint platform create private-key hd-ecdsa-p256 my-key --application my-app
# Create a private key linked to a blockchain node
$ settlemint platform create private-key hd-ecdsa-p256 my-key --blockchain-node node-123
Create a new HD-ECDSA-P256 private key in the SettleMint platform.
Arguments:
name The HD-ECDSA-P256 private key name
Options:
-a, --accept-defaults Accept the default values
-d, --default Save as default private key
--prod Connect to production environment
-w, --wait Wait until deployed
-r, --restart-if-timeout Restart if wait time is exceeded
--application <application> Application unique name
--blockchain-node <blockchainNode> Blockchain Node unique name
-h, --help display help for command
Hsm ecdsa p256
Usage: settlemint platform create private-key hsm-ecdsa-p256|hsm
Examples:
# Create a private key and save as default
$ settlemint platform create private-key hsm-ecdsa-p256 my-key --accept-defaults -d
# Create a private key in a different application
$ settlemint platform create private-key hsm-ecdsa-p256 my-key --application 123456789
# Create a private key linked to a blockchain node
$ settlemint platform create private-key hsm-ecdsa-p256 my-key --blockchain-node node-123
Create a new HSM-ECDSA-P256 private key in the SettleMint platform.
Arguments:
name The HSM-ECDSA-P256 private key name
Options:
-a, --accept-defaults Accept the default values
-d, --default Save as default private key
--prod Connect to production environment
-w, --wait Wait until deployed
-r, --restart-if-timeout Restart if wait time is exceeded
--application <application> Application unique name
--blockchain-node <blockchainNode> Blockchain Node unique name
-h, --help display help for command
Accessible ecdsa p256
Usage: settlemint platform create private-key accessible-ecdsa-p256|acc
Examples:
# Create a private key and save as default
$ settlemint platform create private-key accessible-ecdsa-p256 my-key --accept-defaults -d
# Create a private key in a different application
$ settlemint platform create private-key accessible-ecdsa-p256 my-key --application my-app
# Create a private key linked to a blockchain node
$ settlemint platform create private-key accessible-ecdsa-p256 my-key --blockchain-node node-123
Create a new ACCESSIBLE-ECDSA-P256 private key in the SettleMint platform.
Arguments:
name The ACCESSIBLE-ECDSA-P256 private key
name
Options:
-a, --accept-defaults Accept the default values
-d, --default Save as default private key
--prod Connect to production environment
-w, --wait Wait until deployed
-r, --restart-if-timeout Restart if wait time is exceeded
--application <application> Application unique name
--blockchain-node <blockchainNode> Blockchain Node unique name
-h, --help display help for command
Storage
Usage: settlemint platform create storage|st [options] [command]
Create a storage service in the SettleMint platform
Options:
-h, --help display help for command
Commands:
ipfs|ip [options] <name> Create a new IPFS storage in the SettleMint
platform.
minio|m [options] <name> Create a new MinIO storage in the SettleMint
platform.
help [command] display help for command
Ipfs
Usage: settlemint platform create storage ipfs|ip
Examples:
# Create an IPFS storage and save as default
$ settlemint platform create storage ipfs my-storage --accept-defaults -d
# Create an IPFS storage in a different application
$ settlemint platform create storage ipfs my-storage --application app-123
Create a new IPFS storage in the SettleMint platform.
Arguments:
name The IPFS storage name
Options:
-a, --accept-defaults Accept the default values
-d, --default Save as default storage
--prod Connect to production environment
-w, --wait Wait until deployed
-r, --restart-if-timeout Restart if wait time is exceeded
--provider <provider> Network provider (run `settlemint platform
config` to see available providers)
--region <region> Deployment region (run `settlemint platform
config` to see available regions)
--size <size> Network size (choices: "LARGE", "MEDIUM",
"SMALL", default: "SMALL")
--type <type> Network type (choices: "DEDICATED", "SHARED",
default: "SHARED")
--application <application> Application unique name
-h, --help display help for command
Minio
Usage: settlemint platform create storage minio|m
Examples:
# Create a MinIO storage and save as default
$ settlemint platform create storage minio my-storage --accept-defaults -d
# Create a MinIO storage in a different application
$ settlemint platform create storage minio my-storage --application app-123
Create a new MinIO storage in the SettleMint platform.
Arguments:
name The MinIO storage name
Options:
-a, --accept-defaults Accept the default values
-d, --default Save as default storage
--prod Connect to production environment
-w, --wait Wait until deployed
-r, --restart-if-timeout Restart if wait time is exceeded
--provider <provider> Network provider (run `settlemint platform
config` to see available providers)
--region <region> Deployment region (run `settlemint platform
config` to see available regions)
--size <size> Network size (choices: "LARGE", "MEDIUM",
"SMALL", default: "SMALL")
--type <type> Network type (choices: "DEDICATED", "SHARED",
default: "SHARED")
--application <application> Application unique name
-h, --help display help for command
Workspace
Usage: settlemint platform create workspace|w
Examples:
# Create a workspace with company details
$ settlemint platform create workspace my-workspace --name "SettleMint" --tax-id-type eu_vat --tax-id-value BE0661674810
# Create a workspace with address details
$ settlemint platform create workspace my-workspace --line1 "123 Main St" --city "Brussels" --postal-code "1000" --country BE
# Create a workspace and save as default
$ settlemint platform create workspace my-workspace -d
Create a new workspace in the SettleMint platform.
Arguments:
name The workspace name
Options:
-a, --accept-defaults Accept the default values
-d, --default Save as default workspace
--prod Connect to production environment
--company-name <companyName> Company name
--address-line-1 <addressLine1> Address line 1
--address-line-2 <addressLine2> Address line 2
--city <city> City
--postal-code <code> Postal code
--country <country> Country
--tax-id-value <value> Tax ID value
--tax-id-type <type> Tax ID type (e.g. 'eu_vat' for European VAT number like 'ATU12345678', 'us_ein' for US EIN like '12-3456789') (choices: "ad_nrt", "ar_cuit", "au_abn", "au_arn", "eu_vat", "bh_vat", "by_tin", "bo_tin", "br_cnpj", "br_cpf", "bg_uic", "ca_bn", "ca_gst_hst", "ca_pst_bc", "ca_pst_mb", "ca_pst_sk", "ca_qst", "cl_tin", "cn_tin", "co_nit", "cr_tin", "hr_oib", "do_rcn", "ec_ruc", "eg_tin", "sv_nit", "eu_oss_vat", "ge_vat", "de_stn", "hk_br", "hu_tin", "is_vat", "in_gst", "id_npwp", "il_vat", "jp_cn", "jp_rn", "jp_trn", "kz_bin", "ke_pin", "li_uid", "li_vat", "my_frp", "my_itn", "my_sst", "mx_rfc", "md_vat", "ma_vat", "nz_gst", "ng_tin", "no_vat", "no_voec", "om_vat", "pe_ruc", "ph_tin", "ro_tin", "ru_inn", "ru_kpp", "sa_vat", "rs_pib", "sg_gst", "sg_uen", "si_tin", "za_vat", "kr_brn", "es_cif", "ch_uid", "ch_vat", "tw_vat", "tz_vat", "th_vat", "tr_tin", "ua_vat", "ae_trn", "gb_vat", "us_ein", "uy_ruc", "uz_tin", "uz_vat", "ve_rif", "vn_tin")
--payment-method-id <paymentMethodId> Payment method ID
--parent-id <parentId> Parent workspace ID
-h, --help display help for command