@hirosystems/clarinet-sdk-browser

Clarinet SDK for the Web

The Clarinet SDK can be used to interact with the simnet from web browsers.

If you want to use the Clarinet SDK in Node.js, try @hirosystems/clarinet-sdk.

Find the API references of the SDK in our documentation.
Learn more about unit testing Clarity smart contracts in this guide.

You can use this SDK to:

• Interact with a clarinet project as you would with the Clarinet CLI
• Call public, read-only, and private functions from smart contracts
• Get clarity maps or data-var values
• Get contract interfaces (available functions and data)
• Write unit tests for Clarity smart contracts

Installation

npm install @hirosystems/clarinet-sdk-browser

Usage

There are two ways to use the sdk in the browser:

• With an empty clarinet session:

const simnet = await initSimnet();
await simnet.initEmtpySession();
simnet.runSnippet("(+ 1 2)")

• With a clarinet project (ie: with a Clarinet.toml) 💡 It requires to use a virtual file system. More documentation and examples soon.

const simnet = await initSimnet();
await simnet.initSession("/project", "Clarinet.toml")

Changelog

2.8.0 (2024-08-01)

New Features

• Add stacks_node_next_initiative_delay in devnet config (#1523) (56f7c469)
• Advance burn and stacks chain tips independently (#1506) (efeadc5c)
• Clarinet sdk browser (#1448) (19824418)

Chores

• Update time version (#1525) (428afdc6)
• Clippy warning v1.80 (#1518) (445ea332)
• Update reqwest and tokio version and other dependencies (#1510) (bce1a301)

Documentation Changes

• Fix cbtc example (#1492) (978ee627)

Bug Fixes

• Improve vitest matcher sources resolver (#1514) (0cd1b950)
• Testnet.toml path in project creation template (#1504) (b37d9f82)