@chainlink/contracts-ccip NPM

Chainlink CCIP Smart Contracts

Installation

# via pnpm
$ pnpm add @chainlink/contracts-ccip
# via npm
$ npm install @chainlink/contracts-ccip --save

Directory Structure

@chainlink/contracts-ccip
├── src # Solidity contracts
│   └── v0.8
└── abi # ABI json output
    └── v0.8

Usage

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

import '@chainlink/contracts-ccip/src/v0.8/ccip/applications/CCIPReceiver.sol';

Changesets

We use changesets to manage versioning the contracts.

Every PR that modifies any configuration or code, should most likely accompanied by a changeset file.

To install changesets: 1. Install pnpm if it is not already installed - docs. 2. Run pnpm install.

Either after or before you create a commit, run the pnpm changeset command in the contracts directory to create an accompanying changeset entry which will reflect on the CHANGELOG for the next release.

The format is based on Keep a Changelog,

and this project adheres to Semantic Versioning.

License

The CCIP repo is licensed under the BUSL-1.1 license, however, there are a few exceptions

src/v0.8/ccip/applications/* is licensed under the MIT license
src/v0.8/ccip/interfaces/* is licensed under the MIT license
src/v0.8/ccip/libraries/{Client.sol, Internal.sol} is licensed under the MIT license