@lelantos-org/sdk / protocol / PaymentProofResult

Type Alias: PaymentProofResult

type PaymentProofResult = 
  | {
  asset: AssetId;
  memo?: string;
  ok: true;
  value: CircuitAmount;
}
  | {
  ok: false;
  reason: PaymentProofFailure;
};

Defined in: @lelantos-org/sdk/dist/bundle/payment-proof.d.ts:53

What a payment proof establishes, or why it establishes nothing.

Union Members

Type Literal

{
  asset: AssetId;
  memo?: string;
  ok: true;
  value: CircuitAmount;
}

asset

asset: AssetId;

memo?

optional memo?: string;

The memo the output carries, as the payee reads it. Absent when it carries none.

ok

ok: true;

value

value: CircuitAmount;

---

Type Literal

{
  ok: false;
  reason: PaymentProofFailure;
}