deso-protocol / run

Run your own DeSo node
https://docs.deso.org
190 stars 94 forks source link
deso

Run your own DeSo node

Running your own DeSo node is easy:

  1. Install Docker and Docker Compose if you don't have it already
    • On Mac and Windows, Docker comes with Docker Compose
    • On Linux you need to install Docker Engine and Docker Compose separately
  2. Execute make devnet, make testnet, or make mainnet depending on which type of node you want to run
    • This will automatically run the relevant docker-compose
  3. If you want to start from scratch, you can always do make wipe or make {environment}-wipe. This will delete all prior blocks/data for your node and allow it to start syncing from scratch again.
  4. Visit http://localhost:4200. This will load the frontend service you just ran and show you all the data that your node is syncing.

Check sync progress

You can check on the sync progress of your local node either by looking at the output or by looking in the admin panel of the frontend.

  1. Create a new user OR sign in with your existing seed phrase
  2. Head to the Admin panel to see your sync status. The tooltips should explain what most things mean.

If you're looking at the output in the terminal, note that there is a header-download phase that is usually pretty quick (a few minutes) followed by a block syncing phase (if you're running iwith --sync-type=blocksync) or a hypersync phase (if you're running --sync-type=hypersync-archival). The sync type is specified in the base.env and overridden by the docker-compose.yml file for each environment.

Reset your node

If your node fails to sync or you want to try syncing from scratch you can run make wipe.

Learning More

If you want to learn more about how the DeSo node works, you can start by reading each of the relevant docker-compose.yml files and the base.env file, which has a lot of comments describing each of the flags.

If you want to know how the actual underlying node code works, check out our docs page. To learn more about building an app, see our app tutorial. To learn more about our architecture, including a code walkthrough, see our architecture overview.

To run a validator, see our validator instructions doc.

What's next?

Once your node is synced, you have access to the full firehose of DeSo data in real time! Below are some tips on how take full advantage of your node.

Need help?

You can often find ansers in the DeSo PoS Discussion Telegram Channel The dev team is also active on all DeSo apps such as diamondapp.com and focus.xyz.