@avow-finance/verifier 0.0.0-stage → 0.1.0

package/dist/chain.d.ts

@@ -0,0 +1,160 @@
+import { type Charge, type ChargeKind, type LockTiming, type ObservedTransfer, type RailState, type Side } from '@avow-finance/spec';
+import type { Address, Hex } from 'viem';
+/** What a lock stores for one side of a commitment. */
+export interface LockedBacking {
+    state: RailState;
+    /** The lock's one token. */
+    token: Address;
+    /** Base units of the token, as funded. */
+    amount: bigint;
+    /** What the lock still holds for the commitment, less any part already returned or paid. */
+    held: bigint;
+    /** The supplier's payout address, copied from the approval. */
+    payee: Address;
+    /** The supplier's account, which consents to releases. */
+    supplier: Address;
+    /** The supplier's signing key, which accepts the reserve and reports charges. */
+    supplierSigner: Address;
+    freeCancelBy: bigint;
+    acceptBy: bigint;
+    chargeDeadline: bigint;
+    contestWindow: bigint;
+    releaseDate: bigint;
+    charges: readonly Charge[];
+    day90SupplierShareBps: number;
+    arbiter: Address;
+    termsHash: Hex;
+    mandateHash: Hex;
+    /** The digest of Avow's approval the lock took, which the supplier's acceptance names. */
+    approvalHash: Hex;
+    /** The key that funded the reserve, or the zero address when the account's root key did. */
+    fundingKey: Address;
+    /** Every report ever filed on the commitment, which a release consent names. */
+    reportCount: number;
+    /** The kind of charge the latest report names, or null before any report is filed. */
+    reportKind: ChargeKind | null;
+    /** The latest report's amount in base units of the token, or zero before any report is filed. */
+    reportAmount: bigint;
+    /**
+     * Whether a report stands on the commitment, filed and not withdrawn. The lock takes no other
+     * report while one does, and on an accepted commitment it's open, waiting for Avow's answer.
+     */
+    hasReport: boolean;
+    /**
+     * Whether the business has contested a charge on the commitment. The contest stays on record
+     * when the supplier withdraws the report, so the lock takes no second one, and a later report
+     * pauses at once.
+     */
+    contested: boolean;
+    /** When a confirmed charge became pending and its contest window opened, or zero if one never did. */
+    chargeStart: bigint;
+    /** When the charge paused, which days 30 and 90 count from, or zero if it never paused. */
+    pausedAt: bigint;
+    /** Whether a ruling has been posted on the commitment. */
+    hasRuling: boolean;
+}
+/** A contest a lock logged, as the `Paused` event its contest wrote shows it. */
+export interface ObservedContest {
+    commitmentId: Hex;
+    side: Side;
+    /** The reason's code, which `contestReasonOf` reads as one of the six reasons or as none. */
+    reasonCode: number;
+    /** The hash of the business's statement, which the event logs as its `evidenceHash`. */
+    statementHash: Hex;
+    /** When the lock paused the charge, which days 30 and 90 count from. */
+    pausedAt: bigint;
+}
+/** A contest read from the chain, with where it landed and the report it named. */
+export interface ContestOnChain extends ObservedContest {
+    /** The block the contest landed in. */
+    blockNumber: bigint;
+    /**
+     * Whether that block is at or below the chain's finalized block and is the chain's block at its
+     * height, so no reorganization can drop the contest.
+     */
+    finalized: boolean;
+    /**
+     * The report the contest named, as the lock held it at the end of the contest's block: its
+     * number, which the lock checked the contest against, its kind and its amount in base units.
+     */
+    report: {
+        number: number;
+        kind: ChargeKind;
+        amount: bigint;
+    };
+}
+/** The most reports a lock takes for one commitment, which the spec defines for every package. */
+export { MAX_REPORTS } from '@avow-finance/spec';
+export interface LockInfo {
+    /** True when Avow's factory, as the reader was set up with it, created the lock. */
+    fromFactory: boolean;
+    /** The business account that owns the lock. */
+    account: Address;
+    /** The token the lock holds reserves in. */
+    token: Address;
+    /** The timing the factory fixed in the lock. */
+    timing: LockTiming;
+}
+export interface AgentKeyInfo {
+    /** False once the key is revoked. */
+    active: boolean;
+    /** When the key stops working, or null when it doesn't expire. */
+    expiry: bigint | null;
+    /** The mandate hash bound into the key's authorization, or null when there is none. */
+    witness: Hex | null;
+}
+/**
+ * Everything the verifier reads from the chain. Nothing here comes from Avow, so a supplier's
+ * check doesn't depend on Avow's database. `tempoChainReader` reads Tempo, and `MemoryChain` stands
+ * in for it in tests. A supplier trusts whichever node it reads through, so it picks that node.
+ */
+export interface ChainReader {
+    readonly chainId: number;
+    lock(lock: Address): Promise<LockInfo | null>;
+    backing(lock: Address, commitmentId: Hex, side: Side): Promise<LockedBacking | null>;
+    /**
+     * A key on an account, with the mandate hash logged in the transaction that authorized it.
+     * Returns null when the account has no such key.
+     */
+    agentKey(account: Address, key: Address, authorizedIn: Hex): Promise<AgentKeyInfo | null>;
+    /**
+     * Whether the account's root key or one of its admin keys signed the digest, in the keychain
+     * envelope Tempo requires. On Tempo this asks the chain's own signature verifier.
+     */
+    isAccountSignature(account: Address, digest: Hex, signature: Hex): Promise<boolean>;
+    /**
+     * The log at one index of one transaction, decoded as a TIP-20 `TransferWithMemo` event when it
+     * is one, with whether the transaction succeeded and whether its block is finalized. Returns
+     * null when the chain has no such transaction or log. Nothing is read from calldata.
+     */
+    transfer(transactionHash: Hex, logIndex: number): Promise<ObservedTransfer | null>;
+    /**
+     * The contest of one side of a commitment that one transaction carried, from the `Paused` event
+     * the lock logged with a contest as its cause, with whether its block is final and the report it
+     * named. Returns null when the chain has no such transaction, when it failed, or when it holds no
+     * contest of that side from that lock.
+     */
+    contest(lock: Address, commitmentId: Hex, side: Side, transactionHash: Hex): Promise<ContestOnChain | null>;
+}
+/** A chain reader held in memory, for tests and dry runs. */
+export declare class MemoryChain implements ChainReader {
+    #private;
+    readonly chainId: number;
+    constructor(chainId: number);
+    setLock(lock: Address, info: LockInfo): void;
+    setBacking(lock: Address, commitmentId: Hex, side: Side, backing: LockedBacking | null): void;
+    /** Records a key. With `authorizedIn`, the witness reads back only for that transaction. */
+    setAgentKey(account: Address, key: Address, info: AgentKeyInfo, authorizedIn?: Hex): void;
+    /** Records what the chain holds at one log index of one transaction. */
+    setTransfer(seen: ObservedTransfer): void;
+    /** Records a contest a successful transaction carried to a lock. */
+    setContest(lock: Address, transactionHash: Hex, contest: ContestOnChain): void;
+    addAdminKey(account: Address, key: Address): void;
+    lock(lock: Address): Promise<LockInfo | null>;
+    backing(lock: Address, commitmentId: Hex, side: Side): Promise<LockedBacking | null>;
+    agentKey(account: Address, key: Address, authorizedIn: Hex): Promise<AgentKeyInfo | null>;
+    isAccountSignature(account: Address, digest: Hex, signature: Hex): Promise<boolean>;
+    transfer(transactionHash: Hex, logIndex: number): Promise<ObservedTransfer | null>;
+    contest(lock: Address, commitmentId: Hex, side: Side, transactionHash: Hex): Promise<ContestOnChain | null>;
+}
+//# sourceMappingURL=chain.d.ts.map

package/dist/chain.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"chain.d.ts","sourceRoot":"","sources":["../src/chain.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,MAAM,EACX,KAAK,UAAU,EAEf,KAAK,UAAU,EACf,KAAK,gBAAgB,EACrB,KAAK,SAAS,EACd,KAAK,IAAI,EACV,MAAM,oBAAoB,CAAA;AAC3B,OAAO,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,MAAM,CAAA;AAExC,uDAAuD;AACvD,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,SAAS,CAAA;IAChB,4BAA4B;IAC5B,KAAK,EAAE,OAAO,CAAA;IACd,0CAA0C;IAC1C,MAAM,EAAE,MAAM,CAAA;IACd,4FAA4F;IAC5F,IAAI,EAAE,MAAM,CAAA;IACZ,+DAA+D;IAC/D,KAAK,EAAE,OAAO,CAAA;IACd,0DAA0D;IAC1D,QAAQ,EAAE,OAAO,CAAA;IACjB,iFAAiF;IACjF,cAAc,EAAE,OAAO,CAAA;IACvB,YAAY,EAAE,MAAM,CAAA;IACpB,QAAQ,EAAE,MAAM,CAAA;IAChB,cAAc,EAAE,MAAM,CAAA;IACtB,aAAa,EAAE,MAAM,CAAA;IACrB,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,EAAE,SAAS,MAAM,EAAE,CAAA;IAC1B,qBAAqB,EAAE,MAAM,CAAA;IAC7B,OAAO,EAAE,OAAO,CAAA;IAChB,SAAS,EAAE,GAAG,CAAA;IACd,WAAW,EAAE,GAAG,CAAA;IAChB,0FAA0F;IAC1F,YAAY,EAAE,GAAG,CAAA;IACjB,4FAA4F;IAC5F,UAAU,EAAE,OAAO,CAAA;IACnB,gFAAgF;IAChF,WAAW,EAAE,MAAM,CAAA;IACnB,sFAAsF;IACtF,UAAU,EAAE,UAAU,GAAG,IAAI,CAAA;IAC7B,iGAAiG;IACjG,YAAY,EAAE,MAAM,CAAA;IACpB;;;OAGG;IACH,SAAS,EAAE,OAAO,CAAA;IAClB;;;;OAIG;IACH,SAAS,EAAE,OAAO,CAAA;IAClB,sGAAsG;IACtG,WAAW,EAAE,MAAM,CAAA;IACnB,2FAA2F;IAC3F,QAAQ,EAAE,MAAM,CAAA;IAChB,0DAA0D;IAC1D,SAAS,EAAE,OAAO,CAAA;CACnB;AAED,iFAAiF;AACjF,MAAM,WAAW,eAAe;IAC9B,YAAY,EAAE,GAAG,CAAA;IACjB,IAAI,EAAE,IAAI,CAAA;IACV,6FAA6F;IAC7F,UAAU,EAAE,MAAM,CAAA;IAClB,wFAAwF;IACxF,aAAa,EAAE,GAAG,CAAA;IAClB,wEAAwE;IACxE,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED,mFAAmF;AACnF,MAAM,WAAW,cAAe,SAAQ,eAAe;IACrD,uCAAuC;IACvC,WAAW,EAAE,MAAM,CAAA;IACnB;;;OAGG;IACH,SAAS,EAAE,OAAO,CAAA;IAClB;;;OAGG;IACH,MAAM,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,UAAU,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAA;CAC7D;AAED,kGAAkG;AAClG,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AAEhD,MAAM,WAAW,QAAQ;IACvB,oFAAoF;IACpF,WAAW,EAAE,OAAO,CAAA;IACpB,+CAA+C;IAC/C,OAAO,EAAE,OAAO,CAAA;IAChB,4CAA4C;IAC5C,KAAK,EAAE,OAAO,CAAA;IACd,gDAAgD;IAChD,MAAM,EAAE,UAAU,CAAA;CACnB;AAED,MAAM,WAAW,YAAY;IAC3B,qCAAqC;IACrC,MAAM,EAAE,OAAO,CAAA;IACf,kEAAkE;IAClE,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,uFAAuF;IACvF,OAAO,EAAE,GAAG,GAAG,IAAI,CAAA;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB,IAAI,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC,CAAA;IAC7C,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,YAAY,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC,CAAA;IACpF;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,YAAY,EAAE,GAAG,GAAG,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC,CAAA;IACzF;;;OAGG;IACH,kBAAkB,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IACnF;;;;OAIG;IACH,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,GAAG,IAAI,CAAC,CAAA;IAClF;;;;;OAKG;IACH,OAAO,CACL,IAAI,EAAE,OAAO,EACb,YAAY,EAAE,GAAG,EACjB,IAAI,EAAE,IAAI,EACV,eAAe,EAAE,GAAG,GACnB,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC,CAAA;CAClC;AAED,6DAA6D;AAC7D,qBAAa,WAAY,YAAW,WAAW;;IAWjC,QAAQ,CAAC,OAAO,EAAE,MAAM;IAApC,YAAqB,OAAO,EAAE,MAAM,EAAI;IAExC,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,GAAG,IAAI,CAE3C;IAED,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,YAAY,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,aAAa,GAAG,IAAI,GAAG,IAAI,CAI5F;IAED,4FAA4F;IAC5F,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,YAAY,CAAC,EAAE,GAAG,GAAG,IAAI,CAKxF;IAED,wEAAwE;IACxE,WAAW,CAAC,IAAI,EAAE,gBAAgB,GAAG,IAAI,CAExC;IAED,oEAAoE;IACpE,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,eAAe,EAAE,GAAG,EAAE,OAAO,EAAE,cAAc,GAAG,IAAI,CAG7E;IAED,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,GAAG,IAAI,CAEhD;IAEK,IAAI,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC,CAElD;IAEK,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,YAAY,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC,CAEzF;IAEK,QAAQ,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,YAAY,EAAE,GAAG,GAAG,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC,CAM9F;IAEK,kBAAkB,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,CAExF;IAEK,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,GAAG,IAAI,CAAC,CAEvF;IAEK,OAAO,CACX,IAAI,EAAE,OAAO,EACb,YAAY,EAAE,GAAG,EACjB,IAAI,EAAE,IAAI,EACV,eAAe,EAAE,GAAG,GACnB,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC,CAEhC;CACF"}

package/dist/chain.js

@@ -0,0 +1,72 @@
+import { keychainSignatureCheck, } from '@avow-finance/spec';
+/** The most reports a lock takes for one commitment, which the spec defines for every package. */
+export { MAX_REPORTS } from '@avow-finance/spec';
+/** A chain reader held in memory, for tests and dry runs. */
+export class MemoryChain {
+    chainId;
+    #locks = new Map();
+    #backings = new Map();
+    #keys = new Map();
+    #admins = new Set();
+    #transfers = new Map();
+    #contests = new Map();
+    #check = keychainSignatureCheck((account, key) => this.#admins.has(`${account.toLowerCase()}:${key.toLowerCase()}`));
+    constructor(chainId) {
+        this.chainId = chainId;
+    }
+    setLock(lock, info) {
+        this.#locks.set(lock.toLowerCase(), info);
+    }
+    setBacking(lock, commitmentId, side, backing) {
+        const key = `${lock.toLowerCase()}:${commitmentId.toLowerCase()}:${side}`;
+        if (backing)
+            this.#backings.set(key, backing);
+        else
+            this.#backings.delete(key);
+    }
+    /** Records a key. With `authorizedIn`, the witness reads back only for that transaction. */
+    setAgentKey(account, key, info, authorizedIn) {
+        this.#keys.set(`${account.toLowerCase()}:${key.toLowerCase()}`, {
+            ...info,
+            authorizedIn: authorizedIn ?? null,
+        });
+    }
+    /** Records what the chain holds at one log index of one transaction. */
+    setTransfer(seen) {
+        this.#transfers.set(`${seen.transactionHash.toLowerCase()}:${seen.logIndex}`, seen);
+    }
+    /** Records a contest a successful transaction carried to a lock. */
+    setContest(lock, transactionHash, contest) {
+        const { commitmentId, side } = contest;
+        this.#contests.set(contestKey(lock, commitmentId, side, transactionHash), contest);
+    }
+    addAdminKey(account, key) {
+        this.#admins.add(`${account.toLowerCase()}:${key.toLowerCase()}`);
+    }
+    async lock(lock) {
+        return this.#locks.get(lock.toLowerCase()) ?? null;
+    }
+    async backing(lock, commitmentId, side) {
+        return this.#backings.get(`${lock.toLowerCase()}:${commitmentId.toLowerCase()}:${side}`) ?? null;
+    }
+    async agentKey(account, key, authorizedIn) {
+        const stored = this.#keys.get(`${account.toLowerCase()}:${key.toLowerCase()}`);
+        if (!stored)
+            return null;
+        const { authorizedIn: tx, ...info } = stored;
+        const sameTx = tx === null || tx.toLowerCase() === authorizedIn.toLowerCase();
+        return sameTx ? info : { ...info, witness: null };
+    }
+    async isAccountSignature(account, digest, signature) {
+        return this.#check({ signer: account, digest, signature });
+    }
+    async transfer(transactionHash, logIndex) {
+        return this.#transfers.get(`${transactionHash.toLowerCase()}:${logIndex}`) ?? null;
+    }
+    async contest(lock, commitmentId, side, transactionHash) {
+        return this.#contests.get(contestKey(lock, commitmentId, side, transactionHash)) ?? null;
+    }
+}
+/** One side of one commitment's contest in one transaction to one lock, as a map's key. */
+const contestKey = (lock, commitmentId, side, transactionHash) => `${lock.toLowerCase()}:${commitmentId.toLowerCase()}:${side}:${transactionHash.toLowerCase()}`;
+//# sourceMappingURL=chain.js.map

package/dist/chain.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"chain.js","sourceRoot":"","sources":["../src/chain.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,sBAAsB,GAKvB,MAAM,oBAAoB,CAAA;AAqF3B,kGAAkG;AAClG,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AA6DhD,6DAA6D;AAC7D,MAAM,OAAO,WAAW;IAWD,OAAO;IAVnB,MAAM,GAAG,IAAI,GAAG,EAAoB,CAAA;IACpC,SAAS,GAAG,IAAI,GAAG,EAAyB,CAAA;IAC5C,KAAK,GAAG,IAAI,GAAG,EAAuD,CAAA;IACtE,OAAO,GAAG,IAAI,GAAG,EAAU,CAAA;IAC3B,UAAU,GAAG,IAAI,GAAG,EAA4B,CAAA;IAChD,SAAS,GAAG,IAAI,GAAG,EAA0B,CAAA;IAC7C,MAAM,GAAG,sBAAsB,CAAC,CAAC,OAAO,EAAE,GAAG,EAAE,EAAE,CACxD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,WAAW,EAAE,IAAI,GAAG,CAAC,WAAW,EAAE,EAAE,CAAC,CAClE,CAAA;IAED,YAAqB,OAAe;uBAAf,OAAO;IAAW,CAAC;IAExC,OAAO,CAAC,IAAa,EAAE,IAAc;QACnC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,CAAC,CAAA;IAC3C,CAAC;IAED,UAAU,CAAC,IAAa,EAAE,YAAiB,EAAE,IAAU,EAAE,OAA6B;QACpF,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,WAAW,EAAE,IAAI,YAAY,CAAC,WAAW,EAAE,IAAI,IAAI,EAAE,CAAA;QACzE,IAAI,OAAO;YAAE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;;YACxC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;IACjC,CAAC;IAED,4FAA4F;IAC5F,WAAW,CAAC,OAAgB,EAAE,GAAY,EAAE,IAAkB,EAAE,YAAkB;QAChF,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,WAAW,EAAE,IAAI,GAAG,CAAC,WAAW,EAAE,EAAE,EAAE;YAC9D,GAAG,IAAI;YACP,YAAY,EAAE,YAAY,IAAI,IAAI;SACnC,CAAC,CAAA;IACJ,CAAC;IAED,wEAAwE;IACxE,WAAW,CAAC,IAAsB;QAChC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,eAAe,CAAC,WAAW,EAAE,IAAI,IAAI,CAAC,QAAQ,EAAE,EAAE,IAAI,CAAC,CAAA;IACrF,CAAC;IAED,oEAAoE;IACpE,UAAU,CAAC,IAAa,EAAE,eAAoB,EAAE,OAAuB;QACrE,MAAM,EAAE,YAAY,EAAE,IAAI,EAAE,GAAG,OAAO,CAAA;QACtC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,eAAe,CAAC,EAAE,OAAO,CAAC,CAAA;IACpF,CAAC;IAED,WAAW,CAAC,OAAgB,EAAE,GAAY;QACxC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,WAAW,EAAE,IAAI,GAAG,CAAC,WAAW,EAAE,EAAE,CAAC,CAAA;IACnE,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,IAAa;QACtB,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,IAAI,IAAI,CAAA;IACpD,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,IAAa,EAAE,YAAiB,EAAE,IAAU;QACxD,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,WAAW,EAAE,IAAI,YAAY,CAAC,WAAW,EAAE,IAAI,IAAI,EAAE,CAAC,IAAI,IAAI,CAAA;IAClG,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,OAAgB,EAAE,GAAY,EAAE,YAAiB;QAC9D,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,WAAW,EAAE,IAAI,GAAG,CAAC,WAAW,EAAE,EAAE,CAAC,CAAA;QAC9E,IAAI,CAAC,MAAM;YAAE,OAAO,IAAI,CAAA;QACxB,MAAM,EAAE,YAAY,EAAE,EAAE,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAA;QAC5C,MAAM,MAAM,GAAG,EAAE,KAAK,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,KAAK,YAAY,CAAC,WAAW,EAAE,CAAA;QAC7E,OAAO,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAA;IACnD,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAC,OAAgB,EAAE,MAAW,EAAE,SAAc;QACpE,OAAO,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAA;IAC5D,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,eAAoB,EAAE,QAAgB;QACnD,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,eAAe,CAAC,WAAW,EAAE,IAAI,QAAQ,EAAE,CAAC,IAAI,IAAI,CAAA;IACpF,CAAC;IAED,KAAK,CAAC,OAAO,CACX,IAAa,EACb,YAAiB,EACjB,IAAU,EACV,eAAoB;QAEpB,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,eAAe,CAAC,CAAC,IAAI,IAAI,CAAA;IAC1F,CAAC;CACF;AAED,2FAA2F;AAC3F,MAAM,UAAU,GAAG,CAAC,IAAa,EAAE,YAAiB,EAAE,IAAU,EAAE,eAAoB,EAAE,EAAE,CACxF,GAAG,IAAI,CAAC,WAAW,EAAE,IAAI,YAAY,CAAC,WAAW,EAAE,IAAI,IAAI,IAAI,eAAe,CAAC,WAAW,EAAE,EAAE,CAAA"}

package/dist/consent.d.ts

@@ -0,0 +1,69 @@
+import { type AvowDomain, type HashSigner, type RailToken, type ReasonCode, type ReleaseConsent, type ReleaseReason, type Signed } from '@avow-finance/spec';
+import { type Address, type Hex } from 'viem';
+import { type ChainReader } from './chain.js';
+import { type Disclosure } from './disclosure.js';
+export interface ConsentConfig {
+    chainId: number;
+    /** The supplier's account, whose root key or admin key signs the consent. */
+    account: Address;
+    /** Tokens the supplier accepts, used to show the amount the consent releases. */
+    acceptedTokens: readonly RailToken[];
+}
+export interface ConsentDeps {
+    config: ConsentConfig;
+    chain: ChainReader;
+}
+export interface ReleaseConsentRequest {
+    lock: Address;
+    commitmentId: Hex;
+    reason: ReleaseReason;
+    evidenceHash: Hex;
+    /**
+     * The report count the consent names, the commitment's current count when left out. A later
+     * count makes the consent a preauthorization, which the signer has to confirm.
+     */
+    reportCount?: number;
+    /** When the consent stops working. A supplier keeps its consents short. */
+    expiry: bigint;
+    now: bigint;
+    /** The consent's nonce, a fresh random one when left out. */
+    nonce?: bigint;
+}
+export interface ReadyReleaseConsent {
+    ok: true;
+    consent: ReleaseConsent;
+    domain: AvowDomain;
+    /** The digest the supplier account signs, in Tempo's keychain envelope. */
+    digest: Hex;
+    /** The account that has to sign, the supplier's own. */
+    supplierAccount: Address;
+    /** What to show the person who approves the signature, before signing. */
+    disclosure: Disclosure;
+}
+export type PreparedReleaseConsent = ReadyReleaseConsent | {
+    ok: false;
+    reason: ReasonCode;
+};
+/**
+ * The supported way for a supplier account to get a release consent to sign. It reads the
+ * commitment from the lock and refuses a commitment that isn't this supplier's, one the lock
+ * wouldn't release on consent, a consent that has already expired, and a report count the
+ * commitment has passed or can never reach. A count above the current one is preauthorization,
+ * and the disclosure says so. What it returns is frozen, and `signReleaseConsent` signs nothing
+ * else. The lock takes a correctly signed consent however it was built.
+ */
+export declare function prepareReleaseConsent(request: ReleaseConsentRequest, deps: ConsentDeps): Promise<PreparedReleaseConsent>;
+/**
+ * Signs a consent as the supplier account, with its root key or an admin key, once the person has
+ * seen its disclosure. A consent that names a later report count than the commitment has also
+ * needs `preauthorize: true`. It signs only the object `prepareReleaseConsent` returned, which is
+ * frozen, so a copy or an edit of it throws. It also throws when the confirmation doesn't match,
+ * or when the signature isn't one the chain accepts for the supplier account.
+ */
+export declare function signReleaseConsent(prepared: ReadyReleaseConsent, key: HashSigner, confirmation: {
+    disclosureId: Hex;
+    preauthorize?: boolean;
+}, deps: {
+    chain: ChainReader;
+}): Promise<Signed<ReleaseConsent>>;
+//# sourceMappingURL=consent.d.ts.map

package/dist/consent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"consent.d.ts","sourceRoot":"","sources":["../src/consent.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,UAAU,EAEf,KAAK,UAAU,EACf,KAAK,SAAS,EAEd,KAAK,UAAU,EACf,KAAK,cAAc,EACnB,KAAK,aAAa,EAElB,KAAK,MAAM,EAGZ,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EAAE,KAAK,OAAO,EAAE,KAAK,GAAG,EAA+B,MAAM,MAAM,CAAA;AAC1E,OAAO,EAAE,KAAK,WAAW,EAAe,MAAM,YAAY,CAAA;AAC1D,OAAO,EAAE,KAAK,UAAU,EAAyC,MAAM,iBAAiB,CAAA;AAKxF,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,MAAM,CAAA;IACf,6EAA6E;IAC7E,OAAO,EAAE,OAAO,CAAA;IAChB,iFAAiF;IACjF,cAAc,EAAE,SAAS,SAAS,EAAE,CAAA;CACrC;AAED,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,aAAa,CAAA;IACrB,KAAK,EAAE,WAAW,CAAA;CACnB;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,OAAO,CAAA;IACb,YAAY,EAAE,GAAG,CAAA;IACjB,MAAM,EAAE,aAAa,CAAA;IACrB,YAAY,EAAE,GAAG,CAAA;IACjB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,2EAA2E;IAC3E,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,MAAM,CAAA;IACX,6DAA6D;IAC7D,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,mBAAmB;IAClC,EAAE,EAAE,IAAI,CAAA;IACR,OAAO,EAAE,cAAc,CAAA;IACvB,MAAM,EAAE,UAAU,CAAA;IAClB,2EAA2E;IAC3E,MAAM,EAAE,GAAG,CAAA;IACX,wDAAwD;IACxD,eAAe,EAAE,OAAO,CAAA;IACxB,0EAA0E;IAC1E,UAAU,EAAE,UAAU,CAAA;CACvB;AAED,MAAM,MAAM,sBAAsB,GAAG,mBAAmB,GAAG;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,MAAM,EAAE,UAAU,CAAA;CAAE,CAAA;AAE5F;;;;;;;GAOG;AACH,wBAAsB,qBAAqB,CACzC,OAAO,EAAE,qBAAqB,EAC9B,IAAI,EAAE,WAAW,GAChB,OAAO,CAAC,sBAAsB,CAAC,CAyDjC;AAED;;;;;;GAMG;AACH,wBAAsB,kBAAkB,CACtC,QAAQ,EAAE,mBAAmB,EAC7B,GAAG,EAAE,UAAU,EACf,YAAY,EAAE;IAAE,YAAY,EAAE,GAAG,CAAC;IAAC,YAAY,CAAC,EAAE,OAAO,CAAA;CAAE,EAC3D,IAAI,EAAE;IAAE,KAAK,EAAE,WAAW,CAAA;CAAE,GAC3B,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAgBjC"}

package/dist/consent.js

@@ -0,0 +1,98 @@
+import { digestOf, RELEASE_REASONS, releaseConsentTypedData, signForAccount, takesConsent, } from '@avow-finance/spec';
+import { isAddressEqual, isHex, size } from 'viem';
+import { MAX_REPORTS } from './chain.js';
+import { listedToken, releaseConsentDisclosure } from './disclosure.js';
+import { issue } from './issued.js';
+import { randomNonce } from './nonce.js';
+import { checkPrepared, signedMessage } from './signing.js';
+/**
+ * The supported way for a supplier account to get a release consent to sign. It reads the
+ * commitment from the lock and refuses a commitment that isn't this supplier's, one the lock
+ * wouldn't release on consent, a consent that has already expired, and a report count the
+ * commitment has passed or can never reach. A count above the current one is preauthorization,
+ * and the disclosure says so. What it returns is frozen, and `signReleaseConsent` signs nothing
+ * else. The lock takes a correctly signed consent however it was built.
+ */
+export async function prepareReleaseConsent(request, deps) {
+    const { config, chain } = deps;
+    if (chain.chainId !== config.chainId) {
+        throw new Error(`The chain reader is for chain ${chain.chainId}, not ${config.chainId}`);
+    }
+    const refuse = (reason) => ({ ok: false, reason });
+    if (!Object.hasOwn(RELEASE_REASONS, request.reason) ||
+        !isHex(request.evidenceHash) ||
+        size(request.evidenceHash) !== 32) {
+        return refuse('message.invalid');
+    }
+    const lockInfo = await chain.lock(request.lock);
+    if (!lockInfo?.fromFactory)
+        return refuse('chain.lock_unknown');
+    const b = await chain.backing(request.lock, request.commitmentId, 'buyer');
+    if (!b || b.state === 'none')
+        return refuse('chain.reserve_missing');
+    if (!isAddressEqual(b.supplier, config.account))
+        return refuse('chain.supplier_mismatch');
+    const releasable = takesConsent(b.state) && !(b.state === 'paused' && b.hasRuling);
+    if (!releasable)
+        return refuse('consent.not_releasable');
+    if (request.expiry <= request.now)
+        return refuse('message.expired');
+    const count = request.reportCount ?? b.reportCount;
+    if (!Number.isInteger(count) || count < 0 || count > MAX_REPORTS) {
+        return refuse('consent.count_out_of_range');
+    }
+    if (count < b.reportCount)
+        return refuse('consent.count_passed');
+    const consent = {
+        commitmentId: request.commitmentId,
+        side: 'buyer',
+        reportCount: count,
+        reason: request.reason,
+        evidenceHash: request.evidenceHash,
+        nonce: request.nonce ?? randomNonce(),
+        expiry: request.expiry,
+    };
+    const d = { chainId: config.chainId, verifyingContract: request.lock };
+    const digest = digestOf(releaseConsentTypedData(consent, d));
+    return issue({
+        ok: true,
+        consent,
+        domain: d,
+        digest,
+        supplierAccount: config.account,
+        disclosure: releaseConsentDisclosure({
+            digest,
+            consent,
+            lock: request.lock,
+            chainId: config.chainId,
+            account: lockInfo.account,
+            held: b.held,
+            token: listedToken(config.acceptedTokens, config.chainId, lockInfo.token),
+            currentCount: b.reportCount,
+            now: request.now,
+        }),
+    });
+}
+/**
+ * Signs a consent as the supplier account, with its root key or an admin key, once the person has
+ * seen its disclosure. A consent that names a later report count than the commitment has also
+ * needs `preauthorize: true`. It signs only the object `prepareReleaseConsent` returned, which is
+ * frozen, so a copy or an edit of it throws. It also throws when the confirmation doesn't match,
+ * or when the signature isn't one the chain accepts for the supplier account.
+ */
+export async function signReleaseConsent(prepared, key, confirmation, deps) {
+    const typedData = releaseConsentTypedData(prepared.consent, prepared.domain);
+    const digest = checkPrepared(prepared, typedData, confirmation, {
+        message: 'consent',
+        prepare: 'prepareReleaseConsent',
+    });
+    if (prepared.disclosure.preauthorization && confirmation?.preauthorize !== true) {
+        throw new Error('This consent names a later report count than the commitment has, so it releases the reserve after a report not yet filed. Pass preauthorize: true only if the person means that');
+    }
+    const signature = await signForAccount(prepared.supplierAccount, digest, key);
+    if (!(await deps.chain.isAccountSignature(prepared.supplierAccount, digest, signature))) {
+        throw new Error("The key that signed isn't the supplier account's root key or an admin key");
+    }
+    return signedMessage(typedData, prepared.domain, prepared.consent, signature);
+}
+//# sourceMappingURL=consent.js.map

package/dist/consent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"consent.js","sourceRoot":"","sources":["../src/consent.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,QAAQ,EAGR,eAAe,EAIf,uBAAuB,EAEvB,cAAc,EACd,YAAY,GACb,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EAA0B,cAAc,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,MAAM,CAAA;AAC1E,OAAO,EAAoB,WAAW,EAAE,MAAM,YAAY,CAAA;AAC1D,OAAO,EAAmB,WAAW,EAAE,wBAAwB,EAAE,MAAM,iBAAiB,CAAA;AACxF,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAA;AACnC,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AACxC,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AA8C3D;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB,CACzC,OAA8B,EAC9B,IAAiB;IAEjB,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,CAAA;IAC9B,IAAI,KAAK,CAAC,OAAO,KAAK,MAAM,CAAC,OAAO,EAAE,CAAC;QACrC,MAAM,IAAI,KAAK,CAAC,iCAAiC,KAAK,CAAC,OAAO,SAAS,MAAM,CAAC,OAAO,EAAE,CAAC,CAAA;IAC1F,CAAC;IACD,MAAM,MAAM,GAAG,CAAC,MAAkB,EAA0B,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAA;IACtF,IACE,CAAC,MAAM,CAAC,MAAM,CAAC,eAAe,EAAE,OAAO,CAAC,MAAM,CAAC;QAC/C,CAAC,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC;QAC5B,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,KAAK,EAAE,EACjC,CAAC;QACD,OAAO,MAAM,CAAC,iBAAiB,CAAC,CAAA;IAClC,CAAC;IAED,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;IAC/C,IAAI,CAAC,QAAQ,EAAE,WAAW;QAAE,OAAO,MAAM,CAAC,oBAAoB,CAAC,CAAA;IAC/D,MAAM,CAAC,GAAG,MAAM,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,YAAY,EAAE,OAAO,CAAC,CAAA;IAC1E,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,KAAK,MAAM;QAAE,OAAO,MAAM,CAAC,uBAAuB,CAAC,CAAA;IACpE,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC;QAAE,OAAO,MAAM,CAAC,yBAAyB,CAAC,CAAA;IACzF,MAAM,UAAU,GAAG,YAAY,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,KAAK,QAAQ,IAAI,CAAC,CAAC,SAAS,CAAC,CAAA;IAClF,IAAI,CAAC,UAAU;QAAE,OAAO,MAAM,CAAC,wBAAwB,CAAC,CAAA;IACxD,IAAI,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,GAAG;QAAE,OAAO,MAAM,CAAC,iBAAiB,CAAC,CAAA;IACnE,MAAM,KAAK,GAAG,OAAO,CAAC,WAAW,IAAI,CAAC,CAAC,WAAW,CAAA;IAClD,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,IAAI,KAAK,GAAG,WAAW,EAAE,CAAC;QACjE,OAAO,MAAM,CAAC,4BAA4B,CAAC,CAAA;IAC7C,CAAC;IACD,IAAI,KAAK,GAAG,CAAC,CAAC,WAAW;QAAE,OAAO,MAAM,CAAC,sBAAsB,CAAC,CAAA;IAEhE,MAAM,OAAO,GAAmB;QAC9B,YAAY,EAAE,OAAO,CAAC,YAAY;QAClC,IAAI,EAAE,OAAO;QACb,WAAW,EAAE,KAAK;QAClB,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,YAAY,EAAE,OAAO,CAAC,YAAY;QAClC,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,WAAW,EAAE;QACrC,MAAM,EAAE,OAAO,CAAC,MAAM;KACvB,CAAA;IACD,MAAM,CAAC,GAAG,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,iBAAiB,EAAE,OAAO,CAAC,IAAI,EAAE,CAAA;IACtE,MAAM,MAAM,GAAG,QAAQ,CAAC,uBAAuB,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAA;IAC5D,OAAO,KAAK,CAAC;QACX,EAAE,EAAE,IAAI;QACR,OAAO;QACP,MAAM,EAAE,CAAC;QACT,MAAM;QACN,eAAe,EAAE,MAAM,CAAC,OAAO;QAC/B,UAAU,EAAE,wBAAwB,CAAC;YACnC,MAAM;YACN,OAAO;YACP,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,OAAO,EAAE,QAAQ,CAAC,OAAO;YACzB,IAAI,EAAE,CAAC,CAAC,IAAI;YACZ,KAAK,EAAE,WAAW,CAAC,MAAM,CAAC,cAAc,EAAE,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,KAAK,CAAC;YACzE,YAAY,EAAE,CAAC,CAAC,WAAW;YAC3B,GAAG,EAAE,OAAO,CAAC,GAAG;SACjB,CAAC;KACH,CAAC,CAAA;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,QAA6B,EAC7B,GAAe,EACf,YAA2D,EAC3D,IAA4B;IAE5B,MAAM,SAAS,GAAG,uBAAuB,CAAC,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAA;IAC5E,MAAM,MAAM,GAAG,aAAa,CAAC,QAAQ,EAAE,SAAS,EAAE,YAAY,EAAE;QAC9D,OAAO,EAAE,SAAS;QAClB,OAAO,EAAE,uBAAuB;KACjC,CAAC,CAAA;IACF,IAAI,QAAQ,CAAC,UAAU,CAAC,gBAAgB,IAAI,YAAY,EAAE,YAAY,KAAK,IAAI,EAAE,CAAC;QAChF,MAAM,IAAI,KAAK,CACb,iLAAiL,CAClL,CAAA;IACH,CAAC;IACD,MAAM,SAAS,GAAG,MAAM,cAAc,CAAC,QAAQ,CAAC,eAAe,EAAE,MAAM,EAAE,GAAG,CAAC,CAAA;IAC7E,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC,QAAQ,CAAC,eAAe,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC;QACxF,MAAM,IAAI,KAAK,CAAC,2EAA2E,CAAC,CAAA;IAC9F,CAAC;IACD,OAAO,aAAa,CAAC,SAAS,EAAE,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;AAC/E,CAAC"}