chore: generic cleanup, add explicit reference to RedStone SDK in pul…

…l model (#51)
redstone-finance · Sep 10, 2024 · 9c27eec · 9c27eec
1 parent de53597
commit 9c27eec
Show file tree

Hide file tree

Showing 22 changed files with 12,739 additions and 8,190 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,22 @@
+name: Lint docs
+
+on: push
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+        - uses: actions/checkout@v4
+        - name: Enable corepack
+          run: |
+            mkdir -p $HOME/bin
+            export PATH=$HOME/bin:$PATH
+            echo "$HOME/bin" >> $GITHUB_PATH
+            corepack enable --install-directory $HOME/bin
+        - uses: actions/setup-node@v4
+          with:
+            node-version: 20
+        - name: Install dependencies
+          run: yarn install --immutable
+        - name: prettier
+          run: yarn lint
diff --git a/.gitignore b/.gitignore
@@ -34,9 +34,6 @@ bower_components
 # node-waf configuration
 .lock-wscript
 
-# Compiled binary addons (https://nodejs.org/api/addons.html)
-build/Release
-
 # Dependency directories
 node_modules/
 jspm_packages/
@@ -110,3 +107,4 @@ dist
 build
 .idea/
 
+/.yarn/
diff --git a/.markdownlint-cli2.jsonc b/.markdownlint-cli2.jsonc
@@ -0,0 +1,3 @@
+{
+  "gitignore": true
+}
diff --git a/.markdownlint.json b/.markdownlint.json
@@ -0,0 +1,15 @@
+{
+  "default": true,
+  "MD001": false,
+  "MD004": false,
+  "MD012": false,
+  "MD013": false,
+  "MD021": false,
+  "MD022": false,
+  "MD024": { "siblings_only": true },
+  "MD031": false,
+  "MD032": false,
+  "MD033": false,
+  "MD034": false,
+  "MD041": false
+}
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1 @@
+static
diff --git a/.yarnrc.yml b/.yarnrc.yml
@@ -0,0 +1 @@
+nodeLinker: node-modules
diff --git a/README.md b/README.md
@@ -4,22 +4,22 @@ This website is built using [Docusaurus 2](https://docusaurus.io/), a modern sta
 
 ### Installation
 
-```
-$ yarn
+```sh
+yarn
 ```
 
 ### Local Development
 
-```
-$ yarn start
+```sh
+yarn start
 ```
 
 This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
 
 ### Build
 
-```
-$ yarn build
+```sh
+yarn build
 ```
 
 This command generates static content into the `build` directory and can be served using any static contents hosting service.
@@ -28,14 +28,14 @@ This command generates static content into the `build` directory and can be serv
 
 Using SSH:
 
-```
-$ USE_SSH=true yarn deploy
+```sh
+USE_SSH=true yarn deploy
 ```
 
 Not using SSH:
 
-```
-$ GIT_USER=<Your GitHub username> yarn deploy
+```sh
+GIT_USER=<Your_GitHub_username> yarn deploy
 ```
 
 If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
diff --git a/docs/Introduction.md b/docs/Introduction.md
@@ -3,34 +3,34 @@ sidebar_position: 1
 sidebar_label: "♦️ What is RedStone Oracles?"
 ---
 
+# Introduction
+
 ## Overview
 
 There is a growing need for decentralized applications (dApps) to access data feeds that are frequently updated, reliable, and secure. RedStone Oracles is a leading oracle provider directly fulfilling this need. Trusted by 100+ dApps and securing billions of dollars of value, RedStone provides customizable and cost-efficient data streams for builders empowering the next generation of dApps. RedStone also provides data feeds to blockchains and layer 2 scaling solutions across the entire blockchain ecosystem that are both EVM and non-EVM compatible. The current model of oracle systems suffers from key inefficiencies, all of which RedStone Oracles was specifically designed to solve from the bottom up. This makes RedStone a unique oracle service.
 
 ## The Problems RedStone Solves ♦️
 
-### Problem # 1: The standard approach of providing data to applications is inefficient and expensive. 
-- The standard method of providing data is to ‘push’ the data onto the blockchain regardless of whether it is used by an application. This results in paying more for data and dedicating resources that could be used elsewhere. 
+### Problem # 1: The standard approach of providing data to applications is inefficient and expensive
 
-#### Our Solution
+- The standard method of providing data is to ‘push’ the data onto the blockchain regardless of whether it is used by an application. This results in paying more for data and dedicating resources that could be used elsewhere.
 
-RedStone allows data to be provided on-demand rather than on a fixed schedule, reducing the costs of putting data 'on-chain'. This is achieved by storing data off of the blockchain as cryptography signed packages and allowing smart contracts of dApps to fetch data when necessary. 
+#### Our Solution
 
-_A note on data integrity_: To maintain data integrity RedStone also provides data feeds to Arweave, a decentralized network that provides data storage. Arweave's decentralized network makes it tamper-proof, therefore any data provided by RedStone to Arweave acts as a unbiased source of truth about the historical data provided by RedStone. 
+RedStone allows data to be provided on-demand rather than on a fixed schedule, reducing the costs of putting data 'on-chain'. This is achieved by storing data off of the blockchain as cryptography signed packages and allowing smart contracts of dApps to fetch data when necessary.
 
-Overall, RedStone's approach improves efficiency for dApps and significantly reduces the costs for dApps to access data feeds. 
+_A note on data integrity_: To maintain data integrity RedStone also provides data feeds to Arweave, a decentralized network that provides data storage. Arweave's decentralized network makes it tamper-proof, therefore any data provided by RedStone to Arweave acts as a unbiased source of truth about the historical data provided by RedStone.
 
+Overall, RedStone's approach improves efficiency for dApps and significantly reduces the costs for dApps to access data feeds.
 
-### Problem #2: The typical monolithic architecture of oracles limits scalability.
+### Problem #2: The typical monolithic architecture of oracles limits scalability
 
 - A consequence of a monolithic architecture is that makes it challenging for protocols to reduce latency and list new assets.
 
 #### Our Solution
 
 RedStone was designed with a modular architecture making it easy to incorporate new assets and reduce latency, allowing dApps to scale more efficiently. This means constructing the oracle in such a way that its various components—such as data sources, validation mechanisms, and delivery methods—can be easily interchanged, updated, or augmented without disrupting the system’s overall functionality.
 
-
-
 ## Key facts
 
 - RedStone secures [billions of dollars](https://defillama.com/oracles/RedStone?borrowed=true&doublecounted=true) of value in Web 3.0
@@ -41,10 +41,6 @@ RedStone was designed with a modular architecture making it easy to incorporate
 - Our code was audited by multiple security experts including [ABDK](https://abdk.consulting/) [Peckshield](https://peckshield.com/) and a co-founder of [L2Beat](https://pl.linkedin.com/company/l2beat#:~:text=Join%20Piotr%20Szlachciak%20Cofounder%20%26%20CEO,insights%20shaping%20the%20%23DeFi%20landscape!).
 - RedStone supports leading projects like [Morpho](https://morpho.org/), [Venus](https://venus.io/), and [Pendle Finance](https://www.pendle.finance/).
 
-
-
 <a href="https://raw.githubusercontent.com/redstone-finance/redstone-docs/main/static/img/redstone-architecture-simple.png">
   <img alt="RedStone Architecure" src="/img/redstone-architecture-simple.png" target="_blank"/>
 </a>
-
-
diff --git a/docs/avs/running-avs-operator.md b/docs/avs/running-avs-operator.md
@@ -22,7 +22,7 @@ This registration process is essential for establishing an identity and enabling
 
 To register, the following command should be executed in the terminal:
 
-```sh
+```bash
 docker run -it public.ecr.aws/y7v2w8b2/avs-othentic-client:90fc014d operator register
 ```
 
@@ -36,8 +36,8 @@ After executing the command, the following information will be required:
 The next step involves creating a configuration file that will define the essential parameters needed for the operator to function correctly within the RedStone AVS network.
 This configuration file, named `.env`, should contain the following content:
 
-```
-ORACLE_NODE_WHITELIST=["0x8BB8F32Df04c8b654987DAaeD53D6B6091e3B774","0xdEB22f54738d54976C4c0fe5ce6d408E40d88499","0x51Ce04Be4b3E32572C4Ec9135221d0691Ba7d202","0xDD682daEC5A90d0D295d14DA4b0bec9281017b5bE","0x9c5AE89C4Af6aA32cE58588DBaF90d18a855B6de"]  
+```bash
+ORACLE_NODE_WHITELIST=["0x8BB8F32Df04c8b654987DAaeD53D6B6091e3B774","0xdEB22f54738d54976C4c0fe5ce6d408E40d88499","0x51Ce04Be4b3E32572C4Ec9135221d0691Ba7d202","0xDD682daEC5A90d0D295d14DA4b0bec9281017b5bE","0x9c5AE89C4Af6aA32cE58588DBaF90d18a855B6de"]
 
 DATA_FEED_ID=ETH
 

diff --git a/docs/data-providers/running-oracle-node.md b/docs/data-providers/running-oracle-node.md
@@ -37,12 +37,13 @@ We've prepared a simple .env file and a bash script so you can quickly run your
 :::info More env variables
 The table below contains the main environment variables required for running a node. To see all the supported environment variables (including optional), please take a look at [this file.](https://github.com/redstone-finance/redstone-oracles-monorepo/blob/main/packages/oracle-node/src/config.ts)
 :::
-| Param | Description | Example value |
-|------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|
-| ECDSA_PRIVATE_KEY | Your ECDSA private key | `ECDSA_PRIVATE_KEY=0x123...` |
-| OVERRIDE_DIRECT_CACHE_SERVICE_URLS | Your personal private URLs of gateways to the RedStone Data Distribution Layer (DDL). For running a local node you can simply put `OVERRIDE_DIRECT_CACHE_SERVICE_URLS=["https://httpbin.org/anything"]`. But for production node running you should [request them](https://redstone.finance/discord) from the RedStone team. | `OVERRIDE_DIRECT_CACHE_SERVICE_URLS=["https://xxx.yyy.secret-url-1.com","https://zzz.aaa.secret-url-2.com"]` |
-| OVERRIDE_MANIFEST_USING_FILE | Path to your manifest file. Manifest is a public JSON file that defines the provider's obligation regarding the data that they provide. It sets fetching interval, tokens, sources and other public technical details for the provided data. You can check available manifests [here.](https://github.com/redstone-finance/redstone-oracles-monorepo/tree/main/packages/oracle-node/manifests) | `OVERRIDE_MANIFEST_USING_FILE=./manifests/dev/dev.json` |
-| LEVEL_DB_LOCATION | Path to the level DB. Each RedStone oracle node relies on a single-level DB. It is used to store recently fetched values from the last 15 minutes. These values are used for checking value deviations, filtering outliers and preventing price manipulation attacks. <br/><br/> You don't need to create a Level DB instance manually, it will be created automatically at the specified path during the first node launch. | `LEVEL_DB_LOCATION=/oracle-node-level-db` |
+
+| Param                              | Description                                                                                                                                                                                                                                                                                                                                                                                                                  | Example value                                                                                                |
+| ---------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
+| ECDSA_PRIVATE_KEY                  | Your ECDSA private key                                                                                                                                                                                                                                                                                                                                                                                                       | `ECDSA_PRIVATE_KEY=0x123...`                                                                                 |
+| OVERRIDE_DIRECT_CACHE_SERVICE_URLS | Your personal private URLs of gateways to the RedStone Data Distribution Layer (DDL). For running a local node you can simply put `OVERRIDE_DIRECT_CACHE_SERVICE_URLS=["https://httpbin.org/anything"]`. But for production node running you should [request them](https://redstone.finance/discord) from the RedStone team.                                                                                                 | `OVERRIDE_DIRECT_CACHE_SERVICE_URLS=["https://xxx.yyy.secret-url-1.com","https://zzz.aaa.secret-url-2.com"]` |
+| OVERRIDE_MANIFEST_USING_FILE       | Path to your manifest file. Manifest is a public JSON file that defines the provider's obligation regarding the data that they provide. It sets fetching interval, tokens, sources and other public technical details for the provided data. You can check available manifests [here.](https://github.com/redstone-finance/redstone-oracles-monorepo/tree/main/packages/oracle-node/manifests)                               | `OVERRIDE_MANIFEST_USING_FILE=./manifests/dev/dev.json`                                                      |
+| LEVEL_DB_LOCATION                  | Path to the level DB. Each RedStone oracle node relies on a single-level DB. It is used to store recently fetched values from the last 15 minutes. These values are used for checking value deviations, filtering outliers and preventing price manipulation attacks. <br/><br/> You don't need to create a Level DB instance manually, it will be created automatically at the specified path during the first node launch. | `LEVEL_DB_LOCATION=/oracle-node-level-db`                                                                    |
 
 ### Launch using Docker