@avow-finance/sdk 0.0.0-stage → 0.2.0

package/dist/sandbox/keys.d.ts

@@ -0,0 +1,45 @@
+import { type Address } from 'viem';
+import { type Account } from 'viem/tempo';
+import { type Call } from '../lock.js';
+import type { SandboxClient } from './business.js';
+/**
+ * The block the factory created the business's lock in, read from the factory's own event. Every
+ * key the business authorized came after it, and nothing on this machine can move it. It reads
+ * back from the latest block, since a sandbox business is usually days old, and stops at the block
+ * the factory itself was created in.
+ */
+export declare function lockCreatedIn(m: {
+    client: SandboxClient;
+    factory: Address;
+    account: Address;
+    lock: Address;
+    /** The block the factory was created in. */
+    factoryCreatedIn?: bigint;
+}): Promise<bigint>;
+/**
+ * Every key the account's keychain still lets sign for the account, read from the chain: each
+ * access key and each admin key authorized since `fromBlock` that isn't revoked or expired. The
+ * account's root key isn't in the keychain, so it's never among them. Nothing the agent can write
+ * decides this list.
+ */
+export declare function liveKeys(client: SandboxClient, account: Address, fromBlock: bigint): Promise<Address[]>;
+/** Every supplier the lock approves now, read from the lock's own events and its state. */
+export declare function approvedSuppliers(client: SandboxClient, lock: Address, fromBlock: bigint): Promise<Address[]>;
+/**
+ * The calls that revoke each key in the account's keychain, access or admin, which only the root
+ * key can send.
+ */
+export declare const revokeKeyCalls: (keys: readonly Address[]) => Call[];
+/**
+ * Revokes every key the account's keychain still authorizes, access or admin, apart from `keep`, in
+ * a transaction of its own from the root key. It reads the keys from the chain since `since`, which
+ * the caller takes from the chain too, so no file the agent changed or deleted can keep one live.
+ * It gives the keys it revoked.
+ */
+export declare function revokeOtherKeys(m: {
+    client: SandboxClient;
+    root: Account.RootAccount;
+    since: bigint;
+    keep?: readonly Address[];
+}): Promise<Address[]>;
+//# sourceMappingURL=keys.d.ts.map

package/dist/sandbox/keys.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"keys.d.ts","sourceRoot":"","sources":["../../src/sandbox/keys.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,OAAO,EAMb,MAAM,MAAM,CAAA;AACb,OAAO,EAAQ,KAAK,OAAO,EAAa,MAAM,YAAY,CAAA;AAC1D,OAAO,EAAqB,KAAK,IAAI,EAAE,MAAM,YAAY,CAAA;AAGzD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,eAAe,CAAA;AA8BlD;;;;;GAKG;AACH,wBAAsB,aAAa,CAAC,CAAC,EAAE;IACrC,MAAM,EAAE,aAAa,CAAA;IACrB,OAAO,EAAE,OAAO,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;IAChB,IAAI,EAAE,OAAO,CAAA;IACb,4CAA4C;IAC5C,gBAAgB,CAAC,EAAE,MAAM,CAAA;CAC1B,GAAG,OAAO,CAAC,MAAM,CAAC,CAelB;AAED;;;;;GAKG;AACH,wBAAsB,QAAQ,CAC5B,MAAM,EAAE,aAAa,EACrB,OAAO,EAAE,OAAO,EAChB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,OAAO,EAAE,CAAC,CAqCpB;AAED,2FAA2F;AAC3F,wBAAsB,iBAAiB,CACrC,MAAM,EAAE,aAAa,EACrB,IAAI,EAAE,OAAO,EACb,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,OAAO,EAAE,CAAC,CAkBpB;AAED;;;GAGG;AACH,eAAO,MAAM,cAAc,SAAU,SAAS,OAAO,EAAE,KAAG,IAAI,EAIzD,CAAA;AAEL;;;;;GAKG;AACH,wBAAsB,eAAe,CAAC,CAAC,EAAE;IACvC,MAAM,EAAE,aAAa,CAAA;IACrB,IAAI,EAAE,OAAO,CAAC,WAAW,CAAA;IACzB,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,SAAS,OAAO,EAAE,CAAA;CAC1B,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC,CASrB"}

package/dist/sandbox/keys.js

@@ -0,0 +1,132 @@
+import { encodeFunctionData, getAddress, isAddressEqual, parseAbiItem, zeroAddress, } from 'viem';
+import { Abis, Addresses } from 'viem/tempo';
+import { ADMINISTRATOR_ABI } from '../lock.js';
+import { MODERATO_FACTORY_CREATED_IN } from '../moderato.js';
+import { sendOwn } from '../send.js';
+/** The widest block range one log query takes on Moderato's public node, with room to spare. */
+const STEP = 90000n;
+const KEYCHAIN = Addresses.accountKeychain;
+const KEY_AUTHORIZED = parseAbiItem('event KeyAuthorized(address indexed account, address indexed publicKey, uint8 signatureType, uint64 expiry)');
+const ADMIN_KEY_AUTHORIZED = parseAbiItem('event AdminKeyAuthorized(address indexed account, address indexed publicKey)');
+const LOCK_CREATED = parseAbiItem('event LockCreated(address indexed account, address lock)');
+const SUPPLIER_APPROVED = parseAbiItem('event SupplierApproved(address indexed supplier)');
+/** Every log a filter matches from `fromBlock` to the latest block, a range at a time. */
+async function logsSince(client, fromBlock, read) {
+    const latest = await client.getBlockNumber();
+    const found = [];
+    for (let from = fromBlock; from <= latest; from += STEP) {
+        const to = from + STEP - 1n < latest ? from + STEP - 1n : latest;
+        found.push(...(await read({ fromBlock: from, toBlock: to })));
+    }
+    return found;
+}
+/**
+ * The block the factory created the business's lock in, read from the factory's own event. Every
+ * key the business authorized came after it, and nothing on this machine can move it. It reads
+ * back from the latest block, since a sandbox business is usually days old, and stops at the block
+ * the factory itself was created in.
+ */
+export async function lockCreatedIn(m) {
+    const floor = m.factoryCreatedIn ?? MODERATO_FACTORY_CREATED_IN;
+    for (let to = await m.client.getBlockNumber(); to >= floor; to -= STEP) {
+        const from = to - STEP + 1n > floor ? to - STEP + 1n : floor;
+        const logs = await m.client.getLogs({
+            address: m.factory,
+            event: LOCK_CREATED,
+            args: { account: m.account },
+            fromBlock: from,
+            toBlock: to,
+        });
+        const created = logs.find((l) => l.args.lock && isAddressEqual(l.args.lock, m.lock));
+        if (created && created.blockNumber !== null)
+            return created.blockNumber;
+    }
+    throw new Error(`The factory at ${m.factory} never created the business's lock at ${m.lock}`);
+}
+/**
+ * Every key the account's keychain still lets sign for the account, read from the chain: each
+ * access key and each admin key authorized since `fromBlock` that isn't revoked or expired. The
+ * account's root key isn't in the keychain, so it's never among them. Nothing the agent can write
+ * decides this list.
+ */
+export async function liveKeys(client, account, fromBlock) {
+    const logs = await logsSince(client, fromBlock, async (range) => [
+        ...(await client.getLogs({
+            address: KEYCHAIN,
+            event: KEY_AUTHORIZED,
+            args: { account },
+            ...range,
+        })),
+        ...(await client.getLogs({
+            address: KEYCHAIN,
+            event: ADMIN_KEY_AUTHORIZED,
+            args: { account },
+            ...range,
+        })),
+    ]);
+    const keys = [
+        ...new Set(logs.flatMap((l) => (l.args.publicKey ? [getAddress(l.args.publicKey)] : []))),
+    ].filter((key) => !isAddressEqual(key, account));
+    const now = BigInt(Math.floor(Date.now() / 1000));
+    const live = [];
+    for (const key of keys) {
+        const k = await client.readContract({
+            address: KEYCHAIN,
+            abi: Abis.accountKeychain,
+            functionName: 'getKey',
+            args: [account, key],
+        });
+        const access = !k.isRevoked && k.keyId !== zeroAddress && (k.expiry === 0n || k.expiry > now);
+        const admin = await client.readContract({
+            address: KEYCHAIN,
+            abi: Abis.accountKeychain,
+            functionName: 'isAdminKey',
+            args: [account, key],
+        });
+        if (access || admin)
+            live.push(key);
+    }
+    return live;
+}
+/** Every supplier the lock approves now, read from the lock's own events and its state. */
+export async function approvedSuppliers(client, lock, fromBlock) {
+    const logs = await logsSince(client, fromBlock, (range) => client.getLogs({ address: lock, event: SUPPLIER_APPROVED, ...range }));
+    const candidates = [
+        ...new Set(logs.flatMap((l) => (l.args.supplier ? [getAddress(l.args.supplier)] : []))),
+    ];
+    const approved = [];
+    for (const supplier of candidates) {
+        const still = await client.readContract({
+            address: lock,
+            abi: ADMINISTRATOR_ABI,
+            functionName: 'approvedSupplier',
+            args: [supplier],
+        });
+        if (still)
+            approved.push(supplier);
+    }
+    return approved;
+}
+/**
+ * The calls that revoke each key in the account's keychain, access or admin, which only the root
+ * key can send.
+ */
+export const revokeKeyCalls = (keys) => keys.map((key) => ({
+    to: KEYCHAIN,
+    data: encodeFunctionData({ abi: Abis.accountKeychain, functionName: 'revokeKey', args: [key] }),
+}));
+/**
+ * Revokes every key the account's keychain still authorizes, access or admin, apart from `keep`, in
+ * a transaction of its own from the root key. It reads the keys from the chain since `since`, which
+ * the caller takes from the chain too, so no file the agent changed or deleted can keep one live.
+ * It gives the keys it revoked.
+ */
+export async function revokeOtherKeys(m) {
+    const keep = m.keep ?? [];
+    const live = (await liveKeys(m.client, m.root.address, m.since)).filter((k) => !keep.some((kept) => isAddressEqual(kept, k)));
+    if (live.length > 0) {
+        await sendOwn({ client: m.client, account: m.root, calls: revokeKeyCalls(live) });
+    }
+    return live;
+}
+//# sourceMappingURL=keys.js.map

package/dist/sandbox/keys.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"keys.js","sourceRoot":"","sources":["../../src/sandbox/keys.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,kBAAkB,EAClB,UAAU,EACV,cAAc,EACd,YAAY,EACZ,WAAW,GACZ,MAAM,MAAM,CAAA;AACb,OAAO,EAAE,IAAI,EAAgB,SAAS,EAAE,MAAM,YAAY,CAAA;AAC1D,OAAO,EAAE,iBAAiB,EAAa,MAAM,YAAY,CAAA;AACzD,OAAO,EAAE,2BAA2B,EAAE,MAAM,gBAAgB,CAAA;AAC5D,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AAGpC,gGAAgG;AAChG,MAAM,IAAI,GAAG,MAAO,CAAA;AAEpB,MAAM,QAAQ,GAAG,SAAS,CAAC,eAA0B,CAAA;AACrD,MAAM,cAAc,GAAG,YAAY,CACjC,6GAA6G,CAC9G,CAAA;AACD,MAAM,oBAAoB,GAAG,YAAY,CACvC,8EAA8E,CAC/E,CAAA;AACD,MAAM,YAAY,GAAG,YAAY,CAAC,0DAA0D,CAAC,CAAA;AAC7F,MAAM,iBAAiB,GAAG,YAAY,CAAC,kDAAkD,CAAC,CAAA;AAE1F,0FAA0F;AAC1F,KAAK,UAAU,SAAS,CACtB,MAAqB,EACrB,SAAiB,EACjB,IAAqE;IAErE,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,cAAc,EAAE,CAAA;IAC5C,MAAM,KAAK,GAAQ,EAAE,CAAA;IACrB,KAAK,IAAI,IAAI,GAAG,SAAS,EAAE,IAAI,IAAI,MAAM,EAAE,IAAI,IAAI,IAAI,EAAE,CAAC;QACxD,MAAM,EAAE,GAAG,IAAI,GAAG,IAAI,GAAG,EAAE,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,GAAG,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,MAAM,CAAA;QAChE,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,IAAI,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,CAAA;IAC/D,CAAC;IACD,OAAO,KAAK,CAAA;AACd,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,CAOnC;IACC,MAAM,KAAK,GAAG,CAAC,CAAC,gBAAgB,IAAI,2BAA2B,CAAA;IAC/D,KAAK,IAAI,EAAE,GAAG,MAAM,CAAC,CAAC,MAAM,CAAC,cAAc,EAAE,EAAE,EAAE,IAAI,KAAK,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC;QACvE,MAAM,IAAI,GAAG,EAAE,GAAG,IAAI,GAAG,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,KAAK,CAAA;QAC5D,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC;YAClC,OAAO,EAAE,CAAC,CAAC,OAAO;YAClB,KAAK,EAAE,YAAY;YACnB,IAAI,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;YAC5B,SAAS,EAAE,IAAI;YACf,OAAO,EAAE,EAAE;SACZ,CAAC,CAAA;QACF,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,IAAI,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAA;QACpF,IAAI,OAAO,IAAI,OAAO,CAAC,WAAW,KAAK,IAAI;YAAE,OAAO,OAAO,CAAC,WAAW,CAAA;IACzE,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC,OAAO,yCAAyC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAA;AAC/F,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAC5B,MAAqB,EACrB,OAAgB,EAChB,SAAiB;IAEjB,MAAM,IAAI,GAAG,MAAM,SAAS,CAAC,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC;QAC/D,GAAG,CAAC,MAAM,MAAM,CAAC,OAAO,CAAC;YACvB,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,cAAc;YACrB,IAAI,EAAE,EAAE,OAAO,EAAE;YACjB,GAAG,KAAK;SACT,CAAC,CAAC;QACH,GAAG,CAAC,MAAM,MAAM,CAAC,OAAO,CAAC;YACvB,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,oBAAoB;YAC3B,IAAI,EAAE,EAAE,OAAO,EAAE;YACjB,GAAG,KAAK;SACT,CAAC,CAAC;KACJ,CAAC,CAAA;IACF,MAAM,IAAI,GAAG;QACX,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;KAC1F,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,cAAc,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,CAAA;IAChD,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,CAAA;IACjD,MAAM,IAAI,GAAc,EAAE,CAAA;IAC1B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,MAAM,CAAC,GAAG,MAAM,MAAM,CAAC,YAAY,CAAC;YAClC,OAAO,EAAE,QAAQ;YACjB,GAAG,EAAE,IAAI,CAAC,eAAe;YACzB,YAAY,EAAE,QAAQ;YACtB,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,CAAC;SACrB,CAAC,CAAA;QACF,MAAM,MAAM,GAAG,CAAC,CAAC,CAAC,SAAS,IAAI,CAAC,CAAC,KAAK,KAAK,WAAW,IAAI,CAAC,CAAC,CAAC,MAAM,KAAK,EAAE,IAAI,CAAC,CAAC,MAAM,GAAG,GAAG,CAAC,CAAA;QAC7F,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,YAAY,CAAC;YACtC,OAAO,EAAE,QAAQ;YACjB,GAAG,EAAE,IAAI,CAAC,eAAe;YACzB,YAAY,EAAE,YAAY;YAC1B,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,CAAC;SACrB,CAAC,CAAA;QACF,IAAI,MAAM,IAAI,KAAK;YAAE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IACrC,CAAC;IACD,OAAO,IAAI,CAAA;AACb,CAAC;AAED,2FAA2F;AAC3F,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,MAAqB,EACrB,IAAa,EACb,SAAiB;IAEjB,MAAM,IAAI,GAAG,MAAM,SAAS,CAAC,MAAM,EAAE,SAAS,EAAE,CAAC,KAAK,EAAE,EAAE,CACxD,MAAM,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,iBAAiB,EAAE,GAAG,KAAK,EAAE,CAAC,CACtE,CAAA;IACD,MAAM,UAAU,GAAG;QACjB,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;KACxF,CAAA;IACD,MAAM,QAAQ,GAAc,EAAE,CAAA;IAC9B,KAAK,MAAM,QAAQ,IAAI,UAAU,EAAE,CAAC;QAClC,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,YAAY,CAAC;YACtC,OAAO,EAAE,IAAI;YACb,GAAG,EAAE,iBAAiB;YACtB,YAAY,EAAE,kBAAkB;YAChC,IAAI,EAAE,CAAC,QAAQ,CAAC;SACjB,CAAC,CAAA;QACF,IAAI,KAAK;YAAE,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;IACpC,CAAC;IACD,OAAO,QAAQ,CAAA;AACjB,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,IAAwB,EAAU,EAAE,CACjE,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;IACjB,EAAE,EAAE,QAAQ;IACZ,IAAI,EAAE,kBAAkB,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,eAAe,EAAE,YAAY,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC;CAChG,CAAC,CAAC,CAAA;AAEL;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,CAKrC;IACC,MAAM,IAAI,GAAG,CAAC,CAAC,IAAI,IAAI,EAAE,CAAA;IACzB,MAAM,IAAI,GAAG,CAAC,MAAM,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CACrE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CACrD,CAAA;IACD,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACpB,MAAM,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;IACnF,CAAC;IACD,OAAO,IAAI,CAAA;AACb,CAAC"}

package/dist/sandbox/mailbox.d.ts

@@ -0,0 +1,90 @@
+import { type MailboxOrder, type MailboxOrderRequest, type ReasonCode } from '@avow-finance/spec';
+import { type Hex } from 'viem';
+import { type SandboxStore } from './store.js';
+/** How long an order waits to be funded unless the buyer says otherwise, in seconds. */
+export declare const MAILBOX_ORDER_SECONDS = 600n;
+/** Where a buy got to, in order. */
+export type BuyStep = {
+    step: 'ordered';
+    order: MailboxOrder;
+} | {
+    step: 'quoted';
+    order: MailboxOrder;
+} | {
+    step: 'reserved';
+    fundedIn: Hex | null;
+} | {
+    step: 'accepted';
+    acceptedIn: Hex | null;
+};
+/** How a buy ended. */
+export type BuyOutcome = {
+    ok: true;
+    order: MailboxOrder;
+} | {
+    ok: false;
+    reason: ReasonCode | 'order.expired' | 'acceptance.missed';
+    order: MailboxOrder;
+};
+/** Where a sale got to, in order. */
+export type SellStep = {
+    step: 'compute';
+    reservedIn: Hex | null;
+} | {
+    step: 'quoted';
+} | {
+    step: 'accepted';
+    acceptedIn: Hex | null;
+};
+export interface MailboxOptions {
+    store?: SandboxStore;
+    screenUrl?: string;
+    fetch?: typeof fetch;
+}
+export interface SandboxMailbox {
+    readonly businessId: string;
+    /**
+     * Sends an order for the demo job to another business, with nothing reserved. The order is kept
+     * in the store before it's sent, so `buy` can pick it up after a restart.
+     */
+    order(o: {
+        supplier: string;
+        expiresIn?: bigint;
+    }): Promise<MailboxOrder>;
+    /** The orders this agent sent and hasn't seen through, oldest first, for `buy` to resume. */
+    unfinished(): Promise<MailboxOrderRequest[]>;
+    /** Reads one order, as either side. */
+    read(orderId: string): Promise<MailboxOrder>;
+    /**
+     * Orders a job and sees it through: waits for the quote, checks it, funds the commitment, tells
+     * the mailbox, and waits for the supplier to accept. An order nobody quotes lapses unfunded.
+     * With `resume`, it picks up an unfinished order from where it stands instead of sending one,
+     * and never funds a commitment the lock already holds.
+     */
+    buy(o: {
+        supplier: string;
+        resume?: string;
+        expiresIn?: bigint;
+        onStep?: (step: BuyStep) => void;
+        pollEvery?: number;
+        signal?: AbortSignal;
+    }): Promise<BuyOutcome>;
+    /** The orders waiting on this business as supplier: new ones to quote, funded ones to accept. */
+    inbox(): Promise<MailboxOrder[]>;
+    /** Takes the next step on one order from the inbox: quotes a new one, or accepts a funded one. */
+    sell(order: MailboxOrder, onStep?: (step: SellStep) => void): Promise<void>;
+    /**
+     * Reads the inbox every few seconds and takes each order's next step, until the signal stops it.
+     * An order the handler declines is left to lapse. Nothing wakes this when it isn't running.
+     */
+    listen(o?: {
+        accept?: (order: MailboxOrder) => boolean | Promise<boolean>;
+        onStep?: (order: MailboxOrder, step: SellStep) => void;
+        onError?: (order: MailboxOrder, error: unknown) => void;
+        every?: number;
+        signal?: AbortSignal;
+    }): Promise<void>;
+}
+/** The mailbox for the agent in this folder, as buyer and, when it holds a signing key, supplier. */
+export declare function sandboxMailbox(o?: MailboxOptions): Promise<SandboxMailbox>;
+//# sourceMappingURL=mailbox.d.ts.map

package/dist/sandbox/mailbox.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mailbox.d.ts","sourceRoot":"","sources":["../../src/sandbox/mailbox.ts"],"names":[],"mappings":"AAAA,OAAO,EAWL,KAAK,YAAY,EACjB,KAAK,mBAAmB,EASxB,KAAK,UAAU,EAMhB,MAAM,oBAAoB,CAAA;AAE3B,OAAO,EAAgB,KAAK,GAAG,EAAmB,MAAM,MAAM,CAAA;AAqB9D,OAAO,EAKL,KAAK,YAAY,EAElB,MAAM,YAAY,CAAA;AAenB,wFAAwF;AACxF,eAAO,MAAM,qBAAqB,OAAO,CAAA;AAIzC,oCAAoC;AACpC,MAAM,MAAM,OAAO,GACf;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,KAAK,EAAE,YAAY,CAAA;CAAE,GACxC;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,KAAK,EAAE,YAAY,CAAA;CAAE,GACvC;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,QAAQ,EAAE,GAAG,GAAG,IAAI,CAAA;CAAE,GAC1C;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,UAAU,EAAE,GAAG,GAAG,IAAI,CAAA;CAAE,CAAA;AAEhD,uBAAuB;AACvB,MAAM,MAAM,UAAU,GAClB;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE,YAAY,CAAA;CAAE,GACjC;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,MAAM,EAAE,UAAU,GAAG,eAAe,GAAG,mBAAmB,CAAC;IAAC,KAAK,EAAE,YAAY,CAAA;CAAE,CAAA;AAElG,qCAAqC;AACrC,MAAM,MAAM,QAAQ,GAChB;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,UAAU,EAAE,GAAG,GAAG,IAAI,CAAA;CAAE,GAC3C;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,GAClB;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,UAAU,EAAE,GAAG,GAAG,IAAI,CAAA;CAAE,CAAA;AAEhD,MAAM,WAAW,cAAc;IAC7B,KAAK,CAAC,EAAE,YAAY,CAAA;IACpB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,KAAK,CAAC,EAAE,OAAO,KAAK,CAAA;CACrB;AAmCD,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAC3B;;;OAGG;IACH,KAAK,CAAC,CAAC,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,YAAY,CAAC,CAAA;IACzE,6FAA6F;IAC7F,UAAU,IAAI,OAAO,CAAC,mBAAmB,EAAE,CAAC,CAAA;IAC5C,uCAAuC;IACvC,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,CAAA;IAC5C;;;;;OAKG;IACH,GAAG,CAAC,CAAC,EAAE;QACL,QAAQ,EAAE,MAAM,CAAA;QAChB,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,CAAA;QAChC,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB,MAAM,CAAC,EAAE,WAAW,CAAA;KACrB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IACvB,iGAAiG;IACjG,KAAK,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC,CAAA;IAChC,kGAAkG;IAClG,IAAI,CAAC,KAAK,EAAE,YAAY,EAAE,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,QAAQ,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAC3E;;;OAGG;IACH,MAAM,CAAC,CAAC,CAAC,EAAE;QACT,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,YAAY,KAAK,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;QAC5D,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,YAAY,EAAE,IAAI,EAAE,QAAQ,KAAK,IAAI,CAAA;QACtD,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,OAAO,KAAK,IAAI,CAAA;QACvD,KAAK,CAAC,EAAE,MAAM,CAAA;QACd,MAAM,CAAC,EAAE,WAAW,CAAA;KACrB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CAClB;AAED,qGAAqG;AACrG,wBAAsB,cAAc,CAAC,CAAC,GAAE,cAAmB,GAAG,OAAO,CAAC,cAAc,CAAC,CAwXpF"}