TrueCloudLab/neo-go
8
0
Fork 0
mirror of https://github.com/nspcc-dev/neo-go.git synced 2024-12-23 23:25:22 +00:00
Code Issues Projects Releases Packages Wiki Activity

oracle: improve oracle interop documentation

Browse source
This commit is contained in:
Roman Khimov 2021-04-06 19:32:50 +03:00
parent fc42b77916
commit 607cdcf13d
1 changed files with 36 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

39
pkg/interop/native/oracle/oracle.go
View file

@ -13,19 +13,52 @@ import (
// Hash represents Oracle contract hash.
const Hash = "\x58\x87\x17\x11\x7e\x0a\xa8\x10\x72\xaf\xab\x71\xd2\xdd\x89\xfe\x7c\x4b\x92\xfe"
// Request represents `request` method of Oracle native contract.
// Request makes an oracle request. It can only be successfully invoked by
// deployed contract and it takes the following parameters:
//
// url
// URL to fetch, only https and neofs URLs are supported like
// https://example.com/some.json or
// neofs:6pJtLUnGqDxE2EitZYLsDzsfTDVegD6BrRUn8QAFZWyt/5Cyxb3wrHDw5pqY63hb5otCSsJ24ZfYmsA8NAjtho2gr
//
// filter
// JSONPath filter to process the result, if specified it will be
// applied to the data returned from HTTP/NeoFS and you'll only get
// filtered data in your callback method.
//
// cb
// name of the method that will process oracle data, it must be a method
// of the same contract that invokes Request and it must have the following
// signature for correct invocation:
//
// Method(url string, userData interface{}, code int, result []byte)
//
// where url is the same url specified for Request, userData is anything
// passed in the next parameter, code is the status of the reply and
// result is data returned from request if any.
//
// userData
// data to pass to the callback function.
//
// gasForResponse
// GAS attached to this request for reply callback processing,
// note that it's different from the oracle request price, this
// GAS is used for oracle transaction's network and system fees,
// so it should be enough to pay for reply data as well as
// its processing.
func Request(url string, filter []byte, cb string, userData interface{}, gasForResponse int) {
contract.Call(interop.Hash160(Hash), "request",
contract.States|contract.AllowNotify,
url, filter, cb, userData, gasForResponse)
}
// GetPrice represents `getPrice` method of Oracle native contract.
// GetPrice returns current oracle request price.
func GetPrice() int {
return contract.Call(interop.Hash160(Hash), "getPrice", contract.ReadStates).(int)
}
// SetPrice represents `setPrice` method of Oracle native contract.
// SetPrice allows to set oracle request price. This method can only be
// successfully invoked by the committee.
func SetPrice(amount int) {
contract.Call(interop.Hash160(Hash), "setPrice", contract.States, amount)
}