ZcashNativeBackend
SIP Protocol API Reference v0.7.2
SIP Protocol API Reference / ZcashNativeBackend
Class: ZcashNativeBackend
Section titled “Class: ZcashNativeBackend”Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:5899
Zcash Native Settlement Backend
Handles ZEC → ZEC transfers within the Zcash network. Supports both transparent (t-addr) and shielded (z-addr) addresses.
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ZcashNativeBackend(
config):ZcashNativeBackend
Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:5906
Parameters
Section titled “Parameters”config
Section titled “config”Returns
Section titled “Returns”ZcashNativeBackend
Properties
Section titled “Properties”
readonlyname:"zcash-native"
Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:5900
Backend name (e.g., ‘near-intents’, ‘zcash’, ‘thorchain’)
Implementation of
Section titled “Implementation of”capabilities
Section titled “capabilities”
readonlycapabilities:BackendCapabilities
Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:5901
Backend capabilities
Implementation of
Section titled “Implementation of”SettlementBackend.capabilities
Methods
Section titled “Methods”getQuote()
Section titled “getQuote()”getQuote(
params):Promise<SettlementQuote>
Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:5910
Get a quote for ZEC → ZEC transfer
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<SettlementQuote>
Implementation of
Section titled “Implementation of”getDryQuote()
Section titled “getDryQuote()”getDryQuote(
params):Promise<SettlementQuote>
Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:5914
Get a dry quote (preview without creating deposit address)
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<SettlementQuote>
Implementation of
Section titled “Implementation of”executeSwap()
Section titled “executeSwap()”executeSwap(
params):Promise<SettlementSwapResult>
Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:5918
Execute a ZEC → ZEC swap/transfer
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<SettlementSwapResult>
Implementation of
Section titled “Implementation of”getStatus()
Section titled “getStatus()”getStatus(
swapId):Promise<SwapStatusResponse>
Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:5922
Get swap status
Parameters
Section titled “Parameters”swapId
Section titled “swapId”string
Returns
Section titled “Returns”Promise<SwapStatusResponse>
Implementation of
Section titled “Implementation of”waitForCompletion()
Section titled “waitForCompletion()”waitForCompletion(
swapId,options?):Promise<SwapStatusResponse>
Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:5926
Wait for swap completion
Parameters
Section titled “Parameters”swapId
Section titled “swapId”string
options?
Section titled “options?”interval?
Section titled “interval?”number
timeout?
Section titled “timeout?”number
onStatusChange?
Section titled “onStatusChange?”(status) => void
Returns
Section titled “Returns”Promise<SwapStatusResponse>
Implementation of
Section titled “Implementation of”SettlementBackend.waitForCompletion
notifyDeposit()
Section titled “notifyDeposit()”notifyDeposit(
swapId,txHash,metadata?):Promise<void>
Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:5934
Notify backend of deposit
Parameters
Section titled “Parameters”swapId
Section titled “swapId”string
txHash
Section titled “txHash”string
metadata?
Section titled “metadata?”Record<string, unknown>
Returns
Section titled “Returns”Promise<void>