@hirosystems/clarinet-sdk-wasm

Clarity SDK WASM

This component exposes Clarinet features to a JS interface through wasm-bindgen. It's built with wasm-pack.
It powers @hirosystems/clarinet-sdk and @hirosystems/clarinet-sdk-browser.

Contributing

Build package

Install wasm-pack.

In the root directory of Clarinet, run the following command to build the packages for Node.js and the browser. Under the hood, it will run wasm-pack build twice, once for each target.

npm run build:sdk-wasm

Alternatively, it's also possible to build the packages separately. It should only be done for development purpose.

Build for node

wasm-pack build --release --scope hirosystems --out-dir pkg-node --target nodejs

Build for the browser

wasm-pack build --release --scope hirosystems --out-dir pkg-browser --target web

Release

The package is built twice with wasm-pack as it can't target node and web at the same time. The following script will build for both target, it will also rename the package name for the browser build.

npm run build:sdk-wasm

Once built, the packages can be released by running the following command. Note that by default we release with the beta tag.

npm run publish:sdk-wasm

Changelog

2.9.0 (2024-09-30)

New Features

• Slown down burn blocks when getting close to epoch 3.0 transition (#1569) (8fc863d3)
• Customize number of signers in devnet (#1555) (76eba28a)

Refactors

• Consolidate datastore and burn datastore data (#1562) (c56b2d4b)
• Remove internal dependency on the repl (#1511) (cd00c892)
• Auto extend stacking_orders in devnet config by default (#1528) (a3e90023)

Chores

• Add disable_postgres flag and separate from stack_api disabling (#1558) (1bdc2724)
• Update clarity and clarity-wasm (#1560) (b57802e9)
• Upgrade bitcoin cargo dependencies (#1556) (fb709312)
• Upgrade npm dependencies (#1551) (e38d0aef)
• Remove unused Clarinet3.toml (148bc5de)

Continuous Integration

• Upgrade actions/upload-artifacts and download-artifacts to v4 (#1554) (146e32ea)

Documentation Changes

• Fix documentation link (#1508) (ce1ffeaa)

Bug Fixes

• Handle reorg in epoch 3.0 (#1568) (be42dd98)
• Convert correctly from uSTX to STX when applying a deployment (#1563) (dfe40985)

Tests

• Add block time tests (#1541) (5ecaee9a)