@hirosystems/clarinet-sdk-browser

Clarinet SDK

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

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

Core

npm install @hirosystems/clarinet-sdk-browser

Usage

import { initSimnet } from "@hirosystems/clarinet-sdk-browser";
import { Cl } from "@stacks/transactions";

async function main() {
  const simnet = await initSimnet();

  const accounts = simnet.getAccounts();
  const address1 = accounts.get("wallet_1");
  if (!address1) throw new Error("invalid wallet name.");
  

  const call = simnet.callPublicFn("counter", "add", [Cl.uint(1)], address1);
  console.log(Cl.prettyPrint(call.result)); // (ok u1)

  const counter = simnet.getDataVar("counter", "counter");
  console.log(Cl.prettyPrint(counter)); // 2
}

main();

By default, the SDK will look for a Clarinet.toml file in the current working directory. It's also possible to provide the path to the manifest like so:

 const simnet = await initSimnet("./path/to/Clarinet.toml");

Contributing

The clarinet-sdk requires a few steps to be built and tested locally. We'll look into simplifying this workflow in a future version.

Clone the clarinet repo and cd into it:

git clone [e-mail]:hirosystems/clarinet.git
cd clarinet

Open the SDK workspace in VSCode, it's especially useful to get rust-analyzer to consider the right files with the right cargo features.

code components/clarinet-sdk/clarinet-sdk.code-workspace

The SDK mainly relies on two components:

• the Rust component: components/clarinet-sdk-wasm
• the TS component: components/clarinet-sdk

To work with these two packages locally, the first one needs to be built with wasm-pack and linked with: npm link.

Install wasm-pack and run:

cd components/clarinet-sdk-wasm
wasm-pack build --release --scope hirosystems --out-dir pkg-node --target nodejs
cd pkg-node
npm link