Skip to content

TrackedIntent

SIP Protocol API Reference v0.7.0


SIP Protocol API Reference / TrackedIntent

Defined in: @sip-protocol/types/dist/index.d.ts:324

Full intent with status tracking

intentId: string

Defined in: @sip-protocol/types/dist/index.d.ts:219

Unique intent identifier

ShieldedIntent.intentId


version: "sip-v1"

Defined in: @sip-protocol/types/dist/index.d.ts:221

Protocol version

ShieldedIntent.version


privacyLevel: PrivacyLevel

Defined in: @sip-protocol/types/dist/index.d.ts:223

Privacy level for this intent

ShieldedIntent.privacyLevel


createdAt: number

Defined in: @sip-protocol/types/dist/index.d.ts:225

Intent creation timestamp

ShieldedIntent.createdAt


expiry: number

Defined in: @sip-protocol/types/dist/index.d.ts:227

Intent expiry timestamp

ShieldedIntent.expiry


outputAsset: Asset

Defined in: @sip-protocol/types/dist/index.d.ts:229

Desired output asset

ShieldedIntent.outputAsset


minOutputAmount: bigint

Defined in: @sip-protocol/types/dist/index.d.ts:231

Minimum acceptable output amount

ShieldedIntent.minOutputAmount


maxSlippage: number

Defined in: @sip-protocol/types/dist/index.d.ts:233

Maximum acceptable slippage

ShieldedIntent.maxSlippage


inputCommitment: Commitment

Defined in: @sip-protocol/types/dist/index.d.ts:235

Commitment to input amount (Pedersen commitment)

ShieldedIntent.inputCommitment


senderCommitment: Commitment

Defined in: @sip-protocol/types/dist/index.d.ts:237

Commitment to sender identity

ShieldedIntent.senderCommitment


recipientStealth: StealthAddress

Defined in: @sip-protocol/types/dist/index.d.ts:239

Stealth address for receiving output

ShieldedIntent.recipientStealth


optional fundingProof: ZKProof

Defined in: @sip-protocol/types/dist/index.d.ts:241

Proof of sufficient funds (optional for transparent mode)

ShieldedIntent.fundingProof


optional validityProof: ZKProof

Defined in: @sip-protocol/types/dist/index.d.ts:243

Proof of intent validity (optional for transparent mode)

ShieldedIntent.validityProof


optional viewingKeyHash: `0x${string}`

Defined in: @sip-protocol/types/dist/index.d.ts:245

Hash of viewing key (if compliant mode)

ShieldedIntent.viewingKeyHash


status: IntentStatus

Defined in: @sip-protocol/types/dist/index.d.ts:326

Current status


quotes: Quote[]

Defined in: @sip-protocol/types/dist/index.d.ts:328

Received quotes


optional selectedQuote: Quote

Defined in: @sip-protocol/types/dist/index.d.ts:330

Selected quote (if any)


optional result: FulfillmentResult

Defined in: @sip-protocol/types/dist/index.d.ts:332

Fulfillment result (if completed)