#assembly #tvm #blockchain #vm #everscale #contract

everscale-asm

Rust implementation of TVM Assembler

8 releases

0.0.9 Jun 27, 2024
0.0.8 Jun 10, 2024
0.0.6 Oct 26, 2023

#222 in Magic Beans

Download history 5/week @ 2024-03-11 39/week @ 2024-04-01 1/week @ 2024-05-20 130/week @ 2024-06-10 129/week @ 2024-06-24

259 downloads per month
Used in 3 crates

MIT/Apache

110KB
3K SLoC

everscale-asm   crates-io-batch docs-badge rust-version-badge workflow-badge

Status: WIP

About

Rust implementation of TVM Assembler.

LSP Server/Client

  • Install TVM Assembler VSCode extension
  • Install CLI
    cargo install --locked tvmasm
    

How to use

Building a contract using CLI

tvmasm build ./src/tests/walletv3.tvm -o walletv3.boc

Output:

Code path:      walletv3.boc
Code hash:      84dafa449f98a6987789ba232358072bc0f76dc4524002a5d0918b9a75d2d599
Unique cells:   1
Unique bits:    888

Building a contract from Rust

Runtime:

use everscale_asm::Code;
use everscale_types::prelude::Cell;

let code: Cell = Code::assemble(r#"
    PUSHINT 1
    SWAP DUP
    PUSHCONT {
        TUCK
        MUL
        SWAP
        DEC
    }
    REPEAT
    DROP
"#)?;

Compile time:

use everscale_asm_macros::tvmasm;
use everscale_types::prelude::{Boc, Cell};

const CODE: &[u8] = tvmasm!(
    "PUSHINT 1",
    "PUSHCONT { INC PUSHINT 10 LESS }",
    "PUSHCONT { DUMPSTK }",
    "WHILE",
);

let code: Cell = Boc::decode(CODE)?;

Syntax

// Single-line comments

// Opcodes must be in uppercase, can start with a digit or minus,
// and can contain '#' or '_'
NOP
2DROP
-ROT
STREF_L

// Opcodes with number as an argument
PUSHINT 12
PUSHINT -0xded
PUSHINT 0b10110101

// Opcodes with stack register as an argument
PUSH s1
XCHG s10, s100
PU2XC s1, s(-1), s(-2)

// Opcodes with control registers (c0, .., c5, c7)
PUSH c3
PUSHCTR c7

// Opcodes with slice or continuation
PUSHSLICE x{123123_}
PUSHSLICE b{10001001}
IFREFELSEREF {
  PUSHINT 1
}, {
  PUSHINT 2
}

// Insert raw slices into code
@inline x{a924}

Full opcodes list

Contributing

We welcome contributions to the project! If you notice any issues or errors, feel free to open an issue or submit a pull request.

License

Licensed under either of

at your option.

Dependencies

~6MB
~119K SLoC