SolanaScanParams

SIP Protocol API Reference / SolanaScanParams

Interface: SolanaScanParams

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:15474

Parameters for scanning for incoming stealth payments

Security

This interface requires sensitive cryptographic keys. Never log, store in plain text, or transmit these keys insecurely.

Properties

connection

connection: Connection

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:15476

Solana RPC connection

viewingPrivateKey

viewingPrivateKey: `0x${string}`

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:15483

Recipient’s viewing private key (hex)

Security

SENSITIVE - This key enables scanning for incoming payments. Store securely (encrypted). Never log or expose in error messages.

spendingPublicKey

spendingPublicKey: `0x${string}`

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:15485

Recipient’s spending public key (hex)

fromSlot?

optional fromSlot: number

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:15487

Optional: Start scanning from this slot

toSlot?

optional toSlot: number

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:15489

Optional: Stop scanning at this slot

limit?

optional limit: number

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:15491

Optional: Limit number of results

provider?

optional provider: SolanaRPCProvider

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:15509

Optional: RPC provider for efficient asset queries

When provided, uses provider.getAssetsByOwner() for token detection instead of parsing transaction logs. Recommended for production.

Example

const helius = createProvider('helius', { apiKey: '...' })
const payments = await scanForPayments({
  connection,
  provider: helius,
  viewingPrivateKey,
  spendingPublicKey,
})