package core
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
cmn "github.com/tendermint/tendermint/libs/common"
|
|
|
|
tmquery "github.com/tendermint/tendermint/libs/pubsub/query"
|
|
ctypes "github.com/tendermint/tendermint/rpc/core/types"
|
|
"github.com/tendermint/tendermint/state/txindex/null"
|
|
"github.com/tendermint/tendermint/types"
|
|
)
|
|
|
|
// Tx allows you to query the transaction results. `nil` could mean the
|
|
// transaction is in the mempool, invalidated, or was not sent in the first
|
|
// place.
|
|
//
|
|
// ```shell
|
|
// curl "localhost:26657/tx?hash=0x2B8EC32BA2579B3B8606E42C06DE2F7AFA2556EF"
|
|
// ```
|
|
//
|
|
// ```go
|
|
// client := client.NewHTTP("tcp://0.0.0.0:26657", "/websocket")
|
|
// tx, err := client.Tx([]byte("2B8EC32BA2579B3B8606E42C06DE2F7AFA2556EF"), true)
|
|
// ```
|
|
//
|
|
// > The above command returns JSON structured like this:
|
|
//
|
|
// ```json
|
|
// {
|
|
// "error": "",
|
|
// "result": {
|
|
// "proof": {
|
|
// "Proof": {
|
|
// "aunts": []
|
|
// },
|
|
// "Data": "YWJjZA==",
|
|
// "RootHash": "2B8EC32BA2579B3B8606E42C06DE2F7AFA2556EF",
|
|
// "Total": "1",
|
|
// "Index": "0"
|
|
// },
|
|
// "tx": "YWJjZA==",
|
|
// "tx_result": {
|
|
// "log": "",
|
|
// "data": "",
|
|
// "code": "0"
|
|
// },
|
|
// "index": "0",
|
|
// "height": "52",
|
|
// "hash": "2B8EC32BA2579B3B8606E42C06DE2F7AFA2556EF"
|
|
// },
|
|
// "id": "",
|
|
// "jsonrpc": "2.0"
|
|
// }
|
|
// ```
|
|
//
|
|
// Returns a transaction matching the given transaction hash.
|
|
//
|
|
// ### Query Parameters
|
|
//
|
|
// | Parameter | Type | Default | Required | Description |
|
|
// |-----------+--------+---------+----------+-----------------------------------------------------------|
|
|
// | hash | []byte | nil | true | The transaction hash |
|
|
// | prove | bool | false | false | Include a proof of the transaction inclusion in the block |
|
|
//
|
|
// ### Returns
|
|
//
|
|
// - `proof`: the `types.TxProof` object
|
|
// - `tx`: `[]byte` - the transaction
|
|
// - `tx_result`: the `abci.Result` object
|
|
// - `index`: `int` - index of the transaction
|
|
// - `height`: `int` - height of the block where this transaction was in
|
|
// - `hash`: `[]byte` - hash of the transaction
|
|
func Tx(hash []byte, prove bool) (*ctypes.ResultTx, error) {
|
|
|
|
// if index is disabled, return error
|
|
if _, ok := txIndexer.(*null.TxIndex); ok {
|
|
return nil, fmt.Errorf("Transaction indexing is disabled")
|
|
}
|
|
|
|
r, err := txIndexer.Get(hash)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
if r == nil {
|
|
return nil, fmt.Errorf("Tx (%X) not found", hash)
|
|
}
|
|
|
|
height := r.Height
|
|
index := r.Index
|
|
|
|
var proof types.TxProof
|
|
if prove {
|
|
block := blockStore.LoadBlock(height)
|
|
proof = block.Data.Txs.Proof(int(index)) // XXX: overflow on 32-bit machines
|
|
}
|
|
|
|
return &ctypes.ResultTx{
|
|
Hash: hash,
|
|
Height: height,
|
|
Index: uint32(index),
|
|
TxResult: r.Result,
|
|
Tx: r.Tx,
|
|
Proof: proof,
|
|
}, nil
|
|
}
|
|
|
|
// TxSearch allows you to query for multiple transactions results. It returns a
|
|
// list of transactions (maximum ?per_page entries) and the total count.
|
|
//
|
|
// ```shell
|
|
// curl "localhost:26657/tx_search?query=\"account.owner='Ivan'\"&prove=true"
|
|
// ```
|
|
//
|
|
// ```go
|
|
// client := client.NewHTTP("tcp://0.0.0.0:26657", "/websocket")
|
|
// q, err := tmquery.New("account.owner='Ivan'")
|
|
// tx, err := client.TxSearch(q, true)
|
|
// ```
|
|
//
|
|
// > The above command returns JSON structured like this:
|
|
//
|
|
// ```json
|
|
// {
|
|
// "jsonrpc": "2.0",
|
|
// "id": "",
|
|
// "result": {
|
|
// "txs": [
|
|
// {
|
|
// "proof": {
|
|
// "Proof": {
|
|
// "aunts": [
|
|
// "J3LHbizt806uKnABNLwG4l7gXCA=",
|
|
// "iblMO/M1TnNtlAefJyNCeVhjAb0=",
|
|
// "iVk3ryurVaEEhdeS0ohAJZ3wtB8=",
|
|
// "5hqMkTeGqpct51ohX0lZLIdsn7Q=",
|
|
// "afhsNxFnLlZgFDoyPpdQSe0bR8g="
|
|
// ]
|
|
// },
|
|
// "Data": "mvZHHa7HhZ4aRT0xMDA=",
|
|
// "RootHash": "F6541223AA46E428CB1070E9840D2C3DF3B6D776",
|
|
// "Total": "32",
|
|
// "Index": "31"
|
|
// },
|
|
// "tx": "mvZHHa7HhZ4aRT0xMDA=",
|
|
// "tx_result": {},
|
|
// "index": "31",
|
|
// "height": "12",
|
|
// "hash": "2B8EC32BA2579B3B8606E42C06DE2F7AFA2556EF"
|
|
// }
|
|
// ],
|
|
// "total_count": "1"
|
|
// }
|
|
// }
|
|
// ```
|
|
//
|
|
// ### Query Parameters
|
|
//
|
|
// | Parameter | Type | Default | Required | Description |
|
|
// |-----------+--------+---------+----------+-----------------------------------------------------------|
|
|
// | query | string | "" | true | Query |
|
|
// | prove | bool | false | false | Include proofs of the transactions inclusion in the block |
|
|
// | page | int | 1 | false | Page number (1-based) |
|
|
// | per_page | int | 30 | false | Number of entries per page (max: 100) |
|
|
//
|
|
// ### Returns
|
|
//
|
|
// - `proof`: the `types.TxProof` object
|
|
// - `tx`: `[]byte` - the transaction
|
|
// - `tx_result`: the `abci.Result` object
|
|
// - `index`: `int` - index of the transaction
|
|
// - `height`: `int` - height of the block where this transaction was in
|
|
// - `hash`: `[]byte` - hash of the transaction
|
|
func TxSearch(query string, prove bool, page, perPage int) (*ctypes.ResultTxSearch, error) {
|
|
// if index is disabled, return error
|
|
if _, ok := txIndexer.(*null.TxIndex); ok {
|
|
return nil, fmt.Errorf("Transaction indexing is disabled")
|
|
}
|
|
|
|
q, err := tmquery.New(query)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
results, err := txIndexer.Search(q)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
totalCount := len(results)
|
|
perPage = validatePerPage(perPage)
|
|
page = validatePage(page, perPage, totalCount)
|
|
skipCount := (page - 1) * perPage
|
|
|
|
apiResults := make([]*ctypes.ResultTx, cmn.MinInt(perPage, totalCount-skipCount))
|
|
var proof types.TxProof
|
|
for i := 0; i < len(apiResults); i++ {
|
|
r := results[skipCount+i]
|
|
height := r.Height
|
|
index := r.Index
|
|
|
|
if prove {
|
|
block := blockStore.LoadBlock(height)
|
|
proof = block.Data.Txs.Proof(int(index)) // XXX: overflow on 32-bit machines
|
|
}
|
|
|
|
apiResults[i] = &ctypes.ResultTx{
|
|
Hash: r.Tx.Hash(),
|
|
Height: height,
|
|
Index: index,
|
|
TxResult: r.Result,
|
|
Tx: r.Tx,
|
|
Proof: proof,
|
|
}
|
|
}
|
|
|
|
return &ctypes.ResultTxSearch{Txs: apiResults, TotalCount: totalCount}, nil
|
|
}
|