SIPConfig

Interface: SIPConfig

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:1912

Configuration options for the SIP SDK client

Controls network selection, privacy defaults, proof generation, and settlement backend.

Examples

const sip = new SIP({
  network: 'testnet',
  defaultPrivacy: PrivacyLevel.SHIELDED
})

const sip = new SIP({
  network: 'mainnet',
  mode: 'production',
  proofProvider: new MockProofProvider(),
  intentsAdapter: {
    jwtToken: process.env.NEAR_INTENTS_JWT
  }
})

Properties

network

network: "testnet" | "mainnet"

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:1919

Network to operate on

'mainnet': Production network with real assets
'testnet': Test network for development

mode?

optional mode: "demo" | "production"

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:1928

Operating mode for quote fetching and execution

'demo': Returns mock quotes for testing (default)
'production': Uses real NEAR Intents 1Click API

Default

'demo'

defaultPrivacy?

optional defaultPrivacy: PrivacyLevel

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:1936

Default privacy level for new intents

Can be overridden per intent. See PrivacyLevel for options.

Default

PrivacyLevel.SHIELDED

rpcEndpoints?

optional rpcEndpoints: Partial<Record<ChainId, string>>

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:1953

Custom RPC endpoints for blockchain connections

Maps chain IDs to RPC URLs. Used for direct blockchain interactions when not using settlement adapters.

Example

{
  rpcEndpoints: {
    ethereum: 'https://eth-mainnet.g.alchemy.com/v2/YOUR_KEY',
    solana: 'https://api.mainnet-beta.solana.com'
  }
}

proofProvider?

optional proofProvider: ProofProvider

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:1988

Proof provider for zero-knowledge proof generation

Required for SHIELDED and COMPLIANT privacy modes. If not provided, intents will be created without proofs (must be attached later).

Available providers:

MockProofProvider: For testing and development
NoirProofProvider: For production (import from ‘@sip-protocol/sdk/proofs/noir’)
BrowserNoirProvider: For browser environments (import from ‘@sip-protocol/sdk/browser’)

Examples

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

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

import { NoirProofProvider } from '@sip-protocol/sdk/proofs/noir'

const provider = new NoirProofProvider()
await provider.initialize()

const sip = new SIP({
  network: 'mainnet',
  proofProvider: provider
})

intentsAdapter?

optional intentsAdapter: NEARIntentsAdapter | NEARIntentsAdapterConfig

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:2025

NEAR Intents adapter for production mode

Required when mode: 'production'. Provides connection to the 1Click API for real cross-chain swaps via NEAR Intents.

Can be either:

Configuration object (NEARIntentsAdapterConfig)
Pre-configured adapter instance (NEARIntentsAdapter)

Examples

const sip = new SIP({
  network: 'mainnet',
  mode: 'production',
  intentsAdapter: {
    jwtToken: process.env.NEAR_INTENTS_JWT
  }
})

import { createNEARIntentsAdapter } from '@sip-protocol/sdk'

const adapter = createNEARIntentsAdapter({
  jwtToken: process.env.NEAR_INTENTS_JWT
})

const sip = new SIP({
  network: 'mainnet',
  mode: 'production',
  intentsAdapter: adapter
})