diff --git a/README.md b/README.md index 1d29daf..4132b35 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ Market for each symbol is stored on a dictionary as a contract level field `acce This struct provides the caller with the data received from the oracle network for the symbol in question. Keep in mind that all data is normalized and stored using a USD conversion rate, meaning that conversions into other symbols will derive from that. ### Updating the data -The account where the contract is deployed will be granted with a `OracleAdmin` resource. This resource could be use to create `DataUpdater` resources and publishing a `{&RelayUpdate}` capability to them. An authorized account can claim said capability at the time of creating a `Relay` resource. This resource will grant the ability to call the `updateData` method that will call contract function `access(contract) fun updateRefData (symbolsRates: {String: UInt64}, resolveTime: UInt64, requestID: UInt64)` that will finally update the `symbolsRefData` dictionary. +The account where the contract is deployed will be granted an `OracleAdmin` resource. This resource can create `DataUpdater` resources and publish a `{&RelayUpdate}` capability to them. An authorized account - belonging to a relayer - can claim said capability at the time of creating a `Relay` resource. This resource will grant the ability to call the `updateData` method that will call contract function `access(contract) fun updateRefData (symbolsRates: {String: UInt64}, resolveTime: UInt64, requestID: UInt64)` which in turn updates the `symbolsRefData` dictionary. ### Querying the data By calling the public function `pub fun getReferenceData (baseSymbol: String, quoteSymbol: String): RefData?` any Smart Contract or script would be able to get the price of a `quoteSymbol` in the `baseSymbol` currency. If there are none registries for either the base or quote symbol, the function will return `nil`. \ No newline at end of file