DigiOracle Docs v1.0.1
  • 📔KlayOracle Documentation
  • Fundamentals
    • Introduction
    • Architecture
    • Aggregation Mechanism
    • Node & data provider communication
    • Installing KlayOracle
  • Smart Contract Developers
    • Price Feeds
      • Quick Start: Code Samples
      • How to Use KlayOracle Price Feeds
    • Random Number Generator
      • Quick Start: Code Samples
      • How to Use KlayOracle Random Number Generator
  • Data Providers
    • Introduction
    • Install & run data providers locally
    • How It Works
      • Configuring Data Feeds
      • Reducers
      • Data provider utilities
      • Configuration Files & Environmental Variables
      • OracleProvider Contract
      • Bootstrap Data Providers
    • Best Practices
  • Nodes
    • Introduction
    • Install & run node locally
  • Community
    • DigiOracle Champion Program
      • About the DigiOracle Champion Program
      • How to create content & become a DigiOracle Champion
      • Contribution Guidelines
      • FAQs
    • Bounties
Powered by GitBook
On this page
  1. Data Providers
  2. How It Works

Configuration Files & Environmental Variables

PreviousData provider utilitiesNextOracleProvider Contract

Last updated 2 years ago

The data provider's configuration files and environmental variables are both mechanisms for conveying the data provider's configuration information to its operating environment (e.g. the host server, connecting node, or KlayOracle protocol). However, unlike config files, environmental variables contain secret values and .

In KlayOracle, data provider configuration files are defined within the data-providers/config.yml file, while environmental variables are defined in the data-providers/.env file.

To get up and running quickly, edit the sample file, and copy the contents of to your data-providers/.env file.

config.yml

env

service_node

config.yaml

env

specifies the environment in which the data provider is currently running. Choices: - dev - stage - prod

service_node

the IP address of the node which the data provider is connected to.

feed dictionary

path string

Path to the folder where the data provider's adapters (aka data feeds) are defined. This path is relative to the data-providers folder,

adapters list

organization

k_org_id

name

website

Your organization website.

ssl

key

This should be left blank

certificate

  • Relative path to the folder where the adapters (or data feeds) are defined. This path is

  • The list of adapters

To reference environmental variables as values in your config.yaml file (or other , use the syntax ${ENV_VAR}.

list of data feeds (aka adapters) you want the node to aggregate. each data feed must match the file name in the folder defined in the "path" property. Any adapter not defined within this list will not be aggregated by the node, even if its property is set to true. the

Data providers require the node's self-signed public certificate to communicate securely with the node via SSL (Secure Socket Layer). This file should be saved within the data-provider/certs/node folder.

shouldn't be committed to your code repository
config
env.example
active