Skip to content

CONFIG.md

Latest commit

 

History

History
114 lines (95 loc) · 2.5 KB

CONFIG.md

File metadata and controls

114 lines (95 loc) · 2.5 KB
Raw

This document describes the TOML format for configuration.

Example

ChainID = '<id>'

[[Nodes]]
Name = 'primary'
URL = '<http url>'
APIKey = '<key>'

Global

ChainID = 'Ibiza-808' # Example
FeederURL = 'http://feeder.url' # Example
Enabled = true # Default
OCR2CachePollPeriod = '5s' # Default
OCR2CacheTTL = '1m' # Default
RequestTimeout = '10s' # Default
TxTimeout = '10s' # Default
ConfirmationPoll = '5s' # Default
FeeEstimationMaxAttempts = 5 # Default

ChainID

ChainID = 'Ibiza-808' # Example

ChainID is the Starknet chain ID.

FeederURL

FeederURL = 'http://feeder.url' # Example

FeederURL is required to get tx metadata (that the RPC can't)

Enabled

Enabled = true # Default

Enabled enables this chain.

OCR2CachePollPeriod

OCR2CachePollPeriod = '5s' # Default

OCR2CachePollPeriod is the rate to poll for the OCR2 state cache.

OCR2CacheTTL

OCR2CacheTTL = '1m' # Default

OCR2CacheTTL is the stale OCR2 cache deadline.

RequestTimeout

RequestTimeout = '10s' # Default

RequestTimeout is the RPC client timeout.

TxTimeout

TxTimeout = '10s' # Default

TxTimeout is the timeout for sending txes to an RPC endpoint.

ConfirmationPoll

ConfirmationPoll = '5s' # Default

ConfirmationPoll is how often to confirmer checks for tx inclusion on chain.

FeeEstimationMaxAttempts

FeeEstimationMaxAttempts = 5 # Default

FeeEstimationMaxAttempts is the maximum number of retry attempts for fee estimation.

Nodes

[[Nodes]]
Name = 'primary' # Example
URL = 'http://stark.node' # Example
APIKey = 'key' # Example

Name

Name = 'primary' # Example

Name is a unique (per-chain) identifier for this node.

URL

URL = 'http://stark.node' # Example

URL is the base HTTP(S) endpoint for this node. Use an RPC 0.9 or 0.10.x URL (e.g. .../rpc/v0_10). RPC 0.8 is deprecated as of Starknet v0.14.3. Read-only contract calls use the "latest" block tag; TXM nonce/fee paths use "pre_confirmed" (the RPC 0.9+ replacement for deprecated "pending"). starknet.go v0.17.x implements JSON-RPC spec 0.9.0. Nodes reporting 0.10.x (including devnet-rs 0.8.x) log a version mismatch warning at connect time but remain usable; response-shape drift is only detected at runtime on affected RPC calls.

APIKey

APIKey = 'key' # Example

APIKey Header is optional and only required for Nethermind RPCs