From 48a16943cc8a2b8317523d5eb1516c15f3b969a2 Mon Sep 17 00:00:00 2001 From: balasan Date: Fri, 26 Mar 2021 18:50:04 -0400 Subject: [PATCH] readme --- readme.md | 29 +++++++++++++++++++++++++---- 1 file changed, 25 insertions(+), 4 deletions(-) diff --git a/readme.md b/readme.md index 46ae03b..cca0790 100644 --- a/readme.md +++ b/readme.md @@ -4,17 +4,38 @@ The Oracle module allows validators to run arbitrary off-chain worker processes Unlike onchain smart contracts, offchain workers are able to run non-deterministic code, like fetching exchange price data via an api call, and long-running computations, i.e. AI alogrithms or graph analysis. All of the validators are expected to run the workers and come to a consensus on the results. Exactly how consensus is reached can be decided by the app developer. +The module supports running an arbitrary amount of different oracles simultaniously. + The module is inspired by the [Terra Oracle Module](https://docs.terra.money/dev/spec-oracle.html#concepts) as well as a more recent iteration of it by [Sommelier](https://github.com/PeggyJV/sommelier/tree/main/x/oracle). **oracle** is a blockchain built using Cosmos SDK and Tendermint and created with [Starport](https://github.com/tendermint/starport). -## Get Started with a Tutorial +## Getting Started + +- Tutorial: https://relevant-community.github.io/oracle/tutorial/ +- Documentation: https://relevant-community.github.io/oracle/ + +Run the demo app that fetches ATOM/USD price: + +Clone the repo into your local folder and run: + +``` +$ starport serve +``` -https://relevant-community.github.io/oracle/tutorial/ +In a new browser window, star the oracle worker process: -## Documentation +``` +$ oracled tx oracle start-worker --from alice -o text -y +``` + +After some time, check the on-chain Atom-USD price: + +``` +$ oracled query atom atomUsd +``` -https://relevant-community.github.io/oracle/ +--- ## Starport Docs: