Skip to content

Latest commit

 

History

History
247 lines (160 loc) · 11.3 KB

README.md

File metadata and controls

247 lines (160 loc) · 11.3 KB
Raw

stafi-node

StaFi is:

  • The First Decentralized Protocol Unlocking Liquidity of Staked Assets

The protocol of StaFi is created by Substrate and adopts Nominated Proof-of-Stake (NPoS), which completes Staking by setting up Staking Contracts in the upper layer to communicate with public chains. The Staking process is immune to StaFi’s contracts, for the latter act as the account book during Staking. Tokens staked through contracts will be written in the contracts and finally be locked-up on the original chain.

For more specific guides, see the documentation.

Running from Source

Building

Welcome to participate in us. Download the source:

git clone https://github.com/stafiprotocol/stafi-node.git
cd stafi-node

### Mainnet
git checkout v0.5.1

### Testnet
git checkout seiya

Install system dependencies(recommend ubuntu or macos):

./scripts/init.sh

You can add export PATH="$HOME/.cargo/bin:$PATH" in the ~/.bashrc and restart the terminal or run source ~/.cargo/env to update the environment.

Build StaFi:

cargo build --release

It may take 10m - 1h, which depends on your machine.

You may encounter CMAKE_PROJECT_VERSION error. Please scroll to the bottom and follow the instructions to fix it.

Running

StaFi Mainnet

If you want to be a validator.

./target/release/stafi --validator --name='your name' --execution=NativeElseWasm

If you just want to run a full node.

./target/release/stafi --pruning=archive --rpc-cors=all --ws-external

You can see your node on telemetry (set a custom name with --name "my custom name").

StaFi Testnet

If you want to be a validator.

./target/release/stafi --chain=testnet --validator --name='your name' --execution=NativeElseWasm

If you just want to run a full node.

./target/release/stafi --chain=testnet --pruning=archive --rpc-cors=all --ws-external

You can see your node on telemetry (set a custom name with --name "my custom name").

Note: By default, Validator nodes are in archive mode. If you've already synced the chain not in archive mode, you must first remove the database with staFi purge-chain and then ensure that you run StaFi with the --pruning=archive option. The --pruning=archive flag is implied by the --validator and --sentry flags, so it is only required explicitly if you start your node without one of these two options.

More flags

./target/release/stafi \
  --base-path ~ \
  --chain=testnet \
  --port 30333 \
  --ws-port 9944 \
  --rpc-port 9933 \
  --validator \
  --name 'your custom name' \
  --execution=NativeElseWasm

Flags in detail:

Flags Descriptions
--base-path Specifies a directory where Substrate should store all the data related to this chain. If the directory does not exist it will be created for you.
--chain testnet Specifies which chain specification to use.
--port 30333 Specifies the port that your node will listen for p2p traffic on. 30333 is the default and this flag can be omitted if you're happy with the default. If run multiple nodes on the same physical system, you will need to explicitly specify a different port for it.
--ws-port 9944 Specifies the port that your node will listen for incoming web socket traffic on. 9944 is the default, so it can also be omitted.
--rpc-port 9933 Specifies the port that your node will listen for incoming RPC traffic on. 9933 is the default, so it can also be omitted.
--validator Means that we want to participate in block production and finalization rather than just sync the network.
--name human-readable name in the telemetry UI
--execution The execution strategy that should be used by all execution contexts [possible values: Native, Wasm, Both, NativeElseWasm]
--rpc-methods RPC methods to expose. [default: Auto] [possible values: Auto, Safe, Unsafe]
--rpc-cors Specify browser Origins allowed to access the HTTP & WS RPC servers
--ws-external Listen to all Websocket interfaces

Upgrade

Make sure you are on the right branch. And there is no need to shut down your node when recompiling.

cargo build --release

Please restart your node after the compiling.

Clean

If you need to start from the beginning. You should clean your db.

### Mainnet
./target/release/stafi purge-chain --chain=mainnet

### Testnet
./target/release/stafi purge-chain --chain=testnet

Faucet for Seiya

Seiya is the public testnet of StaFi. You need to have some FIS tokens to participate in Seiya.

Get Faucet

  • Join StaFi Protocol Group: Click Here
  • Join StaFi Faucet Group: Click Here
  • On the Faucet group, reply /faucet + Account
    • Example: /faucet 35Eb25MdWe3aBuehR3Abx9caw7S68za39aYijvnWB5V3uv3S
  • If your account meets the requirements for issuance, 500 tokens will be automatically distributed to your account, you can view your balance via StaFi-apps.

Faucet distribution rules

  • Each Telegram account can receive 1 airdrop within 12 hours.
  • Each address can only receive airdrop for 1 time.
  • The address to receive the airdrop needs to be satisfied with: the address prefix should be start with number 2 or 3 (Create an account).
  • The maximum daily distribution of airdrops is 300, first come first served.
  • The number of each airdrop is a fixed value: 500.

Running using Docker

Coming

Become a validator

Bond FIS tokens

It is highly recommended that you make your controller and stash accounts be two separate accounts. For this, you will create two accounts and make sure each of them have at least enough funds to pay the fees for making transactions. Keep most of your funds in the stash account since it is meant to be the custodian of your staking funds.

Make sure not to bond all your FIS balance since you will be unable to pay transaction fees from your bonded balance.

It is now time to set up our validator. We will do the following:

  • Bond the FIS tokens of the Stash account. These FIS tokens will be put at stake for the security of the network and can be slashed.
  • Select the Controller. This is the account that will decide when to start or stop validating.

First, open StaFi-apps, go to the Staking section. Click on "Account Actions", and then the "+ Stash" button.

  • Stash account - Select your Stash account. In this example, we will bond 10 FIS tokens - make sure that your Stash account contains at least this much. You can, of course, stake more than this.
  • Controller account - Select the Controller account created earlier. This account will also need a small amount of FIS tokens in order to start and stop validating.
  • Value bonded - How much FIS tokens from the Stash account you want to bond/stake. Note that you do not need to bond all of the tokens in that account. Also note that you can always bond more tokens later. However, withdrawing any bonded amount requires the duration of the unbonding period. On StaFi testnet, the unbonding period is 7 hours. On StaFi mainnet, the planned unbonding period is 14 days.
  • Payment destination - The account where the rewards from validating are sent.

Once everything is filled in properly, click Bond and sign the transaction with your Stash account.

After a few seconds, you should see an "ExtrinsicSuccess" message. You should now see a new card with all your accounts (note: you may need to refresh the screen). The bonded amount on the right corresponds to the funds bonded by the Stash account.

Set Session Keys

Once your node is fully synced, you can set the session keys. Just make sure you are running the node in validator mode.

Generating the Session Keys

On your server, it is easier to run this command (while the node is running with the default HTTP RPC port configured):

curl -H "Content-Type: application/json" -d '{"id":1, "jsonrpc":"2.0", "method": "author_rotateKeys", "params":[]}' http://localhost:9933

The output will have a hex-encoded "result" field. The result is the concatenation of the four public keys. Save this result for a later step.

Submitting the setKeys Transaction

You need to tell the chain your Session keys by signing and submitting an extrinsic. This is what associates your validator with your Controller account.

Go to Staking > Account Actions, and click "Set Session Key" on the bonding account you generated earlier. Enter the output from author_rotateKeys in the field and click "Set Session Key".

Submit this extrinsic and you are now ready to start validating.

Validate

To verify that your node is live and synchronized, head to Telemetry and find your node. Note that this will show all nodes on the StaFi network, which is why it is important to select a unique name!

If everything looks good, go ahead and click on "Validate" in StaFi-apps.

  • Payment preferences - You can specify the percentage of the rewards that will get paid to you. The remaining will be split among your nominators.

Click "Validate".

If you go to the "Staking" tab, you will see a list of active validators currently running on the network. At the top of the page, it shows the number of validator slots that are available as well as the number of nodes that have signaled their intention to be a validator. You can go to the "Waiting" tab to double check to see whether your node is listed there.

The validator set is refreshed every era. In the next era, if there is a slot available and your node is selected to join the validator set, your node will become an active validator. Until then, it will remain in the waiting queue. If your validator is not selected to become part of the validator set, it will remain in the waiting queue until it is. There is no need to re-start if you are not selected for the validator set in a particular era. However, it may be necessary to increase the number of FIS tokens staked or seek out nominators for your validator in order to join the validator set.

Congratulations! If you have followed all of these steps, and been selected to be a part of the validator set, you are now running a StaFi validator!

Compile error

  1. Failed to run custom build command for wabt-sys
/home/stafi/.cargo/registry/src/git.luolix.top-1ecc6299db9ec823/wabt-sys-0.7.2/wabt/src/option-parser.cc:60:20: error: MAKE_PROJECT_VERSIONwas not declared in this scope
     printf("%s\n", CMAKE_PROJECT_VERSION);
                    ^~~~~~~~~~~~~~~~~~~~~
make[2]: *** [CMakeFiles/wabt.dir/src/option-parser.cc.o] Error 1
make[1]: *** [CMakeFiles/wabt.dir/all] Error 2
make: *** [all] Error 2

This may be a problem with your cmake version. You can try this to fix it.

wget https://github.com/Kitware/CMake/releases/download/v3.17.3/cmake-3.17.3-Linux-x86_64.tar.gz
tar -xzvf cmake-3.17.3-Linux-x86_64.tar.gz

sudo mv cmake-3.17.3-Linux-x86_64 /opt/cmake-3.17.3

sudo ln -sf /opt/cmake-3.17.3/bin/*  /usr/bin/

cmake --version

More download versions on Cmake