Install the Ika SDK

🚧 Under Construction 🚧

This SDK is still in an experimental phase. We advise you use the SDK with localnet.

The Ika TypeScript SDK is available in the dwallet-labs/ika repository and as a package on npm.

Install from npm

To use the Ika TypeScript SDK, you can install it from npm:

Info

You can use bun, pnpm, yarn, or npm to install the SDK.

pnpm add @ika.xyz/sdk

Install from the repository

To use the Ika TypeScript SDK from the repository, you can clone the repository and install the dependencies:

git clone https://github.com/dwallet-labs/ika.git

To build the SDK, you must have the following tools installed:

🦀 Rust

📖 Install Guide

The programming language and toolchain required to build Ika

Quick install:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

🔧 Sui CLI

📖 Sui Documentation

The command-line interface for interacting with Sui blockchain

Recommended for macOS and Linux users

brew install sui

📦 pnpm

📖 Installation Guide

Fast, disk space efficient package manager

Using npm (most common)

npm install -g pnpm

🕸️ wasm-pack

WebAssembly packager for building and packaging Rust-generated WebAssembly

Quick install:

curl https://drager.github.io/wasm-pack/installer/init.sh -sSf | sh

🔗 wasm-bindgen-cli

WebAssembly binding generator for creating JavaScript bindings

Quick install:

cargo install wasm-bindgen-cli --version 0.2.100

After you have installed these prerequisites and cloned the repository, you can build the SDK by running the following command:

cd sdk/typescript
pnpm install && pnpm build

With the SDK built, you can use it in your project by adding the following to your package.json:

"dependencies": {
  "@ika.xyz/sdk": "file:../sdk/typescript/dist"
}

Note

The file:../sdk/typescript/dist path assumes you're adding this dependency from the root of the cloned repository. Adjust this path based on your project's directory structure relative to the SDK location.