@avow-finance/sdk 0.0.0-stage → 0.2.0

package/dist/job/customer.d.ts

@@ -0,0 +1,43 @@
+import type { ReasonCode } from '@avow-finance/spec';
+import { type DeliveryReport, type JobOffer, type OrderAnswer, type OrderScenario, type OrderState, type QuoteRequest, type SupplierProfile, type TestCustomerProfile } from '@avow-finance/spec';
+import { type AvowRequestConfig } from '../http.js';
+/** The test customer's refusal of a GET, or an answer to one that doesn't read. */
+export declare class TestCustomerError extends Error {
+    readonly status: number;
+    readonly reason: ReasonCode | null;
+    constructor(message: string, status: number, reason: ReasonCode | null);
+}
+/**
+ * Avow's test customer as the developer's job process reaches it. Orders arrive by pull: the
+ * process asks for one, quotes it, polls it while the customer checks the quote and reserves, and
+ * reports delivery. Every POST is signed with the supplier's signing key under the customer's lock,
+ * and resent with the same bytes until the customer answers, as `avowRequests` does for Avow's API.
+ */
+export interface TestCustomer {
+    /** The customer's profile, labelled as Avow's test customer, read when the client connected. */
+    readonly profile: TestCustomerProfile;
+    /**
+     * Asks for a new order for this supplier, the developer's business as Avow registered it. With a
+     * scenario, the customer plays it out on that order.
+     */
+    order(supplier: SupplierProfile, scenario?: OrderScenario): Promise<JobOffer>;
+    /** Sends the quote for an order. The customer answers while it checks it. */
+    quote(orderId: string, quote: QuoteRequest): Promise<OrderAnswer>;
+    /** Where an order stands now. */
+    state(orderId: string): Promise<OrderState>;
+    /** Reports the job delivered, handing over its result. The customer answers, then pays. */
+    delivery(orderId: string, report: DeliveryReport): Promise<OrderAnswer>;
+}
+/** What a test customer client needs: the signed-request settings and the chain expected. */
+export interface TestCustomerConfig extends AvowRequestConfig {
+    /** The chain the customer's lock has to be on. */
+    chainId: number;
+}
+/**
+ * Connects to Avow's test customer at `config.baseUrl`, the sandbox deployment's `customerUrl`,
+ * with `config.key` the supplier's signing key. It reads the customer's profile first and refuses
+ * one on another chain. An offer has to name the supplier that asked for it and the customer the
+ * profile names, and an order's state has to be the order asked about.
+ */
+export declare function connectTestCustomer(config: TestCustomerConfig): Promise<TestCustomer>;
+//# sourceMappingURL=customer.d.ts.map

package/dist/job/customer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"customer.d.ts","sourceRoot":"","sources":["../../src/job/customer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AACpD,OAAO,EACL,KAAK,cAAc,EACnB,KAAK,QAAQ,EACb,KAAK,WAAW,EAChB,KAAK,aAAa,EAClB,KAAK,UAAU,EAOf,KAAK,YAAY,EACjB,KAAK,eAAe,EAEpB,KAAK,mBAAmB,EACzB,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EAAE,KAAK,iBAAiB,EAAgB,MAAM,YAAY,CAAA;AAEjE,mFAAmF;AACnF,qBAAa,iBAAkB,SAAQ,KAAK;IAGxC,QAAQ,CAAC,MAAM,EAAE,MAAM;IACvB,QAAQ,CAAC,MAAM,EAAE,UAAU,GAAG,IAAI;IAHpC,YACE,OAAO,EAAE,MAAM,EACN,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,UAAU,GAAG,IAAI,EAInC;CACF;AAED;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IAC3B,gGAAgG;IAChG,QAAQ,CAAC,OAAO,EAAE,mBAAmB,CAAA;IACrC;;;OAGG;IACH,KAAK,CAAC,QAAQ,EAAE,eAAe,EAAE,QAAQ,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAA;IAC7E,6EAA6E;IAC7E,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,GAAG,OAAO,CAAC,WAAW,CAAC,CAAA;IACjE,iCAAiC;IACjC,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAC3C,2FAA2F;IAC3F,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC,CAAA;CACxE;AAED,6FAA6F;AAC7F,MAAM,WAAW,kBAAmB,SAAQ,iBAAiB;IAC3D,kDAAkD;IAClD,OAAO,EAAE,MAAM,CAAA;CAChB;AAyBD;;;;;GAKG;AACH,wBAAsB,mBAAmB,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,YAAY,CAAC,CAmD3F"}

package/dist/job/customer.js

@@ -0,0 +1,83 @@
+import { parseApiError, parseJobOffer, parseOrderAnswer, parseOrderState, parseTestCustomerProfile, TEST_CUSTOMER_PATHS, } from '@avow-finance/spec';
+import { avowRequests } from '../http.js';
+/** The test customer's refusal of a GET, or an answer to one that doesn't read. */
+export class TestCustomerError extends Error {
+    status;
+    reason;
+    constructor(message, status, reason) {
+        super(message);
+        this.status = status;
+        this.reason = reason;
+        this.name = 'TestCustomerError';
+    }
+}
+/** Reads a GET's JSON, throwing the customer's refusal or an unreadable answer as an error. */
+async function getJson(url, fetchOnce, read) {
+    const answer = await fetchOnce(url, {
+        redirect: 'error',
+        headers: { accept: 'application/json' },
+    });
+    const json = await answer.json().catch(() => null);
+    if (!answer.ok) {
+        const refusal = parseApiError(json);
+        const message = refusal?.message ?? `The test customer answered ${answer.status}`;
+        throw new TestCustomerError(message, answer.status, refusal?.reason ?? null);
+    }
+    const parsed = read(json);
+    if (!parsed.ok) {
+        throw new TestCustomerError(`The answer at ${url} doesn't read`, answer.status, parsed.reason);
+    }
+    return parsed.value;
+}
+/**
+ * Connects to Avow's test customer at `config.baseUrl`, the sandbox deployment's `customerUrl`,
+ * with `config.key` the supplier's signing key. It reads the customer's profile first and refuses
+ * one on another chain. An offer has to name the supplier that asked for it and the customer the
+ * profile names, and an order's state has to be the order asked about.
+ */
+export async function connectTestCustomer(config) {
+    const fetchOnce = config.fetch ?? fetch;
+    const origin = new URL(config.baseUrl).origin;
+    const profile = await getJson(`${origin}${TEST_CUSTOMER_PATHS.profile}`, fetchOnce, parseTestCustomerProfile);
+    if (profile.chainId !== config.chainId) {
+        throw new Error(`The test customer is on chain ${profile.chainId}, not ${config.chainId}`);
+    }
+    const send = avowRequests(config);
+    const domain = { chainId: profile.chainId, verifyingContract: profile.lock };
+    const fromThisCustomer = (businessId) => businessId === profile.businessId;
+    return {
+        profile,
+        order: (supplier, scenario) => send({
+            domain,
+            path: TEST_CUSTOMER_PATHS.orders,
+            body: scenario ? { supplier, scenario } : { supplier },
+            read: (json) => {
+                const offer = parseJobOffer(json);
+                if (!offer.ok)
+                    return offer;
+                const ours = offer.value.supplierBusinessId === supplier.businessId &&
+                    fromThisCustomer(offer.value.customer.businessId);
+                return ours ? offer : { ok: false, reason: 'message.invalid' };
+            },
+        }),
+        quote: (orderId, quote) => send({
+            domain,
+            path: TEST_CUSTOMER_PATHS.quote(orderId),
+            body: quote,
+            read: parseOrderAnswer,
+        }),
+        state: (orderId) => getJson(`${origin}${TEST_CUSTOMER_PATHS.order(orderId)}`, fetchOnce, (json) => {
+            const state = parseOrderState(json);
+            if (!state.ok)
+                return state;
+            return state.value.orderId === orderId ? state : { ok: false, reason: 'message.invalid' };
+        }),
+        delivery: (orderId, report) => send({
+            domain,
+            path: TEST_CUSTOMER_PATHS.delivery(orderId),
+            body: report,
+            read: parseOrderAnswer,
+        }),
+    };
+}
+//# sourceMappingURL=customer.js.map

package/dist/job/customer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"customer.js","sourceRoot":"","sources":["../../src/job/customer.ts"],"names":[],"mappings":"AACA,OAAO,EAOL,aAAa,EACb,aAAa,EACb,gBAAgB,EAChB,eAAe,EACf,wBAAwB,EAGxB,mBAAmB,GAEpB,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EAA0B,YAAY,EAAE,MAAM,YAAY,CAAA;AAEjE,mFAAmF;AACnF,MAAM,OAAO,iBAAkB,SAAQ,KAAK;IAG/B,MAAM;IACN,MAAM;IAHjB,YACE,OAAe,EACN,MAAc,EACd,MAAyB;QAElC,KAAK,CAAC,OAAO,CAAC,CAAA;sBAHL,MAAM;sBACN,MAAM;QAGf,IAAI,CAAC,IAAI,GAAG,mBAAmB,CAAA;IACjC,CAAC;CACF;AA8BD,+FAA+F;AAC/F,KAAK,UAAU,OAAO,CACpB,GAAW,EACX,SAAuB,EACvB,IAAkC;IAElC,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,GAAG,EAAE;QAClC,QAAQ,EAAE,OAAO;QACjB,OAAO,EAAE,EAAE,MAAM,EAAE,kBAAkB,EAAE;KACxC,CAAC,CAAA;IACF,MAAM,IAAI,GAAY,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAA;IAC3D,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,MAAM,OAAO,GAAG,aAAa,CAAC,IAAI,CAAC,CAAA;QACnC,MAAM,OAAO,GAAG,OAAO,EAAE,OAAO,IAAI,8BAA8B,MAAM,CAAC,MAAM,EAAE,CAAA;QACjF,MAAM,IAAI,iBAAiB,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,IAAI,IAAI,CAAC,CAAA;IAC9E,CAAC;IACD,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,CAAA;IACzB,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,MAAM,IAAI,iBAAiB,CAAC,iBAAiB,GAAG,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAA;IAChG,CAAC;IACD,OAAO,MAAM,CAAC,KAAK,CAAA;AACrB,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CAAC,MAA0B;IAClE,MAAM,SAAS,GAAG,MAAM,CAAC,KAAK,IAAI,KAAK,CAAA;IACvC,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,CAAA;IAC7C,MAAM,OAAO,GAAG,MAAM,OAAO,CAC3B,GAAG,MAAM,GAAG,mBAAmB,CAAC,OAAO,EAAE,EACzC,SAAS,EACT,wBAAwB,CACzB,CAAA;IACD,IAAI,OAAO,CAAC,OAAO,KAAK,MAAM,CAAC,OAAO,EAAE,CAAC;QACvC,MAAM,IAAI,KAAK,CAAC,iCAAiC,OAAO,CAAC,OAAO,SAAS,MAAM,CAAC,OAAO,EAAE,CAAC,CAAA;IAC5F,CAAC;IACD,MAAM,IAAI,GAAG,YAAY,CAAC,MAAM,CAAC,CAAA;IACjC,MAAM,MAAM,GAAG,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,iBAAiB,EAAE,OAAO,CAAC,IAAI,EAAE,CAAA;IAC5E,MAAM,gBAAgB,GAAG,CAAC,UAAkB,EAAE,EAAE,CAAC,UAAU,KAAK,OAAO,CAAC,UAAU,CAAA;IAClF,OAAO;QACL,OAAO;QACP,KAAK,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,EAAE,CAC5B,IAAI,CAAC;YACH,MAAM;YACN,IAAI,EAAE,mBAAmB,CAAC,MAAM;YAChC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE;YACtD,IAAI,EAAE,CAAC,IAAI,EAAoB,EAAE;gBAC/B,MAAM,KAAK,GAAG,aAAa,CAAC,IAAI,CAAC,CAAA;gBACjC,IAAI,CAAC,KAAK,CAAC,EAAE;oBAAE,OAAO,KAAK,CAAA;gBAC3B,MAAM,IAAI,GACR,KAAK,CAAC,KAAK,CAAC,kBAAkB,KAAK,QAAQ,CAAC,UAAU;oBACtD,gBAAgB,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;gBACnD,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,iBAAiB,EAAE,CAAA;YAChE,CAAC;SACF,CAAC;QACJ,KAAK,EAAE,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE,CACxB,IAAI,CAAC;YACH,MAAM;YACN,IAAI,EAAE,mBAAmB,CAAC,KAAK,CAAC,OAAO,CAAC;YACxC,IAAI,EAAE,KAAK;YACX,IAAI,EAAE,gBAAgB;SACvB,CAAC;QACJ,KAAK,EAAE,CAAC,OAAO,EAAE,EAAE,CACjB,OAAO,CAAC,GAAG,MAAM,GAAG,mBAAmB,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,EAAE,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE;YAC5E,MAAM,KAAK,GAAG,eAAe,CAAC,IAAI,CAAC,CAAA;YACnC,IAAI,CAAC,KAAK,CAAC,EAAE;gBAAE,OAAO,KAAK,CAAA;YAC3B,OAAO,KAAK,CAAC,KAAK,CAAC,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,iBAAiB,EAAE,CAAA;QAC3F,CAAC,CAAC;QACJ,QAAQ,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,CAC5B,IAAI,CAAC;YACH,MAAM;YACN,IAAI,EAAE,mBAAmB,CAAC,QAAQ,CAAC,OAAO,CAAC;YAC3C,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,gBAAgB;SACvB,CAAC;KACL,CAAA;AACH,CAAC"}

package/dist/job/quote.d.ts

@@ -0,0 +1,34 @@
+import { type BuyerSideReference, type GpuReservationTerms, type JobBuyer, type JobOffer, type QuoteRequest, type RequestKey, type SupplierProfile } from '@avow-finance/spec';
+/** The compute a job relies on: the business's own booking of it, with its terms and salt. */
+export interface ComputeBooking {
+    /** The booking, on the buyer side of the business's own lock. */
+    reference: BuyerSideReference;
+    terms: GpuReservationTerms;
+    salt: `0x${string}`;
+}
+export interface JobQuoteInput {
+    /** The order, Avow's test customer's offer or another business's order from the mailbox. */
+    offer: Pick<JobOffer, 'terms' | 'commitmentId'>;
+    /** The buyer, which the agreement names with its agent's mandate. */
+    customer: JobBuyer;
+    /** The developer's business, as Avow registered it as a supplier. */
+    supplier: SupplierProfile;
+    /** The supplier's signing key, which signs the terms agreement. */
+    signingKey: RequestKey;
+    /**
+     * The compute booking the quote names, or null for a quote that names none, which the customer
+     * refuses as `dependency.required`, as Avow would.
+     */
+    compute: ComputeBooking | null;
+    /** When the agreement lapses, in unix seconds. The customer refuses one valid too long. */
+    expiry: bigint;
+}
+/**
+ * Quotes an order. The quote's terms are the offer's, with the compute booking added as the one
+ * booking they rely on, which makes them version 3. The salt is new, and the signing key signs the
+ * terms agreement naming the offer's commitment id, the customer as buyer under its mandate, this
+ * business as supplier and the job category. The quote shows the compute booking's subject, which
+ * holds no price, so the customer can check the booking fits the job.
+ */
+export declare function quoteJob(input: JobQuoteInput): Promise<QuoteRequest>;
+//# sourceMappingURL=quote.d.ts.map

package/dist/job/quote.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"quote.d.ts","sourceRoot":"","sources":["../../src/job/quote.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,kBAAkB,EAIvB,KAAK,mBAAmB,EAExB,KAAK,QAAQ,EACb,KAAK,QAAQ,EAEb,KAAK,YAAY,EACjB,KAAK,UAAU,EACf,KAAK,eAAe,EAKrB,MAAM,oBAAoB,CAAA;AAG3B,8FAA8F;AAC9F,MAAM,WAAW,cAAc;IAC7B,iEAAiE;IACjE,SAAS,EAAE,kBAAkB,CAAA;IAC7B,KAAK,EAAE,mBAAmB,CAAA;IAC1B,IAAI,EAAE,KAAK,MAAM,EAAE,CAAA;CACpB;AAED,MAAM,WAAW,aAAa;IAC5B,4FAA4F;IAC5F,KAAK,EAAE,IAAI,CAAC,QAAQ,EAAE,OAAO,GAAG,cAAc,CAAC,CAAA;IAC/C,qEAAqE;IACrE,QAAQ,EAAE,QAAQ,CAAA;IAClB,qEAAqE;IACrE,QAAQ,EAAE,eAAe,CAAA;IACzB,mEAAmE;IACnE,UAAU,EAAE,UAAU,CAAA;IACtB;;;OAGG;IACH,OAAO,EAAE,cAAc,GAAG,IAAI,CAAA;IAC9B,2FAA2F;IAC3F,MAAM,EAAE,MAAM,CAAA;CACf;AAID;;;;;;GAMG;AACH,wBAAsB,QAAQ,CAAC,KAAK,EAAE,aAAa,GAAG,OAAO,CAAC,YAAY,CAAC,CA2B1E"}

package/dist/job/quote.js

@@ -0,0 +1,37 @@
+import { chainedJobTerms, digestOf, discloseSection, JOB_CATEGORY, newSalt, termsAgreementTypedData, termsHash, toWire, } from '@avow-finance/spec';
+import { hexToBigInt, toHex } from 'viem';
+const randomUint = () => hexToBigInt(toHex(crypto.getRandomValues(new Uint8Array(16))));
+/**
+ * Quotes an order. The quote's terms are the offer's, with the compute booking added as the one
+ * booking they rely on, which makes them version 3. The salt is new, and the signing key signs the
+ * terms agreement naming the offer's commitment id, the customer as buyer under its mandate, this
+ * business as supplier and the job category. The quote shows the compute booking's subject, which
+ * holds no price, so the customer can check the booking fits the job.
+ */
+export async function quoteJob(input) {
+    const { offer, customer, compute } = input;
+    if (input.signingKey.address.toLowerCase() !== input.supplier.signingKey.toLowerCase()) {
+        throw new Error("The key given isn't the supplier's signing key");
+    }
+    const terms = compute
+        ? chainedJobTerms(offer.terms, [
+            { on: compute.reference, condition: 'accepted', disclosed: 'subject' },
+        ])
+        : offer.terms;
+    const salt = newSalt();
+    const agreement = {
+        commitmentId: offer.commitmentId,
+        termsHash: termsHash(terms, salt),
+        category: JOB_CATEGORY,
+        buyerBusinessId: customer.businessId,
+        supplierBusinessId: input.supplier.businessId,
+        mandateHash: customer.mandateHash,
+        nonce: randomUint(),
+        expiry: input.expiry,
+    };
+    const domain = { chainId: customer.chainId, verifyingContract: customer.lock };
+    const supplierSignature = await input.signingKey.signDigest(digestOf(termsAgreementTypedData(agreement, domain)));
+    const disclosed = compute ? [toWire(discloseSection(compute.terms, compute.salt, 'subject'))] : [];
+    return { terms, salt, agreement, supplierSignature, disclosed };
+}
+//# sourceMappingURL=quote.js.map

package/dist/job/quote.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"quote.js","sourceRoot":"","sources":["../../src/job/quote.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,eAAe,EACf,QAAQ,EACR,eAAe,EAEf,YAAY,EAGZ,OAAO,EAKP,uBAAuB,EACvB,SAAS,EACT,MAAM,GACP,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,MAAM,CAAA;AA4BzC,MAAM,UAAU,GAAG,GAAG,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAA;AAEvF;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,KAAoB;IACjD,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,KAAK,CAAA;IAC1C,IAAI,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,WAAW,EAAE,KAAK,KAAK,CAAC,QAAQ,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,CAAC;QACvF,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAA;IACnE,CAAC;IACD,MAAM,KAAK,GAAG,OAAO;QACnB,CAAC,CAAC,eAAe,CAAC,KAAK,CAAC,KAAK,EAAE;YAC3B,EAAE,EAAE,EAAE,OAAO,CAAC,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,EAAE;SACvE,CAAC;QACJ,CAAC,CAAC,KAAK,CAAC,KAAK,CAAA;IACf,MAAM,IAAI,GAAG,OAAO,EAAE,CAAA;IACtB,MAAM,SAAS,GAAmB;QAChC,YAAY,EAAE,KAAK,CAAC,YAAY;QAChC,SAAS,EAAE,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC;QACjC,QAAQ,EAAE,YAAY;QACtB,eAAe,EAAE,QAAQ,CAAC,UAAU;QACpC,kBAAkB,EAAE,KAAK,CAAC,QAAQ,CAAC,UAAU;QAC7C,WAAW,EAAE,QAAQ,CAAC,WAAW;QACjC,KAAK,EAAE,UAAU,EAAE;QACnB,MAAM,EAAE,KAAK,CAAC,MAAM;KACrB,CAAA;IACD,MAAM,MAAM,GAAG,EAAE,OAAO,EAAE,QAAQ,CAAC,OAAO,EAAE,iBAAiB,EAAE,QAAQ,CAAC,IAAI,EAAE,CAAA;IAC9E,MAAM,iBAAiB,GAAG,MAAM,KAAK,CAAC,UAAU,CAAC,UAAU,CACzD,QAAQ,CAAC,uBAAuB,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CACrD,CAAA;IACD,MAAM,SAAS,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,eAAe,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;IAClG,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,iBAAiB,EAAE,SAAS,EAAE,CAAA;AACjE,CAAC"}

package/dist/lock.d.ts

@@ -0,0 +1,269 @@
+import { type Approval, type AvowDomain, type ContestStatement, type Side, type Signed } from '@avow-finance/spec';
+import { FACTORY_ABI, type LockedBacking } from '@avow-finance/verifier';
+import { type Address, type Chain, type Client, type Hex, type Transport } from 'viem';
+/**
+ * The lock function an agent's key calls to fund a reserve, as the testnet lock declares it. The
+ * lock is unaudited testnet code, and a new factory can change this interface. Knowing it grants
+ * nothing, since on each call the lock checks Avow's signature over every field of the approval,
+ * the calling account and key, the supplier, the caps and the expiry.
+ */
+export declare const RESERVE_ABI: readonly [{
+    readonly type: 'function';
+    readonly name: 'reserve';
+    readonly inputs: readonly [{
+        readonly name: 'a';
+        readonly type: 'tuple';
+        readonly components: readonly [{
+            readonly name: 'commitmentId';
+            readonly type: 'bytes32';
+        }, {
+            readonly name: 'side';
+            readonly type: 'uint8';
+        }, {
+            readonly name: 'token';
+            readonly type: 'address';
+        }, {
+            readonly name: 'amount';
+            readonly type: 'uint256';
+        }, {
+            readonly name: 'supplier';
+            readonly type: 'address';
+        }, {
+            readonly name: 'supplierSigner';
+            readonly type: 'address';
+        }, {
+            readonly name: 'payee';
+            readonly type: 'address';
+        }, {
+            readonly name: 'freeCancelBy';
+            readonly type: 'uint64';
+        }, {
+            readonly name: 'acceptBy';
+            readonly type: 'uint64';
+        }, {
+            readonly name: 'chargeDeadline';
+            readonly type: 'uint64';
+        }, {
+            readonly name: 'releaseDate';
+            readonly type: 'uint64';
+        }, {
+            readonly name: 'contestWindow';
+            readonly type: 'uint64';
+        }, {
+            readonly name: 'charges';
+            readonly type: 'tuple[]';
+            readonly components: readonly [{
+                readonly name: 'kind';
+                readonly type: 'uint8';
+            }, {
+                readonly name: 'most';
+                readonly type: 'uint256';
+            }, {
+                readonly name: 'earliest';
+                readonly type: 'uint64';
+            }];
+        }, {
+            readonly name: 'day90SupplierShareBps';
+            readonly type: 'uint16';
+        }, {
+            readonly name: 'arbiter';
+            readonly type: 'address';
+        }, {
+            readonly name: 'termsHash';
+            readonly type: 'bytes32';
+        }, {
+            readonly name: 'mandateHash';
+            readonly type: 'bytes32';
+        }, {
+            readonly name: 'capPerCommitment';
+            readonly type: 'uint256';
+        }, {
+            readonly name: 'capOpenReserves';
+            readonly type: 'uint256';
+        }, {
+            readonly name: 'fundingKey';
+            readonly type: 'address';
+        }, {
+            readonly name: 'nonce';
+            readonly type: 'uint256';
+        }, {
+            readonly name: 'expiry';
+            readonly type: 'uint64';
+        }];
+    }, {
+        readonly name: 'avowSignature';
+        readonly type: 'bytes';
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: 'nonpayable';
+}];
+/**
+ * The selector of `reserve`, the only lock function an agent's key may call. `agentKeyTerms`
+ * takes it as the key's one lock selector.
+ */
+export declare const RESERVE_SELECTOR: Hex;
+/**
+ * The calls a business account's root key makes on its own lock and on the factory, as the testnet
+ * contracts declare them. Approving a supplier lets an agent reserve for it, and only the account's
+ * root key can do it. Cancelling before free cancellation ends takes a reserve back in full, and
+ * contesting a charge pauses it until someone rules.
+ */
+export declare const ADMINISTRATOR_ABI: readonly [{
+    readonly type: 'function';
+    readonly name: 'approveSupplier';
+    readonly inputs: readonly [{
+        readonly name: 'supplier';
+        readonly type: 'address';
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: 'nonpayable';
+}, {
+    readonly type: 'function';
+    readonly name: 'removeSupplier';
+    readonly inputs: readonly [{
+        readonly name: 'supplier';
+        readonly type: 'address';
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: 'nonpayable';
+}, {
+    readonly type: 'function';
+    readonly name: 'approvedSupplier';
+    readonly inputs: readonly [{
+        readonly name: 'supplier';
+        readonly type: 'address';
+    }];
+    readonly outputs: readonly [{
+        readonly name: '';
+        readonly type: 'bool';
+    }];
+    readonly stateMutability: 'view';
+}, {
+    readonly type: 'function';
+    readonly name: 'cancelFree';
+    readonly inputs: readonly [{
+        readonly name: 'commitmentId';
+        readonly type: 'bytes32';
+    }, {
+        readonly name: 'side';
+        readonly type: 'uint8';
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: 'nonpayable';
+}, {
+    readonly type: 'function';
+    readonly name: 'contest';
+    readonly inputs: readonly [{
+        readonly name: 'commitmentId';
+        readonly type: 'bytes32';
+    }, {
+        readonly name: 'side';
+        readonly type: 'uint8';
+    }, {
+        readonly name: 'reportNumber';
+        readonly type: 'uint8';
+    }, {
+        readonly name: 'reasonCode';
+        readonly type: 'uint16';
+    }, {
+        readonly name: 'statementHash';
+        readonly type: 'bytes32';
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: 'nonpayable';
+}];
+/**
+ * The lock factory's functions. The verifier defines them once, and the SDK passes the same
+ * definition on, so an agent and a supplier never read the factory through two different ABIs.
+ */
+export { FACTORY_ABI };
+/**
+ * The lock's running total of what each mandate's open reserves hold. The lock refuses a reserve
+ * that would take it above the cap on open reserves that Avow's approval carries, and Avow's
+ * reserve check reads the same total before it approves one.
+ */
+export declare const OPEN_RESERVES_ABI: readonly [{
+    readonly type: 'function';
+    readonly name: 'openReserves';
+    readonly inputs: readonly [{
+        readonly name: 'mandateHash';
+        readonly type: 'bytes32';
+    }];
+    readonly outputs: readonly [{
+        readonly name: '';
+        readonly type: 'uint256';
+    }];
+    readonly stateMutability: 'view';
+}];
+/** What the lock holds in open reserves under one mandate, in the token's base units. */
+export declare function readOpenReserves(client: Client<Transport, Chain>, lock: Address, mandateHash: Hex): Promise<bigint>;
+/** One call in a Tempo transaction. */
+export interface Call {
+    to: Address;
+    data: Hex;
+}
+/**
+ * The two calls that fund a reserve in one transaction. The first approves the lock to pull the
+ * approval's amount of its token, and the second calls `reserve` with Avow's approval and
+ * signature.
+ */
+export declare function reserveCalls(approval: Signed<Approval>, d: AvowDomain): Call[];
+/** The call that creates a business account's lock from the factory. */
+export declare function createLockCall(factory: Address, account: Address): Call;
+/** The call, from the business account's root key, that lets its agents reserve for a supplier. */
+export declare function approveSupplierCall(lock: Address, supplier: Address): Call;
+/**
+ * The call, from the business account's root key, that stops its agents reserving for a supplier.
+ * A commitment already reserved for that supplier stays as it is.
+ */
+export declare function removeSupplierCall(lock: Address, supplier: Address): Call;
+/**
+ * The call, from the business account's root key, that cancels a commitment on the lock before
+ * free cancellation ends and gives the whole reserve back. It cancels the buyer's side, the only
+ * side a lock holds a reserve for in this release. Until then Avow refuses to record a
+ * cancellation, with `commitment.cancel_on_lock`, since the business cancels on the lock without
+ * anyone else's signature.
+ */
+export declare function cancelFreeCall(lock: Address, commitmentId: Hex): Call;
+/**
+ * The call, from the business account's root key, that contests the charge or report a statement
+ * names. It carries the statement's reason code and its hash, which the lock logs in its `Paused`
+ * event, and throws on a statement the spec's format refuses.
+ */
+export declare function contestCall(lock: Address, statement: ContestStatement): Call;
+/**
+ * Whether the lock takes `cancelFreeCall` for a commitment at `now`, by the chain's clock. It takes
+ * it for a reserve the supplier hasn't accepted, or one accepted with no report standing, until
+ * free cancellation ends, whatever the agent's mandate permits.
+ */
+export declare function cancelsFree(held: LockedBacking, now: bigint): boolean;
+/**
+ * The lock's `trigger`, as the testnet lock declares it, with the error it reverts with when no
+ * step is due. It takes whichever step is due for one side of a commitment once a deadline has
+ * passed. It returns a reserve the supplier never accepted, releases a kept reserve at its release
+ * date, times out a charge report Avow didn't confirm or refer in time, pays a confirmed charge
+ * once its contest window closes and applies a posted ruling once its delay has passed. At day 90
+ * it resolves a paused charge nobody ruled on, paying a confirmed charge at the day-90 share and
+ * returning an unconfirmed one to the business in full. Anyone can send it, since the lock pays
+ * only the parties it recorded.
+ */
+export declare const TRIGGER_ABI: readonly [{
+    readonly type: 'function';
+    readonly name: 'trigger';
+    readonly inputs: readonly [{
+        readonly name: 'commitmentId';
+        readonly type: 'bytes32';
+    }, {
+        readonly name: 'side';
+        readonly type: 'uint8';
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: 'nonpayable';
+}, {
+    readonly type: 'error';
+    readonly name: 'NothingDue';
+    readonly inputs: readonly [];
+}];
+/** The call that takes the step due for one side of a commitment, from any account. */
+export declare function triggerCall(lock: Address, commitmentId: Hex, side: Side): Call;
+//# sourceMappingURL=lock.d.ts.map

package/dist/lock.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lock.d.ts","sourceRoot":"","sources":["../src/lock.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,QAAQ,EACb,KAAK,UAAU,EAGf,KAAK,gBAAgB,EAGrB,KAAK,IAAI,EACT,KAAK,MAAM,EACZ,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EAAE,WAAW,EAAE,KAAK,aAAa,EAAE,MAAM,wBAAwB,CAAA;AACxE,OAAO,EACL,KAAK,OAAO,EACZ,KAAK,KAAK,EACV,KAAK,MAAM,EAEX,KAAK,GAAG,EACR,KAAK,SAAS,EAEf,MAAM,MAAM,CAAA;AAIb;;;;;GAKG;AACH,eAAO,MAAM,WAAW;aAEpB,IAAI,EAAE,UAAU;aAChB,IAAI,EAAE,SAAS;aACf,MAAM;iBAEF,IAAI,EAAE,GAAG;iBACT,IAAI,EAAE,OAAO;iBACb,UAAU;qBACN,IAAI,EAAE,cAAc;qBAAE,IAAI,EAAE,SAAS;;qBACrC,IAAI,EAAE,MAAM;qBAAE,IAAI,EAAE,OAAO;;qBAC3B,IAAI,EAAE,OAAO;qBAAE,IAAI,EAAE,SAAS;;qBAC9B,IAAI,EAAE,QAAQ;qBAAE,IAAI,EAAE,SAAS;;qBAC/B,IAAI,EAAE,UAAU;qBAAE,IAAI,EAAE,SAAS;;qBACjC,IAAI,EAAE,gBAAgB;qBAAE,IAAI,EAAE,SAAS;;qBACvC,IAAI,EAAE,OAAO;qBAAE,IAAI,EAAE,SAAS;;qBAC9B,IAAI,EAAE,cAAc;qBAAE,IAAI,EAAE,QAAQ;;qBACpC,IAAI,EAAE,UAAU;qBAAE,IAAI,EAAE,QAAQ;;qBAChC,IAAI,EAAE,gBAAgB;qBAAE,IAAI,EAAE,QAAQ;;qBACtC,IAAI,EAAE,aAAa;qBAAE,IAAI,EAAE,QAAQ;;qBACnC,IAAI,EAAE,eAAe;qBAAE,IAAI,EAAE,QAAQ;;qBAErC,IAAI,EAAE,SAAS;qBACf,IAAI,EAAE,SAAS;qBACf,UAAU;yBACN,IAAI,EAAE,MAAM;yBAAE,IAAI,EAAE,OAAO;;yBAC3B,IAAI,EAAE,MAAM;yBAAE,IAAI,EAAE,SAAS;;yBAC7B,IAAI,EAAE,UAAU;yBAAE,IAAI,EAAE,QAAQ;;;qBAGpC,IAAI,EAAE,uBAAuB;qBAAE,IAAI,EAAE,QAAQ;;qBAC7C,IAAI,EAAE,SAAS;qBAAE,IAAI,EAAE,SAAS;;qBAChC,IAAI,EAAE,WAAW;qBAAE,IAAI,EAAE,SAAS;;qBAClC,IAAI,EAAE,aAAa;qBAAE,IAAI,EAAE,SAAS;;qBACpC,IAAI,EAAE,kBAAkB;qBAAE,IAAI,EAAE,SAAS;;qBACzC,IAAI,EAAE,iBAAiB;qBAAE,IAAI,EAAE,SAAS;;qBACxC,IAAI,EAAE,YAAY;qBAAE,IAAI,EAAE,SAAS;;qBACnC,IAAI,EAAE,OAAO;qBAAE,IAAI,EAAE,SAAS;;qBAC9B,IAAI,EAAE,QAAQ;qBAAE,IAAI,EAAE,QAAQ;;;iBAGlC,IAAI,EAAE,eAAe;iBAAE,IAAI,EAAE,OAAO;;aAExC,OAAO;aACP,eAAe,EAAE,YAAY;EAEvB,CAAA;AAEV;;;GAGG;AACH,eAAO,MAAM,gBAAgB,EAAE,GAAwC,CAAA;AAEvE;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB;aAE1B,IAAI,EAAE,UAAU;aAChB,IAAI,EAAE,iBAAiB;aACvB,MAAM;iBAAK,IAAI,EAAE,UAAU;iBAAE,IAAI,EAAE,SAAS;;aAC5C,OAAO;aACP,eAAe,EAAE,YAAY;;aAG7B,IAAI,EAAE,UAAU;aAChB,IAAI,EAAE,gBAAgB;aACtB,MAAM;iBAAK,IAAI,EAAE,UAAU;iBAAE,IAAI,EAAE,SAAS;;aAC5C,OAAO;aACP,eAAe,EAAE,YAAY;;aAG7B,IAAI,EAAE,UAAU;aAChB,IAAI,EAAE,kBAAkB;aACxB,MAAM;iBAAK,IAAI,EAAE,UAAU;iBAAE,IAAI,EAAE,SAAS;;aAC5C,OAAO;iBAAK,IAAI,EAAE,EAAE;iBAAE,IAAI,EAAE,MAAM;;aAClC,eAAe,EAAE,MAAM;;aAGvB,IAAI,EAAE,UAAU;aAChB,IAAI,EAAE,YAAY;aAClB,MAAM;iBACF,IAAI,EAAE,cAAc;iBAAE,IAAI,EAAE,SAAS;;iBACrC,IAAI,EAAE,MAAM;iBAAE,IAAI,EAAE,OAAO;;aAE/B,OAAO;aACP,eAAe,EAAE,YAAY;;aAG7B,IAAI,EAAE,UAAU;aAChB,IAAI,EAAE,SAAS;aACf,MAAM;iBACF,IAAI,EAAE,cAAc;iBAAE,IAAI,EAAE,SAAS;;iBACrC,IAAI,EAAE,MAAM;iBAAE,IAAI,EAAE,OAAO;;iBAC3B,IAAI,EAAE,cAAc;iBAAE,IAAI,EAAE,OAAO;;iBACnC,IAAI,EAAE,YAAY;iBAAE,IAAI,EAAE,QAAQ;;iBAClC,IAAI,EAAE,eAAe;iBAAE,IAAI,EAAE,SAAS;;aAE1C,OAAO;aACP,eAAe,EAAE,YAAY;EAEvB,CAAA;AAEV;;;GAGG;AACH,OAAO,EAAE,WAAW,EAAE,CAAA;AAEtB;;;;GAIG;AACH,eAAO,MAAM,iBAAiB;aAE1B,IAAI,EAAE,UAAU;aAChB,IAAI,EAAE,cAAc;aACpB,MAAM;iBAAK,IAAI,EAAE,aAAa;iBAAE,IAAI,EAAE,SAAS;;aAC/C,OAAO;iBAAK,IAAI,EAAE,EAAE;iBAAE,IAAI,EAAE,SAAS;;aACrC,eAAe,EAAE,MAAM;EAEjB,CAAA;AAEV,yFAAyF;AACzF,wBAAgB,gBAAgB,CAC9B,MAAM,EAAE,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,EAChC,IAAI,EAAE,OAAO,EACb,WAAW,EAAE,GAAG,GACf,OAAO,CAAC,MAAM,CAAC,CAOjB;AAED,uCAAuC;AACvC,MAAM,WAAW,IAAI;IACnB,EAAE,EAAE,OAAO,CAAA;IACX,IAAI,EAAE,GAAG,CAAA;CACV;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,UAAU,GAAG,IAAI,EAAE,CAoB9E;AAED,wEAAwE;AACxE,wBAAgB,cAAc,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,GAAG,IAAI,CAKvE;AAED,mGAAmG;AACnG,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,GAAG,IAAI,CAS1E;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,GAAG,IAAI,CASzE;AAED;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,OAAO,EAAE,YAAY,EAAE,GAAG,GAAG,IAAI,CASrE;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,gBAAgB,GAAG,IAAI,CAe5E;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,aAAa,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAGrE;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,WAAW;aAEpB,IAAI,EAAE,UAAU;aAChB,IAAI,EAAE,SAAS;aACf,MAAM;iBACF,IAAI,EAAE,cAAc;iBAAE,IAAI,EAAE,SAAS;;iBACrC,IAAI,EAAE,MAAM;iBAAE,IAAI,EAAE,OAAO;;aAE/B,OAAO;aACP,eAAe,EAAE,YAAY;;aAE7B,IAAI,EAAE,OAAO;aAAE,IAAI,EAAE,YAAY;aAAE,MAAM;EACnC,CAAA;AAEV,uFAAuF;AACvF,wBAAgB,WAAW,CAAC,IAAI,EAAE,OAAO,EAAE,YAAY,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,GAAG,IAAI,CAS9E"}