Chainlink

Chainlink expands the capabilities of smart contracts by enabling access to real-world data and off-chain computation while maintaining the security and reliability guarantees inherent to blockchain technology.

This repo contains the Chainlink core node and contracts. The core node is the bundled binary available to be run by node operators participating in a decentralized oracle network. All major release versions have pre-built docker images available for download from the Chainlink dockerhub. If you are interested in contributing please see our contribution guidelines. If you are here to report a bug or request a feature, please check currently open Issues. For more information about how to get started with Chainlink, check our official documentation.

Community

Chainlink has an active and ever growing community. Discord is the primary communication channel used for day to day communication, answering development questions, and aggregating Chainlink related content. Take a look at the community docs for more information regarding Chainlink social accounts, news, and networking.

Build Chainlink

1. Install Go 1.27.3, and add your GOPATH's bin directory to your PATH
   • Example Path for macOS export PATH=$GOPATH/bin:$PATH & export GOPATH=/Users/$USER/go
2. Install NodeJS v20 & pnpm v10 via npm.
   • It might be easier long term to use nvm to switch between node versions for different projects. For example, assuming $NODE_VERSION was set to a valid version of NodeJS, you could run: nvm install $NODE_VERSION && nvm use $NODE_VERSION
3. Install Postgres (>= 15.x). It is recommended to run the latest major version of postgres.
   • Note if you are running the official Chainlink docker image, the highest supported Postgres version is 18.x due to the bundled client.
   • You should configure Postgres to use SSL connection (or for testing you can set ?sslmode=disable in your Postgres query string).
4. Download Chainlink: git clone https://github.com/smartcontractkit/chainlink && cd chainlink
5. Build and install Chainlink: make install
6. Run the node: chainlink help

For the latest information on setting up a development environment, see the Development Setup Guide.

Build from PR

To build an unofficial testing-only image from a feature branch or PR. You can do one of the following:

1. Send a workflow dispatch event from our docker-build workflow.
2. Add the build-publish label to your PR and then either retry the docker-build workflow, or push a new commit.

Build Plugins

Plugins are defined in yaml files within the plugins/ directory. Each plugin file is a yaml file and has a plugins. prefix name. Plugins are installed with loopinstall.

To install the plugins, run:

make install-plugins

Some plugins (such as those in plugins/plugins.private.yaml) reference private GitHub repositories. To build these plugins, you must have a GITHUB_TOKEN environment variable set, or preferably use the gh GitHub CLI tool to use the GitHub CLI credential helper like:

# Sets up a credential helper.
gh auth setup-git

Then you can build the plugins with:

make install-plugins-private

Docker Builds

To build the experimental "plugins" Chainlink docker image, you can run this from the root of the repository:

# The GITHUB_TOKEN is required to access private repos which are used by some plugins.
export GITHUB_TOKEN=$(gh auth token) # requires the `gh` cli tool.
make docker-plugins

Ethereum Execution Client Requirements

In order to run the Chainlink node you must have access to a running Ethereum node with an open websocket connection. Any Ethereum based network will work once you've configured the chain ID. Ethereum node versions currently tested and supported:

[Officially supported]

This is the beginning of the README. Read the rest at the original. Read the full README ↗