This repository will contain the components of the BBS token.

To start, make sure you have npm and node 10 installed and run the following command in the root directory of the repo:

nodeos, cleos, keosd and the eos-cdt are required for the eosio part.

Token

Our token is an ethereum ERC20, with an eosio leg connected by a bridge.

Ethereum Contract

./contracts/BBSToken.sol

Boilerplate OpenZeppelin ERC20, ownable, mintable, with the permit mechanism.

EOS Contract

[Boilerplate eosio token, which will give the bridge ownership over itself so only it (the bridge) can mint and burn tokens.

Bridge

A pretty simple eos<=>ethereum bridge, heavily based on Bancor's implementation, and possibly using the same oracles.

Ethereum Contract

./contracts/Bridge.sol

Heavily based on Bancor's BancorX, ported to solidity 8, with permit based transfer call, and all of the Bancor environment requirements removed.

EOS Contract

We are using Bancor's bridge contract as is.

Oracles

We are using Bancor's existing infrastructure.

Governance

We will use Snapshot for voting, but we are considering a move to our own message board, probably with snapshot api. Then we may move to using our own voting, integrating eos token holders, give voting power to tokens staked in our staking rewards contract, and even implementing delegated based liquid democracy (see promising algorithm and implementation here.

Staking Rewards

./contracts/Staking.sol

The staking contract is an upgradable contract that distributes rewards on a quarterly basis to addresses that are willing to lock up their BBS tokens. The rewards for each quarter is divided between the stakers according to the amount of tokens locked and the length of the locking period.

The essesntial idea is described and can be played with in this web-based "paper" demo.

Tests

The eos components are either completely standard or maintained and tested by Bancor, so we only need tests for the ethereum components. These tests are all run on Hardhat, which makes it easy to test on the internal Hardhat network, on a local ganache-cli environment, or on a mainnet fork.

To test on Hardhat network:

To run tests with a coverage report:

To run tests with a gas report:

REPORT_GAS=true npx hardhat test

To run tests with load testing (use any desired number of iterations):

TEST_ITERATIONS=1000 npx hardhat test

To run tests with extra console.debug messages:

TEST_DEBUG=true npx hardhat test

Audits

Our contracts have been audited twice by Peckshield:

• ./docs/audit.peckshield.2021.07.pdf
• ./docs/audit.peckshield.2021.11.pdf

Deployment

All our ethereum related deployment scripts are in ./scripts/deployment/, and eosio related scripts are in ./eosio/deployment/.

A gas calculator for the full deployment process can be found in ./scripts/utils/deployment_gas_calculator.sh.

Etherscan Support

We use Hardhat's Etherscan plugin to automoatically publish our contracts to Etherscan.

Etherscan API-Key token is required to be added to hardhat.config.js:

etherscan: {
    apiKey: 'API_KEY'
}

After Contract deployment:

npx hardhat verify --network NETWORK_NAME CONTRACT_ADDRESS