Themelio is a new public blockchain focused on security, performance, and long-term stability. themelio-node is Themelio's reference implementation in Rust.
For security reasons, until we have reliable reproducible build infrastructure, the only official distribution channel for themelio-node is its source code package on crates.io.
Fortunately, installing themelio-node from source is extremely easy. First, make sure cargo is installed on your machine. Then, simply run
$ cargo install --locked themelio-node
This produces an executable themelio-node in ~/.cargo/bin/, which should already be in your $PATH.
Full nodes replicate every consensus-confirmed block, validating its contents and ensuring network security while providing a local cache of the entire blockchain state. Running a full node helps contribute to the security and (read) performance of the network.
There are two kinds of full nodes:
To run an auditor on the “mainnet” (which at the moment is far from stable, but does have a persistent history), just run:
$ themelio-node
themelio-node will then beginning synchronizing all the blocks in the blockchain. This will take quite a while (a day or so) and store a bunch of data in in ~/.themelio-node/.
To run the auditor on the non-persistent testnet, where most covenant development and testing will happen during the betanet period, run instead
$ themelio-node --bootstrap tm-1.themelio.org:11814 --testnet
Note that two things were needed to connect to the testnet:
You can change the configuration of an auditor node with the following flags:
```
--bootstrap
--database
--listen
--testnet Use testnet validation rules
--override-genesis
Note: there will soon be a tool to automatically generate these configurations.
We can configure a simnet --- a "fake" network local to our computer --- by the combination of three options:
--bootstrap 127.0.0.1:11814 to bootstrap only with ourselves instead of any remote node--override-genesis network-config.yaml, where custom-config.yaml contains configuration for a custom network of the following form:
```yaml network: custom02 # anything from custom02..custom08
init_coindata:
covhash: t5xw3qvzvfezkb748d3zt929zkbt7szgt6jr3zfxxnewj1rtajpjx0
value: 1000000
denom: MEL
additional_data: ""
stakes: deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef: pubkey: 4ce983d241f1d40b0e5b65e0bd1a6877a35acaec5182f110810f1276103c829e estart: 0 epostend: 100000 # essentially never end the stake symsstaked: 10000 # does not matter
initfeepool: 10000 ```
--staker-cfg staker-config.yaml must contain a staker configuration like this:
```yaml
signing_secret: 5b4c8873cbdb089439d025e9fa817b1df1128231699131c245c0027be880d4d44ce983d241f1d40b0e5b65e0bd1a6877a35acaec5182f110810f1276103c829e
listen: 127.0.0.1:20000
bootstrap: 127.0.0.1:20000
payout_addr: t5xw3qvzvfezkb748d3zt929zkbt7szgt6jr3zfxxnewj1rtajpjx0
targetfeemultiplier: 10000 ```
A more detailed explanation of --staker-cfg requires explaining the staker and consensus system, as follows:
WIP
WIP
WIP
Thank you for considering contributing to the Themelio source code! We welcome all contributions from absolutely anyone on the internet.
For minor changes, simply fork, fix, and submit a pull request. If you want to propose a larger change, be sure to get in touch with our dev team on Discord to make sure your change aligns with Themelio's overarching philosophy. This will likely save you a significant amount of time and effort, as well as speed up the review process of your change.
Finally, make sure your code adheres to the following guidelines:
master branchThe license of the project is the Mozilla Public License, version 2.
themelio-node is a highly concurrent program where different tasks are done by separate actors, which are "active" structs that own background async tasks or threads. They concurrently run and communicate both with other actors and with "plain data" types like Mempool. They are represented as green boxes in the following diagram illustrating the data flows of the whole program:
There are the following primary types in themelio-node:
NodeProtocol is the core node actor. It implements the core auditor/full node logic: gossiping with other through the melnet-based auditor P2P network (via the themelio-nodeprot crate) to synchronize the latest blockchain state.
StorageMempool; they are only gossipped further if Mempool accepts themStorage to gossip to other nodesBlockIndexer to answer queries about coin lists (which coins do this address "own")BlockIndexer indexes "nonessential" information about blocks. It continually pulls blocks out of Storage, and indexes them, keeping track of information such as which coins do which address own.Storage encapsulates all persistent storage in the system. It is not an actor, so it does not initiate any data flows.
meshanina (for sparse Merkle tree nodes) and boringdb (for blocks and other metadata)Mempool is a non-persistent field that keeps track of the most likely next block. This is based on the existing blockchain state plus unconfirmed transactions seen in the network.StakerProtocol is the core staker actor, which is only started in staker mode. It runs the Streamlet consensus protocol (implemented in the novasymph crate) over a separate melnet P2P.
Storage (where NodeProtocol will pick them up and gossip them)MempoolThemelio Labs runs a worldwide network of Themelio full nodes --- themelio-node can also be compiled to report metrics for this network.
Read here.