ShieldedIntent
SIP Protocol API Reference v0.7.0
SIP Protocol API Reference / ShieldedIntent
Interface: ShieldedIntent
Section titled “Interface: ShieldedIntent”Defined in: @sip-protocol/types/dist/index.d.ts:217
Shielded Intent - core data structure
Public fields are visible to solvers for quoting. Private fields are hidden and verified via ZK proofs.
Extended by
Section titled “Extended by”Properties
Section titled “Properties”intentId
Section titled “intentId”intentId:
string
Defined in: @sip-protocol/types/dist/index.d.ts:219
Unique intent identifier
version
Section titled “version”version:
"sip-v1"
Defined in: @sip-protocol/types/dist/index.d.ts:221
Protocol version
privacyLevel
Section titled “privacyLevel”privacyLevel:
PrivacyLevel
Defined in: @sip-protocol/types/dist/index.d.ts:223
Privacy level for this intent
createdAt
Section titled “createdAt”createdAt:
number
Defined in: @sip-protocol/types/dist/index.d.ts:225
Intent creation timestamp
expiry
Section titled “expiry”expiry:
number
Defined in: @sip-protocol/types/dist/index.d.ts:227
Intent expiry timestamp
outputAsset
Section titled “outputAsset”outputAsset:
Asset
Defined in: @sip-protocol/types/dist/index.d.ts:229
Desired output asset
minOutputAmount
Section titled “minOutputAmount”minOutputAmount:
bigint
Defined in: @sip-protocol/types/dist/index.d.ts:231
Minimum acceptable output amount
maxSlippage
Section titled “maxSlippage”maxSlippage:
number
Defined in: @sip-protocol/types/dist/index.d.ts:233
Maximum acceptable slippage
inputCommitment
Section titled “inputCommitment”inputCommitment:
Commitment
Defined in: @sip-protocol/types/dist/index.d.ts:235
Commitment to input amount (Pedersen commitment)
senderCommitment
Section titled “senderCommitment”senderCommitment:
Commitment
Defined in: @sip-protocol/types/dist/index.d.ts:237
Commitment to sender identity
recipientStealth
Section titled “recipientStealth”recipientStealth:
StealthAddress
Defined in: @sip-protocol/types/dist/index.d.ts:239
Stealth address for receiving output
fundingProof?
Section titled “fundingProof?”
optionalfundingProof:ZKProof
Defined in: @sip-protocol/types/dist/index.d.ts:241
Proof of sufficient funds (optional for transparent mode)
validityProof?
Section titled “validityProof?”
optionalvalidityProof:ZKProof
Defined in: @sip-protocol/types/dist/index.d.ts:243
Proof of intent validity (optional for transparent mode)
viewingKeyHash?
Section titled “viewingKeyHash?”
optionalviewingKeyHash:`0x${string}`
Defined in: @sip-protocol/types/dist/index.d.ts:245
Hash of viewing key (if compliant mode)