SettlementQuote
SIP Protocol API Reference v0.7.2
SIP Protocol API Reference / SettlementQuote
Interface: SettlementQuote
Section titled “Interface: SettlementQuote”Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:4242
Quote response
Properties
Section titled “Properties”quoteId
Section titled “quoteId”quoteId:
string
Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:4244
Unique quote identifier
amountIn
Section titled “amountIn”amountIn:
string
Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:4246
Expected input amount (in smallest units)
amountOut
Section titled “amountOut”amountOut:
string
Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:4248
Expected output amount (in smallest units)
minAmountOut
Section titled “minAmountOut”minAmountOut:
string
Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:4250
Minimum output amount after slippage (in smallest units)
priceImpact?
Section titled “priceImpact?”
optionalpriceImpact:number
Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:4252
Estimated price impact in basis points
fees:
object
Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:4254
Estimated fees (network + protocol)
networkFee
Section titled “networkFee”networkFee:
string
Network gas fees (in native token)
protocolFee
Section titled “protocolFee”protocolFee:
string
Protocol/solver fees (in output token)
totalFeeUSD?
Section titled “totalFeeUSD?”
optionaltotalFeeUSD:string
Total fees in USD (optional)
depositAddress
Section titled “depositAddress”depositAddress:
string
Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:4263
Deposit address for input tokens
recipientAddress
Section titled “recipientAddress”recipientAddress:
string
Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:4265
Recipient address (stealth address if privacy mode)
refundAddress?
Section titled “refundAddress?”
optionalrefundAddress:string
Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:4267
Refund address (if deposit fails or expires)
expiresAt
Section titled “expiresAt”expiresAt:
number
Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:4269
Quote expiration timestamp
estimatedTime?
Section titled “estimatedTime?”
optionalestimatedTime:number
Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:4271
Expected execution time in seconds
route?
Section titled “route?”
optionalroute:SettlementSwapRoute
Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:4273
Swap route details (optional, for transparency)
metadata?
Section titled “metadata?”
optionalmetadata:Record<string,unknown>
Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:4275
Backend-specific metadata