README
¶
Chainlink Core is the API backend that Chainlink client contracts on Ethereum make requests to. The backend utilizes Solidity contract ABIs to generate types for interacting with Ethereum contracts.
Features
- Headless API implementation
- CLI tool providing conveniance commands for node configuration, administration, and CRUD object operations (e.g. Jobs, Runs, and even the VRF)
Installation
See the root README for instructions on how to build the full Chainlink node.
Directory Structure
This directory contains the majority of the code for the backend of Chainlink.
Outside of the code contained in this repo, some static assets are pulled in using
packr, in the sibling directory packr/.
Additionally, the static assets generated by compiling the
sibling directory operator-ui/ are built by packr and included in the final
binary.
Common Commands
Install:
By default go install will install this directory under the name core.
You can instead, build it, and place it in your path as chainlink:
go build -o $GOPATH/bin/chainlink .
Test:
# A higher parallel number can speed up tests at the expense of more RAM.
go test -p 1 ./...
The golang testsuite is almost entirely parallelizable, and so running the default
go test ./... will commonly peg your processor. Limit parallelization with the
-p 2 or whatever best fits your computer: go test -p 4 ./....
Documentation
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package adapters contain the core adapters used by the Chainlink node.
|
Package adapters contain the core adapters used by the Chainlink node. |
|
Package cmd is the front-end interface for the application as a command-line utility.
|
Package cmd is the front-end interface for the application as a command-line utility. |
|
internal
|
|
|
gethwrappers
Package gethwrappers provides infrastructure for generating and verifying go-ethereum wrapper packages for smart contracts.
|
Package gethwrappers provides infrastructure for generating and verifying go-ethereum wrapper packages for smart contracts. |
|
Package logger exports multiple type loggers: - the *Logger type is a wrapper over uber/zap#SugaredLogger with added conditional utilities.
|
Package logger exports multiple type loggers: - the *Logger type is a wrapper over uber/zap#SugaredLogger with added conditional utilities. |
|
Package services contain the key components of the Chainlink node.
|
Package services contain the key components of the Chainlink node. |
|
keystore/keys/vrfkey
Package vrfkey tracks the secret keys associated with VRF proofs.
|
Package vrfkey tracks the secret keys associated with VRF proofs. |
|
signatures/cryptotest
Package cryptotest provides convenience functions for kyber-based APIs.
|
Package cryptotest provides convenience functions for kyber-based APIs. |
|
signatures/ethdss
Package ethdss implements the Distributed Schnorr Signature protocol from the ////////////////////////////////////////////////////////////////////////////// XXX: Do not use in production until this code has been audited.
|
Package ethdss implements the Distributed Schnorr Signature protocol from the ////////////////////////////////////////////////////////////////////////////// XXX: Do not use in production until this code has been audited. |
|
signatures/ethschnorr
Package ethschnorr implements a version of the Schnorr signature which is ////////////////////////////////////////////////////////////////////////////// XXX: Do not use in production until this code has been audited.
|
Package ethschnorr implements a version of the Schnorr signature which is ////////////////////////////////////////////////////////////////////////////// XXX: Do not use in production until this code has been audited. |
|
signatures/secp256k1
Package secp256k1 is an implementation of the kyber.{Group,Point,Scalar} ////////////////////////////////////////////////////////////////////////////// XXX: Do not use in production until this code has been audited.
|
Package secp256k1 is an implementation of the kyber.{Group,Point,Scalar} ////////////////////////////////////////////////////////////////////////////// XXX: Do not use in production until this code has been audited. |
|
Package store is used to keep application events in sync between the database on the node and the blockchain.
|
Package store is used to keep application events in sync between the database on the node and the blockchain. |
|
models
Package models contain the key job components used by the Chainlink application.
|
Package models contain the key job components used by the Chainlink application. |
|
presenters
Package presenters allow for the specification and result of a Job, its associated TaskSpecs, and every JobRun and TaskRun to be returned in a user friendly human readable format.
|
Package presenters allow for the specification and result of a Job, its associated TaskSpecs, and every JobRun and TaskRun to be returned in a user friendly human readable format. |
|
Package utils is used for common functions and tools used across the codebase.
|
Package utils is used for common functions and tools used across the codebase. |
|
Package web handles receiving and supplying information within the node.
|
Package web handles receiving and supplying information within the node. |
Click to show internal directories.
Click to hide internal directories.