@backt/protocol

protocol

Backt smart contracts implementation

Setup

> npm i -g truffle@4.1.11
> npm i

NOTE: specific truffle version specified above as newer versions break the build - needs investigating.

Test

npm test

Deploy Contracts

The deployment command will recompile contracts, update the ABI and run the tests and then deploy contracts to the blockchain.

// kovan
> npm run deploy-kovan

NOTE: the very first time the contracts are deployed to a new network the deployer should run 'npm run deploy-<network>-first-time' instead of 'npm run deploy-<network>' as this will install the permanent Registry contract that all future deployments share. It contains a mapping of all CFDs ever created as well as the address of the most recent CFDFactory contract.

Publish NPM

// ensure repo has latest abi
> npm run publish-abi
> git add abi && git commit -m "updated ABI" abi

// ensure tests are passing
> truffle develop
truffle> test

// publish NPM
npm version patch     # bumps the version number and tags the commit
npm publish           # see package.json scripts prepare - this will run the tests before publishing
git push --tags

npm

The package is published with the contract ABI JSON files (abi/) and js libraries (lib/) to @backt/protocol.