Skip to main content
Version: Next

TAPLE Client configuration

The configuration of a TAPLE-Cient node can be done in different ways. The supported mechanisms are listed below, from the highest to the lowest priority:

  • Environment variables.
  • Input parameters.
  • File settings.toml.
  • Default value.

General options

Database path

DescriptionPath where the database is stored
EnvVarTAPLE_DB_PATH
Input param-d, --db-path
settings.tomldb-path
Admited valuesAny valid writable folder path. Default to $HOME_PATH/.taple/db. if it does not exist or does not have write permissions, it uses tmp/.taple/db

ID private key

DescriptionPrivate key identifying the node's owner
EnvVarTAPLE_ID_PRIVATE_KEY
Input param-k, --id-private-key
settings.tomlid-private-key
Admited valuesPrivate keys associated with an identity in TAPLE. HEX format

ID key derivator

DescriptionKey derivative to be used by the Taple node.
EnvVarTAPLE_ID_KEY_DERIVATOR
Input param--id-key-derivator
settings.tomlid-key-derivator
Admited valuesed25519 (default), secp256k1

Digest derivator

DescriptionDigest derivator to use when signing.
EnvVarTAPLE_DIGEST_DERIVATOR
Input param--digest-derivator
settings.tomldigest-derivator
Admited valuesBlake3_256 (default), Blake3_512, SHA2_256, SHA2_512, SHA3_256, SHA3_512

Key derivator

DescriptionKey derivator to use when creating new key pairs.
EnvVarTAPLE_KEY_DERIVATOR
Input param--key-derivator
settings.tomlkey-derivator
Admited valuesed25519 (default), secp256k1

Network

Listen address

DescriptionNetwork interface on which incoming connections are listened for
EnvVarTAPLE_NETWORK_LISTEN_ADDR
Input param-a, --network.listen-addr
settings.toml[network]
listen-addr
Admited valuesA valid multiaddr representing a listen interface. More than 1 value can be specified. Default value: /ip4/0.0.0.0/tcp/40040

Known node

DescriptionAddress of a known node at start-up
EnvVarTAPLE_NETWORK_KNOWN_NODE
Input param--network.known-node
settings.toml[network]
known-node
Admited valuesA valid multiaddr. More than 1 value can be specified.

External Address

DescriptionPublic address known at start-up
EnvVarTAPLE_NETWORK_EXTERNAL_ADDR
Input param--network.external-addr
settings.toml[network]
external-addr
Admited valuesA valid multiaddr. More than 1 value can be specified.

API REST

Enable/disable

DescriptionEnable/disable API REST
EnvVarTAPLE_HTTP
Input param--http
settings.toml[http]
http
Admited valuesBoolean value. Default: false

Enable/disable documentation

DescriptionEnable/disable API REST documentation. If enabled, documentation is available at /doc
EnvVarTAPLE_HTTP_DOC
Input param--http.doc
settings.toml[http]
doc
Admited valuesBoolean value. Default: false

Port

DescriptionAPI REST port
EnvVarTAPLE_HTTP_PORT
Input param--http.port
settings.toml[http]
port
Admited valuesA valid port number. Default: 3000

Address

DescriptionNetwork interface on which incoming connections are listened for
EnvVarTAPLE_HTTP_ADDR
Input param--http.addr
settings.toml[http]
addr
Admited valuesA valid network interface. Default: 0.0.0.0

Smart contracts

Build path

DescriptionPath where smart contracts are compiled
EnvVarTAPLE_SC_BUILD_PATH
Input param--sc.build-path
settings.toml[sc]
build-path
Admited valuesAny valid writable folder path. Default to $HOME_PATH/.taple/sc. if it does not exist or does not have write permissions, it uses tmp/.taple/sc