Skip to content

DisclosedTransaction

SIP Protocol API Reference v0.7.0


SIP Protocol API Reference / DisclosedTransaction

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

Disclosed transaction - a transaction revealed to an auditor

transactionId: string

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

Original payment/transaction ID


disclosureId: string

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

Disclosure ID


auditorId: string

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

Auditor ID who received disclosure


disclosedAt: number

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

Disclosure timestamp


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: "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: bigint

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

Amount


sender: string

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

Sender address (may be stealth)


recipient: string

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

Recipient address (may be stealth)


txHash: string

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

Transaction hash


blockNumber: number

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

Block number


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: PrivacyLevel

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

Privacy level used


optional memo: string

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

Memo/reference


optional purpose: PaymentPurpose

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

Purpose


optional riskScore: number

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

Risk score (0-100)


optional riskFlags: string[]

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

Risk flags


optional notes: string

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

Compliance notes


optional tags: string[]

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

Tags for categorization