@colony/colony-js-adapter/README.md

ColonyContract adapter interfaces

# colonyJS Adapter interface

This package exports an interface which is designed to be used for
wrapping JavaScript-Ethereum libraries (e.g.
[ethers.js](https://github.com/ethers-io/ethers.js/),
[web3.js](https://github.com/ethereum/web3.js/)) so that they have a
simple and predictable API. Additionally, the interface requires the
adapter to provide Contract loading functionality.


## Installation

```
yarn add colony-js-adapter
```


## Usage

```JavaScript
/* @flow */

import type { IContract, IAdapter, IProvider } from '@colony/colony-js-adapter';
```


## Contributing

This package is part of the [colonyJS monorepo](https://github.com/JoinColony/colonyJS).

Please read our [contributing guidelines](https://github.com/JoinColony/colonyJS/blob/master/CONTRIBUTING.md).