Skip to content

SolanaClaimParams

SIP Protocol API Reference v0.15.1


SIP Protocol API Reference / SolanaClaimParams

Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:15624

Parameters for claiming a stealth payment

This interface requires highly sensitive cryptographic keys. The spending private key can authorize fund transfers. Never log, store in plain text, or transmit these keys insecurely.

connection: Connection

Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:15626

Solana RPC connection


stealthAddress: string

Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:15628

Stealth address to claim from (base58)


ephemeralPublicKey: string

Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:15630

Ephemeral public key from the payment (base58)


viewingPrivateKey: `0x${string}`

Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:15637

Recipient’s viewing private key (hex)

SENSITIVE - Required for stealth key derivation. Store securely (encrypted). Never log or expose in error messages.


spendingPrivateKey: `0x${string}`

Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:15646

Recipient’s spending private key (hex)

CRITICAL - This key can authorize fund transfers. Store with maximum security (hardware wallet, secure enclave, or encrypted storage). Never log, expose in errors, or transmit over network. Clear from memory after use when possible.


destinationAddress: string

Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:15648

Destination address to send claimed funds (base58)


mint: PublicKey

Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:15650

SPL token mint address


optional version?: "1" | "2"

Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:15656

Announcement scheme version of the payment being claimed. ‘2’ (default) = canonical EIP-5564; ‘1’ = legacy swapped (SIP:1) back-compat. Pass the version returned by parseAnnouncement.


optional tokenProgramId?: PublicKey

Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:15662

SPL token program owning the mint — defaults to the classic Token program; pass TOKEN_2022_PROGRAM_ID for Token-2022 mints. A wrong program id derives the wrong ATA and targets the wrong program (on-chain failure).