@zerc20/wallet-sdk 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <https://unlicense.org/>

package/README.md

@@ -1,3 +1,27 @@
-# Temporary Holding Version
+# @zerc20/wallet-sdk
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+A zERC20 wallet for browsers and Node: deposits, private payments, merges, withdrawals and rage exits. Proofs are made
+on the device, and what the attester and the merge prover need reaches them sealed to an enclave the SDK has checked.
+
+```sh
+npm install @zerc20/wallet-sdk viem
+```
+
+Node 22.12 or later. viem is a peer dependency: the SDK tells a declined wallet prompt by viem's error classes, so it
+must be the app's own copy.
+
+```ts
+import { Wallet, networkFromJson, seedFromSignature } from '@zerc20/wallet-sdk';
+
+const network = networkFromJson(networkJson);
+const { seed } = await seedFromSignature(walletClient); // a viem WalletClient with its account
+const wallet = await Wallet.open({ network, walletClient, seed, persist: { load, save } });
+await wallet.sync();
+wallet.balances();
+const q = await wallet.fees({ kind: 'send', token, amount });
+await (await wallet.send({ to: '0x…', token, amount, maxFee: q.fee })).wait();
+```
+
+## License
+
+[Unlicense](LICENSE)

package/dist/burnWorker.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/burnWorker.js

@@ -0,0 +1,21 @@
+// Searches a burn address off the main thread: core.ts starts one per search, a Web Worker in a browser and a worker
+// thread in Node.
+import { initCore, searchHere } from './core.js';
+async function answer(s) {
+    try {
+        await initCore();
+        return { burn: searchHere(s) };
+    }
+    catch (e) {
+        return { error: e instanceof Error ? e.message : String(e) };
+    }
+}
+if (typeof self !== 'undefined') {
+    self.onmessage = async ({ data }) => postMessage(await answer(data));
+}
+else {
+    // a variable, so that bundlers for the browser leave Node's module alone
+    const threads = 'node:worker_threads';
+    void import(/* @vite-ignore */ threads).then(async ({ parentPort, workerData }) => parentPort.postMessage(await answer(workerData)));
+}
+//# sourceMappingURL=burnWorker.js.map

package/dist/burnWorker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"burnWorker.js","sourceRoot":"","sources":["../src/burnWorker.ts"],"names":[],"mappings":"AAAA,qHAAqH;AACrH,kBAAkB;AAElB,OAAO,EAAoC,QAAQ,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAEnF,KAAK,UAAU,MAAM,CAAC,CAAa;IACjC,IAAI,CAAC;QACH,MAAM,QAAQ,EAAE,CAAC;QACjB,OAAO,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;IACjC,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,OAAO,EAAE,KAAK,EAAE,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;IAC/D,CAAC;AACH,CAAC;AAED,IAAI,OAAO,IAAI,KAAK,WAAW,EAAE,CAAC;IAChC,IAAI,CAAC,SAAS,GAAG,KAAK,EAAE,EAAE,IAAI,EAA4B,EAAE,EAAE,CAAC,WAAW,CAAC,MAAM,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;AACjG,CAAC;KAAM,CAAC;IACN,yEAAyE;IACzE,MAAM,OAAO,GAAG,qBAAqB,CAAC;IAEtC,KAAK,MAAM,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC,IAAI,CAC1C,KAAK,EAAE,EAAE,UAAU,EAAE,UAAU,EAAgD,EAAE,EAAE,CACjF,UAAU,CAAC,WAAW,CAAC,MAAM,MAAM,CAAC,UAAU,CAAC,CAAC,CACnD,CAAC;AACJ,CAAC"}

package/dist/chain.d.ts

@@ -0,0 +1,345 @@
+import { type Address, type Hex, type PublicClient } from 'viem';
+import type { ChainConfig } from './network.js';
+export declare const verifierAbi: readonly [{
+    readonly name: "ledger";
+    readonly type: "function";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly type: "address";
+    }];
+}, {
+    readonly name: "factory";
+    readonly type: "function";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly type: "address";
+    }];
+}, {
+    readonly name: "latestAspRoot";
+    readonly type: "function";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly type: "uint256";
+    }];
+}, {
+    readonly name: "withdrawFee";
+    readonly type: "function";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [{
+        readonly type: "uint32";
+        readonly name: "tokenId";
+    }, {
+        readonly type: "uint256";
+        readonly name: "amount";
+    }];
+    readonly outputs: readonly [{
+        readonly type: "uint256";
+    }];
+}, {
+    readonly name: "rageExit";
+    readonly type: "function";
+    readonly stateMutability: "nonpayable";
+    readonly inputs: readonly [{
+        readonly type: "tuple";
+        readonly components: readonly [{
+            readonly type: "uint64";
+            readonly name: "checkpointIndex";
+        }, {
+            readonly type: "uint256";
+            readonly name: "prevHashChain";
+        }, {
+            readonly type: "uint256[4][]";
+            readonly name: "commitments";
+        }, {
+            readonly type: "uint256";
+            readonly name: "nullifier";
+        }, {
+            readonly name: "proof";
+            readonly type: "tuple";
+            readonly components: readonly [{
+                readonly type: "uint256[2]";
+                readonly name: "pA";
+            }, {
+                readonly type: "uint256[2][2]";
+                readonly name: "pB";
+            }, {
+                readonly type: "uint256[2]";
+                readonly name: "pC";
+            }];
+        }];
+        readonly name: "request";
+    }];
+    readonly outputs: readonly [];
+}];
+export declare const ledgerAbi: readonly [{
+    readonly name: "provedRoots";
+    readonly type: "function";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [{
+        readonly type: "uint64";
+        readonly name: "index";
+    }, {
+        readonly type: "uint256";
+        readonly name: "root";
+    }];
+    readonly outputs: readonly [{
+        readonly type: "bool";
+    }];
+}, {
+    readonly name: "bound";
+    readonly type: "function";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly type: "uint64";
+    }];
+}, {
+    readonly name: "hashChainAt";
+    readonly type: "function";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [{
+        readonly type: "uint64";
+        readonly name: "index";
+    }];
+    readonly outputs: readonly [{
+        readonly type: "uint256";
+    }, {
+        readonly type: "bool";
+    }];
+}, {
+    readonly name: "reserveHashChain";
+    readonly type: "function";
+    readonly stateMutability: "nonpayable";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly type: "uint64";
+        readonly name: "index";
+    }, {
+        readonly type: "uint256";
+        readonly name: "checkpoint";
+    }];
+}, {
+    readonly name: "verifySegment";
+    readonly type: "function";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [{
+        readonly type: "uint64";
+        readonly name: "end";
+    }, {
+        readonly type: "uint256";
+        readonly name: "prev";
+    }, {
+        readonly type: "uint256[4][]";
+        readonly name: "commits";
+    }];
+    readonly outputs: readonly [{
+        readonly type: "uint64";
+        readonly name: "start";
+    }];
+}, {
+    readonly name: "checkpointBefore";
+    readonly type: "function";
+    readonly stateMutability: "nonpayable";
+    readonly inputs: readonly [{
+        readonly type: "uint64";
+        readonly name: "end";
+    }, {
+        readonly type: "uint256";
+        readonly name: "prev";
+    }, {
+        readonly type: "uint256[4][]";
+        readonly name: "commits";
+    }];
+    readonly outputs: readonly [{
+        readonly type: "uint64";
+        readonly name: "start";
+    }];
+}];
+export declare const factoryAbi: readonly [{
+    readonly name: "tokenCount";
+    readonly type: "function";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly type: "uint32";
+    }];
+}, {
+    readonly name: "tokenById";
+    readonly type: "function";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [{
+        readonly type: "uint32";
+        readonly name: "tokenId";
+    }];
+    readonly outputs: readonly [{
+        readonly type: "address";
+    }];
+}];
+export declare const tokenAbi: readonly [{
+    readonly name: "symbol";
+    readonly type: "function";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly type: "string";
+    }];
+}, {
+    readonly name: "decimals";
+    readonly type: "function";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly type: "uint8";
+    }];
+}, {
+    readonly name: "underlyingAsset";
+    readonly type: "function";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly type: "address";
+    }];
+}, {
+    readonly name: "wrap";
+    readonly type: "function";
+    readonly stateMutability: "payable";
+    readonly inputs: readonly [{
+        readonly type: "uint256";
+        readonly name: "amount";
+    }, {
+        readonly type: "address";
+        readonly name: "receiver";
+    }];
+    readonly outputs: readonly [];
+}];
+export declare const erc20Abi: readonly [{
+    readonly name: "balanceOf";
+    readonly type: "function";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [{
+        readonly type: "address";
+        readonly name: "owner";
+    }];
+    readonly outputs: readonly [{
+        readonly type: "uint256";
+    }];
+}, {
+    readonly name: "allowance";
+    readonly type: "function";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [{
+        readonly type: "address";
+        readonly name: "owner";
+    }, {
+        readonly type: "address";
+        readonly name: "spender";
+    }];
+    readonly outputs: readonly [{
+        readonly type: "uint256";
+    }];
+}, {
+    readonly name: "approve";
+    readonly type: "function";
+    readonly stateMutability: "nonpayable";
+    readonly inputs: readonly [{
+        readonly type: "address";
+        readonly name: "spender";
+    }, {
+        readonly type: "uint256";
+        readonly name: "amount";
+    }];
+    readonly outputs: readonly [{
+        readonly type: "bool";
+    }];
+}, {
+    readonly name: "transfer";
+    readonly type: "function";
+    readonly stateMutability: "nonpayable";
+    readonly inputs: readonly [{
+        readonly type: "address";
+        readonly name: "to";
+    }, {
+        readonly type: "uint256";
+        readonly name: "amount";
+    }];
+    readonly outputs: readonly [{
+        readonly type: "bool";
+    }];
+}];
+export declare const depositFactoryAbi: readonly [{
+    readonly name: "predict";
+    readonly type: "function";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [{
+        readonly type: "address";
+        readonly name: "token";
+    }, {
+        readonly type: "address";
+        readonly name: "burnAddress";
+    }, {
+        readonly type: "address";
+        readonly name: "refundAddress";
+    }, {
+        readonly type: "address";
+        readonly name: "feeRecipient";
+    }, {
+        readonly type: "uint256";
+        readonly name: "fee";
+    }];
+    readonly outputs: readonly [{
+        readonly type: "address";
+    }];
+}];
+export declare const depositAddressAbi: readonly [{
+    readonly name: "refund";
+    readonly type: "function";
+    readonly stateMutability: "nonpayable";
+    readonly inputs: readonly [{
+        readonly type: "address";
+        readonly name: "asset";
+    }];
+    readonly outputs: readonly [];
+}];
+/** The native asset's stand-in for `underlyingAsset`. */
+export declare const NATIVE: Address;
+/** `Protocol.UNWRAP_INTENT`: the `withdrawIntent` that pays a withdrawal out as the underlying asset. The EIP-712 struct
+ * hash of `Unwrap()`, reduced into the BN254 field. */
+export declare const UNWRAP_INTENT: bigint;
+/** A zERC20 token on one chain. Amounts are in its base units, the same as its underlying asset's. */
+export interface Token {
+    chainId: bigint;
+    tokenId: number;
+    /** The zERC20 token: what a public withdrawal pays out (unless it unwraps), and what `unwrap` turns back into
+     * `underlying`. */
+    address: Address;
+    underlying: Address;
+    symbol: string;
+    decimals: number;
+}
+export declare class Chain {
+    #private;
+    readonly config: ChainConfig;
+    readonly client: PublicClient;
+    constructor(config: ChainConfig);
+    get chainId(): bigint;
+    ledger(): Promise<Address>;
+    /** The deposit address the factory deploys for `token`, `burnAddress` and `refundAddress`, whose flush pays `fee`
+     * to `feeRecipient`. */
+    predictDepositAddress(token: Address, burnAddress: Hex, refundAddress: Address, feeRecipient: Address, fee: bigint): Promise<Address>;
+    /** The refund address of `address` if it is a deployed deposit address for `token` and `burnAddress`, whatever its
+     * refund address and fee; null if it is not one. A clone's code ends with its immutable args, `abi.encode(token,
+     * burnAddress, refundAddress, feeRecipient, fee)`; the factory's address for them confirms it, so code made to look
+     * like one does not pass. */
+    depositAddressRefund(address: Address, token: Address, burnAddress: Hex): Promise<Address | null>;
+    /** Whether the ledger accepts `root` as the tree at `size` leaves. */
+    provedRoot(size: number, root: Hex): Promise<boolean>;
+    /** `2^64 - 1`, unless the ledger is in an emergency: then it accepts no root above it, and proves none. */
+    bound(): Promise<bigint>;
+    latestAspRoot(): Promise<Hex>;
+    withdrawFee(tokenId: number, amount: bigint): Promise<bigint>;
+    /** Every token the factory has registered, read once and then only the new ones. */
+    tokens(): Promise<Token[]>;
+}

package/dist/chain.js

@@ -0,0 +1,149 @@
+// What a wallet reads from the chain itself, through its own RPC: roots are taken from here, never from a server.
+import { createPublicClient, decodeAbiParameters, http, keccak256, numberToHex, parseAbi, size, slice, toHex, zeroAddress, } from 'viem';
+export const verifierAbi = parseAbi([
+    'function ledger() view returns (address)',
+    'function factory() view returns (address)',
+    'function latestAspRoot() view returns (uint256)',
+    'function withdrawFee(uint32 tokenId, uint256 amount) view returns (uint256)',
+    'struct Groth16Proof { uint256[2] pA; uint256[2][2] pB; uint256[2] pC; }',
+    'struct TransactSignals { uint256 tokenId; uint256 chainId; uint256 commitmentRoot; uint256 aspRoot; uint256 nullifier0; uint256 nullifier1; uint256 withdrawRecipient; uint256 withdrawAmount; uint256 withdrawIntent; uint256 noteHash1; uint256 noteHash2; }',
+    'struct RageExitRequest { uint64 checkpointIndex; uint256 prevHashChain; uint256[4][] commitments; uint256 nullifier; Groth16Proof proof; }',
+    'function rageExit(RageExitRequest request)',
+]);
+export const ledgerAbi = parseAbi([
+    'function provedRoots(uint64 index, uint256 root) view returns (bool)',
+    'function bound() view returns (uint64)',
+    'function hashChainAt(uint64 index) view returns (uint256, bool)',
+    'function reserveHashChain() returns (uint64 index, uint256 checkpoint)',
+    'function verifySegment(uint64 end, uint256 prev, uint256[4][] commits) view returns (uint64 start)',
+    'function checkpointBefore(uint64 end, uint256 prev, uint256[4][] commits) returns (uint64 start)',
+]);
+export const factoryAbi = parseAbi([
+    'function tokenCount() view returns (uint32)',
+    'function tokenById(uint32 tokenId) view returns (address)',
+]);
+export const tokenAbi = parseAbi([
+    'function symbol() view returns (string)',
+    'function decimals() view returns (uint8)',
+    'function underlyingAsset() view returns (address)',
+    'function wrap(uint256 amount, address receiver) payable',
+]);
+export const erc20Abi = parseAbi([
+    'function balanceOf(address owner) view returns (uint256)',
+    'function allowance(address owner, address spender) view returns (uint256)',
+    'function approve(address spender, uint256 amount) returns (bool)',
+    'function transfer(address to, uint256 amount) returns (bool)',
+]);
+export const depositFactoryAbi = parseAbi([
+    'function predict(address token, address burnAddress, address refundAddress, address feeRecipient, uint256 fee) view returns (address)',
+]);
+export const depositAddressAbi = parseAbi(['function refund(address asset)']);
+/** The native asset's stand-in for `underlyingAsset`. */
+export const NATIVE = '0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE';
+/** `Protocol.UNWRAP_INTENT`: the `withdrawIntent` that pays a withdrawal out as the underlying asset. The EIP-712 struct
+ * hash of `Unwrap()`, reduced into the BN254 field. */
+export const UNWRAP_INTENT = BigInt(keccak256(keccak256(toHex('Unwrap()')))) %
+    21888242871839275222246405745257275088548364400416034343698204186575808495617n;
+export class Chain {
+    config;
+    client;
+    #ledger;
+    #tokens;
+    constructor(config) {
+        this.config = config;
+        this.client = createPublicClient({ transport: http(config.rpcUrl) });
+    }
+    get chainId() {
+        return this.config.chainId;
+    }
+    ledger() {
+        this.#ledger ??= this.client.readContract({
+            address: this.config.verifier,
+            abi: verifierAbi,
+            functionName: 'ledger',
+        });
+        return this.#ledger;
+    }
+    /** The deposit address the factory deploys for `token`, `burnAddress` and `refundAddress`, whose flush pays `fee`
+     * to `feeRecipient`. */
+    predictDepositAddress(token, burnAddress, refundAddress, feeRecipient, fee) {
+        return this.client.readContract({
+            address: this.config.depositAddressFactory,
+            abi: depositFactoryAbi,
+            functionName: 'predict',
+            args: [token, burnAddress, refundAddress, feeRecipient, fee],
+        });
+    }
+    /** The refund address of `address` if it is a deployed deposit address for `token` and `burnAddress`, whatever its
+     * refund address and fee; null if it is not one. A clone's code ends with its immutable args, `abi.encode(token,
+     * burnAddress, refundAddress, feeRecipient, fee)`; the factory's address for them confirms it, so code made to look
+     * like one does not pass. */
+    async depositAddressRefund(address, token, burnAddress) {
+        const code = await this.client.getCode({ address });
+        if (!code || size(code) < 160)
+            return null;
+        const [refundAddress, feeRecipient, fee] = decodeAbiParameters([{ type: 'address' }, { type: 'address' }, { type: 'uint256' }], slice(code, size(code) - 96));
+        if (refundAddress === zeroAddress || feeRecipient === zeroAddress)
+            return null; // predict would revert
+        const expected = await this.predictDepositAddress(token, burnAddress, refundAddress, feeRecipient, fee);
+        return expected.toLowerCase() === address.toLowerCase() ? refundAddress : null;
+    }
+    /** Whether the ledger accepts `root` as the tree at `size` leaves. */
+    async provedRoot(size, root) {
+        return this.client.readContract({
+            address: await this.ledger(),
+            abi: ledgerAbi,
+            functionName: 'provedRoots',
+            args: [BigInt(size), BigInt(root)],
+        });
+    }
+    /** `2^64 - 1`, unless the ledger is in an emergency: then it accepts no root above it, and proves none. */
+    async bound() {
+        return this.client.readContract({ address: await this.ledger(), abi: ledgerAbi, functionName: 'bound' });
+    }
+    async latestAspRoot() {
+        const root = await this.client.readContract({
+            address: this.config.verifier,
+            abi: verifierAbi,
+            functionName: 'latestAspRoot',
+        });
+        return numberToHex(root, { size: 32 });
+    }
+    withdrawFee(tokenId, amount) {
+        return this.client.readContract({
+            address: this.config.verifier,
+            abi: verifierAbi,
+            functionName: 'withdrawFee',
+            args: [tokenId, amount],
+        });
+    }
+    /** Every token the factory has registered, read once and then only the new ones. */
+    async tokens() {
+        const factory = await this.client.readContract({
+            address: this.config.verifier,
+            abi: verifierAbi,
+            functionName: 'factory',
+        });
+        const count = await this.client.readContract({ address: factory, abi: factoryAbi, functionName: 'tokenCount' });
+        const known = this.#tokens ?? [];
+        const fresh = await Promise.all(Array.from({ length: count - known.length }, async (_, i) => {
+            const tokenId = known.length + i + 1;
+            const address = await this.client.readContract({
+                address: factory,
+                abi: factoryAbi,
+                functionName: 'tokenById',
+                args: [tokenId],
+            });
+            const read = (functionName) => this.client.readContract({ address, abi: tokenAbi, functionName });
+            const [symbol, decimals, underlying] = await Promise.all([
+                read('symbol'),
+                read('decimals'),
+                read('underlyingAsset'),
+            ]);
+            return { chainId: this.chainId, tokenId, address, underlying, symbol, decimals };
+        }));
+        this.#tokens = [...known, ...fresh];
+        return this.#tokens;
+    }
+}
+//# 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,kHAAkH;AAElH,OAAO,EAIL,kBAAkB,EAClB,mBAAmB,EACnB,IAAI,EACJ,SAAS,EACT,WAAW,EACX,QAAQ,EACR,IAAI,EACJ,KAAK,EACL,KAAK,EACL,WAAW,GACZ,MAAM,MAAM,CAAC;AAGd,MAAM,CAAC,MAAM,WAAW,GAAG,QAAQ,CAAC;IAClC,0CAA0C;IAC1C,2CAA2C;IAC3C,iDAAiD;IACjD,6EAA6E;IAC7E,yEAAyE;IACzE,gQAAgQ;IAChQ,4IAA4I;IAC5I,4CAA4C;CAC7C,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,SAAS,GAAG,QAAQ,CAAC;IAChC,sEAAsE;IACtE,wCAAwC;IACxC,iEAAiE;IACjE,wEAAwE;IACxE,oGAAoG;IACpG,kGAAkG;CACnG,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,UAAU,GAAG,QAAQ,CAAC;IACjC,6CAA6C;IAC7C,2DAA2D;CAC5D,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,QAAQ,GAAG,QAAQ,CAAC;IAC/B,yCAAyC;IACzC,0CAA0C;IAC1C,mDAAmD;IACnD,yDAAyD;CAC1D,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,QAAQ,GAAG,QAAQ,CAAC;IAC/B,0DAA0D;IAC1D,2EAA2E;IAC3E,kEAAkE;IAClE,8DAA8D;CAC/D,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,iBAAiB,GAAG,QAAQ,CAAC;IACxC,uIAAuI;CACxI,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,iBAAiB,GAAG,QAAQ,CAAC,CAAC,gCAAgC,CAAC,CAAC,CAAC;AAE9E,yDAAyD;AACzD,MAAM,CAAC,MAAM,MAAM,GAAY,4CAA4C,CAAC;AAE5E;uDACuD;AACvD,MAAM,CAAC,MAAM,aAAa,GACxB,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IAC/C,8EAA8E,CAAC;AAcjF,MAAM,OAAO,KAAK;IAKK;IAJZ,MAAM,CAAe;IAC9B,OAAO,CAAoB;IAC3B,OAAO,CAAW;IAElB,YAAqB,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;QACtC,IAAI,CAAC,MAAM,GAAG,kBAAkB,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACvE,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC;IAC7B,CAAC;IAED,MAAM;QACJ,IAAI,CAAC,OAAO,KAAK,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;YACxC,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ;YAC7B,GAAG,EAAE,WAAW;YAChB,YAAY,EAAE,QAAQ;SACvB,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;4BACwB;IACxB,qBAAqB,CACnB,KAAc,EACd,WAAgB,EAChB,aAAsB,EACtB,YAAqB,EACrB,GAAW;QAEX,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;YAC9B,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,qBAAqB;YAC1C,GAAG,EAAE,iBAAiB;YACtB,YAAY,EAAE,SAAS;YACvB,IAAI,EAAE,CAAC,KAAK,EAAE,WAAW,EAAE,aAAa,EAAE,YAAY,EAAE,GAAG,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;iCAG6B;IAC7B,KAAK,CAAC,oBAAoB,CAAC,OAAgB,EAAE,KAAc,EAAE,WAAgB;QAC3E,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;QACpD,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,GAAG;YAAE,OAAO,IAAI,CAAC;QAC3C,MAAM,CAAC,aAAa,EAAE,YAAY,EAAE,GAAG,CAAC,GAAG,mBAAmB,CAC5D,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,EAC/D,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAC7B,CAAC;QACF,IAAI,aAAa,KAAK,WAAW,IAAI,YAAY,KAAK,WAAW;YAAE,OAAO,IAAI,CAAC,CAAC,uBAAuB;QACvG,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,qBAAqB,CAAC,KAAK,EAAE,WAAW,EAAE,aAAa,EAAE,YAAY,EAAE,GAAG,CAAC,CAAC;QACxG,OAAO,QAAQ,CAAC,WAAW,EAAE,KAAK,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC;IACjF,CAAC;IAED,sEAAsE;IACtE,KAAK,CAAC,UAAU,CAAC,IAAY,EAAE,IAAS;QACtC,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;YAC9B,OAAO,EAAE,MAAM,IAAI,CAAC,MAAM,EAAE;YAC5B,GAAG,EAAE,SAAS;YACd,YAAY,EAAE,aAAa;YAC3B,IAAI,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;SACnC,CAAC,CAAC;IACL,CAAC;IAED,2GAA2G;IAC3G,KAAK,CAAC,KAAK;QACT,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,OAAO,EAAE,MAAM,IAAI,CAAC,MAAM,EAAE,EAAE,GAAG,EAAE,SAAS,EAAE,YAAY,EAAE,OAAO,EAAE,CAAC,CAAC;IAC3G,CAAC;IAED,KAAK,CAAC,aAAa;QACjB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;YAC1C,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ;YAC7B,GAAG,EAAE,WAAW;YAChB,YAAY,EAAE,eAAe;SAC9B,CAAC,CAAC;QACH,OAAO,WAAW,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;IACzC,CAAC;IAED,WAAW,CAAC,OAAe,EAAE,MAAc;QACzC,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;YAC9B,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ;YAC7B,GAAG,EAAE,WAAW;YAChB,YAAY,EAAE,aAAa;YAC3B,IAAI,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC;SACxB,CAAC,CAAC;IACL,CAAC;IAED,oFAAoF;IACpF,KAAK,CAAC,MAAM;QACV,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;YAC7C,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ;YAC7B,GAAG,EAAE,WAAW;YAChB,YAAY,EAAE,SAAS;SACxB,CAAC,CAAC;QACH,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,UAAU,EAAE,YAAY,EAAE,YAAY,EAAE,CAAC,CAAC;QAChH,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC;QACjC,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,GAAG,CAC7B,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,KAAK,GAAG,KAAK,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE;YAC1D,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,GAAG,CAAC,CAAC;YACrC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;gBAC7C,OAAO,EAAE,OAAO;gBAChB,GAAG,EAAE,UAAU;gBACf,YAAY,EAAE,WAAW;gBACzB,IAAI,EAAE,CAAC,OAAO,CAAC;aAChB,CAAC,CAAC;YACH,MAAM,IAAI,GAAG,CAAsD,YAAe,EAAE,EAAE,CACpF,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,YAAY,EAAE,CAAC,CAAC;YACrE,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,UAAU,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;gBACvD,IAAI,CAAC,QAAQ,CAAC;gBACd,IAAI,CAAC,UAAU,CAAC;gBAChB,IAAI,CAAC,iBAAiB,CAAC;aACxB,CAAC,CAAC;YACH,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;QACnF,CAAC,CAAC,CACH,CAAC;QACF,IAAI,CAAC,OAAO,GAAG,CAAC,GAAG,KAAK,EAAE,GAAG,KAAK,CAAC,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;CACF"}

package/dist/context.d.ts

@@ -0,0 +1,48 @@
+import type { CanisterClient, ViewKey } from '@zerc20/storage-sdk';
+import { type Hex, type WalletClient } from 'viem';
+import type { Chain } from './chain.js';
+import type { ChainConfig, Network } from './network.js';
+import type { Asp, Indexer } from './servers.js';
+import type { ChainState, WalletState } from './state.js';
+export interface ChainCtx {
+    config: ChainConfig;
+    chain: Chain;
+    indexer: Indexer;
+    asp: Asp;
+}
+export interface SpendKey {
+    /** The circuits' `private_key`: only this wallet's own proofs take it. */
+    secret: Hex;
+    /** The hash of the key that signs this key's spends, which the circuits take with `secret`. */
+    authKeyHash: Hex;
+    publicKey: Hex;
+    nullifyingKey: Hex;
+}
+export interface Ctx {
+    network: Network;
+    seed: Uint8Array;
+    address: Hex;
+    walletClient: WalletClient;
+    storage: CanisterClient;
+    view: ViewKey;
+    chains: ChainCtx[];
+    state: WalletState;
+    save(): Promise<void>;
+    /** When storage was last read in full rather than through its log (in memory: the first sync does it). */
+    lastFullRefreshMs: number;
+}
+/** A receive code of this seed's: its chain, token and index (the burn index the code shares). */
+export interface CodeId {
+    chainId: bigint;
+    tokenId: number;
+    index: number;
+}
+/** The key that owns this seed's notes and deposits on every chain and token, or with `code`, the notes paid to that
+ * receive code. */
+export declare function spendKey(ctx: Ctx, code?: CodeId): SpendKey;
+export declare function chainCtx(ctx: Ctx, chainId: bigint): ChainCtx;
+export declare function chainState(ctx: Ctx, chainId: bigint): ChainState;
+/** Waits until the wallet's own node has a transaction mined on ours too: the wallet simulates the next one there, and
+ * where blocks are fast that node lags ours now and then, so the next one would show as reverting. A wallet that does
+ * not answer is not waited on. */
+export declare function walletSees(wc: WalletClient, hash: Hex): Promise<void>;

package/dist/context.js

@@ -0,0 +1,40 @@
+// Everything an open wallet works with, shared by sync and the operations.
+import { publicActions } from 'viem';
+import { core } from './core.js';
+const keys = new WeakMap();
+/** The key that owns this seed's notes and deposits on every chain and token, or with `code`, the notes paid to that
+ * receive code. */
+export function spendKey(ctx, code) {
+    let bySeed = keys.get(ctx.seed);
+    if (!bySeed)
+        keys.set(ctx.seed, (bySeed = new Map()));
+    const id = code ? `${code.chainId}:${code.tokenId}:${code.index}` : '';
+    let key = bySeed.get(id);
+    if (!key) {
+        key = (code ? core.codeKey(ctx.seed, code.chainId, code.tokenId, code.index) : core.spendKey(ctx.seed));
+        bySeed.set(id, key);
+    }
+    return key;
+}
+export function chainCtx(ctx, chainId) {
+    const c = ctx.chains.find((c) => c.config.chainId === chainId);
+    if (!c)
+        throw new Error(`chain ${chainId} is not in this network`);
+    return c;
+}
+export function chainState(ctx, chainId) {
+    let s = ctx.state.chains.find((c) => c.chainId === chainId);
+    if (!s)
+        ctx.state.chains.push((s = { chainId, samples: [], burnNext: {} }));
+    return s;
+}
+/** Waits until the wallet's own node has a transaction mined on ours too: the wallet simulates the next one there, and
+ * where blocks are fast that node lags ours now and then, so the next one would show as reverting. A wallet that does
+ * not answer is not waited on. */
+export async function walletSees(wc, hash) {
+    await wc
+        .extend(publicActions)
+        .waitForTransactionReceipt({ hash, pollingInterval: 1_000, timeout: 30_000 })
+        .catch(() => { });
+}
+//# sourceMappingURL=context.js.map