Solidity Project Contracts Core Library

This project serves as a base dependency for Solidity-based smart contract projects by providing common dependencies, configurations, contracts, scripts, interfaces, constants, and testing utilities.

Table of Contents

• Overview
  • Installation
  • Usage
    • Commands
    • Solidity Contracts
    • Test and Migration Scripts

Overview

Installation

Install as a module dependency in your host NodeJS project:

npm install --save-dev @animoca/ethereum-contracts-core_library

Usage

Commands

npm run compile

Compiles all the contracts in the contracts/ directory.

npm run test [files]

Runs all the tests. If files are specified, runs only these test files.

npm run coverage

Runs the test coverage.

Solidity Contracts

Import dependency contracts into your Solidity contracts and derive as needed:

import "@animoca/ethereum-contracts-core_library/contracts/{{Contract Group}}/{{Contract}}.sol"

Test and Migration Scripts

Require the NodeJS module dependency in your test and migration scripts as needed:

const { constants, interfaces, behaviors } = require('@animoca/ethereum-contracts-core_library');