ReceivePolicyReceipt

TIP-1028 receive-policy claim receipt utilities.

When an inbound transfer or mint violates the recipient's receive policy, the funds are redirected to the ReceivePolicyGuard and a ClaimReceiptV1 witness is emitted. This module decodes those witnesses (required to later claim or burn the blocked funds) from raw bytes or transaction receipts.

TIP-1028

Examples

import { ReceivePolicyReceipt } from 'ox/tempo'
 
const receipts = ReceivePolicyReceipt.fromTransactionReceipt(receipt)
const decoded = ReceivePolicyReceipt.decode('0x...')

Functions

Name	Description
`ReceivePolicyReceipt.decode`	Decodes a `ReceivePolicyReceipt.ReceivePolicyReceipt` (ABI-encoded `ClaimReceiptV1` witness) into its fields.
`ReceivePolicyReceipt.encode`	Encodes decoded fields into a `ReceivePolicyReceipt.ReceivePolicyReceipt`. Inverse of `decode`.
`ReceivePolicyReceipt.from`	Normalizes a `ReceivePolicyReceipt.ReceivePolicyReceipt` from either an encoded receipt (passthrough) or decoded fields.
`ReceivePolicyReceipt.fromLog`	Extracts the `ReceivePolicyReceipt.ReceivePolicyReceipt` from a `ReceivePolicyGuard` `TransferBlocked` log.
`ReceivePolicyReceipt.fromTransactionReceipt`	Extracts every `ReceivePolicyReceipt.ReceivePolicyReceipt` from a transaction receipt's logs.

Types

Name	Description
`ReceivePolicyReceipt.BlockedReason`	Reason an inbound transfer or mint was blocked by a receive policy.
`ReceivePolicyReceipt.Decoded`	A decoded `ReceivePolicyReceipt.ReceivePolicyReceipt`.
`ReceivePolicyReceipt.Kind`	Kind of inbound operation that was blocked.
`ReceivePolicyReceipt.ReceivePolicyReceipt`	A TIP-1028 receive-policy claim receipt: the ABI-encoded `ClaimReceiptV1` witness emitted when an inbound transfer or mint violates the recipient's receive policy.