Skip to main content

atomiq-chain-starknet/src

@atomiqlabs/chain-starknet

@atomiqlabs/chain-starknet is the Starknet integration package for the Atomiq protocol.

Within the Atomiq stack, this library provides the Starknet-side building blocks used for Bitcoin-aware swaps and SPV-backed vault flows on Starknet. It includes:

  • the StarknetInitializer used to register Starknet support in the Atomiq SDK
  • the StarknetChainInterface used to talk to Starknet RPCs
  • Starknet BTC relay, escrow swap, and SPV vault contract wrappers
  • signer helpers for browser and programmatic Starknet integrations
  • retrying RPC and websocket helpers for chain access and realtime events

This package is intended for direct protocol integrations and for higher-level Atomiq SDK layers that need Starknet chain support.

Installation​

Install the package with its starknet peer dependency:

npm install @atomiqlabs/chain-starknet starknet

Supported Chains​

This package exports a single Starknet initializer:

  • Starknet via StarknetInitializer

Canonical deployments currently defined in this package:

ChainCanonical deployments included
StarknetMAINNET, TESTNET, TESTNET4

By default, StarknetInitializer selects SN_MAIN Starknet network when bitcoinNetwork is BitcoinNetwork.MAINNET, and SN_SEPOLIA otherwise. That means both BitcoinNetwork.TESTNET and BitcoinNetwork.TESTNET4 use Starknet Sepolia by default, while the BTC relay contract switches to the matching Bitcoin-network-specific deployment.

If you need a non-canonical deployment, pass explicit, swapContract, spvVaultContract, btcRelayContract, or handler contract overrides in the initializer options.

SDK Example​

Initialize the Atomiq SDK with Starknet network support:

import {StarknetInitializer} from "@atomiqlabs/chain-starknet";
import {BitcoinNetwork, SwapperFactory, TypedSwapper} from "@atomiqlabs/sdk";

// Define chains that you want to support here
const chains = [StarknetInitializer] as const;
type SupportedChains = typeof chains;

const Factory = new SwapperFactory<SupportedChains>(chains);

const swapper: TypedSwapper<SupportedChains> = Factory.newSwapper({
  chains: {
    STARKNET: {
      rpcUrl: starknetRpc,
      wsUrl: starknetWs // Optional, but recommended for realtime event subscriptions
    }
  },
  bitcoinNetwork: BitcoinNetwork.MAINNET // or BitcoinNetwork.TESTNET / BitcoinNetwork.TESTNET4
});

If you use the lower-level initializer directly, you can also override the default Starknet chain ID and canonical contract addresses independently when you need custom deployments.

BTC Relay​

Chain Interface​

Events​

Other​

Providers​

Swaps​

Wallets​