Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Actualize the specification for inputs with the implementation #487

Merged
merged 2 commits into from
May 25, 2023
Merged

Actualize the specification for inputs with the implementation #487

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
37441e2
Actualize the specification for inputs with the implementation
xgreenx May 17, 2023
db65894
Update src/protocol/tx_format/input.md
xgreenx May 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 6 additions & 8 deletions src/protocol/tx_format/input.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,11 @@ Transaction is invalid if:
| `txPointer` | [TXPointer](./tx_pointer.md) | Points to the TX whose output is being spent. |
| `witnessIndex` | `uint8` | Index of witness that authorizes spending the coin. |
| `maturity` | `uint32` | UTXO being spent must have been created at least this many blocks ago. |
| `predicateGasUsed` | `uint64` | Gas used by predicate. |
| `predicateLength` | `uint16` | Length of predicate, in instructions. |
| `predicateDataLength` | `uint16` | Length of predicate input data, in bytes. |
| `predicate` | `byte[]` | Predicate bytecode. |
| `predicateData` | `byte[]` | Predicate input data (parameters). |
| `predicateGasUsed` | `uint64` | Gas used by predicate. |

Given helper `len()` that returns the number of bytes of a field.

Expand All @@ -51,11 +51,9 @@ If `h` is the block height the UTXO being spent was created, transaction is inva

> **Note:** when signing a transaction, `txPointer` and `predicateGasUsed` is set to zero.
>
> **Note:** when verifying a predicate, `txPointer` is initialized to zero.
>
> **Note:** when estimating a predicate, `txPointer` and `predicateGasUsed` is initialized to zero.
> **Note:** when verifying and estimating a predicate, `txPointer` and `predicateGasUsed` is initialized to zero.
>
> **Note:** when executing a script, `txPointer` is initialized to zero.
> **Note:** when executing a script, `txPointer` is initialized to the TX whose output is being spent.

The predicate root is computed [here](../id/predicate.md).

Expand All @@ -78,7 +76,7 @@ Transaction is invalid if:
>
> **Note:** when verifying a predicate, `txID`, `outputIndex`, `balanceRoot`, `stateRoot`, and `txPointer` are initialized to zero.
>
> **Note:** when executing a script, `txID`, `outputIndex`, `balanceRoot`, and `stateRoot` are initialized to the transaction ID, output index, amount, and state root of the contract with ID `contractID`, and `txPointer` is initialized to zero.
> **Note:** when executing a script, `txID`, `outputIndex`, `balanceRoot`, and `stateRoot` are initialized to the transaction ID, output index, amount, and state root of the contract with ID `contractID`, and `txPointer` is initialized to the TX whose output is being spent.

## InputMessage

Expand All @@ -89,13 +87,13 @@ Transaction is invalid if:
| `amount` | `uint64` | Amount of base asset coins sent with message. |
| `nonce` | `byte[32]` | The message nonce. |
| `witnessIndex` | `uint8` | Index of witness that authorizes spending the coin. |
| `predicateGasUsed` | `uint64` | Gas used by predicate execution. |
| `dataLength` | `uint16` | Length of message data, in bytes. |
| `predicateLength` | `uint16` | Length of predicate, in instructions. |
| `predicateDataLength` | `uint16` | Length of predicate input data, in bytes. |
| `data` | `byte[]` | The message data. |
| `predicate` | `byte[]` | Predicate bytecode. |
| `predicateData` | `byte[]` | Predicate input data (parameters). |
| `predicateGasUsed` | `uint64` | Gas used by predicate execution. |

Given helper `len()` that returns the number of bytes of a field.

Expand All @@ -117,4 +115,4 @@ The predicate root is computed [here](../id/predicate.md).
>
> **Note:** when signing a transaction, `predicateGasUsed` is set to zero.
>
> **Note:** when estimating a predicate, `predicateGasUsed` is initialized to zero.
> **Note:** when verifying and estimating a predicate, `predicateGasUsed` is initialized to zero.