Class PacketReceipt

constructor

• new PacketReceipt(
      packetHash: Uint8Array<ArrayBufferLike>,
      destinationHash: Uint8Array<ArrayBufferLike>,
      callbacks?: {
          delivered?: (arg0: PacketReceipt) => void | Promise<void>;
          failed?: (arg0: PacketReceipt) => void | Promise<void>;
      },
  ): PacketReceipt

  Parameters

  • packetHash: Uint8Array<ArrayBufferLike>

    32-byte SHA-256(get_hashable_part(packet)).

  • destinationHash: Uint8Array<ArrayBufferLike>

    16-byte destination the proved packet was sent to; used to recall the verifying identity.

  • Optionalcallbacks: {
        delivered?: (arg0: PacketReceipt) => void | Promise<void>;
        failed?: (arg0: PacketReceipt) => void | Promise<void>;
    } = {}

    • Optionaldelivered?: (arg0: PacketReceipt) => void | Promise<void>

      Fired once when the PROOF validates.

    • Optionalfailed?: (arg0: PacketReceipt) => void | Promise<void>

      Fired once if the PROOF fails validation.

  Returns PacketReceipt

_settledPromise

_settledResolve

_timeoutTimer

callbacks

destinationHash

owner

packetHash

sentAt

status

truncatedHash

clearTimeout

• clearTimeout(): void

  Cancels any pending proof-wait timeout. Idempotent.

  Returns void

setDelivered

• setDelivered(): void

  Marks the receipt delivered, removes it from the registry, and fires the delivered callback once. Idempotent.

  Returns void

setFailed

• setFailed(): void

  Marks the receipt failed and fires the failed callback once. Does not remove from the registry (the caller decides whether to retry or cull).

  Returns void

startTimeout

• startTimeout(timeoutMs: number): void

  Starts the proof-wait timeout: on expiry the receipt is removed from the registry and marked failed (firing the failed callback, which a transport wires to markPathUnresponsive). No-op if already resolved.

  Parameters

  • timeoutMs: number

  Returns void

validateProof

• validateProof(proofData: Uint8Array<ArrayBufferLike>): Promise<boolean>

  Validates an inbound proof body (§6.5.1 / §6.5.5), dispatching purely on length. The verifying identity is recalled by destinationHash — the destination the original packet was addressed to — so receipt creation never needs to thread the recipient identity through.

  Parameters

  • proofData: Uint8Array<ArrayBufferLike>

  Returns Promise<boolean>

  true if the signature verifies over the packet hash (and, for explicit proofs, the embedded hash matches).

whenSettled

• whenSettled(): Promise<number>

  Resolves once the receipt reaches a terminal state, yielding the final ReceiptStatus (DELIVERED or FAILED). Awaiting this is how a caller learns whether the receiver actually proved the packet — the transport's startTimeout guarantees settlement even when no PROOF ever arrives. Resolves immediately for an already-settled receipt.

  Returns Promise<number>