Skip to content
Permalink
Browse files

add governance integration

  • Loading branch information...
thanhson1085 committed Jun 3, 2019
1 parent be901cb commit d581f19e0edaf3bae0e07257e427f28a89fe6beb
Showing with 174 additions and 0 deletions.
  1. +173 −0 docs/developers/staking-integrations.md
  2. +1 −0 mkdocs.yml
@@ -0,0 +1,173 @@
Masternodes and stakers is stored and governared in [TomoChain Validator smart contract](https://scan.tomochain.com/address/0x0000000000000000000000000000000000000088):
- Smart Contract Code: [TomoChain Validator](https://github.com/tomochain/tomomaster/blob/master/contracts/TomoValidator.sol)
- Smart Contract ABI: [TomoValidatorAbi.json](https://raw.githubusercontent.com/tomochain/tomomaster/master/abis/TomoValidatorAbi.json)

TomoChain Validator Smart Contract Interface:
```javascript
// apply a new masternode candidate
function propose(address _candidate) external payable
// Deposit to stake/vote for a candidate
function vote(address _candidate) external payable
// Unstake/unvote for a candidate
function unvote(address _candidate, uint256 _cap) public
// Resign a candidate
function resign(address _candidate) public
// Withdraw after unvote, resign
function withdraw(uint256 _blockNumber, uint _index) public
function getCandidates() public view returns(address[])
function getCandidateCap(address _candidate) public view returns(uint256)
function getCandidateOwner(address _candidate) public view returns(address)
function getVoterCap(address _candidate, address _voter) public view returns(uint256)
function getVoters(address _candidate) public view returns(address[])
function isCandidate(address _candidate) public view returns(bool)
function getWithdrawBlockNumbers() public view returns(uint256[])
function getWithdrawCap(uint256 _blockNumber) public view returns(uint256)
```
TomoChain provides RPC APIs. So you can use Web3 library to directly call the functions in the smart contract.
You can follow the steps below to interact with the smart contract by using Web3 library and NodeJS.
## Init Web3 provider
At the first step, you need init Web3 provider by connecting TomoChain Fullnode RPC endpoint
```javascript
import Web3 from 'web3';
const web3 = new Web3('https://rpc.tomochain.com');
```
## Init Web3 TomoChain Validator Contract
```javascript
const validatorAbi = require('./TomoValidatorAbi.json')
const address = '0x0000000000000000000000000000000000000088'
const validator = new web3.eth.Contract(validatorAbi,
address, {gasPrice: 250000000, gas: 2000000 })
```

Note: you can get TomoValidatorAbi.json [here](https://raw.githubusercontent.com/tomochain/tomomaster/master/abis/TomoValidatorAbi.json)

## Unlock wallet
You need to unlock the wallet before staking for the nodes
#### Example
```javascript
// Unlock wallet by private key
const account = web3.eth.accounts.privateKeyToAccount(pkey)
const owner = account.address
web3.eth.accounts.wallet.add(account)
web.eth.defaultAccount = owner
```

## Propose/Apply a candidate
You need to have at least 50000 TOMO to apply a fullnode to become a Masternode candidate. So make sure you have > 50000 TOMO in your masternode owner wallet to deposit to the smart contract and pay transaction fee.

You can apply a masternode candidate by call `propose` function from the smart contract

#### Example
```javascript
// Masternode coinbase address
const coinbase = "0xf8ac9d5022853c5847ef75aea0104eed09e5f402"
validator.methods.propose(coinbase).call({
from : owner,
value: '50000000000000000000000', // 50000 TOMO
gas: 2000000,
gasPrice: 250000000
})
.then((result) => {
console.log(result)
}).catch(e => console.log(e))
```

## Stake/Vote a candidate
You can stake at least 100 TOMO for a node by calling `vote` function from the smart contract.

#### Example
Stake 500 TOMO to a node.
```javascript
validator.methods.vote(coinbase).call({
from: owner,
value: '500000000000000000000', // 500 TOMO
gas: 2000000,
gasPrice: 250000000
})
.then((result) => {
console.log(result)
}).catch(e => console.log(e))
```

## Unstake/Unvote a candidate
You can unstake by calling `unvote` function from the smart contract

```javascript
// Masternode coinbase address
const coinbase = "0xf8ac9d5022853c5847ef75aea0104eed09e5f402"
validator.methods.vote(coinbase).call({
from : owner,
value: '50000000000000000000000', // 50000 TOMO
gas: 2000000,
gasPrice: 250000000
})
.then((result) => {
console.log(result)
}).catch(e => console.log(e))
```

## Unstake/Unvote a candidate
You can unstake by calling `unvote` function from the smart contract

```javascript
const cap = '500000000000000000000' // unvote 500 TOMO
validator.methods.unvote(coinbase, cap).call({
from : owner,
gas: 2000000,
gasPrice: 250000000
})
.then((result) => {
console.log(result)
}).catch(e => console.log(e))
```

## Resign a candidate

```javascript
validator.methods.resign(coinbase).call({
from : owner,
gas: 2000000,
gasPrice: 250000000
})
.then((result) => {
console.log(result)
}).catch(e => console.log(e))
```

## Withdraw TOMO
You need to wait for 48 epochs (if unvote), 30 days (if resign) to unlock your TOMO staked


```javascript
validator.methods.withdraw(blocknumber, index).call({
from : owner,
gas: 2000000,
gasPrice: 250000000
})
.then((result) => {
console.log(result)
}).catch(e => console.log(e))
```

@@ -101,6 +101,7 @@ nav:
- TRC21 Specification: wp-and-research/specs/trc21_standard.md
- Developers guide:
- Exchange/Wallet integrations: developers/integrations.md
- TomoChain Governance integrations: developers/staking-integrations.md
- Working with TomoChain:
- TomoChain private testnet setup: developers/tutoprivatenet.md
- Useful manual CLI commands: developers/clicommands.md

0 comments on commit d581f19

Please sign in to comment.
You can’t perform that action at this time.