0g-chain/contrib
Denali Marsh 4599caca07
R4R: update pricefeed module rest endpoints (#359)
* query get price implemented - /pricefeed/price/xrp:usd

* query rawprices implemented - /pricefeed/rawprices/xrp:usd

* refactored to QueryWithMarketIDParams, added rest logic for QueryOracles

* new query get oracles implemented for cli and rest - /pricefeed/oracles/xrp:usd

* tx postprice implemented - /pricefeed/postprice/{MsgPostPrice}

* updated contrib with post-price examples and added to README

* added cliCtx.WithHeight(height) and removed import comment
2020-02-02 11:06:33 -05:00
..
genesis_examples [WIP] example proposal.json files for param changes (#331) 2020-01-24 16:44:13 -05:00
init add init scripts 2019-11-25 14:24:46 -05:00
proposal_examples [WIP] example proposal.json files for param changes (#331) 2020-01-24 16:44:13 -05:00
requests R4R: update pricefeed module rest endpoints (#359) 2020-02-02 11:06:33 -05:00
README.md R4R: update pricefeed module rest endpoints (#359) 2020-02-02 11:06:33 -05:00

Contrib

Rest server requests

Setup

Before making a request, query account information for the signing account. Note the 'accountnumber' and 'sequence' fields, we'll need them later in order to send our request:

    kvcli q auth account $(kvcli keys show accB -a)

If testing locally, start the Kava rest server:

    kvcli rest-server

Now we'll create an unsigned request, sign it, and broadcast it to the Kava blockchain via the rest server. Note that if you're using the mainnet or testnet, the host IP address will need to be updated to point at an active rest server instead of http://127.0.0.1.

Create CDP example request

Format the base request in create-cdp.json. You'll need to update the 'from', 'chain-id', 'account_number', 'sequence', and 'gas' as appropriate. Then, populate the CDP creation request's params 'owner', 'collateral', and 'principal'. An example formatted request can be found in example-create-cdp.json.

    # Create an unsigned request
    curl -H "Content-Type: application/json" -X PUT -d @./contrib/requests/create-cdp.json http://127.0.0.1:1317/cdp | jq > ./contrib/requests/create-cdp-unsigned.json

    # Sign the request
    kvcli tx sign ./contrib/requests/create-cdp-unsigned.json --from accB --offline --chain-id testing --sequence 1 --account-number 2 | jq  > ./contrib/requests/broadcast-create-cdp.json

    # Broadcast the request
    kvcli tx broadcast ./contrib/requests/broadcast-create-cdp.json

Congratulations, you've just created a CDP on Kava using the rest server!

Post market price example request

Note that only market oracles can post prices, other senders will have their transactions rejected by Kava.

Format the base request in post-price.json. You'll need to update the 'from', 'chain-id', 'account_number', 'sequence', and 'gas' as appropriate. Then, populate the post price request's params 'from', 'market_id', 'price', and 'expiry'. An example formatted request can be found in example-post-price.json.

    # Create an unsigned request
	curl -H "Content-Type: application/json" -X PUT -d @./contrib/requests/post-price.json http://127.0.0.1:1317/pricefeed/postprice | jq > ./contrib/requests/post-price-unsigned.json


    # Sign the request
    kvcli tx sign ./contrib/requests/post-price-unsigned.json --from validator --offline --chain-id testing --sequence 96 --account-number 0 | jq > ./contrib/requests/broadcast-post-price.json    

    # Broadcast the request
    kvcli tx broadcast ./contrib/requests/broadcast-post-price.json

Congratulations, you've just posted a current market price on Kava using the rest server!

Governance proposals

Example governance proposals are located in /proposal_examples.