IOTA TypeScript SDK Quick Start

The IOTA TypeScript SDK is a modular library of tools for interacting with the IOTA blockchain. Use it to send queries to RPC nodes, build and sign transactions, and interact with an IOTA or local network.

Installation

npm

npm i @iota/iota-sdk

Yarn

yarn add @iota/iota-sdk

pnpm

pnpm add @iota/iota-sdk

Network locations

The following table lists the locations for IOTA networks.

IOTA Mainnet

Base Token	IOTA Token
Protocol	Rebased
Explorer	https://explorer.iota.org
JSON RPC URL	https://api.mainnet.iota.cafe
Websocket	wss://api.mainnet.iota.cafe
Indexer	https://indexer.mainnet.iota.cafe
GraphQL RPC URL	https://graphql.mainnet.iota.cafe

info

It is suggested to use dedicated nodes/shared services rather than public endpoints for production apps with high traffic volume.

You can either run your own full nodes, or outsource this to a professional infrastructure provider (preferred for apps that have high traffic).

IOTA Testnet

Base Token	IOTA Token (no value)
Protocol	Rebased
Explorer	https://explorer.rebased.iota.org/?network=testnet
JSON RPC URL	https://api.testnet.iota.cafe
Websocket	wss://api.testnet.iota.cafe
Indexer	https://indexer.testnet.iota.cafe
GraphQL RPC URL	https://graphql.testnet.iota.cafe
Faucet	https://faucet.testnet.iota.cafe

IOTA Devnet

Base Token	IOTA Token (no value)
Protocol	Rebased
Explorer	https://explorer.rebased.iota.org/?network=devnet
JSON RPC URL	https://api.devnet.iota.cafe
Websocket	wss://api.devnet.iota.cafe
Indexer	https://indexer.devnet.iota.cafe
GraphQL RPC URL	https://graphql.devnet.iota.cafe
Faucet	https://faucet.devnet.iota.cafe

IOTA Localnet

To create a local IOTA network, you can refer to Local Development page.

Base Token	IOTA Token (no value)
Protocol	Custom
Explorer	https://explorer.rebased.iota.org/?network=http://127.0.0.1:9000
JSON RPC URL	http://127.0.0.1:9000
Websocket	ws://127.0.0.1:9000
Indexer	http://127.0.0.1:9124
GraphQL RPC URL	http://127.0.0.1:8000
Faucet	http://127.0.0.1:9123/gas

Module packages

The SDK contains a set of modular packages that you can use independently or together. Import just what you need to keep your code light and compact.

• @iota/iota-sdk/client - A client for interacting with IOTA RPC nodes.
• @iota/iota-sdk/bcs - A BCS builder with pre-defined types for IOTA.
• @iota/iota-sdk/transaction - Utilities for building and interacting with transactions.
• @iota/iota-sdk/keypairs/* - Modular exports for specific KeyPair implementations.
• @iota/iota-sdk/verify - Methods for verifying transactions and messages.
• @iota/iota-sdk/cryptography - Shared types and classes for cryptography.
• @iota/iota-sdk/multisig - Utilities for working with multisig signatures.
• @iota/iota-sdk/utils - Utilities for formatting and parsing various IOTA types.
• @iota/iota-sdk/faucet - Methods for requesting IOTA from a faucet.