Guide
Comprehensive guide to setting up and running a Truflation Stream Network (TSN) node.
This guide will walk you through the process of setting up and running a Truflation Stream Network (TSN) node. By following these steps, you’ll be able to deploy a node, optionally become a validator, and contribute to the TSN.
Prerequisites
Before you begin, ensure you have the following:
- Kwil-admin: Used to generate the initial configuration file.
- Download from the latest GitHub release
- Docker: Required for running the PostgreSQL image.
- Install from Docker’s official website
- TSN Binaries: Necessary for node deployment.
- Download from the latest GitHub release
Setup Steps
1. Generate Initial Configuration
Use kwil-admin
to create your initial configuration file. For example:
2. Set Up PostgreSQL
For a quick setup, run Kwil’s pre-configured PostgreSQL Docker image:
If you prefer a custom PostgreSQL setup, ensure it meets the requirements specified in the configuration guide.
3. Deploy TSN Node
3.1. Install PSQL
To be able to Snapshot from the network, you need to have psql
installed on your machine. You can install it by running:
3.2. Run TSN Binaries
Run the TSN binaries to deploy your node:
Ensure your firewall allows incoming connections on the JSON-RPC port (default: 8484) and P2P port (default: 26656).
The --chain.statesync.enable
and --chain.statesync.rpc-servers
flags are optional and only needed if you want to enable state sync on your node. It will help your node to sync faster with the network with the snapshot provided by the RPC servers.
4. Become a Validator (Optional)
To upgrade your node to a validator:
- Ensure your node is fully synced with the network.
- Submit a validator join request:
- Wait for approval from existing validators. You can check your join request status with:
You can always ping us for help in the validator process.
5. Submit Your Node to Available Node List (Optional)
To help others discover your node:
- Fork the TSN repository.
- Add your node information to the
configs/network/available_nodes.json
file. - Submit a Pull Request with your changes.
We’ll review and merge your PR to include your node in the network’s seed list.
Network Configuration Files
Essential network configuration files are located in the configs/network/
directory:
genesis.json
: The network’s genesis file.network-nodes.csv
: List of available nodes for peer discovery.
When setting up your node, refer to these files for network-specific parameters and peer information.
Additional Resources
For further assistance, join our Discord community or open an issue on our GitHub repository.
Welcome to the truf.network! Your participation helps build a more robust and decentralized data infrastructure.