SDK overview

The Crycket SDK is available for React Native, iOS (Swift), and Android (Kotlin). All three platforms implement the same semantic interface.

Key principles

The SDK wraps the Crycket API, not the chain. It handles the build → sign → submit flow and provides real-time status updates.
The SDK never handles wallet connection. You wrap your wallet in a PaymentWallet interface and pass it to the SDK. The wallet must be ready to sign before invoking the SDK.
Private keys never leave the device. The SDK calls wallet.signTransaction() locally, then submits the signed blob to Crycket for broadcast.

Wallet interface

You must implement the PaymentWallet interface for your wallet provider:

interface PaymentWallet {
  address: string;
  chain: CAIP2ChainId;
  signTransaction(tx: UnsignedTransaction): Promise<SignedTransaction>;
}

protocol PaymentWallet {
  var address: String { get }
  var chain: CAIP2ChainId { get }
  func signTransaction(_ tx: UnsignedTransaction) async throws -> SignedTransaction
}

interface PaymentWallet {
  val address: String
  val chain: CAIP2ChainId
  suspend fun signTransaction(tx: UnsignedTransaction): SignedTransaction
}

Initialization

const sdk = PaymentSDK.init({
  apiKey: 'pk_live_...',
  debug: false, // verbose logging in development
});

Status context

The context object passed to onStatusChange drives UX without requiring chain-specific logic:

interface StatusContext {
  estimatedWaitSeconds: number | null; // from chain config
  isDelayed: boolean;                  // true if past expected confirmation time
  retryRequired: boolean;             // tx dropped, re-sign needed
  expiresAt: string;                  // ISO 8601
  expiresInSeconds: number;
  pendingAtExpiry: boolean;
  ataRentLamports: number | null;
  estimatedFeeDisplay: string | null; // "~$0.001 USDC" or "~0.00001 ETH"
}

Next steps

React Native

TypeScript SDK for React Native apps.

iOS

Swift SDK for iOS apps.

Android

Kotlin SDK for Android apps.

Getting started

Core concepts

Integration guides

SDK

Key principles

Wallet interface

Initialization

Status context

Next steps

React Native

iOS

Android

​Key principles

​Wallet interface

​Initialization

​Status context

​Next steps

React Native

iOS

Android

Key principles

Wallet interface

Initialization

Status context

Next steps