node of the decentralized oracle network, bridging on and off-chain computation
Branch: master
Clone or download
rupurt Merge pull request #991 from smartcontractkit/features/truffle-typesc…
…ript

Configure typescript for solidity tests
Latest commit 410d3fb Feb 20, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci bump CI image versions Feb 13, 2019
.storybook Add StatusCard & fonts to storybook Dec 3, 2018
adapters rename NewApplicationWith{KeyStore,Key} Feb 13, 2019
cmd remove duplication in remove CLI Feb 14, 2019
docs Remove make build and clean up Dockerfile* Nov 5, 2018
e2e Add storybook styleguide Dec 3, 2018
examples Update Ropsten example contracts Feb 14, 2019
gui Add return type definition Feb 13, 2019
integration document the differences in OracleRequest logs Feb 13, 2019
internal make transaction factory have unique hashes Feb 14, 2019
logger refactor ProductionLoggerFilepath to private logFileURI: Feb 14, 2019
services Always print current_height as base 10 Feb 14, 2019
sgx Use result in SGX adapters (not value) Feb 13, 2019
solidity Configure typescript for solidity tests Feb 20, 2019
store Merge pull request #979 from smartcontractkit/feature/like_a_magnifyi… Feb 15, 2019
stories Fix linting errors Jan 10, 2019
tools Fix lint on CI Jan 10, 2019
utils add documentation Feb 13, 2019
web remove unused/duplicate code Feb 14, 2019
.babelrc Add typescript and configure support for GUI Feb 13, 2019
.dockerignore Update .dockerignore to ignore vendor/,Dockerfile-sgx,etc Nov 5, 2018
.gitattributes Enable syntax highlighting for solidity files Jan 30, 2019
.gitignore Gitignore gui/artifacts Feb 13, 2019
.nvmrc Specify node version to lts/carbon May 7, 2018
.soliumignore Update guides to use docs site Nov 1, 2018
.soliumrc.json Add Zeppelin plugin for Solium Sep 6, 2018
Dockerfile Use builder image v1.0.17 Feb 12, 2019
Dockerfile-sgx Use builder image v1.0.17 Feb 12, 2019
Gopkg.lock Merge pull request #990 from smartcontractkit/dependabot/dep/github.c… Feb 20, 2019
Gopkg.toml Bump github.com/tidwall/gjson from 1.1.5 to 1.2.1 Feb 20, 2019
LICENSE add license Feb 15, 2018
Makefile Read contract JSON files from packr Box Feb 11, 2019
README.md Remove bootstrap target, do godep/gencodec install automatically Nov 14, 2018
VERSION Bump VERSION to 0.6.0 Feb 13, 2019
chainlink-launcher-sgx.sh Only kill aesm straggler, not kill -- -$$ Nov 15, 2018
chainlink-launcher.sh separate chainlink-launcher from sgx for proper user prompts Oct 22, 2018
docker-compose.yaml Separate ETH_URL into ETH_WS_URL and ETH_RPC_URL Dec 14, 2018
jest.config.js Add new sign in form styles Jan 29, 2019
jest.setup.js Add finally shim for older browser support Nov 12, 2018
main.go Set the production PasswordPrompter Jan 14, 2019
main_test.go bring back transaction attempts command Feb 14, 2019
package.json Configure typescript for solidity tests Feb 20, 2019
tsconfig.json Add typescript and configure support for GUI Feb 13, 2019
yarn.lock Configure typescript for solidity tests Feb 20, 2019
zos.json Use top-level Chainlink package Jan 2, 2019

README.md

Chainlink CircleCI Maintainability Go Report Card Join the chat at https://gitter.im/smartcontractkit-chainlink/Lobby Test Coverage GoDoc

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.10+, and add your GOPATH's bin directory to your PATH
  2. Install NodeJS & Yarn
  3. Download Chainlink: go get -d github.com/smartcontractkit/chainlink && cd $GOPATH/src/github.com/smartcontractkit/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 internal/bin/self-signed-certs or manually.

To start your Chainlink node, simply run:

$ chainlink 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 wiki.

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/solidity
$ 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!