Configuration
The following page will guide you through the configuration of a node and a client. The node is used to run the blockchain network, produce blocks and validate transactions. The client is used as a gateway to interact with the blockchain network by sending transactions and querying the state. Additionally we walk through running the JSON-RPC server.
These configurations can impact the performance, security, and functionality of your node. Thus, understanding and correctly configuring your node and client is essential.
Config and data directory
By default, your config and data are stored in the folder located at the ~/.lagomd
directory. You can easily change the default directory by using the --home
flag. It is important to note that you can have multiple home directories that each represent a different blockchain.
To specify the lagomd
config and data storage directory; you can update it using the global flag --home <directory>
.
Node Configuration
The Cosmos SDK automatically generates two configuration files inside ~/.lagomd/config
:
config.toml
– Configures CometBFT (Tendermint) settings, including P2P networking, block creation, and consensus parameters.app.toml
– Manages LagomChain-specific settings like state pruning, telemetry, gRPC, REST, and JSON-RPC configurations.
Both files are heavily commented, please refer to them directly to tweak your node.
One example config to tweak is the minimum-gas-prices
field inside app.toml
, which defines the minimum amount the validator node is willing to accept for processing a transaction. It is an anti spam mechanism and it will reject incoming transactions with less than the minimum gas prices.
If it's empty, make sure to edit the field with some value, for example 10token
, or else the node will halt on startup.
Pruning of State
There are four strategies for pruning state. These strategies apply only to state and do not apply to block storage. To set pruning, adjust the pruning
parameter in the ~/.lagomd/config/app.toml
file. The following pruning state settings are available:
everything
: Deletes all old states except the current state.nothing
: Stores all blockchain states (Full archival node).default
: Keeps the last 100 states + every 10,000th block.custom
: Allows manual control usingpruning-keep-recent
settings.
By default, every node is in default
mode which is the recommended setting for most environments. If you would like to change your nodes pruning strategy then you must do so when the node is initialized. Passing a flag when starting Lagom
will always override settings in the app.toml
file, if you would like to change your node to the everything
mode then you can pass the --pruning everything
flag when you call lagomd start
.
danger
IMPORTANT: When you are pruning state you will not be able to query the heights that are not in your store.
Client Configuration
We can view the default client config setting by using lagomd config
command:
You can update values dynamically, e.g., changing the chain ID:
Alternatively, you can edit client.toml
directly:
Running the JSON-RPC Server
This section walks through the steps to enable the JSON-RPC server. JSON-RPC is provided on multiple transports. LagomChain supports JSON-RPC over HTTP and WebSocket. In terms of requirements we recommend a server with minimum 8-core CPU and 64gb of RAM. You must have ports 8545 and 8546 open on your firewall.
tip
Important: You cannot use all JSON RPC methods unless your node stores the entire copy of the blockchain locally.
Enable Server
To enable RPC server use the following flag (set to true by default).
Defining Namespaces
Eth
,Net
and Web3
namespaces are enabled by default, but for the JSON-RPC you need to add more namespaces. In order to enable other namespaces edit app.toml
file.
Set a Gas Cap
eth_call
and eth_estimateGas
define a global gas cap over rpc for DoS protection. You can override the default gas cap value of 25,000,000 by passing a custom value in app.toml
:
CORS
If accessing the RPC from a browser, CORS will need to be enabled with the appropriate domain set. Otherwise, JavaScript calls are limit by the same-origin policy and requests will fail.
The CORS setting can be updated from the app.toml
Pruning
For all methods to work correctly, your node must be archival (store the entire copy of the blockchain locally). Pruning must be disabled. The pruning settings can be updated from the app.toml
WebSocket Server
Websocket is a bidirectional transport protocol. A Websocket connection is maintained by client and server until it is explicitly terminated by one. Most modern browsers support Websocket which means it has good tooling.
Because Websocket is bidirectional, servers can push events to clients. That makes Websocket a good choice for use-cases involving event subscription. Another benefit of Websocket is that after the handshake procedure, the overhead of individual messages is low, making it good for sending high number of requests. The WebSocket Server can be enabled from the app.toml
Last updated