README
¶
Seerlink
Node of the SeerLink decentralized oracle network, bridging on and off-chain computation.
Seerlink is middleware to simplify communication with blockchains. Here you'll find the Seerlink 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 Seerlink's decentralized oracle network. Further development of the Seerlink Node and Seerlink Network will happen here.
Features
- 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
Install
- Install Go 1.14, and add your GOPATH's bin directory to your PATH
- Example Path for macOS
export PATH=$GOPATH/bin:$PATH&export GOPATH=/Users/$USER/go
- Example Path for macOS
- Install NodeJS 12.18 & Yarn
- It might be easier long term to use nvm to switch between node versions for different projects:
nvm install 12.18 && nvm use 12.18
- It might be easier long term to use nvm to switch between node versions for different projects:
- Install Postgres (>= 11.x).
- You should configure Postgres to use SSL connection
- Download Seerlink:
git clone https://github.com/SeerLink/seerlink && cd seerlink - Build Seerlink:
make- If you got any errors regarding locked yarn package, try running
yarn installbefore this step
- If you got any errors regarding locked yarn package, try running
- Run the node:
seerlink help
Run
NOTE: By default, seerlink will run in TLS mode. For local development you can either disable this by setting SEERLINK_DEV to true.
To start your Seerlink node, simply run:
seerlink node start
By default this will start on port 6688.
Once your node has started, you can view your current jobs with:
seerlink job_specs list # v1 jobs
seerlink jobs list # v2 jobs
View details of a specific job with:
seerlink job_specs show "$JOB_ID # v1 jobs"
To find out more about the Seerlink CLI, you can always run seerlink help.
Build your current version
go build -o seerlink ./core/
- Run the binary:
./seerlink
Use of Go Generate
Go generate is used to generate mocks in this project. Mocks are generated with mockery and live in core/internal/mocks.
Contributing
Seerlink's source code is licensed under the MIT License, and contributions are welcome.
Thank you!
License
Directories
¶
| Path | Synopsis |
|---|---|
|
adapters
Package adapters contain the core adapters used by the Seerlink node.
|
Package adapters contain the core adapters used by the Seerlink node. |
|
cmd
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. |
|
logger
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. |
|
services
Package services contain the key components of the Seerlink node.
|
Package services contain the key components of the Seerlink node. |
|
services/signatures/cryptotest
package cryptotest provides convenience functions for kyber-based APIs.
|
package cryptotest provides convenience functions for kyber-based APIs. |
|
services/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. |
|
services/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. |
|
services/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. |
|
services/vrf
Numbers are deterministically generated from seeds and a secret key, and are statistically indistinguishable from uniform sampling from {0,...,2**256-1}, to computationally-bounded observers who know the seeds, don't know the key, and only see the generated numbers.
|
Numbers are deterministically generated from seeds and a secret key, and are statistically indistinguishable from uniform sampling from {0,...,2**256-1}, to computationally-bounded observers who know the seeds, don't know the key, and only see the generated numbers. |
|
store
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. |
|
store/models
Package models contain the key job components used by the Seerlink application.
|
Package models contain the key job components used by the Seerlink application. |
|
store/models/vrfkey
Package vrfkey tracks the secret keys associated with VRF proofs.
|
Package vrfkey tracks the secret keys associated with VRF proofs. |
|
store/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. |
|
utils
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. |
|
web
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.