ox 0.14.26 → 0.14.28

package/_esm/tempo/MultisigConfig.js

@@ -0,0 +1,312 @@
+import * as Address from '../core/Address.js';
+import * as Errors from '../core/Errors.js';
+import * as Hash from '../core/Hash.js';
+import * as Hex from '../core/Hex.js';
+/** Maximum number of owners allowed in a native multisig config. */
+export const maxOwners = 10;
+/** Maximum encoded byte length for one primitive owner approval. */
+export const maxOwnerSignatureBytes = 2049;
+/** Tempo signature type byte for native multisig signatures. */
+export const signatureTypeByte = '0x05';
+/** Zero 32-byte salt (the default when no salt is provided). */
+export const zeroSalt = `0x${'00'.repeat(32)}`;
+/** Domain prefix for the native multisig account address derivation. */
+const accountDomain = 'tempo:multisig:account';
+/** Domain prefix for the native multisig config ID derivation. */
+const configDomain = 'tempo:multisig:config';
+/** Domain prefix for native multisig owner approvals. */
+const signatureDomain = 'tempo:multisig:signature';
+/**
+ * Asserts that a native multisig {@link ox#MultisigConfig.Config} is valid.
+ *
+ * Mirrors the Tempo `validate_multisig_config` rules: owners non-empty and
+ * `<= maxOwners`, strictly ascending unique nonzero owner addresses, nonzero
+ * owner weights, `threshold >= 1`, total weight `<= u32::MAX`, and
+ * `threshold <= total weight`.
+ *
+ * @example
+ * ```ts twoslash
+ * import { MultisigConfig } from 'ox/tempo'
+ *
+ * MultisigConfig.assert({
+ *   threshold: 1,
+ *   owners: [
+ *     { owner: '0x1111111111111111111111111111111111111111', weight: 1 },
+ *   ],
+ * })
+ * ```
+ *
+ * @param config - The multisig config.
+ */
+export function assert(config) {
+    const { salt, threshold, owners } = config;
+    if (typeof salt !== 'undefined' && Hex.size(salt) !== 32)
+        throw new InvalidConfigError({ reason: 'salt must be 32 bytes' });
+    if (owners.length === 0)
+        throw new InvalidConfigError({ reason: 'owners cannot be empty' });
+    if (owners.length > maxOwners)
+        throw new InvalidConfigError({ reason: 'too many owners' });
+    if (Number(threshold) < 1)
+        throw new InvalidConfigError({ reason: 'threshold cannot be zero' });
+    let totalWeight = 0;
+    let previous;
+    for (const owner of owners) {
+        if (!Address.validate(owner.owner) || Hex.toBigInt(owner.owner) === 0n)
+            throw new InvalidConfigError({ reason: 'owner cannot be zero' });
+        if (Number(owner.weight) < 1)
+            throw new InvalidConfigError({ reason: 'owner weight cannot be zero' });
+        const current = Hex.toBigInt(owner.owner);
+        if (typeof previous !== 'undefined' && previous >= current)
+            throw new InvalidConfigError({
+                reason: 'owners must be strictly ascending',
+            });
+        previous = current;
+        totalWeight += Number(owner.weight);
+    }
+    if (totalWeight > 0xffffffff)
+        throw new InvalidConfigError({
+            reason: 'total owner weight exceeds u32 max',
+        });
+    if (Number(threshold) > totalWeight)
+        throw new InvalidConfigError({
+            reason: 'threshold exceeds total owner weight',
+        });
+}
+/**
+ * Normalizes a native multisig {@link ox#MultisigConfig.Config}.
+ *
+ * Sorts owners into strictly ascending `owner` address order (the canonical
+ * form required for config ID derivation) and asserts the config is valid.
+ *
+ * @example
+ * ```ts twoslash
+ * import { MultisigConfig } from 'ox/tempo'
+ *
+ * const config = MultisigConfig.from({
+ *   threshold: 2,
+ *   owners: [
+ *     { owner: '0x2222222222222222222222222222222222222222', weight: 1 },
+ *     { owner: '0x1111111111111111111111111111111111111111', weight: 1 },
+ *   ],
+ * })
+ * // owners are now sorted ascending by address
+ * ```
+ *
+ * @param config - The multisig config.
+ * @returns The normalized multisig config.
+ */
+export function from(config) {
+    const owners = [...config.owners].sort((a, b) => Hex.toBigInt(a.owner) < Hex.toBigInt(b.owner) ? -1 : 1);
+    const normalized = {
+        salt: config.salt ? Hex.padLeft(config.salt, 32) : zeroSalt,
+        threshold: config.threshold,
+        owners,
+    };
+    assert(normalized);
+    return normalized;
+}
+/**
+ * Converts an RLP {@link ox#MultisigConfig.Tuple} back to a
+ * {@link ox#MultisigConfig.Config}.
+ *
+ * @example
+ * ```ts twoslash
+ * import { MultisigConfig } from 'ox/tempo'
+ *
+ * const config = MultisigConfig.fromTuple([
+ *   `0x${'00'.repeat(32)}`,
+ *   '0x01',
+ *   [['0x1111111111111111111111111111111111111111', '0x01']],
+ * ])
+ * ```
+ *
+ * @param tuple - The RLP tuple.
+ * @returns The multisig config.
+ */
+export function fromTuple(tuple) {
+    const [salt, threshold, owners] = tuple;
+    return {
+        salt: salt && salt !== '0x' ? Hex.padLeft(salt, 32) : zeroSalt,
+        threshold: threshold === '0x' ? 0 : Hex.toNumber(threshold),
+        owners: owners.map((owner) => {
+            const [ownerAddress, weight] = owner;
+            return {
+                owner: ownerAddress,
+                weight: !weight || weight === '0x' ? 0 : Hex.toNumber(weight),
+            };
+        }),
+    };
+}
+/**
+ * Derives the stable native multisig account address.
+ *
+ * `keccak256("tempo:multisig:account" || config_id)[12:32]`.
+ *
+ * @example
+ * ```ts twoslash
+ * import { MultisigConfig } from 'ox/tempo'
+ *
+ * const config = MultisigConfig.from({
+ *   threshold: 1,
+ *   owners: [
+ *     { owner: '0x1111111111111111111111111111111111111111', weight: 1 },
+ *   ],
+ * })
+ *
+ * const address = MultisigConfig.getAddress({ config })
+ * ```
+ *
+ * @param value - The config or config ID to derive the address from.
+ * @returns The multisig account address.
+ */
+export function getAddress(value) {
+    const id = 'configId' in value ? value.configId : toId(value.config);
+    const hash = Hash.keccak256(Hex.concat(Hex.fromString(accountDomain), id));
+    return Address.from(Hex.slice(hash, 12, 32));
+}
+/**
+ * Computes the digest a native multisig owner approves (signs).
+ *
+ * `keccak256("tempo:multisig:signature" || inner_digest || account || config_id)`,
+ * where `inner_digest` is the transaction sign payload
+ * ({@link ox#TxEnvelopeTempo.(getSignPayload:function)}).
+ *
+ * @example
+ * ```ts twoslash
+ * import { MultisigConfig, TxEnvelopeTempo } from 'ox/tempo'
+ *
+ * const config = MultisigConfig.from({
+ *   threshold: 1,
+ *   owners: [
+ *     { owner: '0x1111111111111111111111111111111111111111', weight: 1 },
+ *   ],
+ * })
+ * const configId = MultisigConfig.toId(config)
+ * const account = MultisigConfig.getAddress({ configId })
+ *
+ * const envelope = TxEnvelopeTempo.from({
+ *   chainId: 1,
+ *   calls: [],
+ * })
+ *
+ * const digest = MultisigConfig.getSignPayload({
+ *   payload: TxEnvelopeTempo.getSignPayload(envelope),
+ *   account,
+ *   configId,
+ * })
+ * ```
+ *
+ * @param value - The digest derivation parameters.
+ * @returns The owner approval digest.
+ */
+export function getSignPayload(value) {
+    const { payload, account, configId } = value;
+    return Hash.keccak256(Hex.concat(Hex.fromString(signatureDomain), Hex.from(payload), account, configId));
+}
+/**
+ * Derives the permanent config ID for a native multisig
+ * {@link ox#MultisigConfig.Config}.
+ *
+ * Preimage (fixed-width big-endian, **not** RLP):
+ * `keccak256("tempo:multisig:config" || salt || be_u32(threshold) || be_u32(owners.length) || (owner || be_u32(weight)) for each owner)`.
+ *
+ * @example
+ * ```ts twoslash
+ * import { MultisigConfig } from 'ox/tempo'
+ *
+ * const config = MultisigConfig.from({
+ *   threshold: 1,
+ *   owners: [
+ *     { owner: '0x1111111111111111111111111111111111111111', weight: 1 },
+ *   ],
+ * })
+ *
+ * const configId = MultisigConfig.toId(config)
+ * ```
+ *
+ * @param config - The multisig config.
+ * @returns The 32-byte config ID.
+ */
+export function toId(config) {
+    assert(config);
+    const id = Hash.keccak256(Hex.concat(Hex.fromString(configDomain), Hex.padLeft(config.salt ?? zeroSalt, 32), Hex.fromNumber(config.threshold, { size: 4 }), Hex.fromNumber(config.owners.length, { size: 4 }), ...config.owners.flatMap((owner) => [
+        owner.owner,
+        Hex.fromNumber(owner.weight, { size: 4 }),
+    ])));
+    if (Hex.toBigInt(id) === 0n)
+        throw new InvalidConfigError({ reason: 'config ID cannot be zero' });
+    return id;
+}
+/**
+ * Converts a {@link ox#MultisigConfig.Config} to its RLP tuple form (carried
+ * by the multisig signature `init`).
+ *
+ * Tuple shape: `[salt, threshold, [[owner, weight], ...]]`. The
+ * 32-byte `salt` encodes as a full fixed-width string; other integers use
+ * canonical RLP encoding (zero values encode as `0x`).
+ *
+ * @example
+ * ```ts twoslash
+ * import { MultisigConfig } from 'ox/tempo'
+ *
+ * const tuple = MultisigConfig.toTuple({
+ *   threshold: 1,
+ *   owners: [
+ *     { owner: '0x1111111111111111111111111111111111111111', weight: 1 },
+ *   ],
+ * })
+ * ```
+ *
+ * @param config - The multisig config.
+ * @returns The RLP tuple.
+ */
+export function toTuple(config) {
+    assert(config);
+    const owners = config.owners.map((owner) => [owner.owner, Hex.fromNumber(owner.weight)]);
+    // `salt` is a fixed 32-byte value: it RLP-encodes as a full 32-byte string
+    // (including the zero salt), never trimmed like an integer.
+    const salt = config.salt ? Hex.padLeft(config.salt, 32) : zeroSalt;
+    return [salt, Hex.fromNumber(config.threshold), owners];
+}
+/**
+ * Validates a native multisig {@link ox#MultisigConfig.Config}. Returns `true`
+ * if valid, `false` otherwise.
+ *
+ * @example
+ * ```ts twoslash
+ * import { MultisigConfig } from 'ox/tempo'
+ *
+ * const valid = MultisigConfig.validate({
+ *   threshold: 1,
+ *   owners: [
+ *     { owner: '0x1111111111111111111111111111111111111111', weight: 1 },
+ *   ],
+ * })
+ * // @log: true
+ * ```
+ *
+ * @param config - The multisig config.
+ * @returns Whether the config is valid.
+ */
+export function validate(config) {
+    try {
+        assert(config);
+        return true;
+    }
+    catch {
+        return false;
+    }
+}
+/** Thrown when a native multisig config is invalid. */
+export class InvalidConfigError extends Errors.BaseError {
+    constructor({ reason }) {
+        super(`Invalid native multisig config: ${reason}.`);
+        Object.defineProperty(this, "name", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 'MultisigConfig.InvalidConfigError'
+        });
+    }
+}
+//# sourceMappingURL=MultisigConfig.js.map

package/_esm/tempo/MultisigConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MultisigConfig.js","sourceRoot":"","sources":["../../tempo/MultisigConfig.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,oBAAoB,CAAA;AAE7C,OAAO,KAAK,MAAM,MAAM,mBAAmB,CAAA;AAC3C,OAAO,KAAK,IAAI,MAAM,iBAAiB,CAAA;AACvC,OAAO,KAAK,GAAG,MAAM,gBAAgB,CAAA;AAGrC,oEAAoE;AACpE,MAAM,CAAC,MAAM,SAAS,GAAG,EAAE,CAAA;AAE3B,oEAAoE;AACpE,MAAM,CAAC,MAAM,sBAAsB,GAAG,IAAI,CAAA;AAE1C,gEAAgE;AAChE,MAAM,CAAC,MAAM,iBAAiB,GAAG,MAAe,CAAA;AAEhD,gEAAgE;AAChE,MAAM,CAAC,MAAM,QAAQ,GAAG,KAAK,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,EAAW,CAAA;AAEvD,wEAAwE;AACxE,MAAM,aAAa,GAAG,wBAAwB,CAAA;AAE9C,kEAAkE;AAClE,MAAM,YAAY,GAAG,uBAAuB,CAAA;AAE5C,yDAAyD;AACzD,MAAM,eAAe,GAAG,0BAA0B,CAAA;AAiClD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,MAAM,CAAsB,MAA0B;IACpE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;IAE1C,IAAI,OAAO,IAAI,KAAK,WAAW,IAAI,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE;QACtD,MAAM,IAAI,kBAAkB,CAAC,EAAE,MAAM,EAAE,uBAAuB,EAAE,CAAC,CAAA;IACnE,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC;QACrB,MAAM,IAAI,kBAAkB,CAAC,EAAE,MAAM,EAAE,wBAAwB,EAAE,CAAC,CAAA;IACpE,IAAI,MAAM,CAAC,MAAM,GAAG,SAAS;QAC3B,MAAM,IAAI,kBAAkB,CAAC,EAAE,MAAM,EAAE,iBAAiB,EAAE,CAAC,CAAA;IAC7D,IAAI,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC;QACvB,MAAM,IAAI,kBAAkB,CAAC,EAAE,MAAM,EAAE,0BAA0B,EAAE,CAAC,CAAA;IAEtE,IAAI,WAAW,GAAG,CAAC,CAAA;IACnB,IAAI,QAA4B,CAAA;IAChC,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE;YACpE,MAAM,IAAI,kBAAkB,CAAC,EAAE,MAAM,EAAE,sBAAsB,EAAE,CAAC,CAAA;QAClE,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC;YAC1B,MAAM,IAAI,kBAAkB,CAAC,EAAE,MAAM,EAAE,6BAA6B,EAAE,CAAC,CAAA;QAEzE,MAAM,OAAO,GAAG,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;QACzC,IAAI,OAAO,QAAQ,KAAK,WAAW,IAAI,QAAQ,IAAI,OAAO;YACxD,MAAM,IAAI,kBAAkB,CAAC;gBAC3B,MAAM,EAAE,mCAAmC;aAC5C,CAAC,CAAA;QACJ,QAAQ,GAAG,OAAO,CAAA;QAElB,WAAW,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;IACrC,CAAC;IAED,IAAI,WAAW,GAAG,UAAU;QAC1B,MAAM,IAAI,kBAAkB,CAAC;YAC3B,MAAM,EAAE,oCAAoC;SAC7C,CAAC,CAAA;IACJ,IAAI,MAAM,CAAC,SAAS,CAAC,GAAG,WAAW;QACjC,MAAM,IAAI,kBAAkB,CAAC;YAC3B,MAAM,EAAE,sCAAsC;SAC/C,CAAC,CAAA;AACN,CAAC;AAMD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,UAAU,IAAI,CAClB,MAA0B;IAE1B,MAAM,MAAM,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAC9C,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CACvD,CAAA;IACD,MAAM,UAAU,GAAG;QACjB,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ;QAC3D,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,MAAM;KACe,CAAA;IACvB,MAAM,CAAC,UAAU,CAAC,CAAA;IAClB,OAAO,UAAU,CAAA;AACnB,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,SAAS,CAAC,KAAY;IACpC,MAAM,CAAC,IAAI,EAAE,SAAS,EAAE,MAAM,CAAC,GAAG,KAAK,CAAA;IACvC,OAAO;QACL,IAAI,EAAE,IAAI,IAAI,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ;QAC9D,SAAS,EAAE,SAAS,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,SAAS,CAAC;QAC3D,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;YAC3B,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,GAAG,KAA2B,CAAA;YAC1D,OAAO;gBACL,KAAK,EAAE,YAA+B;gBACtC,MAAM,EAAE,CAAC,MAAM,IAAI,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC;aAC9D,CAAA;QACH,CAAC,CAAC;KACH,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,UAAU,CAAC,KAAuB;IAChD,MAAM,EAAE,GAAG,UAAU,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;IACpE,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE,EAAE,CAAC,CAAC,CAAA;IAC1E,OAAO,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,CAAA;AAC9C,CAAC;AAcD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAM,UAAU,cAAc,CAAC,KAA2B;IACxD,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,KAAK,CAAA;IAC5C,OAAO,IAAI,CAAC,SAAS,CACnB,GAAG,CAAC,MAAM,CACR,GAAG,CAAC,UAAU,CAAC,eAAe,CAAC,EAC/B,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,EACjB,OAAO,EACP,QAAQ,CACT,CACF,CAAA;AACH,CAAC;AAmBD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,UAAU,IAAI,CAAC,MAAc;IACjC,MAAM,CAAC,MAAM,CAAC,CAAA;IACd,MAAM,EAAE,GAAG,IAAI,CAAC,SAAS,CACvB,GAAG,CAAC,MAAM,CACR,GAAG,CAAC,UAAU,CAAC,YAAY,CAAC,EAC5B,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,IAAI,QAAQ,EAAE,EAAE,CAAC,EACxC,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,EAC7C,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,EACjD,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC;QAClC,KAAK,CAAC,KAAK;QACX,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;KAC1C,CAAC,CACH,CACF,CAAA;IACD,IAAI,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE;QACzB,MAAM,IAAI,kBAAkB,CAAC,EAAE,MAAM,EAAE,0BAA0B,EAAE,CAAC,CAAA;IACtE,OAAO,EAAE,CAAA;AACX,CAAC;AAYD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,UAAU,OAAO,CAAC,MAAc;IACpC,MAAM,CAAC,MAAM,CAAC,CAAA;IACd,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,CAC9B,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,CAAc,CACpE,CAAA;IACD,2EAA2E;IAC3E,4DAA4D;IAC5D,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAA;IAClE,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,MAAM,CAAU,CAAA;AAClE,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,QAAQ,CAAC,MAAc;IACrC,IAAI,CAAC;QACH,MAAM,CAAC,MAAM,CAAC,CAAA;QACd,OAAO,IAAI,CAAA;IACb,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAA;IACd,CAAC;AACH,CAAC;AAED,uDAAuD;AACvD,MAAM,OAAO,kBAAmB,SAAQ,MAAM,CAAC,SAAS;IAEtD,YAAY,EAAE,MAAM,EAAsB;QACxC,KAAK,CAAC,mCAAmC,MAAM,GAAG,CAAC,CAAA;QAFnC;;;;mBAAO,mCAAmC;WAAA;IAG5D,CAAC;CACF"}

package/_esm/tempo/ReceivePolicyReceipt.js

@@ -0,0 +1,176 @@
+import * as AbiEvent from '../core/AbiEvent.js';
+import * as AbiParameters from '../core/AbiParameters.js';
+/** @internal */
+const blockedReasons = ['none', 'tokenFilter', 'receivePolicy'];
+/** @internal */
+const kinds = ['transfer', 'mint'];
+/** @internal ABI parameters for the `ClaimReceiptV1` witness. */
+const parameters = [
+    {
+        type: 'tuple',
+        components: [
+            { name: 'version', type: 'uint8' },
+            { name: 'token', type: 'address' },
+            { name: 'recoveryAuthority', type: 'address' },
+            { name: 'originator', type: 'address' },
+            { name: 'recipient', type: 'address' },
+            { name: 'blockedAt', type: 'uint64' },
+            { name: 'blockedNonce', type: 'uint64' },
+            { name: 'blockedReason', type: 'uint8' },
+            { name: 'kind', type: 'uint8' },
+            { name: 'memo', type: 'bytes32' },
+        ],
+    },
+];
+/** @internal `TransferBlocked` event emitted by the `ReceivePolicyGuard`. */
+const transferBlocked = AbiEvent.from('event TransferBlocked(address indexed token, address indexed receiver, uint64 indexed blockedNonce, uint256 amount, uint8 receiptVersion, bytes receipt)');
+/**
+ * Decodes a {@link ox#ReceivePolicyReceipt.ReceivePolicyReceipt} (ABI-encoded
+ * `ClaimReceiptV1` witness) into its fields.
+ *
+ * [TIP-1028](https://docs.tempo.xyz/protocol/tips/tip-1028)
+ *
+ * @example
+ * ```ts twoslash
+ * import { ReceivePolicyReceipt } from 'ox/tempo'
+ *
+ * const decoded = ReceivePolicyReceipt.decode('0x...')
+ * ```
+ *
+ * @param receipt - The receive-policy receipt.
+ * @returns The decoded fields.
+ */
+export function decode(receipt) {
+    const [decoded] = AbiParameters.decode(parameters, receipt);
+    return {
+        version: decoded.version,
+        token: decoded.token,
+        recoveryAuthority: decoded.recoveryAuthority,
+        originator: decoded.originator,
+        recipient: decoded.recipient,
+        blockedAt: decoded.blockedAt,
+        blockedNonce: decoded.blockedNonce,
+        blockedReason: blockedReasons[decoded.blockedReason] ?? 'none',
+        kind: kinds[decoded.kind] ?? 'transfer',
+        memo: decoded.memo,
+    };
+}
+/**
+ * Encodes decoded fields into a
+ * {@link ox#ReceivePolicyReceipt.ReceivePolicyReceipt}. Inverse of `decode`.
+ *
+ * [TIP-1028](https://docs.tempo.xyz/protocol/tips/tip-1028)
+ *
+ * @example
+ * ```ts twoslash
+ * // @noErrors
+ * import { ReceivePolicyReceipt } from 'ox/tempo'
+ *
+ * const decoded = ReceivePolicyReceipt.decode('0x...')
+ * const receipt = ReceivePolicyReceipt.encode(decoded)
+ * ```
+ *
+ * @param decoded - The decoded fields.
+ * @returns The receive-policy receipt.
+ */
+export function encode(decoded) {
+    return AbiParameters.encode(parameters, [
+        {
+            version: decoded.version,
+            token: decoded.token,
+            recoveryAuthority: decoded.recoveryAuthority,
+            originator: decoded.originator,
+            recipient: decoded.recipient,
+            blockedAt: decoded.blockedAt,
+            blockedNonce: decoded.blockedNonce,
+            blockedReason: blockedReasons.indexOf(decoded.blockedReason),
+            kind: kinds.indexOf(decoded.kind),
+            memo: decoded.memo,
+        },
+    ]);
+}
+/**
+ * Normalizes a {@link ox#ReceivePolicyReceipt.ReceivePolicyReceipt} from either
+ * an encoded receipt (passthrough) or decoded fields.
+ *
+ * [TIP-1028](https://docs.tempo.xyz/protocol/tips/tip-1028)
+ *
+ * @example
+ * ```ts twoslash
+ * // @noErrors
+ * import { ReceivePolicyReceipt } from 'ox/tempo'
+ *
+ * // From an encoded receipt (passthrough).
+ * const a = ReceivePolicyReceipt.from('0x...')
+ *
+ * // From decoded fields.
+ * const b = ReceivePolicyReceipt.from(ReceivePolicyReceipt.decode('0x...'))
+ * ```
+ *
+ * @param value - An encoded receipt or decoded fields.
+ * @returns The receive-policy receipt.
+ */
+export function from(value) {
+    if (typeof value === 'string')
+        return value;
+    return encode(value);
+}
+/**
+ * Extracts the {@link ox#ReceivePolicyReceipt.ReceivePolicyReceipt} from a
+ * `ReceivePolicyGuard` `TransferBlocked` log.
+ *
+ * Throws if the log is not a `TransferBlocked` event. Use
+ * `fromTransactionReceipt` to extract every blocked transfer in a transaction
+ * (which skips unrelated logs).
+ *
+ * [TIP-1028](https://docs.tempo.xyz/protocol/tips/tip-1028)
+ *
+ * @example
+ * ```ts twoslash
+ * // @noErrors
+ * import { ReceivePolicyReceipt } from 'ox/tempo'
+ *
+ * const receipt = ReceivePolicyReceipt.fromLog(log)
+ * ```
+ *
+ * @param log - A `TransferBlocked` log (`data` & `topics`).
+ * @returns The receive-policy receipt.
+ */
+export function fromLog(log) {
+    const { receipt } = AbiEvent.decode(transferBlocked, log);
+    return receipt;
+}
+/**
+ * Extracts every {@link ox#ReceivePolicyReceipt.ReceivePolicyReceipt} from a
+ * transaction receipt's logs.
+ *
+ * A single transaction may block multiple inbound transfers (e.g. a batched
+ * transfer to several recipients), so this returns an array – one entry per
+ * `TransferBlocked` log, in log order. Returns an empty array when no transfers
+ * were blocked.
+ *
+ * [TIP-1028](https://docs.tempo.xyz/protocol/tips/tip-1028)
+ *
+ * @example
+ * ```ts twoslash
+ * // @noErrors
+ * import { ReceivePolicyReceipt } from 'ox/tempo'
+ *
+ * const receipts = ReceivePolicyReceipt.fromTransactionReceipt(receipt)
+ * // @log: ['0x...'] (pass each to `claim` / `burn`)
+ * ```
+ *
+ * @param receipt - The transaction receipt (or any object with `logs`).
+ * @returns The receive-policy receipts, one per blocked transfer.
+ */
+export function fromTransactionReceipt(receipt) {
+    const selector = AbiEvent.getSelector(transferBlocked);
+    const receipts = [];
+    for (const log of receipt.logs ?? []) {
+        if (log.topics[0] !== selector)
+            continue;
+        receipts.push(fromLog(log));
+    }
+    return receipts;
+}
+//# sourceMappingURL=ReceivePolicyReceipt.js.map

package/_esm/tempo/ReceivePolicyReceipt.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ReceivePolicyReceipt.js","sourceRoot":"","sources":["../../tempo/ReceivePolicyReceipt.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,QAAQ,MAAM,qBAAqB,CAAA;AAC/C,OAAO,KAAK,aAAa,MAAM,0BAA0B,CAAA;AA+CzD,gBAAgB;AAChB,MAAM,cAAc,GAAG,CAAC,MAAM,EAAE,aAAa,EAAE,eAAe,CAAU,CAAA;AAExE,gBAAgB;AAChB,MAAM,KAAK,GAAG,CAAC,UAAU,EAAE,MAAM,CAAU,CAAA;AAE3C,iEAAiE;AACjE,MAAM,UAAU,GAAG;IACjB;QACE,IAAI,EAAE,OAAO;QACb,UAAU,EAAE;YACV,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,EAAE;YAClC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE;YAClC,EAAE,IAAI,EAAE,mBAAmB,EAAE,IAAI,EAAE,SAAS,EAAE;YAC9C,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,SAAS,EAAE;YACvC,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,SAAS,EAAE;YACtC,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,EAAE;YACrC,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,QAAQ,EAAE;YACxC,EAAE,IAAI,EAAE,eAAe,EAAE,IAAI,EAAE,OAAO,EAAE;YACxC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE;YAC/B,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE;SAClC;KACF;CACO,CAAA;AAEV,6EAA6E;AAC7E,MAAM,eAAe,GAAG,QAAQ,CAAC,IAAI,CACnC,0JAA0J,CAC3J,CAAA;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,MAAM,CAAC,OAA6B;IAClD,MAAM,CAAC,OAAO,CAAC,GAAG,aAAa,CAAC,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,CAAA;IAC3D,OAAO;QACL,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,iBAAiB,EAAE,OAAO,CAAC,iBAAiB;QAC5C,UAAU,EAAE,OAAO,CAAC,UAAU;QAC9B,SAAS,EAAE,OAAO,CAAC,SAAS;QAC5B,SAAS,EAAE,OAAO,CAAC,SAAS;QAC5B,YAAY,EAAE,OAAO,CAAC,YAAY;QAClC,aAAa,EAAE,cAAc,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,MAAM;QAC9D,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,UAAU;QACvC,IAAI,EAAE,OAAO,CAAC,IAAI;KACnB,CAAA;AACH,CAAC;AAMD;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,MAAM,CAAC,OAAgB;IACrC,OAAO,aAAa,CAAC,MAAM,CAAC,UAAU,EAAE;QACtC;YACE,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,iBAAiB,EAAE,OAAO,CAAC,iBAAiB;YAC5C,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,YAAY,EAAE,OAAO,CAAC,YAAY;YAClC,aAAa,EAAE,cAAc,CAAC,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC;YAC5D,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC;YACjC,IAAI,EAAE,OAAO,CAAC,IAAI;SACnB;KACF,CAAC,CAAA;AACJ,CAAC;AAMD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,UAAU,IAAI,CAClB,KAAqC;IAErC,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAA;IAC3C,OAAO,MAAM,CAAC,KAAK,CAAC,CAAA;AACtB,CAAC;AAMD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,UAAU,OAAO,CAAC,GAAgB;IACtC,MAAM,EAAE,OAAO,EAAE,GAAG,QAAQ,CAAC,MAAM,CAAC,eAAe,EAAE,GAAG,CAAC,CAAA;IACzD,OAAO,OAAO,CAAA;AAChB,CAAC;AAQD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,UAAU,sBAAsB,CACpC,OAAuC;IAEvC,MAAM,QAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,eAAe,CAAC,CAAA;IACtD,MAAM,QAAQ,GAA2B,EAAE,CAAA;IAC3C,KAAK,MAAM,GAAG,IAAI,OAAO,CAAC,IAAI,IAAI,EAAE,EAAE,CAAC;QACrC,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,QAAQ;YAAE,SAAQ;QACxC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAA;IAC7B,CAAC;IACD,OAAO,QAAQ,CAAA;AACjB,CAAC"}