Chainlink is middleware to simplify communication with blockchains. Here you'll find the Chainlink Golang node, currently in alpha. This initial implementation is intended for use and review by developers, and will go on to form the basis for Chainlink's decentralized oracle network. Further development of the Chainlink Node and Chainlink Network will happen here, if you are interested in contributing please see our contribution guidelines.
Examples of how to utilize and integrate Chainlinks can be found in the Chainlink Truffle Box.
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.
nvm install 12.18 && nvm use 12.18
git clone https://github.com/smartcontractkit/chainlink && cd chainlink
yarn installbefore this step
yarn installthrows a network connection error, try increasing the network timeout by running
yarn install --network-timeout 150000before this step
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:
NOTE: By default, chainlink will run in TLS mode. For local development you can either disable this by setting CHAINLINK_DEV to true, or 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, where it exposes a REST API.
Once your node has started, you can view your current jobs with:
chainlink job_specs list # v1 jobs chainlink jobs list # v2 jobs
View details of a specific job with:
chainlink job_specs show "$JOB_ID # v1 jobs"
To find out more about the Chainlink CLI, you can always run
You can configure your node's behavior by setting environment variables. All the environment variables can be found in the
ConfigSchema struct of
schema.go. You can also read the official documentation to learn the most up to date information on each of them. For every variable, default values get used if no corresponding environment variable is found.
Chainlink is a monorepo containing several logically separatable and relatable projects.
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.
For the latest information on setting up a development environment, see the guide here.
go build -o chainlink ./core/
make command will install the correct version.
yarn yarn setup:contracts
go generate ./... go run ./packr/main.go ./core/services/eth/
export DATABASE_URL=postgresql://127.0.0.1:5432/chainlink_test?sslmode=disable export CHAINLINK_DEV=true # I prefer to use direnv and skip this
go run ./core/main.go local db preparetest
If you do end up modifying the migrations for the database, you will need to rerun
go test -parallel=1 ./...
evm-contracts/directory houses Solidity versions <=0.7. New contracts, using v0.8, are being developed in the
contracts/directory, using hardhat.
yarn yarn setup
i. Solidity versions
Go generate is used to generate mocks in this project. Mocks are generated with mockery and live in core/internal/mocks.
To use it:
nix develop. You will be put in shell containing all the dependencies. Alternatively, a
direnvintegration exists to automatically change the environment when
cd-ing into the folder.
cd $PGDATA/ initdb pg_ctl -l $PGDATA/postgres.log -o "--unix_socket_directories='$PWD'" start createdb chainlink_test -h localhost createuser --superuser --no-password chainlink -h localhost
pg_ctl -l $PGDATA/postgres.log -o "--unix_socket_directories='$PWD'" start
Now you can run tests or compile code as usual.
For more tips on how to build and test Chainlink, see our development tips page.
Chainlink's source code is licensed under the MIT License, and contributions are welcome.
Please check out our contributing guidelines for more details.