@agoric/wallet-backend 0.13.4-dev-bc4e1aa.0 → 0.13.4-dev-8b50322.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/wallet-backend",
-  "version": "0.13.4-dev-bc4e1aa.0+bc4e1aa",
+  "version": "0.13.4-dev-8b50322.0+8b50322",
   "description": "Wallet backend",
   "type": "module",
   "scripts": {
@@ -14,23 +14,23 @@
     "lint:eslint": "eslint ."
   },
   "devDependencies": {
-    "@agoric/deploy-script-support": "0.9.5-dev-bc4e1aa.0+bc4e1aa",
-    "@agoric/vats": "0.13.1-dev-bc4e1aa.0+bc4e1aa",
+    "@agoric/vats": "0.13.1-dev-8b50322.0+8b50322",
     "@endo/bundle-source": "^2.4.2",
     "@endo/init": "^0.5.52",
     "ava": "^5.1.0"
   },
   "dependencies": {
-    "@agoric/assert": "0.5.2-dev-bc4e1aa.0+bc4e1aa",
-    "@agoric/cache": "0.2.4-dev-bc4e1aa.0+bc4e1aa",
-    "@agoric/ertp": "0.15.4-dev-bc4e1aa.0+bc4e1aa",
-    "@agoric/inter-protocol": "0.13.2-dev-bc4e1aa.0+bc4e1aa",
-    "@agoric/internal": "0.2.2-dev-bc4e1aa.0+bc4e1aa",
+    "@agoric/assert": "0.5.2-dev-8b50322.0+8b50322",
+    "@agoric/cache": "0.2.4-dev-8b50322.0+8b50322",
+    "@agoric/ertp": "0.15.4-dev-8b50322.0+8b50322",
+    "@agoric/inter-protocol": "0.13.2-dev-8b50322.0+8b50322",
+    "@agoric/internal": "0.2.2-dev-8b50322.0+8b50322",
     "@agoric/nat": "^4.1.0",
-    "@agoric/notifier": "0.5.2-dev-bc4e1aa.0+bc4e1aa",
-    "@agoric/store": "0.8.4-dev-bc4e1aa.0+bc4e1aa",
-    "@agoric/vat-data": "0.4.4-dev-bc4e1aa.0+bc4e1aa",
-    "@agoric/zoe": "0.25.4-dev-bc4e1aa.0+bc4e1aa",
+    "@agoric/notifier": "0.5.2-dev-8b50322.0+8b50322",
+    "@agoric/smart-wallet": "0.4.3-dev-8b50322.0+8b50322",
+    "@agoric/store": "0.8.4-dev-8b50322.0+8b50322",
+    "@agoric/vat-data": "0.4.4-dev-8b50322.0+8b50322",
+    "@agoric/zoe": "0.25.4-dev-8b50322.0+8b50322",
     "@endo/eventual-send": "^0.16.8",
     "@endo/marshal": "^0.8.1",
     "@endo/promise-kit": "^0.2.52",
@@ -57,5 +57,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "bc4e1aa1f2e80bd58ca6d9fdf7b2216f09754da2"
+  "gitHead": "8b50322bfb6ed332518045e0514741796ca01fe1"
 }

package/scripts/build-bundles.js

@@ -1,6 +1,6 @@
 #! /usr/bin/env node
 import '@endo/init';
-import { createBundles } from '@agoric/deploy-script-support';
+import { createBundles } from '@agoric/internal/src/createBundles.js';
 import url from 'url';
 
 const dirname = url.fileURLToPath(new URL('.', import.meta.url));

package/src/internal-types.js

@@ -7,6 +7,8 @@
  * @property {PurseActions} actions
  */
 
+/** @typedef {import('@agoric/deploy-script-support/src/externalTypes').Petname} Petname */
+
 /**
  * @typedef {PursesJSONState & PursesAddedState} PursesFullState
  */

package/src/lib-wallet.js

@@ -33,12 +33,12 @@ import {
 } from '@agoric/notifier';
 import { makePromiseKit } from '@endo/promise-kit';
 
+import { makeExportContext } from '@agoric/smart-wallet/src/marshal-contexts.js';
 import { makeIssuerTable } from './issuerTable.js';
 import { makeDehydrator } from './lib-dehydrate.js';
 import { makeId, findOrMakeInvitation } from './findOrMakeInvitation.js';
 import { bigintStringify } from './bigintStringify.js';
 import { makePaymentActions } from './actions.js';
-import { makeExportContext } from './marshal-contexts.js';
 
 import '@agoric/store/exported.js';
 import '@agoric/zoe/exported.js';

package/test/test-middleware.js

@@ -6,7 +6,7 @@ import {
   makeExportContext,
   makeImportContext,
   makeLoggingPresence,
-} from '../src/marshal-contexts.js';
+} from '@agoric/smart-wallet/src/marshal-contexts.js';
 
 const capData1 = {
   body: JSON.stringify([

package/test/test-wallet-marshal.js

@@ -7,7 +7,7 @@ import { makeHandle } from '@agoric/zoe/src/makeHandle.js';
 import {
   makeExportContext,
   makeImportContext,
-} from '../src/marshal-contexts.js';
+} from '@agoric/smart-wallet/src/marshal-contexts.js';
 
 /** @param {ReturnType<typeof makeBoard>} board */
 const makeAMM = board => {

package/src/marshal-contexts.js

@@ -1,389 +0,0 @@
-// @ts-check
-import { makeScalarMapStore } from '@agoric/store';
-import { Far, makeMarshal, Remotable } from '@endo/marshal';
-import { HandledPromise } from '@endo/eventual-send'; // TODO: convince tsc this isn't needed
-
-const { Fail, quote: q } = assert;
-
-/**
- * For a value with a known id in the board, we can use
- * that board id as a slot to preserve identity when marshaling.
- *
- * @typedef {`board${Digits}`} BoardId
- */
-
-/**
- * @param {unknown} specimen
- * @returns {specimen is BoardId}
- */
-const isBoardId = specimen => {
-  return typeof specimen === 'string' && !!specimen.match(/^board[^:]/);
-};
-
-/**
- * When marshaling a purse, payment, etc. we partition the slots
- * using prefixes.
- *
- * @template {Record<string, IdTable<*,*>>} T
- * @typedef {`${string & keyof T}:${Digits}`} WalletSlot<T>
- */
-/**
- * @template {string} K
- * @typedef {`${K}:${Digits}`} KindSlot<K>
- */
-
-/**
- * @template {Record<string, IdTable<*,*>>} T
- * @param {T} _tables
- * @param {string & keyof T} kind
- * @param {number} id
- * @returns {WalletSlot<T>}
- */
-const makeWalletSlot = (_tables, kind, id) => {
-  const digits = /** @type {Digits} */ (`${id}`);
-  return `${kind}:${digits}`;
-};
-
-/**
- * @template {Record<string, IdTable<*,*>>} T
- * @param {T} record
- * @param {(value: string, index: number, obj: string[]) => boolean} predicate
- * @returns {string & keyof T | undefined}
- */
-const findKey = (record, predicate) => {
-  const key = Object.keys(record).find(predicate);
-  return key;
-};
-
-/**
- * @template {Record<string, IdTable<*,*>>} T
- * @param {T} tables
- * @param {string} slot
- * @returns {{ kind: undefined | string & keyof T, id: number }}
- */
-const parseWalletSlot = (tables, slot) => {
-  const kind = findKey(tables, k => slot.startsWith(`${k}:`));
-  const id = kind ? Number(slot.slice(kind.length + 1)) : NaN;
-  return { kind, id };
-};
-
-/**
- * Since KindSlots always include a colon and BoardIds never do,
- * we an mix them without confusion.
- *
- * @template {Record<string, IdTable<*,*>>} T
- * @typedef {WalletSlot<T> | BoardId} MixedSlot<T>
- */
-/**
- * @typedef {`1` | `12` | `123`} Digits - 1 or more digits.
- * NOTE: the typescript definition here is more restrictive than
- * actual usage.
- */
-
-/**
- * @template Slot
- * @template Val
- *
- * @typedef {{
- *   bySlot: MapStore<Slot, Val>,
- *   byVal: MapStore<Val, Slot>,
- * }} IdTable<Value>
- */
-
-/**
- * @template Slot
- * @template Val
- * @param {IdTable<Slot, Val>} table
- * @param {Slot} slot
- * @param {Val} val
- */
-const initSlotVal = (table, slot, val) => {
-  table.bySlot.init(slot, val);
-  table.byVal.init(val, slot);
-};
-
-/**
- * Make context for exporting wallet data where brands etc. can be recognized by boardId.
- * Export for use outside the smart wallet.
- *
- * When serializing wallet state for, there's a tension between
- *
- *  - keeping purses etc. closely held
- *  - recognizing identity of brands also referenced in the state of contracts such as the AMM
- *
- * `makeMarshal()` is parameterized by the type of slots. Here we use a disjoint union of
- *   - board ids for widely shared objects
- *   - kind:seq ids for closely held objects; for example purse:123
- */
-export const makeExportContext = () => {
-  const walletObjects = {
-    /** @type {IdTable<number, Purse>} */
-    purse: {
-      bySlot: makeScalarMapStore(),
-      byVal: makeScalarMapStore(),
-    },
-    /** @type {IdTable<number, Payment>} */
-    payment: {
-      bySlot: makeScalarMapStore(),
-      byVal: makeScalarMapStore(),
-    },
-    // TODO: offer, contact, dapp
-    /** @type {IdTable<number, unknown>} */
-    unknown: {
-      bySlot: makeScalarMapStore(),
-      byVal: makeScalarMapStore(),
-    },
-  };
-  /** @type {IdTable<BoardId, unknown>} */
-  const boardObjects = {
-    bySlot: makeScalarMapStore(),
-    byVal: makeScalarMapStore(),
-  };
-
-  /**
-   * Look up the slot in mappings from published data
-   * else try walletObjects that we have seen.
-   *
-   * @throws if not found (a slotToVal function typically
-   *         conjures a new identity)
-   *
-   * @param {MixedSlot<typeof walletObjects>} slot
-   * @param {string} _iface
-   */
-  const slotToVal = (slot, _iface) => {
-    if (isBoardId(slot) && boardObjects.bySlot.has(slot)) {
-      return boardObjects.bySlot.get(slot);
-    }
-    const { kind, id } = parseWalletSlot(walletObjects, slot);
-    kind || Fail`bad slot kind: ${slot}`;
-    const val = walletObjects[kind].bySlot.get(id); // or throw
-    return val;
-  };
-
-  let unknownNonce = 0;
-
-  /**
-   * @param {unknown} val
-   * @returns {MixedSlot<typeof walletObjects>}
-   */
-  const valToSlot = val => {
-    if (boardObjects.byVal.has(val)) {
-      return boardObjects.byVal.get(val);
-    }
-    const kind = findKey(walletObjects, k => walletObjects[k].byVal.has(val));
-    if (kind) {
-      // @ts-expect-error has(val) above ensures val has the right type
-      const id = walletObjects[kind].byVal.get(val);
-      return makeWalletSlot(walletObjects, kind, id);
-    }
-    unknownNonce += 1;
-    const slot = makeWalletSlot(walletObjects, 'unknown', unknownNonce);
-    initSlotVal(walletObjects.unknown, unknownNonce, val);
-    return slot;
-  };
-
-  /**
-   * @template V
-   * @param {string & keyof typeof walletObjects} kind
-   * @param {IdTable<number, V>} table
-   */
-  const makeSaver = (kind, table) => {
-    let nonce = 0;
-    /** @param {V} val */
-    const saver = val => {
-      nonce += 1;
-      initSlotVal(table, nonce, val);
-    };
-    return saver;
-  };
-
-  return harden({
-    savePurseActions: makeSaver('purse', walletObjects.purse),
-    savePaymentActions: makeSaver('payment', walletObjects.payment),
-    /**
-     * @param {number} id
-     * @param {Purse} purse
-     */
-    initPurseId: (id, purse) => {
-      initSlotVal(walletObjects.purse, id, purse);
-    },
-    purseEntries: walletObjects.purse.bySlot.entries,
-    /**
-     * @param {BoardId} id
-     * @param {unknown} val
-     */
-    initBoardId: (id, val) => {
-      initSlotVal(boardObjects, id, val);
-    },
-    /**
-     * @param {BoardId} id
-     * @param {unknown} val
-     */
-    ensureBoardId: (id, val) => {
-      if (boardObjects.byVal.has(val)) {
-        assert.equal(boardObjects.byVal.get(val), id);
-        return;
-      }
-      initSlotVal(boardObjects, id, val);
-    },
-    ...makeMarshal(valToSlot, slotToVal),
-  });
-};
-
-const defaultMakePresence = iface => {
-  const severed = `SEVERED: ${iface.replace(/^Alleged: /, '')}`;
-  return Far(severed, {});
-};
-
-/**
- * Make context for marshalling wallet or board data.
- * To be imported into the client, which never exports objects.
- *
- * @param {(iface: string) => unknown} [makePresence]
- */
-export const makeImportContext = (makePresence = defaultMakePresence) => {
-  const walletObjects = {
-    /** @type {IdTable<number, unknown>} */
-    purse: {
-      bySlot: makeScalarMapStore(),
-      byVal: makeScalarMapStore(),
-    },
-    /** @type {IdTable<number, unknown>} */
-    payment: {
-      bySlot: makeScalarMapStore(),
-      byVal: makeScalarMapStore(),
-    },
-    /** @type {IdTable<number, unknown>} */
-    unknown: {
-      bySlot: makeScalarMapStore(),
-      byVal: makeScalarMapStore(),
-    },
-  };
-  /** @type {IdTable<BoardId, unknown>} */
-  const boardObjects = {
-    bySlot: makeScalarMapStore(),
-    byVal: makeScalarMapStore(),
-  };
-
-  /**
-   * @template Slot
-   * @template Val
-   * @param {IdTable<Slot, Val>} table
-   * @param {Slot} slot
-   * @param {string} iface
-   */
-  const provideVal = (table, slot, iface) => {
-    if (table.bySlot.has(slot)) {
-      return table.bySlot.get(slot);
-    }
-    const val = makePresence(iface);
-    initSlotVal(table, slot, val);
-    return val;
-  };
-
-  const slotToVal = {
-    /**
-     * @param {string} slot
-     * @param {string} iface
-     */
-    fromBoard: (slot, iface) => {
-      isBoardId(slot) || Fail`bad board slot ${q(slot)}`;
-      return provideVal(boardObjects, slot, iface);
-    },
-
-    /**
-     * @param {string} slot
-     * @param {string} iface
-     */
-    fromMyWallet: (slot, iface) => {
-      if (!slot) {
-        // Empty or null slots are neither in the wallet nor the board.
-        return makePresence(`${slot}`);
-      }
-      const { kind, id } = parseWalletSlot(walletObjects, slot);
-      return kind
-        ? provideVal(walletObjects[kind], id, iface)
-        : slotToVal.fromBoard(slot, iface);
-    },
-  };
-
-  const valToSlot = {
-    fromBoard: val => boardObjects.byVal.get(val),
-    /** @param {unknown} val */
-    fromMyWallet: val => {
-      const kind = findKey(walletObjects, k => walletObjects[k].byVal.has(val));
-      if (kind === undefined) {
-        throw Fail`cannot serialize unregistered ${val}`;
-      }
-
-      const id = walletObjects[kind].byVal.get(val);
-      return makeWalletSlot(walletObjects, kind, id);
-    },
-  };
-
-  const marshal = {
-    fromBoard: makeMarshal(valToSlot.fromBoard, slotToVal.fromBoard, {
-      marshalName: 'fromBoard',
-    }),
-    fromMyWallet: makeMarshal(valToSlot.fromMyWallet, slotToVal.fromMyWallet, {
-      marshalName: 'fromMyWallet',
-    }),
-  };
-
-  return harden({
-    /**
-     * @param {BoardId} id
-     * @param {unknown} val
-     */
-    initBoardId: (id, val) => {
-      initSlotVal(boardObjects, id, val);
-    },
-    /**
-     * @param {BoardId} id
-     * @param {unknown} val
-     */
-    ensureBoardId: (id, val) => {
-      if (boardObjects.byVal.has(val)) {
-        assert.equal(boardObjects.byVal.get(val), id);
-        return;
-      }
-      initSlotVal(boardObjects, id, val);
-    },
-    fromMyWallet: Far('wallet marshaller', { ...marshal.fromMyWallet }),
-    fromBoard: Far('board marshaller', { ...marshal.fromBoard }),
-  });
-};
-
-/**
- * @param {string} iface
- * @param {{
- *   applyMethod: (target: unknown, method: string | symbol, args: unknown[]) => void,
- *   applyFunction: (target: unknown, args: unknown[]) => void,
- * }} handler
- */
-const makePresence = (iface, handler) => {
-  let obj;
-  // eslint-disable-next-line no-new
-  new HandledPromise((resolve, reject, resolveWithPresence) => {
-    obj = resolveWithPresence(handler);
-  });
-  assert(obj);
-  return Remotable(iface, undefined, obj);
-};
-
-/**
- * @param {string} iface
- * @param {(parts: unknown[]) => void} log
- */
-export const makeLoggingPresence = (iface, log) => {
-  /** @type {any} */ // TODO: solve types puzzle
-  const it = makePresence(iface, {
-    applyMethod: (target, method, args) => {
-      log(harden(['applyMethod', target, method, args]));
-    },
-    applyFunction: (target, args) => {
-      log(harden(['applyFunction', target, args]));
-    },
-  });
-  return it;
-};