DisclosedTransaction
SIP Protocol API Reference v0.7.0
SIP Protocol API Reference / DisclosedTransaction
Interface: DisclosedTransaction
Section titled “Interface: DisclosedTransaction”Defined in: @sip-protocol/types/dist/index.d.ts:1932
Disclosed transaction - a transaction revealed to an auditor
Properties
Section titled “Properties”transactionId
Section titled “transactionId”transactionId:
string
Defined in: @sip-protocol/types/dist/index.d.ts:1934
Original payment/transaction ID
disclosureId
Section titled “disclosureId”disclosureId:
string
Defined in: @sip-protocol/types/dist/index.d.ts:1936
Disclosure ID
auditorId
Section titled “auditorId”auditorId:
string
Defined in: @sip-protocol/types/dist/index.d.ts:1938
Auditor ID who received disclosure
disclosedAt
Section titled “disclosedAt”disclosedAt:
number
Defined in: @sip-protocol/types/dist/index.d.ts:1940
Disclosure timestamp
disclosedBy
Section titled “disclosedBy”disclosedBy:
string
Defined in: @sip-protocol/types/dist/index.d.ts:1942
Who authorized the disclosure
type:
"payment"|"swap"|"deposit"|"withdrawal"
Defined in: @sip-protocol/types/dist/index.d.ts:1944
Transaction type
direction
Section titled “direction”direction:
"inbound"|"outbound"
Defined in: @sip-protocol/types/dist/index.d.ts:1946
Direction
token:
Asset
Defined in: @sip-protocol/types/dist/index.d.ts:1948
Token
amount
Section titled “amount”amount:
bigint
Defined in: @sip-protocol/types/dist/index.d.ts:1950
Amount
sender
Section titled “sender”sender:
string
Defined in: @sip-protocol/types/dist/index.d.ts:1952
Sender address (may be stealth)
recipient
Section titled “recipient”recipient:
string
Defined in: @sip-protocol/types/dist/index.d.ts:1954
Recipient address (may be stealth)
txHash
Section titled “txHash”txHash:
string
Defined in: @sip-protocol/types/dist/index.d.ts:1956
Transaction hash
blockNumber
Section titled “blockNumber”blockNumber:
number
Defined in: @sip-protocol/types/dist/index.d.ts:1958
Block number
timestamp
Section titled “timestamp”timestamp:
number
Defined in: @sip-protocol/types/dist/index.d.ts:1960
Transaction timestamp
chain:
ChainId
Defined in: @sip-protocol/types/dist/index.d.ts:1962
Chain
privacyLevel
Section titled “privacyLevel”privacyLevel:
PrivacyLevel
Defined in: @sip-protocol/types/dist/index.d.ts:1964
Privacy level used
optionalmemo:string
Defined in: @sip-protocol/types/dist/index.d.ts:1966
Memo/reference
purpose?
Section titled “purpose?”
optionalpurpose:PaymentPurpose
Defined in: @sip-protocol/types/dist/index.d.ts:1968
Purpose
riskScore?
Section titled “riskScore?”
optionalriskScore:number
Defined in: @sip-protocol/types/dist/index.d.ts:1970
Risk score (0-100)
riskFlags?
Section titled “riskFlags?”
optionalriskFlags:string[]
Defined in: @sip-protocol/types/dist/index.d.ts:1972
Risk flags
notes?
Section titled “notes?”
optionalnotes:string
Defined in: @sip-protocol/types/dist/index.d.ts:1974
Compliance notes
optionaltags:string[]
Defined in: @sip-protocol/types/dist/index.d.ts:1976
Tags for categorization