# @animoca/ethereum-contracts-core_library

> Base dependency for solidity contracts projects

Latest version **4.0.3** (published 2021-02-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install @animoca/ethereum-contracts-core_library
pnpm add @animoca/ethereum-contracts-core_library
yarn add @animoca/ethereum-contracts-core_library
bun add @animoca/ethereum-contracts-core_library
```

## Health

**Score 5/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: insecure dependencies; abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.0.3 |
| Published | 2021-02-04 |
| First published | 2020-04-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 29 |
| Unpacked size | 2 MB |
| Known vulnerabilities | 0 (+5 in 1 direct dependencies) |
| Install scripts | yes |
| GitHub stars | 5 |
| Author | Animoca Brands |
| Maintainers | animocabrands, nataouze, efabian, jackyyab1, ikutoski, ironbuddha, jpazucena, andysob |
| Keywords | animoca, animocabrands, solidity, ethereum, smart, contracts, hardhat |

## Links

- npm: https://www.npmjs.com/package/@animoca/ethereum-contracts-core_library
- Repository: https://github.com/animocabrands/ethereum-contracts-core_library
- Homepage: https://github.com/animocabrands/ethereum-contracts-core_library#readme
- Issues: https://github.com/animocabrands/ethereum-contracts-core_library/issues
- npm.io page: https://npm.io/package/@animoca/ethereum-contracts-core_library

## Dependencies (29)

- [chai](https://npm.io/package/chai.md) ^4.2.0
- [glob](https://npm.io/package/glob.md) ^7.1.6
- [web3](https://npm.io/package/web3.md) ^1.3.3
- [mocha](https://npm.io/package/mocha.md) ^8.2.1
- [eslint](https://npm.io/package/eslint.md) ^7.18.0
- [solhint](https://npm.io/package/solhint.md) ^3.3.2
- [wait-on](https://npm.io/package/wait-on.md) ^5.2.1
- [fs-extra](https://npm.io/package/fs-extra.md) ^9.1.0
- [prettier](https://npm.io/package/prettier.md) ^2.2.1
- [cross-env](https://npm.io/package/cross-env.md) ^7.0.3
- [lodash.zip](https://npm.io/package/lodash.zip.md) ^4.2.0
- [solc-0.6.8](https://npm.io/package/solc-0.6.8.md) npm:solc@0.6.8
- [solc-0.7.4](https://npm.io/package/solc-0.7.4.md) npm:solc@0.7.4
- [ganache-cli](https://npm.io/package/ganache-cli.md) ^6.12.2
- [npm-run-all](https://npm.io/package/npm-run-all.md) ^4.1.5
- [solidity-docgen](https://npm.io/package/solidity-docgen.md) ^0.5.11
- [solidity-coverage](https://npm.io/package/solidity-coverage.md) ^0.7.14
- [eslint-config-mocha](https://npm.io/package/eslint-config-mocha.md) ^0.0.0
- [eslint-plugin-mocha](https://npm.io/package/eslint-plugin-mocha.md) ^8.0.0
- [@smartdec/smartcheck](https://npm.io/package/@smartdec/smartcheck.md) ^2.0.1
- [hardhat-gas-reporter](https://npm.io/package/hardhat-gas-reporter.md) ^1.0.4
- [eslint-config-prettier](https://npm.io/package/eslint-config-prettier.md) ^7.2.0
- [eslint-plugin-prettier](https://npm.io/package/eslint-plugin-prettier.md) ^3.3.1
- [@nomiclabs/hardhat-web3](https://npm.io/package/@nomiclabs/hardhat-web3.md) ^2.0.0
- [@openzeppelin/contracts](https://npm.io/package/@openzeppelin/contracts.md) =3.3.0
- [solhint-plugin-prettier](https://npm.io/package/solhint-plugin-prettier.md) ^0.0.5
- [prettier-plugin-solidity](https://npm.io/package/prettier-plugin-solidity.md) ^1.0.0-beta.3
- [@openzeppelin/test-helpers](https://npm.io/package/@openzeppelin/test-helpers.md) git+https://github.com/nataouze/openzeppelin-test-helpers.git#fix_bn_array_event_args
- [@nomiclabs/hardhat-truffle5](https://npm.io/package/@nomiclabs/hardhat-truffle5.md) ^2.0.0

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 4.0.3 (latest) — 2021-02-04
- 4.0.2 — 2021-02-01
- 4.0.1 — 2021-02-01
- 4.0.0 — 2021-02-01
- 3.1.1 — 2020-08-10
- 3.1.0 — 2020-07-03
- 3.0.0 — 2020-06-17
- 2.0.0 — 2020-05-27
- 1.1.0 — 2020-05-06
- 1.0.0 — 2020-05-04
- 0.0.2 — 2020-04-22

## README

# 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](#overview)
  * [Installation](#installation)
  * [Usage](#usage)
    - [Commands](#commands)
    - [Solidity Contracts](#solidity-contracts)
    - [Test and Migration Scripts](#test-and-migration-scripts)


## Overview

### Installation

Install as a module dependency in your host NodeJS project:

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


### Usage

#### Commands

```bash
npm run compile
```
Compiles all the contracts in the `contracts/` directory.

```bash
npm run test [files]
```
Runs all the tests. If `files` are specified, runs only these test files.

```bash
npm run coverage
```
Runs the test coverage.

#### Solidity Contracts

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

```solidity
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:

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

---
_Source: https://npm.io/package/@animoca/ethereum-contracts-core_library · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
