From df727566e8efcd50e2e550c2fb9309db7db5909a Mon Sep 17 00:00:00 2001 From: satawatnack Date: Fri, 8 Mar 2024 02:04:49 +0700 Subject: [PATCH] update --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b4df8cf..bcefab4 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # Premium Data Sources Gateway +The gateway for data sources on BandChain that require an API key for access. However, to prevent exposing the key on the chain, our solution allows secure access to the API without revealing the key. Only validators assigned to retrieve data for BandChain requests have the capability to obtain price data from these data sources. + ## Requirements ### Environment Variables @@ -14,6 +16,8 @@ Ensure to update the environment variables for the Gateway and your chosen adapt ## Running the Application +> Note: You have the option to set the environment variable `MODE=development` to facilitate testing your API locally. This allows you to make requests without the necessity of verifying that the requests originate from validators assigned to retrieve data for BandChain. + ### Docker Compose To run the application using Docker Compose: @@ -73,9 +77,9 @@ Example: - `ADAPTER_NAME = "coin_gecko"` - `API_KEY = ` -## VerifiableAi +## VerifiableAI -This VerifiableAi adapter type is used to request the Ai API. +This VerifiableAI adapter type is used to request the AI API. ### OpenAI