@defichain/salmon

Mono-repo for DeFi Blockchain price oracle service with e2e setup. Includes infrastructure, scripts and serverless functions for the Price Oracle service.

🚧 Work in progress.

Publishing

On release types: [ published, prereleased ], GitHub Action will automatically build all packages in this repo and publish a build artifact.

Usage

Salmon is designed with AWS Lambda in mind, although the individual packages can be used to fetch prices or push prices to oracles. See the configuration section below for more information.

Configuration

salmon-lambda-functions is configurable via the following environment variables:

OCEAN_URL: url of local or remote whale instance
NETWORK: regtest|testnet|mainnet
CURRENCY: USD, etc
SYMBOLS: a comma separated list of symbols to fetch from the providers
ORACLE_ID: the id of the oracle to push prices to on DeFiChain
PRIVATE_KEY_SSM_KEY: SSM key in AWS for the private key
API_TOKEN: (optional) API token for certain providers e.g. Tiingo, Finnhubb, IEXCloud

IntelliJ IDEA

IntelliJ IDEA is the IDE of choice for writing and maintaining this library. IntelliJ's files are included for convenience with basic toolchain setup but use of IntelliJ is totally optional.

Security issues

If you discover a security vulnerability in @defichain/salmon, please see submit it privately.

License & Disclaimer

By using @defichain/salmon (this repo), you (the user) agree to be bound by the terms of this license.