ShieldedPayment
SIP Protocol API Reference v0.7.0
SIP Protocol API Reference / ShieldedPayment
Interface: ShieldedPayment
Section titled “Interface: ShieldedPayment”Defined in: @sip-protocol/types/dist/index.d.ts:1447
Shielded payment - a privacy-preserving stablecoin transfer
Unlike ShieldedIntent which is for cross-chain swaps, ShieldedPayment is specifically for same-token transfers (e.g., USDC to USDC).
Extended by
Section titled “Extended by”Properties
Section titled “Properties”paymentId
Section titled “paymentId”paymentId:
string
Defined in: @sip-protocol/types/dist/index.d.ts:1449
Unique payment identifier
version
Section titled “version”version:
string
Defined in: @sip-protocol/types/dist/index.d.ts:1451
SIP version
privacyLevel
Section titled “privacyLevel”privacyLevel:
PrivacyLevel
Defined in: @sip-protocol/types/dist/index.d.ts:1453
Privacy level for this payment
createdAt
Section titled “createdAt”createdAt:
number
Defined in: @sip-protocol/types/dist/index.d.ts:1455
Creation timestamp (Unix seconds)
expiry
Section titled “expiry”expiry:
number
Defined in: @sip-protocol/types/dist/index.d.ts:1457
Expiration timestamp (Unix seconds)
token:
Asset
Defined in: @sip-protocol/types/dist/index.d.ts:1459
The token being transferred
amount
Section titled “amount”amount:
bigint
Defined in: @sip-protocol/types/dist/index.d.ts:1461
Amount in smallest units (hidden via commitment in shielded mode)
amountCommitment?
Section titled “amountCommitment?”
optionalamountCommitment:Commitment
Defined in: @sip-protocol/types/dist/index.d.ts:1463
Pedersen commitment to amount (for shielded mode)
senderCommitment?
Section titled “senderCommitment?”
optionalsenderCommitment:Commitment
Defined in: @sip-protocol/types/dist/index.d.ts:1465
Pedersen commitment to sender (for shielded mode)
recipientStealth?
Section titled “recipientStealth?”
optionalrecipientStealth:object
Defined in: @sip-protocol/types/dist/index.d.ts:1467
Recipient stealth address (for shielded mode)
address
Section titled “address”address:
`0x${string}`
ephemeralPublicKey
Section titled “ephemeralPublicKey”ephemeralPublicKey:
`0x${string}`
viewTag
Section titled “viewTag”viewTag:
number
recipientAddress?
Section titled “recipientAddress?”
optionalrecipientAddress:string
Defined in: @sip-protocol/types/dist/index.d.ts:1473
Direct recipient address (for transparent mode)
sourceChain
Section titled “sourceChain”sourceChain:
ChainId
Defined in: @sip-protocol/types/dist/index.d.ts:1475
Source chain
destinationChain
Section titled “destinationChain”destinationChain:
ChainId
Defined in: @sip-protocol/types/dist/index.d.ts:1477
Destination chain (can be same as source for same-chain transfers)
purpose?
Section titled “purpose?”
optionalpurpose:PaymentPurpose
Defined in: @sip-protocol/types/dist/index.d.ts:1479
Payment purpose (for compliance)
optionalmemo:string
Defined in: @sip-protocol/types/dist/index.d.ts:1481
Optional memo/reference (encrypted in shielded mode)
encryptedMemo?
Section titled “encryptedMemo?”
optionalencryptedMemo:`0x${string}`
Defined in: @sip-protocol/types/dist/index.d.ts:1483
Encrypted memo (for shielded mode with viewing key)
fundingProof?
Section titled “fundingProof?”
optionalfundingProof:ZKProof
Defined in: @sip-protocol/types/dist/index.d.ts:1485
Funding proof (balance >= amount)
authorizationProof?
Section titled “authorizationProof?”
optionalauthorizationProof:ZKProof
Defined in: @sip-protocol/types/dist/index.d.ts:1487
Authorization proof
viewingKeyHash?
Section titled “viewingKeyHash?”
optionalviewingKeyHash:`0x${string}`
Defined in: @sip-protocol/types/dist/index.d.ts:1489
Viewing key hash (for compliant mode)