How to Debug Sent Messages

This guide provides instructions on debugging sent messages using command-line tools. It covers retrieving message status, inspecting arguments of emitted events by the Endpoint, and more. If you have not deployed your custom protocol yet, refer to the Getting Started guide before proceeding.

Hardhat Troubleshooting

Retrieving Account Balance

To get the balance of any account on an EVM-compatible network, execute the command below. It will print the specified account balance.

npx hardhat balance --acc <address> --network <network_name>

Retrieving the Last Received Message by Sender

To get the last received message using a sender address, execute the command below. If the message is found, it will output message length and the message itself in bytes, which is the decoded representation.

npx hardhat getLastMessage --sender <sender_address> --network <network_name>

Fetching Block Data

To retrieve block details from an EVM-compatible network, execute the command below. It will output the block number, block hash, and creation timestamp.

npx hardhat getBlock --num <block_number> --network <network_name>

Extracting Transaction Details

To obtain details of a specific transaction, execute the command below. It will output the sender address, the receiver address, msg.value, payload, and block number.

npx hardhat getTxData --tx <tx_hash> --network <network_name>

Printing Proposal Data

If a proposal was sent to the Endpoint, parse the emitted event by executing the below command. It will output the destination chain ID, msg.value, selector slot, agent parameters, sender address, destination address, encoded payload.

npx hardhat proposal --tx <tx_hash> --network <network_name>

Retrieving Proposal and Message Hash

To find the message hash associated with a transaction hash from the source network, execute the command below. If a proposal is found in the transaction receipt, it will be reconstructed, and the corresponding message hashes will be displayed.

npx hardhat getMsgHash --hash <source_tx_hash> --network <network_name>

Status Codes

0  = NOT_INITIALIZED
1  = INVALID
2  = SAVED
3  = TRANSMITTED
4  = QUEUED
5  = PENDING
6  = PROTOCOL_FAILED
7  = EXTENSION_NOT_REGISTERED
8  = EXTENSION_NOT_REACHABLE
9  = EXTENSION_PANICKED
10 = UNDERESTIMATED
11 = SUCCESS
12 = FAILED
13 = OUT_OF_GAS

Check Message Status by Hash

To determine the current status of a sent message, execute the below command. If the transaction is found, the output will display its current status along with information from the initial proposal.

npx hardhat getMsgStatusByHash --hash <teib_tx_hash> --network teib

Output

Current status of message with hash <teib_tx_hash>

Status: SUCCESS

Zone: delivery

Retrieve Entire Message

Retrieve the full message, including status, nonce, and initial proposal:

npx hardhat getMsg --hash <teib_tx_hash> --network teib

Output

In this example, some values have been shortened (indicated by "...") for visibility.

Message of hash:
0x6...186612c12bae

- GLOBAL -
Status: 11 | SUCCESS | delivery zone
Global nonce: 30539

- Proposal -
Destination chain:          5003
Native amount:              1
Selector slot:              0x0...0af859a79
Sender address:             0x0...03f5a530b
Destination address:        0x0...00cd4b974
Payload:                    0x0...01bdd243c
Reserved:                   0x
Block finalization option:  0
Custom gas limit:           300000

- Source chain -
Location:       1127457...683956
Source tx hash: 0xf...1b65841895

Retrieve Initial Proposal & Source Chain Data --  delete
Retrieve Source Chain ID -- delete
Retrieve Destination Chain ID --  delete

Retrieve Source & Destination Chain ID

npx hardhat getChainIds --hash <teib_tx_hash> --network teib

Output

Current status of message with hash 0x93f013014a46f9dc8ba9efa60da3683700a73fae736770c7234f477898ebab3b

Source chain id: 5003

Destination chain id: 33133

Retrieve Initial msg.value

npx hardhat getReward --hash <teib_tx_hash> --network teib

Output

Current status of message with hash 0x6bf45198264adcb493e2c07864c71d324eec70d111552757f842186612c12bae

Reward: 1

UIP Specific Commands

Checking Message Execution on Destination Endpoint

npx hardhat getMsgExecution --hash <teib_tx_hash> --network <dest_network_name>

Output

Current execution status of message with hash 0xdfc2c4b17f947abca4aa90697d3d82627e520c0644f9b56e6bace16d16d6b43c

Execution status: Executed

Status Codes

0 - Does not exist
1 - Executed
2 - Protocol failed