Adding `tycho_types` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add tycho-types

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

tycho-types = "0.3.0"

The tycho_types library will be automatically available globally. Read the tycho_types library documentation.

Back to the crate overview.

Readme

tycho-types

Status: WIP

About

A set of primitive types and utilities for the Tycho node.

Basic usage

Decode Cell from bytes using the BOC (Bag Of Cells) format:

use tycho_types::boc::Boc;

let cell: Cell = Boc::decode(bytes)?;

Encode TLB model e.g.MerkleProof:

use tycho_types::boc::BocRepr;

let proof = MerkleProof::create_for_cell(cell.as_ref(), some_filter).build()?;

let encoded = BocRepr::encode_base64(proof)?;
let decoded = BocRepr::decode_base64(encoded)?:

Parse TLB type from Cell:

use tycho_types::models::BlockProof;

let proof: BlockProof = cell.parse::<BlockProof>()?;

Parse TLB type from proof cell (partially pruned):

use tycho_types::cell::DynCell;
use tycho_types::models::Block;

let virt_cell: &DynCell = proof.virtualize();
let block = virt_cell.parse::<Block>()?;

Use CellBuilder to create any Cell:

let mut builder = CellBuilder::new();
builder.store_bit_one()?;
builder.store_u32(100u32)?
builder.store_slice(slice)?;
builder.store_raw(&[0xdd, 0x55], 10)?;

// store references to another cells
builder.store_reference(cell)?;
builder.store_reference(another_cell)?;

let final_cell: Cell = builder.build()?;

// === or ===
let other_cell: Cell = CellBuilder::build_from((
    true,
    100u32,
    cell,
    another_cell,
))?;

Development

How to bench

cargo bench boc
cargo bench dict

How to miri check

# Add Miri component
rustup +nightly component add miri

# Run all tests with Miri
cargo +nightly miri test

How to fuzz

# Install fuzzer
cargo install cargo-fuzz

# Run any of the fuzzer targets
cargo +nightly fuzz run boc_decode -j 12
cargo +nightly fuzz run boc_decode_encode -j 12
cargo +nightly fuzz run boc_decode_pair -j 12
cargo +nightly fuzz run boc_dict -j 12
cargo +nightly fuzz run boc_message -j 12

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

Apache License, Version 2.0 (LICENSE-APACHE or https://www.apache.org/licenses/LICENSE-2.0)
MIT license (LICENSE-MIT or https://opensource.org/licenses/MIT)

at your option.

Adding tycho_types library as a dependency

Adding `tycho_types` library as a dependency