FuelLabs/fuel-tx

Enhance ScriptExecutionResult

Open

#100 opened on Mar 31, 2022

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Rust (3 forks)auto 404
good first issue

Repository metrics

Stars
 (14 stars)
PR merge metrics
 (PR metrics pending)

Description

ref https://github.com/FuelLabs/fuel-tx/pull/99#issuecomment-1084909047

Currently, ScriptExecutionResult only supports 3 variants (Success, Revert, Panic), which only require 2 bits to represent.

This leaves 62 bits unused in the canonical encoding, which could be used to pack extra additional metadata. This could be things like

  • PanicReason when result is a panic
  • $pc - assuming it's safe to represent as 32bits, which is more than enough for the VM_MAX_MEMORY unless we decide to allow transactions to use 4gb of mem in the future.
  • the index of the resultant receipt in the set of receipts
  • etc

It's impossible to fully represent all the data that's needed, so we'd have to come up with a transparent yet compact encoding of metadata useful for debugging.

Contributor guide

Research direction
Investigate the current ScriptExecutionResult encoding and identify how to pack additional metadata such as PanicReason, $pc, and receipt index into the unused 62 bits. Provide a transparent compact encoding scheme.
Tech stack
rust
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Rust
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40