Skip to content

config.md

Latest commit

 

History

History
121 lines (97 loc) · 4.48 KB

config.md

File metadata and controls

121 lines (97 loc) · 4.48 KB
Raw

Configuration reference

Full reference for config.conf. At startup, wallet-cli first reads ./config.conf from the process working directory. If that file does not exist, it loads the bundled classpath resource (src/main/resources/config.conf in a source checkout). You can also switch networks at runtime with SwitchNetwork.

Minimal config

A minimal config.conf needs a full-node endpoint. Keeping net.type is useful when configuring a mainnet API key, but it does not select the active network:

net {
  type = mainnet
}

fullnode = {
  ip.list = [
    "fullnode ip : port"
  ]
}

Full annotated config

Optional Solidity node, Ledger debug, account lock, GasFree, TronGrid API key, TronLink multi-sig, and record limits:

net {
 type = mainnet
}

fullnode = {
  ip.list = [
    "fullnode ip : port"
  ]
}

#soliditynode = {
#  //The IPs in this list can only be totally set to solidity.
#  ip.list = [
#     "ip : solidity port" // default solidity
#  ]
#  // NOTE: solidity node is optional
#}

# open ledger debug
# ledger_debug = true

# To use the lock and unlock function of the login account, it is necessary to configure
# lockAccount = true in the config.conf. The current login account is locked, which means that
# signatures and transactions are not allowed. After the current login account is locked, it can be
# unlocked. By default, it will be unlocked again after 300 seconds. Unlocking can specify
# parameters in seconds.

# lockAccount = true

# To use the gasfree feature, please first apply for an APIkey and apiSecret.
# For details, please refer to
# https://docs.google.com/forms/d/e/1FAIpQLSc5EB1X8JN7LA4SAVAG99VziXEY6Kv6JxmlBry9rUBlwI-GaQ/viewform
gasfree = {
  mainnet = {
     apiKey = ""
     apiSecret = ""
  }
  testnet = {
     apiKey = ""
     apiSecret = ""
  }
}

# If gRPC requests on the main network are limited in speed, you can apply for an apiKey of Trongrid to improve the user experience
grpc = {
  mainnet = {
    apiKey = ""
  }
}

# Set the maximum number of transactions and backup records that can be retained
maxRecords = 1000

# To use the tronlink multi-sign feature, please first apply for an secretId and secretKey.
# For details, please refer to
# https://docs.google.com/forms/d/e/1FAIpQLSc5EB1X8JN7LA4SAVAG99VziXEY6Kv6JxmlBry9rUBlwI-GaQ/viewform
# If you prefer not to apply, a speed-limited secretId and secretKey will be provided for use: 
# secretId = "TEST", secretKey = "TESTTESTTEST", channel = "test".
tronlink = {
  mainnet = {
    secretId = ""
    secretKey = ""
    channel = ""
  }
  testnet = {
    secretId = ""
    secretKey = ""
    channel = ""
  }
}

Field summary

Field Purpose
net.type Controls whether grpc.mainnet.apiKey is loaded. It does not select the active network.
fullnode.ip.list Full node endpoint(s) ip : port.
soliditynode.ip.list Optional Solidity node endpoint(s).
ledger_debug Enable Ledger debug output.
lockAccount Enable the Lock/Unlock feature (default unlock duration 300 seconds).
gasfree.{mainnet,testnet}.apiKey / apiSecret GasFree credentials.
grpc.mainnet.apiKey TronGrid API key to raise gRPC rate limits.
maxRecords Maximum retained transactions / backup records.
tronlink.{mainnet,testnet}.secretId / secretKey / channel TronLink multi-sign credentials.

Connecting to Java-tron

wallet-cli connects to Java-tron via gRPC. The startup network is inferred by comparing the endpoints you supplied — fullnode.ip.list, soliditynode.ip.list, or both — with the built-in Mainnet, Nile, and Shasta endpoints. An endpoint you leave out is not compared, so naming only Nile's full node still starts on Nile; anything that does not match a built-in network is CUSTOM. Consequently, net.type = mainnet with Nile endpoints still starts on Nile. Check the endpoints themselves before sending funds.

To override the bundled file without rebuilding the jar, place config.conf in the directory from which you launch java -jar. You can also use SwitchNetwork to switch among mainnet, Nile, Shasta, and custom endpoints at runtime — see commands/network.

See also