ambrosus-node-contracts

Smart contracts used in AMB-NET

Development

Install dependencies and compile contracts:

yarn
yarn build

First you need an RPC running. For example you may want to start ganache-cli with running

yarn global add ganache-cli
ganache-cli -e 1000000

Next you need to set environment variables for the RPC address and private key. In case you run ganache copy one of the available private keys and set

export WEB3_RPC=http://localhost:8545
export WEB3_NODEPRIVATEKEY="COPIED_PRIVATE_KEY"

Then deploy genesis contracts and save outcome to an environment file:

yarn task deployGenesis --save <path to file>

Deploy the cryptoeconomy contracts:

yarn task deploy initial --save <path to file>

Then you need to set the addresses of multisig validators. It is a comma separated list:

export MULTISIG_APPROVAL_ADDRESSES="APPROVAL_ADDRESS1,APPROVAL_ADDRESS2,APPROVAL_ADDRESS3,APPROVAL_ADDRESS4,APPROVAL_ADDRESS5,APPROVAL_ADDRESS6"

To deploy the multisignature contract provide number of address required to approve each transaction:

yarn task deployMultisig --save <path to file> --required 4

You are ready to play.

In case you need to update to the cryptoeconomy contracts:

yarn task deploy update

The following administrative tasks are available:

yarn task deployGenesis (only for testing purposes as this are normally included in the genesis block)
yarn task deploy initial [--turbo] 
yarn task deploy update [--turbo] 
yarn task deployMultisig [--save file] [--required number_of_approvers]
yarn task whitelist add [address] [node type] [required stake/deposit]
yarn task whitelist remove [address]
yarn task whitelist get [address]
yarn task onboard [node type]
yarn task upload [bundleId] [storagePeriods]
yarn task nodeService setUrl [new node url]
yarn task payouts period
yarn task payouts total
yarn task payouts withdraw
yarn task challenge start [sheltererAddress bundleId]
yarn task challenge expire [challengeId]
yarn task challenge status [challengeId]
yarn task retire
yarn task moveOwnershipToMultiplexer [address]
yarn task moveOwnershipFromMultiplexer [address]
yarn task checkOwnership [contract address]

Testing

To install dependencies call:

yarn

To compile contracts:

yarn build

To run tests:

yarn test:units
yarn test:tasks

Alternatively, to compile contracts and test:

yarn test:all

To check gas consumption of common operations

yarn test:gasbenchmark

Production and deployment

Before distributing the compiled contract files you should strip away unnecessary fields:

yarn strip