README.md

Lock-SmartContracts

This repository contains all Lock smart contracts

Getting Started

It integrates with Truffle, an Ethereum development environment. Please install Truffle.

npm install -g truffle

Clone Lock-SmartContracts

git clone https://github.com/LockFinance/contracts.git
cd lock/smart-contracts
npm i

Compile and Deploy

These commands apply to the RPC provider running on port 8545. You may want to have TestRPC running in the background. They are really wrappers around the corresponding Truffle commands.

Compile all contracts to obtain ABI and bytecode:

npm run compile

Migrate all contracts required for the basic framework onto network associated with RPC provider:

npm run migrate

Network Artifacts

Show the deployed addresses of all contracts on all networks:

npm run networks

Testing

Run all tests (requires Node version >=8 for async/await, and will automatically run TestRPC in the background):

npm test

Test Coverage

Get test coverage stats(requires Node version >=8 for async/await, and will automatically run TestRPC in the background):

npm run coverage