starknet-js

starknet.js v10 SDK

Related modules: skills catalog.

When to Use

• Building Starknet apps with provider, account, contract, wallet, or paymaster flows.

When NOT to Use

• Cairo contract authoring, deployment-only runbooks, or security audits.

Quick Start

npm install starknet@^10.8.0

Minimal setup to read from Starknet:

import { RpcProvider, Contract } from 'starknet';

const provider = await RpcProvider.create({ nodeUrl: 'https://api.cartridge.gg/x/starknet/mainnet/rpc/v0_10' });
const contract = new Contract({ abi, address: contractAddress, providerOrAccount: provider });
const result = await contract.get_balance();

Core Architecture

Provider -> Account -> Contract
   |          |          |
Network   Identity   Interaction

• Provider: Read-only network connection (RpcProvider)
• Account: Signs and sends transactions; in v10 it no longer extends Provider, so call provider methods through account.provider
• Contract: Type-safe interface to deployed contracts

Use Provider for read operations, Account for write operations.

Provider Setup

import { RpcProvider } from 'starknet';

// Recommended: Auto-detect RPC spec version
const provider = await RpcProvider.create({
  nodeUrl: 'https://api.cartridge.gg/x/starknet/mainnet/rpc/v0_10'
});

Networks (keyless public Cartridge endpoints on RPC spec 0.10, rate limited; use your own provider in production):

• Mainnet: https://api.cartridge.gg/x/starknet/mainnet/rpc/v0_10
• Sepolia: https://api.cartridge.gg/x/starknet/sepolia/rpc/v0_10

Key Methods:

const chainId = await provider.getChainId();
const block = await provider.getBlock('latest');
const nonce = await provider.getNonceForAddress(accountAddress);
await provider.waitForTransaction(txHash);

// Read storage directly (v10 returns { value, last_update_block }, not a bare felt)
const { value } = await provider.getStorageAt(contractAddress, storageKey);