Skip to main content
The IOTA TypeScript SDK (@iota/iota-sdk) is designed for interacting with the IOTA Rebased protocol. It provides utility classes and functions for applications to sign transactions and interact with the IOTA network.
The SDK and RPC API are still being iterated before TestNet. Expect frequent breaking changes in the short-term. The API will stabilize after the upcoming TestNet launch.

​
Package Manager Installation

Install the SDK using your preferred package manager: 
npm install @iota/iota-sdk

​
Version Requirements

The SDK requires:
  • Node.js: version 24 or higher
  • Package Manager: pnpm version 9.6.0 to 9.15.9 (for monorepo development)

​
Release Cycle

The SDK is published to npm registry with a bi-weekly release cycle that syncs with:

​
Working with Different Networks

​
Devnet (Stable)

For production-ready development against Devnet: 
npm install @iota/iota-sdk

​
Localnet (Experimental)

For local development with the latest changes from main branch: 
npm install @iota/iota-sdk@experimental
The experimental tag contains the latest changes and may be out of sync with the stable release. Use this when developing against a local network.

​
Verifying Installation

After installation, verify the SDK is working: 
import { IotaClient, getFullnodeUrl } from '@iota/iota-sdk/client';

// Create a client instance
const client = new IotaClient({ url: getFullnodeUrl('devnet') });

console.log('IOTA SDK installed successfully!');

​
Available Exports

The SDK provides modular exports for different functionality:
  • @iota/iota-sdk/client - IOTA client and network utilities
  • @iota/iota-sdk/transactions - Transaction building
  • @iota/iota-sdk/keypairs/ed25519 - Ed25519 keypairs
  • @iota/iota-sdk/keypairs/secp256k1 - Secp256k1 keypairs
  • @iota/iota-sdk/keypairs/secp256r1 - Secp256r1 keypairs
  • @iota/iota-sdk/multisig - Multisig functionality
  • @iota/iota-sdk/faucet - Faucet integration
  • @iota/iota-sdk/graphql - GraphQL transport
  • @iota/iota-sdk/bcs - Binary Canonical Serialization
  • @iota/iota-sdk/utils - Utility functions
  • @iota/iota-sdk/verify - Signature verification

​
Building from Source

To build the SDK locally: 
# Install pnpm if not already installed
npm install -g pnpm

# Install dependencies
pnpm install

# Build the TypeScript SDK
pnpm run build

​
Next Steps

Quick Start

Get started with a working example

Client Setup

Configure the IotaClient for different networks

Build docs developers (and LLMs) love

Get started for freeTalk to us