Clarinet SDK Overview

The Clarinet SDK is a JavaScript library that spawns and interacts with a simulated Clarinet environment.

The Clarinet SDK allows you to write unit tests for your Clarity smart contracts. You can theoretically use any JavaScript test framework, but the SDK supports Vitest out of the box.

Here is a non-exhaustive list of some of simnet's use-cases:

  • Call public and read-only 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
Requirements

The SDK requires Node.js >= 18.0 and NPM to be installed.

Guides

Simulate a blockchain with Clarinet SDK

Learn how to interact with a simulated network without running a node.

Unit testing with Clarinet SDK

Add new contracts to your project and have them automatically configured in your project file.

API References

Learn how to enable the `check_checker` feature to identify potentially dangerous areas in your contracts.

Last updated on

Quickstart

Installation