@zerc20/storage-sdk 0.0.0-stage → 0.1.0

package/dist/formats.js

@@ -0,0 +1,238 @@
+// What every blob holds, and the ids and keys of the slots that hold them.
+//
+// A plaintext is `type(1) ‖ body ‖ zeros`, padded to the one length its blob has: every blob is `BLOB_LEN` bytes, so
+// its kind does not show. Each type has one fixed body. A reader takes the body and ignores what follows it, so a
+// later version can append a field that an older reader passes over; a record an older reader must not misread takes
+// a new type, which that reader drops.
+import { bech32m } from '@scure/base';
+import { compare, concat, kdf, readU32, readU64, taggedHash, u32be, u64be, unhex } from './crypto.js';
+import { BLOB_LEN } from './wire.js';
+/** A sealed slot's plaintext: the blob less the nonce and the tag. */
+export const SLOT_PLAIN = BLOB_LEN - 12 - 16;
+/** An inbox announcement's plaintext: also less the ephemeral key. */
+export const ANNOUNCE_PLAIN = BLOB_LEN - 32 - 12 - 16;
+/** The most salts a burn block holds. */
+export const BURN_BLOCK = 6;
+/** The BN254 scalar field modulus `Fr`, big-endian. */
+export const FR_BE = unhex('30644e72e131a029b85045b68181585d2833e84879b9709143e1f593f0000001');
+/** Record types, the first byte of every plaintext. */
+export const NOTE = 0x01;
+export const CODE_NOTE = 0x02;
+export const SELF_NOTE = 0x03;
+export const DEPOSIT = 0x04;
+export const BURN_BLOCK_RECORD = 0x05;
+export const RETURNED = 0x06;
+export const DEPOSIT_ADDRESS = 0x07;
+export const POS_LANE = 0x08;
+export const SENT_TO_ADDRESS = 0x10;
+export const SENT_TO_CODE = 0x11;
+export const CHANNEL = 0x20;
+export const RECEIVE_CODE = 0x40;
+// ---- ids and keys ----
+/** The inbox announcements of channels to `address` go to, under its registration's notify key: another
+ * registration, another inbox, so payers then open fresh channels. */
+export const addressInbox = (address, notifyKey) => taggedHash('zerc20/storage/inbox/v1', [address, notifyKey]);
+/** The payer's seed for its channel to `inbox`, recomputable from the payer's view key alone. */
+export const channelSeed = (seed, payer, inbox) => kdf(seed, 'channel', [payer, inbox]);
+/** A channel's lane key. Binding the inbox and the claimed payer means a seed learned from one channel opens
+ * nothing when replayed into another inbox or under another name. */
+export const channelKey = (channelSeed, inbox, payer) => kdf(channelSeed, 'channel-key', [inbox, payer]);
+/** The lane key of receive code `index` (burn index `index` of `tokenId` on `chainId`). Every payer of the code
+ * writes its notes to this one lane, and the owner finds them through the log: no inbox, no announcement. */
+export const codeKey = (seed, chainId, tokenId, index) => kdf(seed, 'code', [u64be(chainId), u32be(tokenId), u32be(index)]);
+/** The owner's own lane key: notes to self (merge outputs and change) and burn blocks, which only the owner's
+ * devices write and read. */
+export const ownKey = (seed) => kdf(seed, 'own');
+/** The lane key of the owner's point of sale `n`, handed to that point of sale alone: it records there the burn
+ * addresses it makes for the owner, ahead of handing them out. */
+export const posKey = (seed, n) => kdf(seed, 'pos', [u32be(n)]);
+/** The slot of record `slotIndex` on `chainId` in the lane of `laneKey`. */
+export const slotId = (laneKey, chainId, slotIndex) => kdf(laneKey, 'slot', [u64be(chainId), u32be(slotIndex)]);
+export const sealKey = (laneKey) => kdf(laneKey, 'seal');
+export const outgoingId = (seed, index) => kdf(seed, 'outgoing-id', [u32be(index)]);
+export const outgoingKey = (seed) => kdf(seed, 'outgoing');
+/** The lanes each record type belongs in. A code's notes name their payer, and only the own lane's say what they are
+ * the change or the output of. */
+const LANES = {
+    [NOTE]: ['channel'],
+    [CODE_NOTE]: ['code'],
+    [SELF_NOTE]: ['own'],
+    [DEPOSIT]: ['channel'],
+    [BURN_BLOCK_RECORD]: ['own', 'pos'],
+    [RETURNED]: ['own'],
+    [DEPOSIT_ADDRESS]: ['own'],
+    [POS_LANE]: ['own'],
+};
+/** `type ‖ body`, zero-padded to `size`. */
+function record(type, body, size = SLOT_PLAIN) {
+    const out = new Uint8Array(size);
+    out[0] = type;
+    out.set(body, 1);
+    return out;
+}
+/** A value's 31 bytes on the wire, or `null` if it is not below 2^248. */
+function valueBytes(value) {
+    return value.length === 32 && value[0] === 0 ? value.subarray(1) : null;
+}
+const isField = (x) => x.length === 32 && compare(x, FR_BE) < 0;
+const RECEIPTS = ['sent', 'sent-to-code', 'withdrawn', 'unwrapped', 'merged'];
+/** A value back from its 31 bytes on the wire. */
+const wideValue = (b) => concat(Uint8Array.of(0), b);
+/** `kind(1) ‖ amount(31) ‖ fee(31) ‖ counterparty(20)`, or `null` if a field is out of range. */
+function receiptBytes(r) {
+    const [amount, fee] = [valueBytes(r.amount), valueBytes(r.fee)];
+    if (!amount || !fee || !RECEIPTS.includes(r.kind) || r.counterparty.length !== 20)
+        return null;
+    return concat(Uint8Array.of(RECEIPTS.indexOf(r.kind) + 1), amount, fee, r.counterparty);
+}
+/** The receipt in `b`, or `undefined` for a kind this version does not know: the note, which may be spendable change,
+ * is kept all the same. */
+function readReceipt(b) {
+    const kind = RECEIPTS[b[0] - 1];
+    return (kind && {
+        kind,
+        amount: wideValue(b.subarray(1, 32)),
+        fee: wideValue(b.subarray(32, 63)),
+        counterparty: b.slice(63, 83),
+    });
+}
+/** A note's plaintext, `token_id(4) ‖ value(31) ‖ note_salt(32)`, or `null` if a field is out of the circuit's range
+ * (an out-of-range field can hash like a different value). With `payer` it is a note to a receive code, naming its
+ * payer; with `receipt`, a note to self, saying what it is the change or the output of. */
+export function notePlaintext(opening, extra = null) {
+    const value = valueBytes(opening.value);
+    if (!value || !isField(opening.noteSalt))
+        return null;
+    const body = concat(u32be(opening.tokenId), value, opening.noteSalt);
+    if (!extra)
+        return record(NOTE, body);
+    if ('payer' in extra)
+        return extra.payer.length === 20 ? record(CODE_NOTE, concat(body, extra.payer)) : null;
+    const receipt = receiptBytes(extra.receipt);
+    return receipt && record(SELF_NOTE, concat(body, receipt));
+}
+/** A deposit's announcement, `token_id(4) ‖ value(31) ‖ burn_salt(32) ‖ burn_address(20)`, or `null` if the value or
+ * the salt is out of range. */
+export function depositPlaintext(tokenId, value, burnSalt, burnAddress) {
+    const v = valueBytes(value);
+    if (!v || !isField(burnSalt) || burnAddress.length !== 20)
+        return null;
+    return record(DEPOSIT, concat(u32be(tokenId), v, burnSalt, burnAddress));
+}
+/** `token_id(4) ‖ burn_address(20) ‖` then a return's `index(8) ‖ recipient(20) ‖ amount(31) ‖ tx_hash(32)`, or a
+ * deposit address's `deposit_address(20)`. */
+export function ownReceiptPlaintext(r) {
+    const amount = r.kind === 'returned' && valueBytes(r.amount);
+    const rest = r.kind === 'returned'
+        ? amount &&
+            r.recipient.length === 20 &&
+            r.txHash.length === 32 &&
+            concat(u64be(BigInt(r.index)), r.recipient, amount, r.txHash)
+        : r.depositAddress.length === 20 && r.depositAddress;
+    if (!rest || r.burnAddress.length !== 20)
+        throw new Error('an own receipt holds 20-byte addresses, a 32-byte hash and a value below 2^248');
+    return record(r.kind === 'returned' ? RETURNED : DEPOSIT_ADDRESS, concat(u32be(r.tokenId), r.burnAddress, rest));
+}
+/** `token_id(4) ‖ first(4) ‖ count(1) ‖ salt(32) × count`. */
+export function burnBlockPlaintext(b) {
+    if (b.salts.length === 0 || b.salts.length > BURN_BLOCK || b.salts.some((s) => s.length !== 32)) {
+        throw new Error(`a burn block holds 1 to ${BURN_BLOCK} salts of 32 bytes`);
+    }
+    return record(BURN_BLOCK_RECORD, concat(u32be(b.tokenId), u32be(b.first), Uint8Array.of(b.salts.length), ...b.salts));
+}
+/** `n(4)`. */
+export function posLanePlaintext(n) {
+    return record(POS_LANE, u32be(n));
+}
+/** The record a slot of a `lane` lane on `chainId` held, or `null` if it is malformed or not one such a lane holds. */
+export function readLaneRecord(lane, chainId, slotIndex, atNs, plain) {
+    const type = plain[0];
+    if (plain.length !== SLOT_PLAIN || !LANES[type]?.includes(lane))
+        return null;
+    const stamp = { slotIndex, atNs };
+    const tokenId = readU32(plain, 1);
+    if (type === BURN_BLOCK_RECORD) {
+        const count = plain[9];
+        if (count === 0 || count > BURN_BLOCK)
+            return null;
+        const salts = Array.from({ length: count }, (_, i) => plain.slice(10 + 32 * i, 42 + 32 * i));
+        return { kind: 'burn-block', ...stamp, chainId, tokenId, first: readU32(plain, 5), salts };
+    }
+    if (type === POS_LANE)
+        return { kind: 'pos-lane', ...stamp, n: readU32(plain, 1) };
+    if (type === RETURNED || type === DEPOSIT_ADDRESS) {
+        const head = { ...stamp, chainId, tokenId, burnAddress: plain.slice(5, 25) };
+        if (type === DEPOSIT_ADDRESS)
+            return { ...head, kind: 'deposit-address', depositAddress: plain.slice(25, 45) };
+        const [recipient, amount, txHash] = [plain.slice(33, 53), wideValue(plain.subarray(53, 84)), plain.slice(84, 116)];
+        return { ...head, kind: 'returned', index: Number(readU64(plain, 25)), recipient, amount, txHash };
+    }
+    // a note or a deposit
+    const value = wideValue(plain.subarray(5, 36));
+    const salt = plain.slice(36, 68);
+    if (!isField(salt))
+        return null;
+    if (type === DEPOSIT)
+        return { kind: 'deposit', ...stamp, chainId, tokenId, value, burnSalt: salt, burnAddress: plain.slice(68, 88) };
+    const note = { kind: 'note', ...stamp, opening: { chainId, tokenId, value, noteSalt: salt } };
+    if (type === CODE_NOTE)
+        note.payer = plain.slice(68, 88);
+    const receipt = type === SELF_NOTE && readReceipt(plain.subarray(68, 151));
+    if (receipt)
+        note.receipt = receipt;
+    return note;
+}
+const codeBody = (c) => {
+    if (c.burnAddress.length !== 20 || c.publicKey.length !== 32 || c.key.length !== 32)
+        throw new Error('not a receive code');
+    return concat(u64be(c.chainId), u32be(c.tokenId), c.burnAddress, c.publicKey, c.key);
+};
+const readCodeBody = (b) => ({
+    chainId: readU64(b, 0),
+    tokenId: readU32(b, 8),
+    burnAddress: b.slice(12, 32),
+    publicKey: b.slice(32, 64),
+    key: b.slice(64, 96),
+});
+const CODE_PREFIX = 'zerc20';
+/** A receive code as text: bech32m of `RECEIVE_CODE ‖ chain_id(8) ‖ token_id(4) ‖ burn_address(20) ‖ public_key(32) ‖
+ * key(32)`, so a mistyped one fails its checksum instead of paying someone else. */
+export function encodeCode(c) {
+    return bech32m.encode(CODE_PREFIX, bech32m.toWords(concat(Uint8Array.of(RECEIVE_CODE), codeBody(c))), false);
+}
+/** The receive code `text` holds, or `null` for anything else. */
+export function decodeCode(text) {
+    try {
+        const { prefix, bytes } = bech32m.decodeToBytes(text.trim(), false);
+        if (prefix !== CODE_PREFIX || bytes.length !== 97 || bytes[0] !== RECEIVE_CODE)
+            return null;
+        return readCodeBody(bytes.subarray(1));
+    }
+    catch {
+        return null;
+    }
+}
+/** `address(20) ‖ notify_key(32)`, or the code's body. */
+export function targetPlaintext(t) {
+    return 'address' in t ? record(SENT_TO_ADDRESS, concat(t.address, t.notifyKey)) : record(SENT_TO_CODE, codeBody(t));
+}
+export function readTarget(plain) {
+    if (plain.length !== SLOT_PLAIN)
+        return null;
+    if (plain[0] === SENT_TO_ADDRESS)
+        return { address: plain.slice(1, 21), notifyKey: plain.slice(21, 53) };
+    if (plain[0] === SENT_TO_CODE)
+        return readCodeBody(plain.subarray(1, 97));
+    return null;
+}
+/** A channel's announcement, `payer(20) ‖ channel_seed(32)`: who claims to open it, and the seed its lane key derives
+ * from. */
+export function channelPlaintext(payer, seed) {
+    return record(CHANNEL, concat(payer, seed), ANNOUNCE_PLAIN);
+}
+export function readChannel(plain) {
+    if (plain.length !== ANNOUNCE_PLAIN || plain[0] !== CHANNEL)
+        return null;
+    return { payer: plain.slice(1, 21), seed: plain.slice(21, 53) };
+}
+//# sourceMappingURL=formats.js.map

package/dist/formats.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"formats.js","sourceRoot":"","sources":["../src/formats.ts"],"names":[],"mappings":"AAAA,2EAA2E;AAC3E,EAAE;AACF,qHAAqH;AACrH,kHAAkH;AAClH,qHAAqH;AACrH,uCAAuC;AAEvC,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AACtC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACtG,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAErC,sEAAsE;AACtE,MAAM,CAAC,MAAM,UAAU,GAAG,QAAQ,GAAG,EAAE,GAAG,EAAE,CAAC;AAC7C,sEAAsE;AACtE,MAAM,CAAC,MAAM,cAAc,GAAG,QAAQ,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;AACtD,yCAAyC;AACzC,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,CAAC;AAC5B,uDAAuD;AACvD,MAAM,CAAC,MAAM,KAAK,GAAG,KAAK,CAAC,kEAAkE,CAAC,CAAC;AAE/F,uDAAuD;AACvD,MAAM,CAAC,MAAM,IAAI,GAAG,IAAI,CAAC;AACzB,MAAM,CAAC,MAAM,SAAS,GAAG,IAAI,CAAC;AAC9B,MAAM,CAAC,MAAM,SAAS,GAAG,IAAI,CAAC;AAC9B,MAAM,CAAC,MAAM,OAAO,GAAG,IAAI,CAAC;AAC5B,MAAM,CAAC,MAAM,iBAAiB,GAAG,IAAI,CAAC;AACtC,MAAM,CAAC,MAAM,QAAQ,GAAG,IAAI,CAAC;AAC7B,MAAM,CAAC,MAAM,eAAe,GAAG,IAAI,CAAC;AACpC,MAAM,CAAC,MAAM,QAAQ,GAAG,IAAI,CAAC;AAC7B,MAAM,CAAC,MAAM,eAAe,GAAG,IAAI,CAAC;AACpC,MAAM,CAAC,MAAM,YAAY,GAAG,IAAI,CAAC;AACjC,MAAM,CAAC,MAAM,OAAO,GAAG,IAAI,CAAC;AAC5B,MAAM,CAAC,MAAM,YAAY,GAAG,IAAI,CAAC;AAEjC,yBAAyB;AAEzB;sEACsE;AACtE,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,OAAmB,EAAE,SAAqB,EAAc,EAAE,CACrF,UAAU,CAAC,yBAAyB,EAAE,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC;AAE9D,iGAAiG;AACjG,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,IAAgB,EAAE,KAAiB,EAAE,KAAiB,EAAc,EAAE,CAChG,GAAG,CAAC,IAAI,EAAE,SAAS,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;AAEvC;qEACqE;AACrE,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,WAAuB,EAAE,KAAiB,EAAE,KAAiB,EAAc,EAAE,CACtG,GAAG,CAAC,WAAW,EAAE,aAAa,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;AAElD;6GAC6G;AAC7G,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,IAAgB,EAAE,OAAe,EAAE,OAAe,EAAE,KAAa,EAAc,EAAE,CACvG,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAEpE;6BAC6B;AAC7B,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,IAAgB,EAAc,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AAEzE;kEACkE;AAClE,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,IAAgB,EAAE,CAAS,EAAc,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAEhG,4EAA4E;AAC5E,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,OAAmB,EAAE,OAAe,EAAE,SAAiB,EAAc,EAAE,CAC5F,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;AAC3D,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,OAAmB,EAAc,EAAE,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;AAEjF,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,IAAgB,EAAE,KAAa,EAAc,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,aAAa,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AACpH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,IAAgB,EAAc,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;AAmGnF;kCACkC;AAClC,MAAM,KAAK,GAA+B;IACxC,CAAC,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC;IACnB,CAAC,SAAS,CAAC,EAAE,CAAC,MAAM,CAAC;IACrB,CAAC,SAAS,CAAC,EAAE,CAAC,KAAK,CAAC;IACpB,CAAC,OAAO,CAAC,EAAE,CAAC,SAAS,CAAC;IACtB,CAAC,iBAAiB,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC;IACnC,CAAC,QAAQ,CAAC,EAAE,CAAC,KAAK,CAAC;IACnB,CAAC,eAAe,CAAC,EAAE,CAAC,KAAK,CAAC;IAC1B,CAAC,QAAQ,CAAC,EAAE,CAAC,KAAK,CAAC;CACpB,CAAC;AAEF,4CAA4C;AAC5C,SAAS,MAAM,CAAC,IAAY,EAAE,IAAgB,EAAE,IAAI,GAAG,UAAU;IAC/D,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC;IACjC,GAAG,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IACd,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IACjB,OAAO,GAAG,CAAC;AACb,CAAC;AAED,0EAA0E;AAC1E,SAAS,UAAU,CAAC,KAAiB;IACnC,OAAO,KAAK,CAAC,MAAM,KAAK,EAAE,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AAC1E,CAAC;AAED,MAAM,OAAO,GAAG,CAAC,CAAa,EAAW,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,EAAE,IAAI,OAAO,CAAC,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC;AAErF,MAAM,QAAQ,GAAsB,CAAC,MAAM,EAAE,cAAc,EAAE,WAAW,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;AAEjG,kDAAkD;AAClD,MAAM,SAAS,GAAG,CAAC,CAAa,EAAc,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAE7E,iGAAiG;AACjG,SAAS,YAAY,CAAC,CAAU;IAC9B,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IAChE,IAAI,CAAC,MAAM,IAAI,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,YAAY,CAAC,MAAM,KAAK,EAAE;QAAE,OAAO,IAAI,CAAC;IAC/F,OAAO,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,YAAY,CAAC,CAAC;AAC1F,CAAC;AAED;2BAC2B;AAC3B,SAAS,WAAW,CAAC,CAAa;IAChC,MAAM,IAAI,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IAChC,OAAO,CACL,IAAI,IAAI;QACN,IAAI;QACJ,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACpC,GAAG,EAAE,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;QAClC,YAAY,EAAE,CAAC,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,CAAC;KAC9B,CACF,CAAC;AACJ,CAAC;AAED;;2FAE2F;AAC3F,MAAM,UAAU,aAAa,CAC3B,OAAoB,EACpB,QAA6D,IAAI;IAEjE,MAAM,KAAK,GAAG,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACxC,IAAI,CAAC,KAAK,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC;QAAE,OAAO,IAAI,CAAC;IACtD,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;IACrE,IAAI,CAAC,KAAK;QAAE,OAAO,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACtC,IAAI,OAAO,IAAI,KAAK;QAAE,OAAO,KAAK,CAAC,KAAK,CAAC,MAAM,KAAK,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAC7G,MAAM,OAAO,GAAG,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC5C,OAAO,OAAO,IAAI,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;AAC7D,CAAC;AAED;+BAC+B;AAC/B,MAAM,UAAU,gBAAgB,CAC9B,OAAe,EACf,KAAiB,EACjB,QAAoB,EACpB,WAAuB;IAEvB,MAAM,CAAC,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;IAC5B,IAAI,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,WAAW,CAAC,MAAM,KAAK,EAAE;QAAE,OAAO,IAAI,CAAC;IACvE,OAAO,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAC;AAC3E,CAAC;AAED;8CAC8C;AAC9C,MAAM,UAAU,mBAAmB,CAAC,CAAa;IAC/C,MAAM,MAAM,GAAG,CAAC,CAAC,IAAI,KAAK,UAAU,IAAI,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;IAC7D,MAAM,IAAI,GACR,CAAC,CAAC,IAAI,KAAK,UAAU;QACnB,CAAC,CAAC,MAAM;YACN,CAAC,CAAC,SAAS,CAAC,MAAM,KAAK,EAAE;YACzB,CAAC,CAAC,MAAM,CAAC,MAAM,KAAK,EAAE;YACtB,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,SAAS,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC;QAC/D,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,MAAM,KAAK,EAAE,IAAI,CAAC,CAAC,cAAc,CAAC;IACzD,IAAI,CAAC,IAAI,IAAI,CAAC,CAAC,WAAW,CAAC,MAAM,KAAK,EAAE;QACtC,MAAM,IAAI,KAAK,CAAC,gFAAgF,CAAC,CAAC;IACpG,OAAO,MAAM,CAAC,CAAC,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,eAAe,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC,CAAC;AACnH,CAAC;AAED,8DAA8D;AAC9D,MAAM,UAAU,kBAAkB,CAAC,CAAY;IAC7C,IAAI,CAAC,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,UAAU,IAAI,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,EAAE,CAAC,EAAE,CAAC;QAChG,MAAM,IAAI,KAAK,CAAC,2BAA2B,UAAU,oBAAoB,CAAC,CAAC;IAC7E,CAAC;IACD,OAAO,MAAM,CAAC,iBAAiB,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;AACxH,CAAC;AAED,cAAc;AACd,MAAM,UAAU,gBAAgB,CAAC,CAAS;IACxC,OAAO,MAAM,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;AACpC,CAAC;AAED,uHAAuH;AACvH,MAAM,UAAU,cAAc,CAC5B,IAAc,EACd,OAAe,EACf,SAAiB,EACjB,IAAY,EACZ,KAAiB;IAEjB,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IACtB,IAAI,KAAK,CAAC,MAAM,KAAK,UAAU,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC;IAC7E,MAAM,KAAK,GAAG,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;IAClC,MAAM,OAAO,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;IAClC,IAAI,IAAI,KAAK,iBAAiB,EAAE,CAAC;QAC/B,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QACvB,IAAI,KAAK,KAAK,CAAC,IAAI,KAAK,GAAG,UAAU;YAAE,OAAO,IAAI,CAAC;QACnD,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;QAC7F,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,GAAG,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC;IAC7F,CAAC;IACD,IAAI,IAAI,KAAK,QAAQ;QAAE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,KAAK,EAAE,CAAC,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,CAAC;IACnF,IAAI,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,eAAe,EAAE,CAAC;QAClD,MAAM,IAAI,GAAG,EAAE,GAAG,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC;QAC7E,IAAI,IAAI,KAAK,eAAe;YAAE,OAAO,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE,iBAAiB,EAAE,cAAc,EAAE,KAAK,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC;QAC/G,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,SAAS,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC,CAAC;QACnH,OAAO,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;IACrG,CAAC;IACD,sBAAsB;IACtB,MAAM,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;IAC/C,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IACjC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC;IAChC,IAAI,IAAI,KAAK,OAAO;QAClB,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC;IAClH,MAAM,IAAI,GAAS,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,KAAK,EAAE,OAAO,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,CAAC;IACpG,IAAI,IAAI,KAAK,SAAS;QAAE,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IACzD,MAAM,OAAO,GAAG,IAAI,KAAK,SAAS,IAAI,WAAW,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC,CAAC;IAC3E,IAAI,OAAO;QAAE,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACpC,OAAO,IAAI,CAAC;AACd,CAAC;AAgBD,MAAM,QAAQ,GAAG,CAAC,CAAc,EAAc,EAAE;IAC9C,IAAI,CAAC,CAAC,WAAW,CAAC,MAAM,KAAK,EAAE,IAAI,CAAC,CAAC,SAAS,CAAC,MAAM,KAAK,EAAE,IAAI,CAAC,CAAC,GAAG,CAAC,MAAM,KAAK,EAAE;QACjF,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;IACxC,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC;AACvF,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,CAAa,EAAe,EAAE,CAAC,CAAC;IACpD,OAAO,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC;IACtB,OAAO,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC;IACtB,WAAW,EAAE,CAAC,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,CAAC;IAC5B,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,CAAC;IAC1B,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,CAAC;CACrB,CAAC,CAAC;AAEH,MAAM,WAAW,GAAG,QAAQ,CAAC;AAE7B;oFACoF;AACpF,MAAM,UAAU,UAAU,CAAC,CAAc;IACvC,OAAO,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC,YAAY,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;AAC/G,CAAC;AAED,kEAAkE;AAClE,MAAM,UAAU,UAAU,CAAC,IAAY;IACrC,IAAI,CAAC;QACH,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,KAAK,CAAC,CAAC;QACpE,IAAI,MAAM,KAAK,WAAW,IAAI,KAAK,CAAC,MAAM,KAAK,EAAE,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,YAAY;YAAE,OAAO,IAAI,CAAC;QAC5F,OAAO,YAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IACzC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAMD,0DAA0D;AAC1D,MAAM,UAAU,eAAe,CAAC,CAAS;IACvC,OAAO,SAAS,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;AACtH,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,KAAiB;IAC1C,IAAI,KAAK,CAAC,MAAM,KAAK,UAAU;QAAE,OAAO,IAAI,CAAC;IAC7C,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,eAAe;QAAE,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,SAAS,EAAE,KAAK,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC;IACzG,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,YAAY;QAAE,OAAO,YAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;IAC1E,OAAO,IAAI,CAAC;AACd,CAAC;AAED;WACW;AACX,MAAM,UAAU,gBAAgB,CAAC,KAAiB,EAAE,IAAgB;IAClE,OAAO,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,cAAc,CAAC,CAAC;AAC9D,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,KAAiB;IAC3C,IAAI,KAAK,CAAC,MAAM,KAAK,cAAc,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,OAAO;QAAE,OAAO,IAAI,CAAC;IACzE,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC;AAClE,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+export type { Action, AuditRecord, AuditRequest, CanisterError, Kind, Registration, Service, Slot } from './candid.js';
+export { idlFactory } from './candid.js';
+export { CanisterClient, StorageError } from './canister.js';
+export { BURN_BLOCK, FR_BE, addressInbox, codeKey, decodeCode, encodeCode, posKey, type BurnBlock, type Deposit, type LaneRecord, type Note, type NoteOpening, type OwnReceipt, type PosLane, type Receipt, type ReceiveCode, type Via, } from './formats.js';
+export { commit, nextPosLane, planBurnBlock, planDeposit, planPayCode, planPosLane, planReceipt, planSelf, planSend, writePosBlock, } from './send.js';
+export { type ChainLane, type NewRecord, type StoredLane, type SyncState, emptyState, exportState, importState, refresh, } from './sync.js';
+export { type Recipient, type Signer, type ViewKey, eip191Signer, lookupRecipient, notifyKey, notifySecret, openEscrow, registeredViewKey, register, verifyRegistration, viewKey, } from './viewKey.js';
+export { REGISTER_POW_BITS, actionsDigest, auditMessage, powOk, registerDigest, registerMessage, requiredPowBits, solvePow, vetkdInput, } from './wire.js';

package/dist/index.js

@@ -0,0 +1,24 @@
+// zerc20-storage SDK: private note delivery for zERC20 on the Internet Computer.
+//
+// - View keys (`registeredViewKey`): an address's key, derived from its zERC20 root seed. Everything only the owner can
+//   compute derives from it. Registering (one wallet signature) publishes what payers need: the address's zERC20
+//   public key and the key announcements are encrypted to, which payers look up with `lookupRecipient`. It also
+//   escrows the view key to the auditor.
+// - History (`refresh`): both sides recover their channels and records from the view key alone, and each refresh
+//   reads only what is new. Keep the state with `exportState`.
+// - Payments (`planSend`, `planDeposit`, `planPayCode`, and `planSelf` for merge outputs and change, with what each
+//   was), submitted with `commit`; `planReceipt` for what leaves no note to self.
+// - Burn blocks (`planBurnBlock`): which burn addresses the owner's devices hand out. Each of a wallet's own is also
+//   a receive code (`encodeCode`), paid by a deposit or by a note, any amount, any number of times.
+// - Points of sale (`planPosLane`): a lane whose key (`posKey`) the owner hands to one point of sale, which records
+//   there the burn addresses it hands out (`writePosBlock`), for every device of the owner to find.
+//
+// Payers are not verified: a record's `peer` is only what was claimed.
+export { idlFactory } from './candid.js';
+export { CanisterClient, StorageError } from './canister.js';
+export { BURN_BLOCK, FR_BE, addressInbox, codeKey, decodeCode, encodeCode, posKey, } from './formats.js';
+export { commit, nextPosLane, planBurnBlock, planDeposit, planPayCode, planPosLane, planReceipt, planSelf, planSend, writePosBlock, } from './send.js';
+export { emptyState, exportState, importState, refresh, } from './sync.js';
+export { eip191Signer, lookupRecipient, notifyKey, notifySecret, openEscrow, registeredViewKey, register, verifyRegistration, viewKey, } from './viewKey.js';
+export { REGISTER_POW_BITS, actionsDigest, auditMessage, powOk, registerDigest, registerMessage, requiredPowBits, solvePow, vetkdInput, } from './wire.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,iFAAiF;AACjF,EAAE;AACF,wHAAwH;AACxH,iHAAiH;AACjH,gHAAgH;AAChH,yCAAyC;AACzC,iHAAiH;AACjH,+DAA+D;AAC/D,oHAAoH;AACpH,kFAAkF;AAClF,qHAAqH;AACrH,oGAAoG;AACpG,oHAAoH;AACpH,oGAAoG;AACpG,EAAE;AACF,uEAAuE;AAGvE,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7D,OAAO,EACL,UAAU,EACV,KAAK,EACL,YAAY,EACZ,OAAO,EACP,UAAU,EACV,UAAU,EACV,MAAM,GAWP,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,MAAM,EACN,WAAW,EACX,aAAa,EACb,WAAW,EACX,WAAW,EACX,WAAW,EACX,WAAW,EACX,QAAQ,EACR,QAAQ,EACR,aAAa,GACd,MAAM,WAAW,CAAC;AACnB,OAAO,EAKL,UAAU,EACV,WAAW,EACX,WAAW,EACX,OAAO,GACR,MAAM,WAAW,CAAC;AACnB,OAAO,EAIL,YAAY,EACZ,eAAe,EACf,SAAS,EACT,YAAY,EACZ,UAAU,EACV,iBAAiB,EACjB,QAAQ,EACR,kBAAkB,EAClB,OAAO,GACR,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,iBAAiB,EACjB,aAAa,EACb,YAAY,EACZ,KAAK,EACL,cAAc,EACd,eAAe,EACf,eAAe,EACf,QAAQ,EACR,UAAU,GACX,MAAM,WAAW,CAAC"}

package/dist/powWorker.d.ts

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

package/dist/powWorker.js

@@ -0,0 +1,4 @@
+// solvePow's search, in a Web Worker: off the page's thread, it never needs to yield.
+import { findNonce } from './wire.js';
+onmessage = async ({ data }) => postMessage(await findNonce(data.digest, data.bits, Infinity));
+//# sourceMappingURL=powWorker.js.map

package/dist/powWorker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"powWorker.js","sourceRoot":"","sources":["../src/powWorker.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAEtC,SAAS,GAAG,KAAK,EAAE,EAAE,IAAI,EAAsD,EAAE,EAAE,CACjF,WAAW,CAAC,MAAM,SAAS,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC"}

package/dist/send.d.ts

@@ -0,0 +1,51 @@
+import type { Action } from './candid.js';
+import { type CanisterClient } from './canister.js';
+import { type BurnBlock, type NoteOpening, type OwnReceipt, type Receipt, type ReceiveCode } from './formats.js';
+import { type NewRecord, type SyncState } from './sync.js';
+import type { Recipient, ViewKey } from './viewKey.js';
+/** A note with `opening` (what the on-chain note commits to) for `recipient`, as `lookupRecipient` found it. The
+ * on-chain note must be owned by `recipient.publicKey`. */
+export declare function planSend(view: ViewKey, state: SyncState, recipient: Recipient, opening: NoteOpening): Action[];
+/** Tells `recipient` of a deposit of `value` of `tokenId` on `chainId` into its burn address of `burnSalt`, under
+ * `recipient.publicKey`, which the payer then pays by a plain transfer. */
+export declare function planDeposit(view: ViewKey, state: SyncState, recipient: Recipient, deposit: {
+    chainId: bigint;
+    tokenId: number;
+    value: Uint8Array;
+    burnSalt: Uint8Array;
+    burnAddress: Uint8Array;
+}): Action[];
+/** A note with `opening` paying `code`; the on-chain note must be owned by `code.publicKey`. Every payer of the code
+ * writes to its one lane, naming itself: the first payment records the code for the payer's history and looks for
+ * the lane's end, later ones take it from `state`. Another payer writing first makes the submit `Occupied`, which
+ * `commit` plans again. */
+export declare function planPayCode(client: CanisterClient, view: ViewKey, state: SyncState, code: ReceiveCode, opening: NoteOpening): Promise<Action[]>;
+/** A note to self in the own lane, which only the owner reads: the output of a merge, or the change of a payment.
+ * Put a payment's change in the payment's batch, so both are written or neither:
+ * `[...planSend(..), ...planSelf(..)]`. `receipt` says what the payment or merge was, for the owner's other devices; a
+ * zero-value change is unspendable, and worth writing only to carry it. */
+export declare function planSelf(view: ViewKey, state: SyncState, opening: NoteOpening, receipt: Receipt): Action[];
+/** What the owner did that leaves no note to self (a rage exit, a deposit address registered), in the own lane. */
+export declare function planReceipt(view: ViewKey, state: SyncState, receipt: OwnReceipt): Action[];
+/** The record of `block` in the own lane, to submit before handing out any of its burn addresses, so that every
+ * device of the owner watches them. Record blocks ahead of need, not as an address is handed out: the time of the
+ * write would otherwise mark the first payment to it. */
+export declare function planBurnBlock(view: ViewKey, state: SyncState, block: BurnBlock): Action[];
+/** The number the owner's next point of sale takes: one past the highest the own lane records. */
+export declare const nextPosLane: (state: SyncState) => number;
+/** The record of point of sale `n` in the own lane, so that every device of the owner reads its lane (`posKey`). Plan
+ * it with `n = nextPosLane(state)` inside `commit`'s plan: after `Occupied`, another device took that number. */
+export declare function planPosLane(view: ViewKey, state: SyncState, chainId: bigint, n: number): Action[];
+/** Writes `block` to the lane of `laneKey`, as the point of sale that alone holds the key, at the lane's first empty
+ * slot from `from` on; returns the slot after it. A slot someone else took first is passed over, and the same salts
+ * written twice are found once. */
+export declare function writePosBlock(client: CanisterClient, laneKey: Uint8Array, block: BurnBlock, from?: number): Promise<number>;
+/** Submits the actions `plan` builds from `state`, then refreshes; continue from the returned state,
+ * or the next plan reuses a slot that is taken. After `Occupied` (another device wrote there first)
+ * it refreshes and plans once more. Calls that fail without an answer are retried with the same
+ * actions, which is safe: writes are write-once and batches atomic. */
+export declare function commit<T extends Action[]>(client: CanisterClient, view: ViewKey, state: SyncState, plan: (state: SyncState) => T | Promise<T>): Promise<{
+    planned: T;
+    state: SyncState;
+    added: NewRecord[];
+}>;

package/dist/send.js

@@ -0,0 +1,162 @@
+// Planning payments, deposits, notes to self, burn blocks and points of sale from a synced state, and submitting them.
+// A point of sale writes its own lane with its key alone (`writePosBlock`).
+//
+// Write the note here first, then create the on-chain note with the same opening: a note that exists
+// only on chain cannot be found. Receivers match notes one-to-one to on-chain leaves (by
+// `commitment_index`) and treat the unmatched as pending.
+import { StorageError } from './canister.js';
+import { equal, seal, sealTo } from './crypto.js';
+import { burnBlockPlaintext, channelKey, channelPlaintext, channelSeed, depositPlaintext, notePlaintext, outgoingId, outgoingKey, ownKey, ownReceiptPlaintext, posLanePlaintext, sealKey, slotId, targetPlaintext, } from './formats.js';
+import { checkState, refresh, sequenceEnd } from './sync.js';
+/** The record at `slotIndex` of the lane of `laneKey` on `chainId`. */
+function put(laneKey, chainId, slotIndex, plaintext) {
+    const id = slotId(laneKey, chainId, slotIndex);
+    return { Put: { kind: { Lane: null }, id, data: seal(sealKey(laneKey), id, plaintext) } };
+}
+/** The next free slot of a lane `state` has read, which must be on a watched chain. */
+function nextSlotIndex(state, chains, chainId) {
+    if (!state.chains.includes(chainId))
+        throw new Error(`watch chain ${chainId} and refresh first`);
+    return chains?.find((c) => c.chainId === chainId)?.nextSlotIndex ?? 0;
+}
+function plaintextOf(plain) {
+    if (!plain)
+        throw new Error('out of range: value ≥ 2^248 or salt ≥ Fr');
+    return plain;
+}
+/** A record for `recipient` on `chainId`, through the channel to it, which is opened first if there is none yet. */
+function toAddress(view, state, recipient, chainId, plaintext) {
+    checkState(view, state);
+    const actions = [];
+    const { inbox } = recipient;
+    const channel = state.outgoing.lanes.find((c) => c.inbox && equal(c.inbox, inbox));
+    let key = channel?.key;
+    if (!key) {
+        // first contact: announce `payer ‖ seed` to the receiver, and record the channel for the payer
+        const c = channelSeed(view.seed, view.address, inbox);
+        const enc_announcement = sealTo(recipient.notifyKey, 'announce', inbox, channelPlaintext(view.address, c));
+        if (!enc_announcement)
+            throw new Error('low-order notify key');
+        const outgoing_id = outgoingId(view.seed, state.outgoing.next);
+        const target = { address: recipient.address, notifyKey: recipient.notifyKey };
+        const enc_outgoing = seal(outgoingKey(view.seed), outgoing_id, targetPlaintext(target));
+        actions.push({ OpenChannel: { inbox, enc_announcement, outgoing_id, enc_outgoing } });
+        key = channelKey(c, inbox, view.address);
+    }
+    actions.push(put(key, chainId, nextSlotIndex(state, channel?.chains, chainId), plaintext));
+    return actions;
+}
+/** A note with `opening` (what the on-chain note commits to) for `recipient`, as `lookupRecipient` found it. The
+ * on-chain note must be owned by `recipient.publicKey`. */
+export function planSend(view, state, recipient, opening) {
+    return toAddress(view, state, recipient, opening.chainId, plaintextOf(notePlaintext(opening)));
+}
+/** Tells `recipient` of a deposit of `value` of `tokenId` on `chainId` into its burn address of `burnSalt`, under
+ * `recipient.publicKey`, which the payer then pays by a plain transfer. */
+export function planDeposit(view, state, recipient, deposit) {
+    const plaintext = plaintextOf(depositPlaintext(deposit.tokenId, deposit.value, deposit.burnSalt, deposit.burnAddress));
+    return toAddress(view, state, recipient, deposit.chainId, plaintext);
+}
+/** A note with `opening` paying `code`; the on-chain note must be owned by `code.publicKey`. Every payer of the code
+ * writes to its one lane, naming itself: the first payment records the code for the payer's history and looks for
+ * the lane's end, later ones take it from `state`. Another payer writing first makes the submit `Occupied`, which
+ * `commit` plans again. */
+export async function planPayCode(client, view, state, code, opening) {
+    if (opening.chainId !== code.chainId || opening.tokenId !== code.tokenId)
+        throw new Error("the note is not for the code's chain and token");
+    const plaintext = plaintextOf(notePlaintext(opening, { payer: view.address }));
+    checkState(view, state);
+    const { chainId, key } = code;
+    const lane = state.outgoing.lanes.find((c) => equal(c.key, key));
+    if (lane)
+        return [put(key, chainId, nextSlotIndex(state, lane.chains, chainId), plaintext)];
+    nextSlotIndex(state, undefined, chainId); // a watched chain
+    const id = outgoingId(view.seed, state.outgoing.next);
+    const record = seal(outgoingKey(view.seed), id, targetPlaintext(code));
+    const end = await sequenceEnd(client, (i) => slotId(key, chainId, i));
+    return [{ Put: { kind: { Outgoing: null }, id, data: record } }, put(key, chainId, end, plaintext)];
+}
+/** A note to self in the own lane, which only the owner reads: the output of a merge, or the change of a payment.
+ * Put a payment's change in the payment's batch, so both are written or neither:
+ * `[...planSend(..), ...planSelf(..)]`. `receipt` says what the payment or merge was, for the owner's other devices; a
+ * zero-value change is unspendable, and worth writing only to carry it. */
+export function planSelf(view, state, opening, receipt) {
+    checkState(view, state);
+    const plaintext = plaintextOf(notePlaintext(opening, { receipt }));
+    return [put(ownKey(view.seed), opening.chainId, nextSlotIndex(state, state.own, opening.chainId), plaintext)];
+}
+/** What the owner did that leaves no note to self (a rage exit, a deposit address registered), in the own lane. */
+export function planReceipt(view, state, receipt) {
+    checkState(view, state);
+    return [
+        put(ownKey(view.seed), receipt.chainId, nextSlotIndex(state, state.own, receipt.chainId), ownReceiptPlaintext(receipt)),
+    ];
+}
+/** The record of `block` in the own lane, to submit before handing out any of its burn addresses, so that every
+ * device of the owner watches them. Record blocks ahead of need, not as an address is handed out: the time of the
+ * write would otherwise mark the first payment to it. */
+export function planBurnBlock(view, state, block) {
+    checkState(view, state);
+    return [
+        put(ownKey(view.seed), block.chainId, nextSlotIndex(state, state.own, block.chainId), burnBlockPlaintext(block)),
+    ];
+}
+/** The number the owner's next point of sale takes: one past the highest the own lane records. */
+export const nextPosLane = (state) => 1 + Math.max(-1, ...state.incoming.map((c) => (c.via.type === 'pos' ? c.via.n : -1)));
+/** The record of point of sale `n` in the own lane, so that every device of the owner reads its lane (`posKey`). Plan
+ * it with `n = nextPosLane(state)` inside `commit`'s plan: after `Occupied`, another device took that number. */
+export function planPosLane(view, state, chainId, n) {
+    checkState(view, state);
+    return [put(ownKey(view.seed), chainId, nextSlotIndex(state, state.own, chainId), posLanePlaintext(n))];
+}
+/** Writes `block` to the lane of `laneKey`, as the point of sale that alone holds the key, at the lane's first empty
+ * slot from `from` on; returns the slot after it. A slot someone else took first is passed over, and the same salts
+ * written twice are found once. */
+export async function writePosBlock(client, laneKey, block, from = 0) {
+    const plaintext = burnBlockPlaintext(block);
+    for (;;) {
+        const at = await sequenceEnd(client, (i) => slotId(laneKey, block.chainId, i), from);
+        try {
+            await submit(client, [put(laneKey, block.chainId, at, plaintext)]);
+            return at + 1;
+        }
+        catch (e) {
+            if (!(e instanceof StorageError && e.occupied))
+                throw e;
+            from = at + 1;
+        }
+    }
+}
+/** Submits the actions `plan` builds from `state`, then refreshes; continue from the returned state,
+ * or the next plan reuses a slot that is taken. After `Occupied` (another device wrote there first)
+ * it refreshes and plans once more. Calls that fail without an answer are retried with the same
+ * actions, which is safe: writes are write-once and batches atomic. */
+export async function commit(client, view, state, plan) {
+    let planned = await plan(state);
+    // a record is announced by one refresh only: keep what the one between the attempts announced too
+    let added = [];
+    try {
+        await submit(client, planned);
+    }
+    catch (e) {
+        if (!(e instanceof StorageError && e.occupied))
+            throw e;
+        ({ state, added } = await refresh(client, view, state));
+        planned = await plan(state);
+        await submit(client, planned);
+    }
+    const last = await refresh(client, view, state);
+    return { planned, state: last.state, added: [...added, ...last.added] };
+}
+async function submit(client, actions) {
+    for (let attempt = 1;; attempt++) {
+        try {
+            return await client.submit(actions);
+        }
+        catch (e) {
+            if (e instanceof StorageError || attempt === 3)
+                throw e;
+        }
+    }
+}
+//# sourceMappingURL=send.js.map

package/dist/send.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"send.js","sourceRoot":"","sources":["../src/send.ts"],"names":[],"mappings":"AAAA,uHAAuH;AACvH,4EAA4E;AAC5E,EAAE;AACF,qGAAqG;AACrG,yFAAyF;AACzF,0DAA0D;AAG1D,OAAO,EAAuB,YAAY,EAAE,MAAM,eAAe,CAAC;AAClE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAClD,OAAO,EAML,kBAAkB,EAClB,UAAU,EACV,gBAAgB,EAChB,WAAW,EACX,gBAAgB,EAChB,aAAa,EACb,UAAU,EACV,WAAW,EACX,MAAM,EACN,mBAAmB,EACnB,gBAAgB,EAChB,OAAO,EACP,MAAM,EACN,eAAe,GAChB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAkD,UAAU,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAG7G,uEAAuE;AACvE,SAAS,GAAG,CAAC,OAAmB,EAAE,OAAe,EAAE,SAAiB,EAAE,SAAqB;IACzF,MAAM,EAAE,GAAG,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC;IAC/C,OAAO,EAAE,GAAG,EAAE,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,EAAE,EAAE,SAAS,CAAC,EAAE,EAAE,CAAC;AAC5F,CAAC;AAED,uFAAuF;AACvF,SAAS,aAAa,CAAC,KAAgB,EAAE,MAA+B,EAAE,OAAe;IACvF,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,eAAe,OAAO,oBAAoB,CAAC,CAAC;IACjG,OAAO,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,KAAK,OAAO,CAAC,EAAE,aAAa,IAAI,CAAC,CAAC;AACxE,CAAC;AAED,SAAS,WAAW,CAAC,KAAwB;IAC3C,IAAI,CAAC,KAAK;QAAE,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;IACxE,OAAO,KAAK,CAAC;AACf,CAAC;AAED,oHAAoH;AACpH,SAAS,SAAS,CAChB,IAAa,EACb,KAAgB,EAChB,SAAoB,EACpB,OAAe,EACf,SAAqB;IAErB,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACxB,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,MAAM,EAAE,KAAK,EAAE,GAAG,SAAS,CAAC;IAC5B,MAAM,OAAO,GAAG,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;IACnF,IAAI,GAAG,GAAG,OAAO,EAAE,GAAG,CAAC;IACvB,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,+FAA+F;QAC/F,MAAM,CAAC,GAAG,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QACtD,MAAM,gBAAgB,GAAG,MAAM,CAAC,SAAS,CAAC,SAAS,EAAE,UAAU,EAAE,KAAK,EAAE,gBAAgB,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC;QAC3G,IAAI,CAAC,gBAAgB;YAAE,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;QAC/D,MAAM,WAAW,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC/D,MAAM,MAAM,GAAG,EAAE,OAAO,EAAE,SAAS,CAAC,OAAO,EAAE,SAAS,EAAE,SAAS,CAAC,SAAS,EAAE,CAAC;QAC9E,MAAM,YAAY,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC;QACxF,OAAO,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,EAAE,KAAK,EAAE,gBAAgB,EAAE,WAAW,EAAE,YAAY,EAAE,EAAE,CAAC,CAAC;QACtF,GAAG,GAAG,UAAU,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IAC3C,CAAC;IACD,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,EAAE,aAAa,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC;IAC3F,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;2DAC2D;AAC3D,MAAM,UAAU,QAAQ,CAAC,IAAa,EAAE,KAAgB,EAAE,SAAoB,EAAE,OAAoB;IAClG,OAAO,SAAS,CAAC,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,CAAC,OAAO,EAAE,WAAW,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AACjG,CAAC;AAED;2EAC2E;AAC3E,MAAM,UAAU,WAAW,CACzB,IAAa,EACb,KAAgB,EAChB,SAAoB,EACpB,OAA+G;IAE/G,MAAM,SAAS,GAAG,WAAW,CAC3B,gBAAgB,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,WAAW,CAAC,CACxF,CAAC;IACF,OAAO,SAAS,CAAC,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;AACvE,CAAC;AAED;;;2BAG2B;AAC3B,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,MAAsB,EACtB,IAAa,EACb,KAAgB,EAChB,IAAiB,EACjB,OAAoB;IAEpB,IAAI,OAAO,CAAC,OAAO,KAAK,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,OAAO,KAAK,IAAI,CAAC,OAAO;QACtE,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;IACpE,MAAM,SAAS,GAAG,WAAW,CAAC,aAAa,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;IAC/E,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACxB,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;IAC9B,MAAM,IAAI,GAAG,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;IACjE,IAAI,IAAI;QAAE,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,EAAE,aAAa,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC;IAC5F,aAAa,CAAC,KAAK,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC,kBAAkB;IAC5D,MAAM,EAAE,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACtD,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC;IACvE,MAAM,GAAG,GAAG,MAAM,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC;IACtE,OAAO,CAAC,EAAE,GAAG,EAAE,EAAE,IAAI,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,GAAG,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,SAAS,CAAC,CAAC,CAAC;AACtG,CAAC;AAED;;;2EAG2E;AAC3E,MAAM,UAAU,QAAQ,CAAC,IAAa,EAAE,KAAgB,EAAE,OAAoB,EAAE,OAAgB;IAC9F,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACxB,MAAM,SAAS,GAAG,WAAW,CAAC,aAAa,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;IACnE,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,OAAO,EAAE,aAAa,CAAC,KAAK,EAAE,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,OAAO,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC;AAChH,CAAC;AAED,mHAAmH;AACnH,MAAM,UAAU,WAAW,CAAC,IAAa,EAAE,KAAgB,EAAE,OAAmB;IAC9E,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACxB,OAAO;QACL,GAAG,CACD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EACjB,OAAO,CAAC,OAAO,EACf,aAAa,CAAC,KAAK,EAAE,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,OAAO,CAAC,EAChD,mBAAmB,CAAC,OAAO,CAAC,CAC7B;KACF,CAAC;AACJ,CAAC;AAED;;yDAEyD;AACzD,MAAM,UAAU,aAAa,CAAC,IAAa,EAAE,KAAgB,EAAE,KAAgB;IAC7E,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACxB,OAAO;QACL,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,OAAO,EAAE,aAAa,CAAC,KAAK,EAAE,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,OAAO,CAAC,EAAE,kBAAkB,CAAC,KAAK,CAAC,CAAC;KACjH,CAAC;AACJ,CAAC;AAED,kGAAkG;AAClG,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,KAAgB,EAAU,EAAE,CACtD,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAExF;iHACiH;AACjH,MAAM,UAAU,WAAW,CAAC,IAAa,EAAE,KAAgB,EAAE,OAAe,EAAE,CAAS;IACrF,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACxB,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,aAAa,CAAC,KAAK,EAAE,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAC1G,CAAC;AAED;;mCAEmC;AACnC,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,MAAsB,EACtB,OAAmB,EACnB,KAAgB,EAChB,IAAI,GAAG,CAAC;IAER,MAAM,SAAS,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC;IAC5C,SAAS,CAAC;QACR,MAAM,EAAE,GAAG,MAAM,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;QACrF,IAAI,CAAC;YACH,MAAM,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,EAAE,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;YACnE,OAAO,EAAE,GAAG,CAAC,CAAC;QAChB,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,CAAC,CAAC,CAAC,YAAY,YAAY,IAAI,CAAC,CAAC,QAAQ,CAAC;gBAAE,MAAM,CAAC,CAAC;YACxD,IAAI,GAAG,EAAE,GAAG,CAAC,CAAC;QAChB,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;uEAGuE;AACvE,MAAM,CAAC,KAAK,UAAU,MAAM,CAC1B,MAAsB,EACtB,IAAa,EACb,KAAgB,EAChB,IAA0C;IAE1C,IAAI,OAAO,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,CAAC;IAChC,kGAAkG;IAClG,IAAI,KAAK,GAAgB,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,IAAI,CAAC,CAAC,CAAC,YAAY,YAAY,IAAI,CAAC,CAAC,QAAQ,CAAC;YAAE,MAAM,CAAC,CAAC;QACxD,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,MAAM,OAAO,CAAC,MAAM,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;QACxD,OAAO,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,CAAC;QAC5B,MAAM,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,CAAC;IACD,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,MAAM,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;IAChD,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,CAAC,GAAG,KAAK,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;AAC1E,CAAC;AAED,KAAK,UAAU,MAAM,CAAC,MAAsB,EAAE,OAAiB;IAC7D,KAAK,IAAI,OAAO,GAAG,CAAC,GAAI,OAAO,EAAE,EAAE,CAAC;QAClC,IAAI,CAAC;YACH,OAAO,MAAM,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACtC,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,CAAC,YAAY,YAAY,IAAI,OAAO,KAAK,CAAC;gBAAE,MAAM,CAAC,CAAC;QAC1D,CAAC;IACH,CAAC;AACH,CAAC"}

package/dist/sync.d.ts

@@ -0,0 +1,82 @@
+import type { CanisterClient } from './canister.js';
+import { type LaneRecord, type Via } from './formats.js';
+import { type ViewKey } from './viewKey.js';
+/** One lane on one chain. */
+export interface ChainLane {
+    chainId: bigint;
+    /** Where the next record goes: the first empty slot index (slots that do not open count too). */
+    nextSlotIndex: number;
+    /** What it held, in slot order. An app that keeps records of its own may empty this. */
+    records: LaneRecord[];
+}
+/** A lane other than the own lane: one payer → receiver channel, a receive code's lane, which every payer of the code
+ * writes to, or the lane of one of the owner's points of sale. */
+export interface StoredLane {
+    /** Outgoing: the receiver, or `null` for a code (which never names its receiver). Incoming: the payer as claimed
+     * by whoever opened the channel, or `null` for a code, whose notes each claim their own, and for a point of sale;
+     * it is NOT verified. */
+    peer: Uint8Array | null;
+    via: Via;
+    /** The channel seed and its inbox; `null` for a code and a point of sale, which have neither. */
+    seed: Uint8Array | null;
+    inbox: Uint8Array | null;
+    /** The lane key. */
+    key: Uint8Array;
+    /** One entry per watched chain. */
+    chains: ChainLane[];
+}
+/** Everything one view key has seen so far. Plain data: keep it with `exportState`, and treat it as read-only. */
+export interface SyncState {
+    address: Uint8Array;
+    /** The chains whose lanes are read. Add one and the next refresh reads it from slot 0. */
+    chains: bigint[];
+    addressInboxRead: number;
+    /** Channels to the address, the address's own receive codes (one for each burn index in its burn blocks), and the
+     * lanes of its points of sale (one for each the own lane records). */
+    incoming: StoredLane[];
+    outgoing: {
+        next: number;
+        lanes: StoredLane[];
+    };
+    /** The own lane (notes to self, burn blocks and points of sale), one entry per watched chain. */
+    own: ChainLane[];
+    /** How far the canister's lane log has been read; `null` until the first full read. */
+    log: number | null;
+}
+/** A record a refresh found. */
+export interface NewRecord {
+    direction: 'incoming' | 'outgoing' | 'own';
+    /** `null` in the own lane. */
+    lane: StoredLane | null;
+    /** Who is on the other side, as claimed and unverified: an incoming channel's payer, an outgoing one's receiver,
+     * a note's payer in one of the owner's codes. `null` in the own lane and a point of sale's, and for a payment to a
+     * code. */
+    peer: Uint8Array | null;
+    record: LaneRecord;
+}
+export declare const emptyState: (view: ViewKey, chains: bigint[]) => SyncState;
+export declare function checkState(view: ViewKey, state: SyncState): void;
+/** Reads what is new since `state` and returns the extended state, plus the records it found. `state` itself is
+ * left untouched, so a failed refresh loses nothing. A first sync is a refresh of `emptyState`.
+ *
+ * Queries only spot news: whatever is kept is read again as update calls, so a single lying replica
+ * can neither plant entries nor make a cursor skip one. With nothing new it costs queries only: one
+ * for outgoing records, one for the address inbox, and one for the lane log.
+ *
+ * A replica can still leave log entries out, which only delays those records: `full` reads every
+ * lane instead (one query per 256 of them: every channel, point of sale and the own lane on every
+ * watched chain, every code on its own), as the first refresh of a state does. Do that now and then, say hourly. */
+export declare function refresh(client: CanisterClient, view: ViewKey, state: SyncState, opts?: {
+    full?: boolean;
+}): Promise<{
+    state: SyncState;
+    added: NewRecord[];
+}>;
+/** The first empty slot of a lane's sequence from slot `from` on: where a code's first payment goes, or a point of
+ * sale's next block. */
+export declare function sequenceEnd(client: CanisterClient, idAt: (index: number) => Uint8Array, from?: number): Promise<number>;
+/** `state`, encrypted under a key only `view` derives, for the app to store anywhere. */
+export declare function exportState(view: ViewKey, state: SyncState): Uint8Array;
+/** The state `exportState` encrypted, or `null` if `bytes` is not one for `view` (start over from
+ * `emptyState` then). */
+export declare function importState(view: ViewKey, bytes: Uint8Array): SyncState | null;