Transaction, Command and Receipt
Command
A command is a useful operation that Parallelchain allows the user to do. A sequence of commands can be inserted into a transaction to be carried out. There are currently 13 different kinds of commands, each corresponding to a variant of the command enum type. These are further divided into three categories: account commands, staking commands, and protocol commands. Most commands take inputs, which are part of the command type as the fields of its corresponding variant.
Account commands
Transfer
| Name | Input | Description |
|---|---|---|
| Transfer | PublicAddress)u64) |
Transfer an amount from the signer's balance to the recipient's balance. |
| Deploy | Vec<u8>)u32) |
Deploy a contract that implements a given CBI version. |
| Call | PublicAddress)String)Option<Vec<Vec<u8>>>)Option<u64>) |
Call a contract method with given arguments, optionally transferring some tokens. |
Staking commands
| Name | Input | Description |
|---|---|---|
| Create pool | u8) |
Create a new pool with the signer as the operator which charges a given commission rate on the validator rewards of delegated stakes |
| Set pool settings | u8) |
Set the commission rate of an existing pool, operated by the signer. |
| Delete pool | Delete an existing pool, as well as all of its existing stakes. | |
| Create Deposit | PublicAddress)u64)bool) |
Create a deposit that targets a given operator, with the given balance, and stake the validator rewards that it receives optionally. |
| Set deposit settings | PublicAddress)bool) |
Set whether a given deposit automatically stakes validator rewards. |
| Top up deposit | PublicAddress)u64) |
Transfer more tokens into an existing deposit. |
| Withdraw Deposit | PublicAdddress)u64) |
Try to withdraw a given amount from a deposit into the signer's balance. |
| Stake | PublicAddress)u64) |
Try to stake a given amount from a deposit. |
| Unstake | PublicAddress)u64) |
Try to reduce a deposit's stake by a given amount. |
Notes:
The actual amount of tokens that could be withdrawn, staked, or unstaked by the final three kinds of commands depends on timing and order, factors that users do not have precise control over. For example, the number of tokens that can be withdrawn from a deposit can change significantly between epochs as the deposit's bonded balance decreases, or increases.
Therefore, these commands accept as input a "max amount" instead of a precise amount. These commands try to withdraw, stake, or unstake as close to the maximum amount as possible, and inform the precise amount in its return value.
Protocol commands
| Name | Input | Description |
|---|---|---|
| Next epoch | None | Reward the current epoch's validators, and confirm the next epoch's validator set. |
Transaction
A transaction is a digitally signed instruction that tells the Mainnet state machine to execute a sequence of commands.
A transaction has the following fields:
Signer: the public address of the external-owned account that signed this transaction.Nonce: the number of transactions signed by the signer that has been included on the blockchain before this transaction. This ensures that all of the signer’s transactions are included in the blockchain in an expected order and prevents the same transaction from being included in multiple blocks.Commands: a sequence of Commands to be executed in a transaction.Gas Limit: the maximum number of gas units that should be used in executing this transaction.Max Base Fee per Gas: the maximum number of grays that the signer is willing to burn for a gas unit used in this transaction.Priority Fee per Gas: the number of grays that the signer is willing to pay the block proposer for including this transaction in a block.Signature: the signature formed by signing over content in this transaction using the signer’s private key.Hash: the cryptographic hash of the signature.
Receipt and Logs
A receipt is produced upon execution of each transaction. It consists of a sequence of CommandReceipt, which provides a succinct summary of what happened during the execution of the corresponding Command in a transaction.
A Command Receipt has the following fields:
Exit Status: tells whether the corresponding command in the sequence succeeded in doing its operation and, if it failed, whether the failure is because of gas exhaustion or some other reason.Gas Used: how much gas was used in the execution of the transaction. This will at most be the transaction’s gas limit.Return Values: the return values of the corresponding command.Logs: the logs emitted during the corresponding call command.
Possible values for Exit Status are:
| Code | Name | Description |
|---|---|---|
| 0x00 | Operation successful | The command successfully did what it is supposed to do. |
| 0x01 | Operation failed | The command failed to do what it is supposed to do. |
| 0x02 | Gas exhausted | Execution halted in the middle of the command because the gas limit was hit. |
Logs are topic-value pairs emitted during smart contract execution. Logs allow decentralised applications to quickly prove to users that a particular branch/line of code was executed during a transaction, by querying for the existence of logs in blocks.