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

Some clarification after implementation #533

Merged
merged 5 commits into from
Nov 30, 2023
Merged

Some clarification after implementation #533

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0eab75e
Some clarification after implementation
xgreenx Nov 7, 2023
286414b
Applied the check for `Create` transaciton too
xgreenx Nov 7, 2023
b4bf86f
Use `ScriptGasLimit` instead of `GasLimit`
xgreenx Nov 8, 2023
f68e2a5
Bump Policices GTF
xgreenx Nov 8, 2023
2208d0e
Merge branch 'master' into feature/some-clarification
xgreenx Nov 29, 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
2 changes: 1 addition & 1 deletion src/fuel-vm/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ If script bytecode is present, transaction validation requires execution.
The VM is [initialized](#vm-initialization), then:

1. `$pc` and `$is` are set to the start of the transaction's script bytecode.
1. `$ggas` and `$cgas` are set to `tx.gasLimit`.
1. `$ggas` and `$cgas` are set to `tx.scriptGasLimit`.

Following initialization, execution begins.

Expand Down
13 changes: 6 additions & 7 deletions src/fuel-vm/instruction-set.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2442,7 +2442,7 @@ Get [fields from the transaction](../tx-format/transaction.md).
| name | `imm` | set `$rA` to |
|-------------------------------------------|---------|-------------------------------------------------------------------|
| `GTF_TYPE` | `0x001` | `tx.type` |
| `GTF_SCRIPT_GAS_LIMIT` | `0x002` | `tx.gasLimit` |
| `GTF_SCRIPT_GAS_LIMIT` | `0x002` | `tx.scriptGasLimit` |
| `GTF_SCRIPT_SCRIPT_LENGTH` | `0x003` | `tx.scriptLength` |
| `GTF_SCRIPT_SCRIPT_DATA_LENGTH` | `0x004` | `tx.scriptDataLength` |
| `GTF_SCRIPT_INPUTS_COUNT` | `0x005` | `tx.inputsCount` |
Expand Down Expand Up @@ -2508,12 +2508,11 @@ Get [fields from the transaction](../tx-format/transaction.md).
| `GTF_OUTPUT_CONTRACT_CREATED_STATE_ROOT` | `0x308` | Memory address of `tx.outputs[$rB].stateRoot` |
| `GTF_WITNESS_DATA_LENGTH` | `0x400` | `tx.witnesses[$rB].dataLength` |
| `GTF_WITNESS_DATA` | `0x401` | Memory address of `tx.witnesses[$rB].data` |
| `GTF_POLICY_COUNT` | `0x500` | `count_ones(tx.policyTypes)` |
| `GTF_POLICY_TYPE` | `0x501` | `tx.policies[$rB].type` |
| `GTF_POLICY_GAS_PRICE` | `0x502` | `tx.policies[0x00].gasPrice` |
| `GTF_POLICY_WITNESS_LIMIT` | `0x504` | `tx.policies[count_ones(0b11 & tx.policyTypes) - 1].witnessLimit` |
| `GTF_POLICY_MATURITY` | `0x505` | `tx.policies[count_ones(0b111 & tx.policyTypes) - 1].maturity` |
| `GTF_POLICY_MAX_FEE` | `0x506` | `tx.policies[count_ones(0b1111 & tx.policyTypes) - 1].maxFee` |
| `GTF_POLICY_TYPES` | `0x500` | `tx.policies.policyTypes` |
| `GTF_POLICY_GAS_PRICE` | `0x501` | `tx.policies[0x00].gasPrice` |
| `GTF_POLICY_WITNESS_LIMIT` | `0x502` | `tx.policies[count_ones(0b11 & tx.policyTypes) - 1].witnessLimit` |
| `GTF_POLICY_MATURITY` | `0x503` | `tx.policies[count_ones(0b111 & tx.policyTypes) - 1].maturity` |
| `GTF_POLICY_MAX_FEE` | `0x504` | `tx.policies[count_ones(0b1111 & tx.policyTypes) - 1].maxFee` |

Panic if:

Expand Down
4 changes: 2 additions & 2 deletions src/protocol/tx-validity.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ def unavailable_balance(tx, asset_id) -> int:
return sentBalance

def fee_balance(tx, asset_id) -> int:
gas = tx.gasLimit + sum_predicate_gas_used(tx)
gas = tx.scriptGasLimit + sum_predicate_gas_used(tx)
gasBalance = gasPrice * gas / GAS_PRICE_FACTOR
bytesBalance = size(tx) * GAS_PER_BYTE * gasPrice / GAS_PRICE_FACTOR
# Total fee balance
Expand Down Expand Up @@ -205,7 +205,7 @@ Once the free balances are computed, the [script is executed](../fuel-vm/index.m
1. The unspent free balance `unspentBalance` for each asset ID.
1. The unspent gas `unspentGas` from the `$ggas` register.

The fees incurred for a transaction are `ceiling(((size(tx) * GAS_PER_BYTE) + (tx.gasLimit - unspentGas) + sum(tx.inputs[i].predicateGasUsed)) * tx.gasPrice / GAS_PRICE_FACTOR)`.
The fees incurred for a transaction are `ceiling(((size(tx) * GAS_PER_BYTE) + (tx.scriptGasLimit - unspentGas) + sum(tx.inputs[i].predicateGasUsed)) * tx.gasPrice / GAS_PRICE_FACTOR)`.

`size(tx)` includes the entire transaction serialized according to the transaction format, including witness data.
This ensures every byte of block space either on Fuel or corresponding DA layer can be accounted for.
Expand Down
39 changes: 21 additions & 18 deletions src/tx-format/transaction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,23 +55,24 @@ enum ReceiptType : uint8 {
}
```

| name | type | description |
|--------------------|-----------------------------|------------------------------------------------------|
| `gasLimit` | `uint64` | Gas limit for transaction (including predicate gas). |
| `scriptLength` | `uint16` | Script length, in instructions. |
| `scriptDataLength` | `uint16` | Length of script input data, in bytes. |
| `policyTypes` | `uint32` | Bitfield of used policy types. |
| `inputsCount` | `uint8` | Number of inputs. |
| `outputsCount` | `uint8` | Number of outputs. |
| `witnessesCount` | `uint8` | Number of witnesses. |
| `receiptsRoot` | `byte[32]` | Merkle root of receipts. |
| `script` | `byte[]` | Script to execute. |
| `scriptData` | `byte[]` | Script input data (parameters). |
| `policies` | [Policy](./policy.md)`[]` | List of policies, sorted by PolicyType. |
| `inputs` | [Input](./input.md)`[]` | List of inputs. |
| `outputs` | [Output](./output.md)`[]` | List of outputs. |
| `witnesses` | [Witness](./witness.md)`[]` | List of witnesses. |

| name | type | description |
|--------------------|-----------------------------|-----------------------------------------|
| `scriptGasLimit` | `uint64` | Gas limits the script execution. |
| `scriptLength` | `uint16` | Script length, in instructions. |
| `scriptDataLength` | `uint16` | Length of script input data, in bytes. |
| `policyTypes` | `uint32` | Bitfield of used policy types. |
| `inputsCount` | `uint8` | Number of inputs. |
| `outputsCount` | `uint8` | Number of outputs. |
| `witnessesCount` | `uint8` | Number of witnesses. |
| `receiptsRoot` | `byte[32]` | Merkle root of receipts. |
| `script` | `byte[]` | Script to execute. |
| `scriptData` | `byte[]` | Script input data (parameters). |
| `policies` | [Policy](./policy.md)`[]` | List of policies, sorted by PolicyType. |
| `inputs` | [Input](./input.md)`[]` | List of inputs. |
| `outputs` | [Output](./output.md)`[]` | List of outputs. |
| `witnesses` | [Witness](./witness.md)`[]` | List of witnesses. |

Given helper `max_gas()` returns the maximum gas that the transaction can use.
Copy link
Member

@Voxelot Voxelot Nov 8, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we define max_gas() anywhere? It might be confusing without more context. i.e in tx-validity

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it is what you've started in the #529 =D I decided not to describe it here because we have another PR dedicated to the gas model description.

Given helper `len()` that returns the number of bytes of a field.
Given helper `count_ones()` that returns the number of ones in the binary representation of a field.
Given helper `count_variants()` that returns the number of variants in an enum.
Expand All @@ -84,7 +85,7 @@ Transaction is invalid if:
- `scriptDataLength > MAX_SCRIPT_DATA_LENGTH`
- `scriptLength * 4 != len(script)`
- `scriptDataLength != len(scriptData)`
- `gasLimit > MAX_GAS_PER_TX`
- `max_gas(tx) > MAX_GAS_PER_TX`
- No policy of type `PolicyType.GasPrice`
- `count_ones(policyTypes) > count_variants(PolicyType)`
- `policyTypes > sum_variants(PolicyType)`
Expand Down Expand Up @@ -116,6 +117,7 @@ The receipts root `receiptsRoot` is the root of the [binary Merkle tree](../prot
| `outputs` | [Output](./output.md)`[]` | List of outputs. |
| `witnesses` | [Witness](./witness.md)`[]` | List of witnesses. |

Given helper `max_gas()` returns the maximum gas that the transaction can use.
Given helper `count_ones()` that returns the number of ones in the binary representation of a field.
Given helper `count_variants()` that returns the number of variants in an enum.
Given helper `sum_variants()` that sums all variants of an enum.
Expand All @@ -133,6 +135,7 @@ Transaction is invalid if:
- The keys of `storageSlots` are not in ascending lexicographic order
- The computed contract ID (see below) is not equal to the `contractID` of the one `OutputType.ContractCreated` output
- `storageSlotsCount > MAX_STORAGE_SLOTS`
- `max_gas(tx) > MAX_GAS_PER_TX`
- The [Sparse Merkle tree](../protocol/cryptographic-primitives.md#sparse-merkle-tree) root of `storageSlots` is not equal to the `stateRoot` of the one `OutputType.ContractCreated` output
- No policy of type `PolicyType.GasPrice`
- `count_ones(policyTypes) > count_variants(PolicyType)`
Expand Down