SIP

SIP Protocol API Reference v0.7.2

SIP Protocol API Reference / SIP

Class: SIP

Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:2224

Main SIP SDK client for privacy-preserving cross-chain transactions

The SIP class is the primary interface for interacting with the Shielded Intents Protocol. It provides methods for:

Creating shielded intents with privacy guarantees
Fetching quotes from solvers/market makers
Executing cross-chain swaps via settlement backends
Managing stealth addresses and viewing keys
Generating zero-knowledge proofs

Key Concepts:

Intent: A declaration of desired output (e.g., “I want 95+ ZEC on Zcash”)
Privacy Levels: transparent (public), shielded (private), compliant (private + auditable)
Stealth Address: One-time recipient address for unlinkable transactions
Commitment: Cryptographic hiding of amounts using Pedersen commitments
Viewing Key: Selective disclosure key for compliance/auditing

Examples

import { SIP, PrivacyLevel } from '@sip-protocol/sdk'

// Initialize client
const sip = new SIP({ network: 'testnet' })

// Create a shielded intent
const intent = await sip.createIntent({
  input: {
    asset: { chain: 'solana', symbol: 'SOL', address: null, decimals: 9 },
    amount: 10n * 10n**9n, // 10 SOL
  },
  output: {
    asset: { chain: 'ethereum', symbol: 'ETH', address: null, decimals: 18 },
    minAmount: 0n, // Accept any amount
    maxSlippage: 0.01, // 1%
  },
  privacy: PrivacyLevel.SHIELDED,
})

// Get quotes from solvers
const quotes = await sip.getQuotes(intent)

// Execute with best quote
const result = await sip.execute(intent, quotes[0])
console.log('Swap completed:', result.txHash)

import { SIP, PrivacyLevel, MockProofProvider } from '@sip-protocol/sdk'

// Initialize with production backend
const sip = new SIP({
  network: 'mainnet',
  mode: 'production',
  proofProvider: new MockProofProvider(), // Use NoirProofProvider in prod
  intentsAdapter: {
    jwtToken: process.env.NEAR_INTENTS_JWT,
  },
})

// Connect wallet
sip.connect(myWalletAdapter)

// Generate stealth keys for receiving
const stealthMetaAddress = sip.generateStealthKeys('ethereum', 'My Privacy Wallet')

// Create intent with stealth recipient
const intent = await sip.createIntent({
  input: { asset: { chain: 'near', symbol: 'NEAR', address: null, decimals: 24 }, amount: 100n },
  output: { asset: { chain: 'zcash', symbol: 'ZEC', address: null, decimals: 8 }, minAmount: 0n, maxSlippage: 0.01 },
  privacy: PrivacyLevel.SHIELDED,
  recipientMetaAddress: sip.getStealthAddress(),
})

// Get real quotes
const quotes = await sip.getQuotes(intent)

// Execute with deposit callback
const result = await sip.execute(intent, quotes[0], {
  onDepositRequired: async (depositAddr, amount) => {
    console.log(`Deposit ${amount} to ${depositAddr}`)
    const tx = await wallet.transfer(depositAddr, amount)
    return tx.hash
  },
  onStatusUpdate: (status) => console.log('Status:', status),
})

See

SIPConfig for configuration options
createShieldedIntent for intent creation
PrivacyLevel for privacy modes

Constructors

Constructor

new SIP(config): SIP

Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:2257

Create a new SIP SDK client

Parameters

config

SIPConfig

Configuration options for the client

Returns

SIP

Throws

If configuration is invalid

Examples

const sip = new SIP({ network: 'testnet' })

const sip = new SIP({
  network: 'mainnet',
  mode: 'production',
  defaultPrivacy: PrivacyLevel.COMPLIANT,
  proofProvider: await NoirProofProvider.create(),
  intentsAdapter: { jwtToken: process.env.JWT },
  rpcEndpoints: {
    ethereum: 'https://eth-mainnet.g.alchemy.com/v2/KEY',
  },
})

Methods

getMode()

getMode(): "demo" | "production"

Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:2261

Get the current mode

Returns

"demo" | "production"

isProductionMode()

isProductionMode(): boolean

Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:2265

Check if running in production mode with real NEAR Intents

Returns

boolean

getIntentsAdapter()

getIntentsAdapter(): NEARIntentsAdapter | undefined

Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:2269

Get the NEAR Intents adapter

Returns

NEARIntentsAdapter | undefined

setIntentsAdapter()

setIntentsAdapter(adapter): void

Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:2273

Set the NEAR Intents adapter

Parameters

adapter

NEARIntentsAdapter | NEARIntentsAdapterConfig

Returns

void

getProofProvider()

getProofProvider(): ProofProvider | undefined

Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:2277

Get the configured proof provider

Returns

ProofProvider | undefined

setProofProvider()

setProofProvider(provider): void

Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:2281

Set or update the proof provider

Parameters

provider

ProofProvider

Returns

void

hasProofProvider()

hasProofProvider(): boolean

Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:2285

Check if proof provider is available and ready

Returns

boolean

connect()

connect(wallet): void

Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:2289

Connect a wallet

Parameters

wallet

WalletAdapter

Returns

void

disconnect()

disconnect(): void

Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:2293

Disconnect wallet

Returns

void

isConnected()

isConnected(): boolean

Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:2297

Check if wallet is connected

Returns

boolean

getWallet()

getWallet(): WalletAdapter | undefined

Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:2301

Get connected wallet

Returns

WalletAdapter | undefined

generateStealthKeys()

generateStealthKeys(chain, label?): StealthMetaAddress

Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:2307

Generate and store stealth keys for this session

Parameters

chain

ChainId

label?

string

Returns

StealthMetaAddress

Throws

If chain is invalid

getStealthAddress()

getStealthAddress(): string | undefined

Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:2311

Get the encoded stealth meta-address for receiving

Returns

string | undefined

intent()

intent(): IntentBuilder

Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:2327

Create a new intent builder

The builder is automatically configured with the SIP client’s proof provider (if one is set), so proofs will be generated automatically when .build() is called.

Returns

IntentBuilder

Example

const intent = await sip.intent()
  .input('near', 'NEAR', 100n)
  .output('zcash', 'ZEC', 95n)
  .privacy(PrivacyLevel.SHIELDED)
  .build()

createIntent()

createIntent(params, options?): Promise<TrackedIntent>

Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:2334

Create a shielded intent directly

Uses the SIP client’s configured proof provider (if any) to generate proofs automatically for SHIELDED and COMPLIANT privacy levels.

Parameters

params

CreateIntentParams

options?

allowPlaceholders?

boolean

Allow placeholder signatures for proof generation (demo/testing only)

ownershipSignature?

Uint8Array<ArrayBufferLike>

Ownership signature proving wallet control

senderSecret?

Uint8Array<ArrayBufferLike>

Sender secret for nullifier derivation

authorizationSignature?

Uint8Array<ArrayBufferLike>

Authorization signature for this intent

Returns

Promise<TrackedIntent>

getQuotes()

getQuotes(params, recipientMetaAddress?, senderAddress?, transparentRecipient?): Promise<ProductionQuote[]>

Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:2356

Get quotes for an intent

In production mode: fetches real quotes from NEAR 1Click API In demo mode: returns mock quotes for testing

Parameters

params

Intent parameters (CreateIntentParams for production, ShieldedIntent/CreateIntentParams for demo)

ShieldedIntent | CreateIntentParams

recipientMetaAddress?

Optional stealth meta-address for privacy modes

string | StealthMetaAddress

senderAddress?

string

Optional sender wallet address for cross-curve refunds

transparentRecipient?

string

Optional explicit recipient address for transparent mode (defaults to senderAddress)

Returns

Promise<ProductionQuote[]>

Array of quotes (with deposit info in production mode)

execute()

execute(intent, quote, options?): Promise<FulfillmentResult>

Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:2368

Execute an intent with a selected quote

In production mode: initiates real swap via NEAR 1Click API In demo mode: returns mock result

Parameters

intent

TrackedIntent

The intent to execute

quote

Selected quote from getQuotes()

Quote | ProductionQuote

options?

Execution options

onDepositRequired?

(depositAddress, amount) => Promise<string>

Callback when deposit is required

onStatusUpdate?

(status) => void

Callback for status updates

timeout?

number

Timeout for waiting (ms)

Returns

Promise<FulfillmentResult>

Fulfillment result with transaction hash (when available)

generateViewingKey()

generateViewingKey(path?): ViewingKey

Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:2379

Generate a viewing key for compliant mode

Parameters

path?

string

Returns

ViewingKey

deriveViewingKey()

deriveViewingKey(masterKey, childPath): ViewingKey

Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:2383

Derive a child viewing key

Parameters

masterKey

ViewingKey

childPath

string

Returns

ViewingKey

getNetwork()

getNetwork(): "testnet" | "mainnet"

Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:2387

Get network configuration

Returns

"testnet" | "mainnet"

executeSameChain()

executeSameChain(chain, params): Promise<SameChainExecuteResult>

Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:2430

Execute a same-chain private transfer

Bypasses cross-chain settlement for direct on-chain privacy transfers. Currently supports Solana only.

Parameters

chain

ChainId

Chain to execute on (must be ‘solana’)

params

SameChainExecuteParams

Transfer parameters

Returns

Promise<SameChainExecuteResult>

Transfer result with stealth address

Example

const result = await sip.executeSameChain('solana', {
  recipientMetaAddress: {
    chain: 'solana',
    spendingKey: '0x...',
    viewingKey: '0x...',
  },
  amount: 5_000_000n,  // 5 USDC
  token: 'USDC',
  connection,
  sender: wallet.publicKey,
  signTransaction: wallet.signTransaction,
})

console.log('Sent to stealth:', result.stealthAddress)

isSameChainSupported()

isSameChainSupported(chain): boolean

Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:2434

Check if same-chain privacy is supported for a chain

Parameters

chain

ChainId

Returns

boolean