https://github.com/smartcontractkit/chainlink-brownie-contracts

A repository for automatically using the latest chainlink repo from the core chainlink repo.
https://github.com/smartcontractkit/chainlink-brownie-contracts

chainlink

Last synced: about 4 hours ago
JSON representation

A repository for automatically using the latest chainlink repo from the core chainlink repo.

• Host: GitHub
• URL: https://github.com/smartcontractkit/chainlink-brownie-contracts
• Owner: smartcontractkit
• Created: 2021-04-05T14:45:01.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-10-22T03:06:45.000Z (3 months ago)
• Last Synced: 2025-01-20T00:02:31.710Z (7 days ago)
• Topics: chainlink
• Language: Solidity
• Homepage:
• Size: 47.6 MB
• Stars: 351
• Watchers: 11
• Forks: 72
• Open Issues: 15
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-foundry - Chainlink Brownie Contracts - This repository is a slimmed down version of Chainlink's official repo. It clones only the Chainlink contracts folder and the repo automatically updates every time there is a new NPM release. (Templates & Libraries)

README

        

# Overview

This repository is a slimmed down version of Chainlink's official repo. It clones *only* the Chainlink `contracts` folder and the repo automatically updates every time there is a new NPM release. 

- NPM's latest release can be found here: https://www.npmjs.com/package/@chainlink/contracts

- Chainlink's official repo: https://github.com/smartcontractkit/chainlink

# chainlink-brownie-contracts

A minimal repo that is a copy of the npm package [@chainlink/contracts](https://www.npmjs.com/package/@chainlink/contracts). These contracts are taken from the [core chainlink github](https://github.com/smartcontractkit/chainlink), compressed, and deployed to npm. 

Everyday at 3AM, the latest version of the package is updated here, this way, you can use the Chainlink contracts with foundry without having to use npm/yarn. This also makes other third party packages like Brownie and Ape easier to work with. 

## Usage

### Foundry

1. Run this in your projects root directory.

```bash

forge install smartcontractkit/chainlink-brownie-contracts --no-commit

```

2. Then, update your `foundry.toml` to include the following in the `remappings`.

```

remappings = [

  '@chainlink/contracts/=lib/chainlink-brownie-contracts/contracts/src/',

]

```

>! IMPORTANT

There were compatibility issues with `1.0.0`, `1.1.0` and `1.2.0`, where there were originally 2 versions of each version. We have deleted the deprecated and outdated versions so that there is no longer any conflict. 

All the releases of this package are going to match the [@chainlink/contracts NPM tags](https://www.npmjs.com/package/@chainlink/contracts). 

So the versioning will look "backwards", but we are starting with v0.2.1