@chainlink/contracts

Chainlink smart contracts

Usage no npm install needed!

<script type="module">
  import chainlinkContracts from 'https://cdn.skypack.dev/@chainlink/contracts';
</script>

README

Chainlink Smart Contracts

Installation

# via Yarn
$ yarn add @chainlink/contracts
# via npm
$ npm install @chainlink/contracts --save

Directory Structure

@chainlink/contracts
├── src # Solidity contracts
│   ├── v0.4
│   ├── v0.5
│   ├── v0.6
│   ├── v0.7
│   └── v0.8
└── abi # ABI json output
    ├── v0.4
    ├── v0.5
    ├── v0.6
    ├── v0.7
    └── v0.8

Usage

The solidity smart contracts themselves can be imported via the src directory of @chainlink/contracts:

import '@chainlink/contracts/src/v0.8/KeeperCompatibleInterface.sol';

Local Development

Note: Contracts in dev/ directories are under active development and are likely unaudited. Please refrain from using these in production applications.

# Clone Chainlink repository
$ git clone https://github.com/smartcontractkit/chainlink.git
# Continuing via Yarn
$ cd contracts/
$ yarn
$ yarn test

Contributing

Contributions are welcome! Please refer to Chainlink's contributing guidelines for detailed contribution information.

Thank you!

License

MIT