Skip to content
node of the decentralized oracle network, bridging on and off-chain computation
Go TypeScript CSS JavaScript Solidity Rust Other
Branch: develop
Clone or download
se3000 Merge pull request #2325 from smartcontractkit/chore/bump-shm-again
bump shm size again for integration tests
Latest commit eeba71d Feb 17, 2020
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Merge pull request #2300 from smartcontractkit/chore/run-go-tests-on-… Feb 12, 2020
.githooks Add rebase check to CI Dec 18, 2019
.github/ISSUE_TEMPLATE add startup command to node operator issue Oct 21, 2019
belt Bump belt to 0.0.1 Feb 12, 2020
core Fix postgres advisory locking tests Feb 16, 2020
docs feat(issues): [templates] Add Issue Templates Oct 17, 2019
evm-box Regenerate @truffle/hdwallet-provider Feb 12, 2020
evm-contracts Merge pull request #2303 from smartcontractkit/chore/remove-virtual-k… Feb 12, 2020
evm-test-helpers Bump @chainlink/test-helpers to 0.0.2 Feb 12, 2020
examples Bump solc from 0.6.0 to 0.6.2 Feb 10, 2020
explorer Fix clean command for explorer/client Feb 11, 2020
feeds Bump counter to 20 mins for ETH / USD & BTC / USD feeds Feb 12, 2020
integration-scripts Bump @chainlink/test-helpers to 0.0.2 Feb 12, 2020
integration Merge pull request #2248 from smartcontractkit/chore/170521326-update… Feb 13, 2020
operator_ui Bump babel-plugin-universal-import from 3.1.2 to 4.0.0 Feb 10, 2020
packr make install embeds eth/contracts.go w packr Dec 20, 2019
styleguide Make build and clean scripts more consistent Feb 8, 2020
tools bump shm size again for integration tests Feb 17, 2020
.codeclimate.yml Configure eslint on codeclimate Feb 27, 2019
.dockerignore Use @chainlink/contracts across repo Feb 8, 2020
.eslintignore Ignore fixtures for eslint Feb 12, 2020
.eslintrc.js Use @chainlink/contracts across repo Feb 8, 2020
.gitattributes Enable syntax highlighting for solidity files Jan 30, 2019
.gitignore Use updated package name @chainlink/feeds Feb 4, 2020
.nvmrc Update .nvmrc config file to nodejs 10.16.3 Nov 27, 2019
.prettierignore Prettier + eslint as workspace commands Dec 17, 2019
.prettierrc.js Prettier + eslint as workspace commands Dec 17, 2019
.solhint.json mark solhint errors Jul 29, 2019
.solhintignore Remove unused examples Nov 11, 2019
Dockerfile.web Feeds heroku build can set Google Analytics ID Feb 4, 2020
GNUmakefile Make build and clean scripts more consistent Feb 8, 2020
LICENSE add license Feb 15, 2018
README.md README: Correct test instructions Feb 14, 2020
VERSION bump patch version Jan 21, 2020
babel.config.js Run eslint --fix Dec 17, 2019
box-img-lg.png update Truffle Box logos May 17, 2019
box-img-sm.png update Truffle Box logos May 17, 2019
go.mod Bump github.com/tidwall/gjson from 1.4.0 to 1.5.0 Feb 17, 2020
go.sum Bump github.com/tidwall/gjson from 1.4.0 to 1.5.0 Feb 17, 2020
heroku.yml Feeds heroku build can set Google Analytics ID Feb 4, 2020
kit.json Move box to root of repo Feb 11, 2020
package.json Move box to root of repo Feb 11, 2020
requirements.txt bump slither version Dec 20, 2019
truffle-box.json Remove interactive selector from unpack Feb 12, 2020
tsconfig.cjs.json Make build and clean scripts more consistent Feb 8, 2020
tsconfig.es6.json Consolidate tsconfig.json Feb 8, 2020
unbox.sh Move box to root of repo Feb 11, 2020
yarn.lock Regenerate @truffle/hdwallet-provider Feb 12, 2020

README.md

Chainlink

Join the chat at https://discordapp.com/invite/aSK4zew CircleCI Go Report Card GoDoc Maintainability Test Coverage

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. The current node supports:

  • easy connectivity of on-chain contracts to any off-chain computation or API
  • multiple methods for scheduling both on-chain and off-chain computation for a user's smart contract
  • automatic gas price bumping to prevent stuck transactions, assuring your data is delivered in a timely manner
  • push notification of smart contract state changes to off-chain systems, by tracking Ethereum logs
  • translation of various off-chain data types into EVM consumable types and transactions
  • easy to implement smart contract libraries for connecting smart contracts directly to their preferred oracles
  • easy to install node, which runs natively across operating systems, blazingly fast, and with a low memory footprint

Examples of how to utilize and integrate Chainlinks can be found in the examples directory.

Install

  1. Install Go 1.12+, and add your GOPATH's bin directory to your PATH
  2. Install NodeJS & Yarn
  3. Download Chainlink: git clone https://github.com/smartcontractkit/chainlink && cd chainlink
  4. Build and install Chainlink: make install
  5. Run the node: chainlink help

Ethereum Node 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:

Run

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 local node

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 jobspecs

View details of a specific job with:

$ chainlink show $JOB_ID

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

Check out the wiki's pages on Adapters and Initiators to learn more about how to create Jobs and Runs.

Configure

You can configure your node's behavior by setting environment variables which can be, along with default values that get used if no corresponding environment variable is found. The latest information on configuration variables are available in the docs.

Project Directory

This project contains several sub-projects, some with their own documentation.

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.

Development Setup

For the latest information on setting up a development environment, see the guide here.

Build your current version

$ go build -o chainlink ./core/
  • Run the binary:
$ ./chainlink

Test

  1. Install Yarn

  2. Build contracts:

$ yarn
$ yarn setup:contracts
  1. Ready for testing:
$ go test -parallel=1 ./...

Solidity Development

  1. Install Yarn
  2. Install the dependencies:
$ cd evm
$ yarn install
  1. Run tests:
$ yarn run test-sol

Use of Go Generate

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

Development Tips

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

Contributing

Chainlink's source code is licensed under the MIT License, and contributions are welcome.

Please check out our contributing guidelines for more details.

Thank you!

You can’t perform that action at this time.