stacks-encoding-native-js v1.0.0

stacks-encoding-native-js

This project was bootstrapped by create-neon.

NodeJS native addon library written in Rust providing functions for decoding binary/wire formats from the Stacks blockchain. This includes Clarity values, transactions, post-conditions, Stacks and Bitcoin addresses, and more. All of which use ASM/SIMD where available.

Supported platforms

• Linux (glibc) x86_64
• Linux (glibc) aarch64
• Linux (musl) x86_64
• Linux (musl) aarch64
• MacOS x86_64
• MacOS aarch64
• Windows x86_64

Project Layout

The directory structure of this project is:

The Rust source code inside the src/**/deserialize.rs files are responsible for deserializing the Stacks blockchain wire/binary formats defined in SIP-005.

NPM Library Bundling

The Node addon modules for all supported platforms are compiled by CI and bundled inside the npm package. The native binary files are small enough that the bundled npm package is an acceptable ~20 MB in size.