We are moving our documentation to the new "" website. To access the most up-to-date and complete version of our guides and articles, please visit our new website. This old documentation site will no longer be maintained or updated, so we strongly recommend referring to the new website for the latest information. If you can't find what you're looking for on the new site, please be patient as we are still in the process of migrating all of our content. Thank you for your understanding!
Visit the new article
Make sure to have the . First, initialize the node.
bitsongd init <your_custom_moniker>
Note Monikers can contain only ASCII characters. Using Unicode characters is not supported and renders your node unreachable.
By default, the init command creates your ~/.bitsongd directory with subfolders config and data. In the config directory, the most important files for configuration are app.toml and config.toml.
You can edit the moniker in the ~/.bitsongd/config/config.toml file:
# A custom human readable name for this node
moniker = "<your_custom_moniker>"
For optimized node performance, edit the ~/.bitsongd/config/app.toml file to enable the anti-spam mechanism and reject incoming transactions with less than the minimum gas prices:
# This is a TOML config file.
# For more information, see https://github.com/toml-lang/toml
###############################################################################
### Base Configuration ###
###############################################################################
# The minimum gas prices a validator is willing to accept for processing a
# transaction. A transaction's fees must meet the minimum of any denomination
# specified in this config (e.g. 0.25token1;0.0001token2).
minimum-gas-prices = "0.0025ubtsg"
Your full node has been initialized!
Genesis & Seeds
Copy the Genesis File
Fetch the mainnet's genesis.json file into bitsongd's config directory.
By default, the REST API is disabled. To enable the REST API, edit the ~/.bitsongd/config/app.toml file, and set enable to true in the [api] section.
###############################################################################
### API Configuration ###
###############################################################################
[api]
# Enable defines if the API server should be enabled.
enable = false
# Swagger defines if swagger documentation should automatically be registered.
swagger = false
# Address defines the API server to listen on.
address = "tcp://0.0.0.0:1317"
Optionally, you can activate swagger by setting swagger to true or change the port of the REST API in the parameter address. After restarting your application, you can access the REST API on YOURNODEIP:1317.
GRPC Configuration
By default, gRPC is enabled on port 9090. In the ~/.bitsongd/config/app.toml file, you can make changes in the gRPC section. To disable the gRPC endpoint, set enable to false. To change the port, use the address parameter.
###############################################################################
### gRPC Configuration ###
###############################################################################
[grpc]
# Enable defines if the gRPC server should be enabled.
enable = true
# Address defines the gRPC server address to bind to.
address = "0.0.0.0:9090"
Background Process
To run the node in a background process with automatic restarts, you can use a service manager like systemd. To set this up run the following:
We can then start the process and confirm that it is running
sudo -S systemctl start bitsongd
sudo service bitsongd status
Now we have to syncronise the node with the current state of the blockchain. The fastest way to achieve this is by using , which we will use for this purpose.
