Skip to main content

​
Installation

Install Starkzap using npm or yarn: 
npm install starkzap
or 
yarn add starkzap
Building for React Native/Expo? Use React Native Integration and install starkzap-native instead of using starkzap directly in your mobile app.

​
Dependencies

The SDK depends on:
  • starknet (v9+) - Starknet.js core library
This will be installed automatically when you install starkzap.

​
Peer dependencies by feature

All peer dependencies are optional to keep the package lean. Install only what you need:
FeatureIncluded inPeer Dependencies
Ethereum bridging (deposit / withdraw to Ethereum)starkzap,
starkzap-native		ethers@^6
Solana bridging (deposit / withdraw to Solana via Hyperlane)starkzap,
starkzap-native		@solana/web3.js@^1, @hyperlane-xyz/sdk@^14, @hyperlane-xyz/registry@^19, @hyperlane-xyz/utils@^14
Cartridge Controller wallet (web-only)starkzap@cartridge/controller@^0.13
Confidential transfers (Tongo)starkzap,
starkzap-native		@fatsolutions/tongo-sdk@^1
React Native / Expostarkzap-nativereact-native-get-random-values@^1, fast-text-encoding@^1, @ethersproject/shims@^5, buffer@^6
# Ethereum bridging
npm install ethers

# Solana bridging
npm install @solana/web3.js @hyperlane-xyz/sdk @hyperlane-xyz/registry @hyperlane-xyz/utils

# Cartridge Controller (only for Web)
npm install @cartridge/controller

# Confidential transfers
npm install @fatsolutions/tongo-sdk

# React Native / Expo (use starkzap-native instead of starkzap)
npm install starkzap-native react-native-get-random-values fast-text-encoding @ethersproject/shims buffer

​
Next Steps

Once installed, configure the SDK:
  1. Set up Configuration for networks, RPC providers, and optional features
  2. If you are building a mobile app, follow React Native Integration for starkzap-native + Metro setup
  3. Then check out the Quick Start Guide to get your first wallet integration working in minutes