SIPNativeBackend
SIP Protocol API Reference v0.15.1
SIP Protocol API Reference / SIPNativeBackend
Class: SIPNativeBackend
Section titled “Class: SIPNativeBackend”Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:20989
SIP Native Privacy Backend
Uses stealth addresses and Pedersen commitments for transaction privacy, with viewing key support for regulatory compliance.
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new SIPNativeBackend(
config?):SIPNativeBackend
Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:21000
Create a new SIP Native backend
Parameters
Section titled “Parameters”config?
Section titled “config?”Backend configuration
Returns
Section titled “Returns”SIPNativeBackend
Properties
Section titled “Properties”version
Section titled “version”
readonlyversion:PrivacyBackendVersion
Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:20990
Interface version implemented by this backend
- v1: Initial interface (deprecated, no version field)
- v2: Current interface with versioning support
Backends without a version field are treated as v1 with deprecation warning.
Default
Section titled “Default”1 (for backwards compatibility)Implementation of
Section titled “Implementation of”
readonlyname:"sip-native"="sip-native"
Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:20991
Unique backend identifier
Implementation of
Section titled “Implementation of”
readonlytype:PrivacyBackendType
Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:20992
Backend type classification
Implementation of
Section titled “Implementation of”chains
Section titled “chains”
readonlychains:string[]
Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:20993
Supported blockchain networks
Implementation of
Section titled “Implementation of”Methods
Section titled “Methods”checkAvailability()
Section titled “checkAvailability()”checkAvailability(
params):Promise<PrivacyAvailabilityResult>
Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:21004
Check if backend is available for given parameters
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<PrivacyAvailabilityResult>
Implementation of
Section titled “Implementation of”PrivacyBackend.checkAvailability
getCapabilities()
Section titled “getCapabilities()”getCapabilities():
PrivacyBackendCapabilities
Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:21008
Get backend capabilities
Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”PrivacyBackend.getCapabilities
execute()
Section titled “execute()”execute(
params):Promise<PrivacyTransactionResult>
Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:21018
Execute a privacy-preserving transfer
This creates a stealth address transfer with:
- Ephemeral keypair generation
- Stealth address derivation
- Pedersen commitment for amount
- Optional viewing key encryption
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<PrivacyTransactionResult>
Implementation of
Section titled “Implementation of”estimateCost()
Section titled “estimateCost()”estimateCost(
params):Promise<bigint>
Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:21022
Estimate cost for a transfer
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<bigint>