Skip to main content

​
Installation

Install Starkzap using npm or yarn:
or
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 (v10+) - Starknet.js core library
  • @starknet-io/starknet-types-0103 - RPC spec 0.10.3 type declarations, referenced by Starkzap’s published types
Both are 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:
Two features are reached through their own entry points rather than the package root: Cartridge from starkzap/cartridge, and the STRK20 privacy pool from starkzap/privacy (starkzap-native/privacy on React Native). Their types name the optional peer, and carrying them on the root entry would make that peer mandatory for everyone — so the subpath is what keeps it optional. Everything else, bridging and Tongo included, imports from the root.
These are the ranges Starkzap declares as peer dependencies. Installing an older minor within the same major (ethers@6.0.0, say) satisfies the docs but not the peer range, and npm reports a conflict — so install at least the versions listed.

​
STRK20 privacy pool

The privacy SDK is not on npm, so it needs two extra steps before npm install works.
Installing the SDK is not enough to deposit. Deposit screening runs through Elliptic under a StarkWare API key, so the proving service that performs it is not public — contact StarkWare for deposit access. Transfers, withdrawals, and the discovery service can be self-hosted. See STRK20 privacy pool.
Point the @starkware-libs scope at GitHub Packages in your project’s .npmrc:
Reads require authentication even though the package is public. Put a token with read:packages in your ~/.npmrc, never in the committed project file:
Then install:
Node 24 or later is required for the WebCrypto APIs the OHTTP transport relies on. This is not enforced by the installer, so an older Node fails at runtime rather than at install time.

​
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