Commit Results (v0.38.x)

Download OpenAPI specification:Download

URL: https://nuvalabs.com/ License: Apache 2.0

Overview

The Node RPC endpoints are intended for working with the blockchain consensus layer directly. These endpoints return information about the blocks, validators, and network layer itself while the API endpoints work at a higher level and are used to return information at the blockchain Application layer.

The RPC service would typically be used by users and applications that wish to retrieve information about raw blocks being produced or monitor for transactions and network activity.

The Node RPC service supports the following communication protocols:

URI over HTTP
JSONRPC over HTTP
JSONRPC over websockets

Authentication

A bearer token is required for all requests.

Exchange client id and client secret for a token:

curl -XPOST https://dev-v6yakh57b7z3ngqo.us.auth0.com/oauth/token \
-H \"content-type: application/json\" \
-d '{\"client_id\":\"<id>\",\"client_secret\":\"<secret>\",\"audience\":\"https://api.provlabs.com\",\"grant_type\":\"client_credentials\"}'

The returned token can then be used to make API calls:

curl -XGET -H \"Authorization: Bearer <token>\" https://pio-mainnet-1-rpc.provlabs.com/block?height=5

Arguments

Arguments which expect strings or byte arrays may be passed as quoted strings, like "abc" or as 0x-prefixed strings, like 0x616263.

URI/HTTP

A REST like interface.

curl https://pio-mainnet-1-rpc.provlabs.com/block?height=5

JSONRPC/HTTP

JSONRPC requests can be POST'd to the root RPC endpoint via HTTP.

curl --header "Content-Type: application/json" --request POST --data '{"method": "block", "params": ["5"], "id": 1}' https://pio-mainnet-1-rpc.provlabs.com

JSONRPC/websockets

JSONRPC requests can be also made via websocket. The websocket endpoint is at /websocket, e.g. https://pio-mainnet-1-rpc.provlabs.com/websocket. Asynchronous RPC functions like event subscribe and unsubscribe are only available via websockets.

For example using the websocat tool, you can subscribe for 'NewBlock` events with the following command:

echo '{ "jsonrpc": "2.0","method": "subscribe","id": 0,"params": {"query": "tm.event='"'NewBlock'"'"} }' | websocat -n -t wss://pio-mainnet-1-rpc.provlabs.com/websocket

Get block results at a specified height

Get block_results.

If the height field is set to a non-default value, upon success, the Cache-Control header will be set with the default maximum age.

query Parameters

height

integer

Default: 0

Example: height=1

height to return. If no height is provided, it will fetch information regarding the latest block.

Responses

Response samples

200
500

Content type

application/json

{"jsonrpc": "2.0",
"id": 0,
"result": {"height": "12",
"txs_results": [{"code": "0",
"data": "",
"log": "not enough gas",
"info": "",
"gas_wanted": "100",
"gas_used": "100",
"events": [{"type": "app",
"attributes": [{"key": "action",
"value": "send",
"index": false
}
]
}
],
"codespace": "ibc"
}
],
"finalize_block_events": [{"type": "app",
"attributes": [{"key": "action",
"value": "send",
"index": false
}
]
}
],
"validator_updates": [{"pub_key": {"type": "tendermint/PubKeyEd25519",
"value": "9tK9IT+FPdf2qm+5c2qaxi10sWP+3erWTKgftn2PaQM="
},
"power": "300"
}
],
"consensus_param_updates": {"block": {"max_bytes": "22020096",
"max_gas": "1000",
"time_iota_ms": "1000"
},
"evidence": {"max_age": "100000"
},
"validator": {"pub_key_types": ["ed25519"
]
}
}
}
}

Get commit results at a specified height

Get Commit.