This repository has been archived by the owner on Aug 2, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
[docs] Update Query Transaction Info cleos How-to - 2.0 #10076
Merged
Merged
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
184 changes: 178 additions & 6 deletions
184
docs/02_cleos/02_how-to-guides/how-to-get-transaction-information.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,20 +1,192 @@ | ||
| ## Goal | ||
|
|
||
| Query infomation of a transaction | ||
| Query infomation of an EOSIO transaction | ||
|
|
||
| ## Before you begin | ||
|
|
||
| * Install the currently supported version of `cleos` | ||
|
|
||
| * Understand the following: | ||
|
|
||
| * What is a transaction | ||
|
|
||
| ## Steps | ||
| * Install the currently supported version of `cleos`. | ||
|
|
||
| [[info | Note]] | ||
| | `cleos` is bundled with the EOSIO software. [Installing EOSIO](../../00_install/index.md) will also install `cleos`. | ||
|
|
||
|
|
||
|
|
||
| * Understand how transactions work in an EOSIO blockchain. For more information on transactions, see the [Transactions Protocol](https://developers.eos.io/welcome/latest/protocol-guides/transactions_protocol) section. | ||
|
|
||
| ## Steps | ||
| Run the following command to query information of an executed transaction: | ||
| ```sh | ||
| cleos get transaction id | ||
| cleos get transaction <id> | ||
| ``` | ||
| Where `id` is the transaction ID of the executed transaction. | ||
|
|
||
| **Example Output** | ||
|
|
||
| The following example shows detailed information of a transaction executed to create a new blockchain account **bob**: | ||
|
|
||
| ```console | ||
| cleos get transaction 870a6b6e3882061ff0f64016e1eedfdd9439e2499bf978c3fb29fcedadada9b1 | ||
| { | ||
| "id": "870a6b6e3882061ff0f64016e1eedfdd9439e2499bf978c3fb29fcedadada9b1", | ||
| "trx": { | ||
| "receipt": { | ||
| "status": "executed", | ||
| "cpu_usage_us": 3493, | ||
| "net_usage_words": 25, | ||
| "trx": [ | ||
| 1,{ | ||
| "signatures": [ | ||
| "SIG_K1_KYEvKx3nC81H6brKXHNjhrw32rNtTC2dP6nYFjZvj1N3k7KSU4CXBTJyiXd38ANu2ZPTUf66qUghUp5Jarkhiqdx3D8pwf" | ||
| ], | ||
| "compression": "none", | ||
| "packed_context_free_data": "", | ||
| "packed_trx": "0c252e60fe001fe2acca00000000010000000000ea305500409e9a2264b89a010000000000ea305500000000a8ed3232660000000000ea30550000000000000e3d01000000010002dfcee032f2e84bfc8ecc5c10fffb870ec1c690c1f3fdae3d8b7d65690b6455560100000001000000010002dfcee032f2e84bfc8ecc5c10fffb870ec1c690c1f3fdae3d8b7d65690b6455560100000000" | ||
| } | ||
| ] | ||
| }, | ||
| "trx": { | ||
| "expiration": "2021-02-18T08:27:56", | ||
| "ref_block_num": 254, | ||
| "ref_block_prefix": 3400327711, | ||
| "max_net_usage_words": 0, | ||
| "max_cpu_usage_ms": 0, | ||
| "delay_sec": 0, | ||
| "context_free_actions": [], | ||
| "actions": [{ | ||
| "account": "eosio", | ||
| "name": "newaccount", | ||
| "authorization": [{ | ||
| "actor": "eosio", | ||
| "permission": "active" | ||
| } | ||
| ], | ||
| "data": { | ||
| "creator": "eosio", | ||
| "name": "bob", | ||
| "owner": { | ||
| "threshold": 1, | ||
| "keys": [{ | ||
| "key": "EOS6b4ENeXffuKGmsk3xCk3kbFM5M8dcANrUa9Mj9RzKLNhPKhzyj", | ||
| "weight": 1 | ||
| } | ||
| ], | ||
| "accounts": [], | ||
| "waits": [] | ||
| }, | ||
| "active": { | ||
| "threshold": 1, | ||
| "keys": [{ | ||
| "key": "EOS6b4ENeXffuKGmsk3xCk3kbFM5M8dcANrUa9Mj9RzKLNhPKhzyj", | ||
| "weight": 1 | ||
| } | ||
| ], | ||
| "accounts": [], | ||
| "waits": [] | ||
| } | ||
| }, | ||
| "hex_data": "0000000000ea30550000000000000e3d01000000010002dfcee032f2e84bfc8ecc5c10fffb870ec1c690c1f3fdae3d8b7d65690b6455560100000001000000010002dfcee032f2e84bfc8ecc5c10fffb870ec1c690c1f3fdae3d8b7d65690b64555601000000" | ||
| } | ||
| ], | ||
| "transaction_extensions": [], | ||
| "signatures": [ | ||
| "SIG_K1_KYEvKx3nC81H6brKXHNjhrw32rNtTC2dP6nYFjZvj1N3k7KSU4CXBTJyiXd38ANu2ZPTUf66qUghUp5Jarkhiqdx3D8pwf" | ||
| ], | ||
| "context_free_data": [] | ||
| } | ||
| }, | ||
| "block_time": "2021-02-18T08:27:27.000", | ||
| "block_num": 256, | ||
| "last_irreversible_block": 305, | ||
| "traces": [{ | ||
| "action_ordinal": 1, | ||
| "creator_action_ordinal": 0, | ||
| "closest_unnotified_ancestor_action_ordinal": 0, | ||
| "receipt": { | ||
| "receiver": "eosio", | ||
| "act_digest": "2640ce4d4a789393dec3b7938cea2f78c5669498d0d22adeab9204c489c2cfd6", | ||
| "global_sequence": 256, | ||
| "recv_sequence": 256, | ||
| "auth_sequence": [[ | ||
| "eosio", | ||
| 256 | ||
| ] | ||
| ], | ||
| "code_sequence": 0, | ||
| "abi_sequence": 0 | ||
| }, | ||
| "receiver": "eosio", | ||
| "act": { | ||
| "account": "eosio", | ||
| "name": "newaccount", | ||
| "authorization": [{ | ||
| "actor": "eosio", | ||
| "permission": "active" | ||
| } | ||
| ], | ||
| "data": { | ||
| "creator": "eosio", | ||
| "name": "bob", | ||
| "owner": { | ||
| "threshold": 1, | ||
| "keys": [{ | ||
| "key": "EOS6b4ENeXffuKGmsk3xCk3kbFM5M8dcANrUa9Mj9RzKLNhPKhzyj", | ||
| "weight": 1 | ||
| } | ||
| ], | ||
| "accounts": [], | ||
| "waits": [] | ||
| }, | ||
| "active": { | ||
| "threshold": 1, | ||
| "keys": [{ | ||
| "key": "EOS6b4ENeXffuKGmsk3xCk3kbFM5M8dcANrUa9Mj9RzKLNhPKhzyj", | ||
| "weight": 1 | ||
| } | ||
| ], | ||
| "accounts": [], | ||
| "waits": [] | ||
| } | ||
| }, | ||
| "hex_data": "0000000000ea30550000000000000e3d01000000010002dfcee032f2e84bfc8ecc5c10fffb870ec1c690c1f3fdae3d8b7d65690b6455560100000001000000010002dfcee032f2e84bfc8ecc5c10fffb870ec1c690c1f3fdae3d8b7d65690b64555601000000" | ||
| }, | ||
| "context_free": false, | ||
| "elapsed": 1565, | ||
| "console": "", | ||
| "trx_id": "870a6b6e3882061ff0f64016e1eedfdd9439e2499bf978c3fb29fcedadada9b1", | ||
| "block_num": 256, | ||
| "block_time": "2021-02-18T08:27:27.000", | ||
| "producer_block_id": null, | ||
| "account_ram_deltas": [{ | ||
| "account": "bob", | ||
| "delta": 2724 | ||
| } | ||
| ], | ||
| "except": null, | ||
| "error_code": null | ||
| } | ||
| ] | ||
| } | ||
| ``` | ||
|
|
||
| [[info]] | ||
| | Be aware that you need to connect to a `nodeos` instance that enables history API plugin to query transaction information. | ||
|
|
||
|
|
||
|
|
||
|
|
||
| **Trobleshooting** | ||
|
|
||
| If the history API plugin is not enabled in the `nodeos` **config.ini file**, the `cleos get transaction id` command will result in an error as shown below. | ||
|
|
||
| ```console | ||
| cleos get transaction 509eee3aa8988d533a336fec7a4c8b067ae3205cd97e2d27b3e9a2da61ef460c | ||
| Error 3110003: Missing History API Plugin | ||
| Ensure that you have eosio::history_api_plugin added to your node's configuration! | ||
| Error Details: | ||
| History API plugin is not enabled | ||
| ``` | ||
|
|
||
| To troubleshoot this error, enable the history API plugin and run the command again. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
if user takes it literally he will run the command like this
cleos get transaction <870a6b6e3882061ff0f64016e1eedfdd9439e2499bf978c3fb29fcedadada9b1>I would re-phrase it
"Assuming you want to get transaction with id 870a6b6e3882061ff0f64016e1eedfdd9439e2499bf978c3fb29fcedadada9b1 run the following command:
cleos get transaction 870a6b6e3882061ff0f64016e1eedfdd9439e2499bf978c3fb29fcedadada9b1
"