Types

Core Types

Hex

type Hex = `0x${string}`

Template literal type for hex-encoded strings.

SdkErrorCode

type SdkErrorCode = 'CONFIG' | 'ASSETS' | 'STORAGE' | 'SYNC' | 'CRYPTO' | 'MERKLE' | 'WITNESS' | 'PROOF' | 'RELAYER'

TransactionReceipt

type TransactionReceipt = Awaited<ReturnType<PublicClient['waitForTransactionReceipt']>>

viem transaction receipt type.

---

Configuration Types

ChainConfigInput

interface ChainConfigInput {
  chainId: number;
  rpcUrl?: string;
  entryUrl?: string;
  ocashContractAddress?: Address;
  relayerUrl?: string;
  merkleProofUrl?: string;
  tokens?: TokenMetadata[];
  contract?: Address;  // Legacy alias
}

TokenMetadata

interface TokenMetadata {
  id: string;
  symbol: string;
  decimals: number;
  wrappedErc20: Address;
  viewerPk: [string, string];
  freezerPk: [string, string];
  depositFeeBps?: number;
  withdrawFeeBps?: number;
  transferMaxAmount?: bigint | string;
  withdrawMaxAmount?: bigint | string;
}

---

UTXO Types

UtxoRecord

interface UtxoRecord {
  chainId: number;
  assetId: string;
  amount: bigint;
  commitment: Hex;
  nullifier: Hex;
  mkIndex: number;
  isFrozen: boolean;
  isSpent: boolean;
  memo?: Hex;
  createdAt?: number;
}

CommitmentData

interface CommitmentData {
  asset_id: bigint;
  asset_amount: bigint;
  user_pk: { user_address: [bigint, bigint] };
  blinding_factor: bigint;
  is_frozen: boolean;
}

---

Sync Types

SyncCursor

interface SyncCursor {
  memo: number;
  nullifier: number;
  merkle: number;
}

SyncChainStatus

interface SyncChainStatus {
  memo: { status: 'idle' | 'syncing' | 'synced' | 'error'; downloaded: number; total?: number; errorMessage?: string };
  nullifier: { status: 'idle' | 'syncing' | 'synced' | 'error'; downloaded: number; total?: number; errorMessage?: string };
  merkle: { status: 'idle' | 'syncing' | 'synced' | 'error'; cursor: number; errorMessage?: string };
}

---

Merkle Types

MerkleTreeState

interface MerkleTreeState {
  root: Hex;
  totalElements: number;
  lastUpdated: number;
}

MerkleNodeRecord

interface MerkleNodeRecord {
  id: string;
  hash: Hex;
}

MerkleLeafRecord

interface MerkleLeafRecord {
  chainId: number;
  cid: number;
  commitment: Hex;
}

---

Operation Types

OperationType

type OperationType = 'deposit' | 'transfer' | 'withdraw'

OperationStatus

type OperationStatus = 'pending' | 'submitted' | 'confirmed' | 'failed'

StoredOperation

interface StoredOperation<TDetail = unknown> {
  id: string;
  type: OperationType;
  status: OperationStatus;
  chainId: number;
  assetId: string;
  amount: bigint;
  detail?: TDetail;
  createdAt: number;
  updatedAt?: number;
  txHash?: Hex;
  error?: string;
}

ListOperationsQuery

interface ListOperationsQuery {
  chainId?: number;
  tokenId?: string;
  type?: OperationType;
  status?: OperationStatus;
  limit?: number;
  offset?: number;
  sort?: 'asc' | 'desc';
}

---

Proof Types

ProofResult

interface ProofResult {
  proof: string;
  publicInputs: string[];
}

WitnessBuildResult

interface WitnessBuildResult {
  witness: string;  // JSON-serialized witness
  context?: WitnessContext;
}

RelayerRequest

interface RelayerRequest {
  kind: 'relayer';
  method: 'POST';
  path: string;
  body: Record<string, unknown>;
}

---

Entry Types

EntryMemoRecord

interface EntryMemoRecord {
  chainId: number;
  cid: number;
  commitment: Hex;
  memo: Hex;
  createdAt: number;
}

EntryNullifierRecord

interface EntryNullifierRecord {
  chainId: number;
  nullifier: Hex;
  createdAt: number;
}

---

Key Types

WalletSessionInput

interface WalletSessionInput {
  seed: string | Uint8Array;
  accountNonce?: number;
}