Skip to content
node of the decentralized oracle network, bridging on and off-chain computation
Go TypeScript JavaScript Solidity Rust Shell Other
Branch: develop
Clone or download
se3000 Merge pull request #1560 from smartcontractkit/dependabot/go_modules/…
…github.com/onsi/gomega-1.6.0

Bump github.com/onsi/gomega from 1.5.0 to 1.6.0
Latest commit 3b489d8 Aug 20, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci use `mod download` insted of `mod tidy` Aug 9, 2019
core Merge pull request #1555 from felder-cl/fix/controllers-use-cause Aug 20, 2019
docs move internal/bin to tools/bin Apr 10, 2019
evm Improve gas usage in oracleRequest Aug 16, 2019
examples Add preliminary linting and fix lint errors Aug 6, 2019
explorer Add craco to dev deps Aug 15, 2019
integration use geth from builder image instead of installing Aug 8, 2019
operator_ui Enable 404 page Aug 15, 2019
sgx Upgrade bigdecimal-rs to 0.1.0 May 11, 2019
src/github.com/ethereum Refactor Bridges/List to tsx Aug 6, 2019
styleguide Add type definitions closer to create location Aug 15, 2019
tools Add a note that credentials are dev only Aug 12, 2019
.codeclimate.yml Configure eslint on codeclimate Feb 27, 2019
.dockerignore Verbose dep ensure in makefile Jul 11, 2019
.eslintignore rename gui to operator_ui Apr 17, 2019
.eslintrc Use eslint with a typescript parser to replace tslint Apr 16, 2019
.gitattributes Enable syntax highlighting for solidity files Jan 30, 2019
.gitignore Add tsbuildinfo to gitignore Aug 1, 2019
.nvmrc Specify node version to lts/carbon May 7, 2018
.prettierignore rename gui to operator_ui Apr 17, 2019
.prettierrc Add create-react-app for frontend dev with snapshotting Mar 12, 2019
.solhint.json mark solhint errors Jul 29, 2019
.solhintignore Switched from solium to solhint Jul 28, 2019
Dockerfile use `mod download` insted of `mod tidy` Aug 9, 2019
Dockerfile-sgx Upgrade builder image to get new SGX SDK May 10, 2019
GNUmakefile Merge pull request #1501 from smartcontractkit/gomod3 Aug 9, 2019
LICENSE add license Feb 15, 2018
README.md update docs for go modules Aug 7, 2019
VERSION bump core version number Jul 23, 2019
babel.config.js Add styleguide to workspace Jun 27, 2019
box-img-lg.png update Truffle Box logos May 17, 2019
box-img-sm.png update Truffle Box logos May 17, 2019
chainlink-launcher-sgx.sh Pass LD_LIBRARY_PATH to aesm_service May 10, 2019
docker-compose.yaml Add a note that credentials are dev only Aug 12, 2019
go.mod Bump github.com/onsi/gomega from 1.5.0 to 1.6.0 Aug 20, 2019
go.sum Bump github.com/onsi/gomega from 1.5.0 to 1.6.0 Aug 20, 2019
kit.json Add support for OpenZeppelin Starter Kits Aug 12, 2019
package.json Remove web3 from root package.json Aug 13, 2019
truffle-box.json Add support for OpenZeppelin Starter Kits Aug 12, 2019
tsconfig.base.json Add base tsconfig Aug 1, 2019
tsconfig.json Use eslint with a typescript parser to replace tslint Apr 16, 2019
tslint.json Add prettier for code linting & formatting with standard rules Feb 27, 2019
unbox.sh Add support for OpenZeppelin Starter Kits Aug 12, 2019
yarn.lock Pull quickselect into its own library Aug 15, 2019

README.md

Chainlink

Join the chat at https://gitter.im/smartcontractkit-chainlink/Lobby 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 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.

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
  • Run the binary:
$ ./chainlink

Test

$ cd $GOPATH/src/github.com/smartcontractkit/chainlink
$ go test ./...

Solidity Development

  1. Install Yarn
  2. Install the dependencies:
$ cd $GOPATH/src/github.com/smartcontractkit/chainlink/evm
$ yarn install
  1. Run tests:
$ yarn run test-sol

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.