@ocario/contracts-utils
v0.0.1
Published
Smart contract utils of Ocario protocol
Downloads
8
Readme
Contracts utils
This package contains smart contract utilities and libraries that are used throughout the entire codebase of smart contracts. These contracts are all generic and may helpful to use outside of the context of Ocario protocol.
Installation
Install
npm install @ocario/contracts-utils --save
Contributing
We strongly recommend that the community help us make improvements and determine the future direction of the protocol. To report bugs within this package, please create an issue in this repository.
For proposals regarding the Ocario protocol's smart contract architecture, message format, or additional functionality, go to the Ocario Improvement Proposals (ZEIPs) repository and follow the contribution guidelines provided therein.
Please read our contribution guidelines before getting started.
Install Dependencies
If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:
yarn config set workspaces-experimental true
Then install dependencies
yarn install
Build
To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory:
PKG=@ocario/contracts-utils yarn build
Or continuously rebuild on change:
PKG=@ocario/contracts-utils yarn watch
Clean
yarn clean
Lint
yarn lint
Run Tests
yarn test