5 releases
0.58.2 | Oct 7, 2024 |
---|---|
0.58.1 | Oct 6, 2024 |
0.58.0 | Oct 5, 2024 |
0.57.1 | Sep 26, 2024 |
0.57.0 | Sep 17, 2024 |
#22 in #fuel-vm
7,736 downloads per month
Used in 13 crates
(2 directly)
79KB
2K
SLoC
Fuel execution environment
The repository contains crates implementing the FuelVM specification used by fuel-core and the Sway compiler.
Crates living here
Testing
The ci_checks.sh script file can be used to run all CI checks, including the running of tests.
source ci_checks.sh
The script requires pre-installed tools. For more information run:
cat ci_checks.sh
Bug reporting and reproduction
If you find any bug or unexpected behavior, please open an issue. It would be helpful to provide a scenario of how to reproduce the problem:
- A text description of the problem(maybe with links)
- A runnable script with instruction
- A repository with reproduction code and instructions on how to compile/run
- A unit test with the usage of the pure opcodes from
fuel-asm
How to use pure opcodes
The fuel-vm
has many unit tests, almost for each opcode.
Supporting a huge test codebase requires proper test utils that you can re-use to reproduce a bug.
Add a new test case
If a specific opcode has unexpected behaviors, maybe there is a unit test
already that you can reuse to reproduce a bug. You need to add a new test_case
like:
#[test_case(JumpMode::Absolute, 0, 0, 100 => Ok(4); "absolute jump")]
Before the test and run this specific test or all tests.
Build custom scripts
If you need to write your own specific script and run it, you can use test_helpers::run_script
.
For example:
#[test]
fn dynamic_call_frame_ops_bug_missing_ssp_check() {
let ops = vec![
op::cfs(RegId::SP),
op::slli(0x10, RegId::ONE, 26),
op::aloc(0x10),
op::sw(RegId::ZERO, 0x10, 0),
op::ret(RegId::ONE),
];
let receipts = run_script(ops);
assert_panics(&receipts, PanicReason::MemoryOverflow);
}
It returns receipts
that contain result of execution. The assert_panics
can be used to check for panics.
Build custom transactions
The fuel-tx
provides fuel_tx::TransactionBuilder
that simplifies the building
of custom transaction for testing purposes.
You can check how TransactionBuilder::script
or TransactionBuilder::create
are used for better understanding.
lib.rs
:
Compression and decompression of fuel-types for the DA layer
Dependencies
~0.5–1MB
~23K SLoC