Skip to content

Commit

Permalink
docs: more description for config for each data pair
Browse files Browse the repository at this point in the history
  • Loading branch information
nick-bisonai committed May 1, 2024
1 parent c266bf6 commit 62cbb2a
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion en/node-operators-guide/data-feed-v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The **Orakl Network Data Feed** is one of the main Orakl Network solutions. The

A single data feed is defined by a pair of an adapter and an aggregator, and can be accessed on-chain through a `FeedProxy` smart contract. The `FeedProxy` is an auxiliary contract that redirects read requests to `Feed` contract. The `Feed` contract holds all submissions from all node operators, and aggregated value that is served to consumers through `FeedProxy` contract.

Every data feed is configured with 3 different intervals. `fetchInterval`, `aggregateInterval`, and `submitInterval`. Detailed specification for each feeds can be found in [orakl-config](https://github.com/Bisonai/orakl-config) as `configs.json` file. `OraklNode`, which stands for new datafeed performing off-chain aggregation, will execute each jobs based on defined intervals. Datafeed is updated once the finalized value have been generated off chain among OraklNodes.
Detailed specification for each feeds can be found in [orakl-config](https://github.com/Bisonai/orakl-config) as `configs.json` file. Every data feed is configured with 3 different intervals. `fetchInterval`, `aggregateInterval`, and `submitInterval`. `OraklNode`, which stands for new datafeed performing off-chain aggregation, will execute each jobs based on defined intervals. Datafeed is updated once the finalized value have been generated off chain among OraklNodes. `address` stands for the Feed contract address which takes the value for certain pair. `feeds` contains definitions to fetch and parse value from datasource.

The code is located under [`node` directory](https://github.com/Bisonai/orakl/tree/master/node) and it follows modular monolith pattern. The entrypoints can be found from `./node/cmd` directory, and its implementation codes can be found from `./node/pkg` directory.

Expand Down

0 comments on commit 62cbb2a

Please sign in to comment.