smartcontractkit/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.26.5, 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 (>= 12.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 17.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]

• Parity/Openethereum (NOTE: Parity is deprecated and support for this client may be removed in future)
• Geth
• Besu

[Supported but broken] These clients are supported by Chainlink, but have bugs that prevent Chainlink from working reliably on these execution clients.

• Nethermind Blocking issues:
  • #4384
• Erigon Blocking issues:
  • #4946
  • #4030

We cannot recommend specific version numbers for ethereum nodes since the software is being continually updated, but you should usually try to run the latest version available.

Running a local Chainlink node

NOTE: By default, chainlink will run in TLS mode. For local development you can disable this by using a dev build using make chainlink-dev and setting the TOML fields:

[WebServer]
SecureCookies = false
TLS.HTTPSPort = 0

[Insecure]
DevWebServer = true

Alternatively, you can generate self signed certificates using tools/bin/self-signed-certs or manually.

To start your Chainlink node, simply run:

chainlink node start

By default this will start on port 6688. You should be able to access the UI at http://localhost:6688/.

Chainlink provides a remote CLI client as well as a UI. Once your node has started, you can open a new terminal window to use the CLI. You will need to log in to authorize the client first:

chainlink admin login

(You can also set ADMIN_CREDENTIALS_FILE=/path/to/credentials/file in future if you like, to avoid having to login again).

Now you can view your current jobs with:

chainlink jobs list

To find out more about the Chainlink CLI, you can always run chainlink help.

Check out the doc pages on Jobs to learn more about how to create Jobs.

Configuration

Node configuration is managed by a combination of environment variables and direct setting via API/UI/CLI.

Check the official documentation for more information on how to configure your node.

External Adapters

External adapters are what make Chainlink easily extensible, providing simple integration of custom computations and specialized APIs. A Chainlink node communicates with external adapters via a simple REST API.

For more information on creating and using external adapters, please see our external adapters page.

Verify Official Chainlink Releases

We use cosign with OIDC keyless signing during the Build, Sign and Publish Chainlink workflow.

It is encourage for any node operator building from the official Chainlink docker image to verify the tagged release version was did indeed built from this workflow.

You will need cosign in order to do this verification. Follow the instruction here to install cosign.

# tag is the tagged release version - ie. 2.16.0
cosign verify index.docker.io/smartcontract/chainlink:${tag} \
      --certificate-oidc-issuer https://token.actions.githubusercontent.com \
      --certificate-identity "https://github.com/smartcontractkit/chainlink/.github/workflows/build-publish.yml@refs/tags/v${tag}"

Development

Githooks

Optionally install Git hooks with Lefthook to automatically catch lint errors, secrets, and typos before committing or pushing.

# Install lefthook with asdf or mise, or directly: https://lefthook.dev/install/
# Activate lefthook
lefthook install

git commit -m "commit message" # pre-commit hooks will run against changes, checking for linting issues and typos
git push                       # pre-push hooks will run minimal unit tests before activating CI
# Optionally use the `--no-verify` flag to disable githooks for specific commits/pushes
git commit -m "commit message" --no-verify
git push --no-verify
# Or use LEFTHOOK=0
LEFTHOOK=0 gh stack push

Note: Hooks help you catch issues before pushing to CI. They're meant to be quick, local checks to stop common mistakes and oversights. They are neither exhaustive or mandatory. CI is the ultimate, mandatory source of authority on code quality checks.

Condensed Test Flow (new)

Use make test which handles most of the test DB setup for you in plain go (see tools/test/README.md for details).

make test ARGS="-h"         # See full capabilities of the test harness
make test ARGS="./core/..." # Setup ephemeral test DB and run all tests in ./core

# Re-run tests in full isolation and get detailed stats to root out flakes and races
make test ARGS="diagnose --iterations 5 --parallel-iterations 3 -- ./core/config/..."

Manual Test Flow (old)

1. Install pnpm 10 via npm

2. Install gencodec and jq to be able to run go generate ./... and make abigen

3. Install mockery

   # Using the `make` command will install the correct version.
   make mockery
   

4. Generate and compile static assets:

   make generate
   

5. Prepare your development environment

   The tests require a postgres database. In turn, the environment variable CL_DATABASE_URL must be set to value that can connect to _test database, and the user must be able to create and drop the given _test database.

   Note: Other environment variables should not be set for all tests to pass

   There helper script for initial setup to create an appropriate test user. It requires postgres to be running on localhost at port 5432. You will be prompted for the postgres user password

   make setup-testdb
   

   This script will save the CL_DATABASE_URL in .dbenv

   Changes to database require migrations to be run. Similarly, pull'ing the repo may require migrations to run. After the one-time setup above:

   source .dbenv
   make testdb
   

   If you encounter the error database accessed by other users (SQLSTATE 55006) exit status 1 and you want force the database creation then use

   source .dbenv
   make testdb-force
   

6. Run tests:

   go test ./...
   

Notes

• The parallel flag can be used to limit CPU usage, for running tests in the background (-parallel=4) - the default is GOMAXPROCS
• The p flag can be used to limit the number of packages tested concurrently, if they are interfering with one another (-p=1)
• The -short flag skips tests which depend on the database, for quickly spot checking simpler tests in around one minute

Race Detector

As of Go 1.1, the runtime includes a data race detector, enabled with the -race flag. This is used in CI via the tools/bin/go_core_race_tests script. If the action detects a race, the artifact on the summary page will include race.* files with detailed stack traces.

It will not issue false positives, so take its warnings seriously.

For local, targeted race detection, you can run:

GORACE="log_path=$PWD/race" go test -race ./core/path/to/pkg -count 10
GORACE="log_path=$PWD/race" go test -race ./core/path/to/pkg -count 100 -run TestFooBar/sub_test

https://go.dev/doc/articles/race_detector

Fuzz tests

As of Go 1.18, fuzz tests func FuzzXXX(*testing.F) are included as part of the normal test suite, so existing cases are executed with go test.

Additionally, you can run active fuzzing to search for new cases:

go test ./pkg/path -run=XXX -fuzz=FuzzTestName

Go Modules

This repository contains three Go modules:

flowchart RL
    github.com/smartcontractkit/chainlink/v2
    github.com/smartcontractkit/chainlink/integration-tests --> github.com/smartcontractkit/chainlink/v2
    github.com/smartcontractkit/chainlink/core/scripts --> github.com/smartcontractkit/chainlink/v2

The integration-tests and core/scripts modules import the root module using a relative replace in their go.mod files, so dependency changes in the root go.mod often require changes in those modules as well. After making a change, go mod tidy can be run on all three modules using:

make gomodtidy

Code Generation

Go generate is used to generate mocks in this project. Mocks are generated with mockery and live in core/internal/mocks.

Nix

A shell.nix is provided for use with the Nix package manager. By default,we utilize the shell through Nix Flakes.

Nix defines a declarative, reproducible development environment. Flakes version use deterministic, frozen (flake.lock) dependencies to gain more consistency/reproducibility on the built artifacts.

To use it:

1. Install nix package manager in your system.

   • Enable flakes support

2. Run nix develop. You will be put in shell containing all the dependencies.

   • Optionally, nix develop --command $SHELL will make use of your current shell instead of the default (bash).
   • You can use direnv to enable it automatically when cd-ing into the folder; for that, enable nix-direnv and use flake on it.

3. Create a local postgres database:

   mkdir -p $PGDATA && cd $PGDATA/
   initdb
   pg_ctl -l postgres.log -o "--unix_socket_directories='$PWD'" start
   createdb chainlink_test -h localhost
   createuser --superuser --password chainlink -h localhost
   # then type a test password, e.g.: chainlink, and set it in shell.nix CL_DATABASE_URL
   

4. When re-entering project, you can restart postgres: cd $PGDATA; pg_ctl -l postgres.log -o "--unix_socket_directories='$PWD'" start Now you can run tests or compile code as usual.

5. When you're done, stop it: cd $PGDATA; pg_ctl -o "--unix_socket_directories='$PWD'" stop

Changesets

We use changesets to manage versioning for libs and the services.

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 make gocs command 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.

Tips

For more tips on how to build and test Chainlink, see our development tips page.

Contributing

Contributions are welcome to Chainlink's source code.

Please check out our contributing guidelines for more details.

Thank you!