@agoric/swingset-vat 0.32.3-dev-55a8847.0 → 0.32.3-dev-d322e42.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/swingset-vat",
-  "version": "0.32.3-dev-55a8847.0+55a8847",
+  "version": "0.32.3-dev-d322e42.0+d322e42",
   "description": "Vat/Container Launcher",
   "type": "module",
   "main": "src/index.js",
@@ -27,16 +27,16 @@
     "@types/yargs-parser": "^21.0.0"
   },
   "dependencies": {
-    "@agoric/internal": "0.3.3-dev-55a8847.0+55a8847",
-    "@agoric/kmarshal": "0.1.1-dev-55a8847.0+55a8847",
-    "@agoric/store": "0.9.3-dev-55a8847.0+55a8847",
-    "@agoric/swing-store": "0.9.2-dev-55a8847.0+55a8847",
-    "@agoric/swingset-liveslots": "0.10.3-dev-55a8847.0+55a8847",
-    "@agoric/swingset-xsnap-supervisor": "0.10.3-dev-55a8847.0+55a8847",
-    "@agoric/time": "0.3.3-dev-55a8847.0+55a8847",
-    "@agoric/vat-data": "0.5.3-dev-55a8847.0+55a8847",
-    "@agoric/xsnap": "0.14.3-dev-55a8847.0+55a8847",
-    "@agoric/xsnap-lockdown": "0.14.1-dev-55a8847.0+55a8847",
+    "@agoric/internal": "0.3.3-dev-d322e42.0+d322e42",
+    "@agoric/kmarshal": "0.1.1-dev-d322e42.0+d322e42",
+    "@agoric/store": "0.9.3-dev-d322e42.0+d322e42",
+    "@agoric/swing-store": "0.9.2-dev-d322e42.0+d322e42",
+    "@agoric/swingset-liveslots": "0.10.3-dev-d322e42.0+d322e42",
+    "@agoric/swingset-xsnap-supervisor": "0.10.3-dev-d322e42.0+d322e42",
+    "@agoric/time": "0.3.3-dev-d322e42.0+d322e42",
+    "@agoric/vat-data": "0.5.3-dev-d322e42.0+d322e42",
+    "@agoric/xsnap": "0.14.3-dev-d322e42.0+d322e42",
+    "@agoric/xsnap-lockdown": "0.14.1-dev-d322e42.0+d322e42",
     "@endo/base64": "^1.0.8",
     "@endo/bundle-source": "^3.4.1",
     "@endo/captp": "^4.4.0",
@@ -103,5 +103,5 @@
   "typeCoverage": {
     "atLeast": 75.82
   },
-  "gitHead": "55a8847943d19b700f08560ef2347b7aa90342ef"
+  "gitHead": "d322e42bcb8bf53aba0468f67907464b34d9e937"
 }

package/src/devices/mailbox/mailbox.js

@@ -71,6 +71,23 @@ import { Nat } from '@endo/nat';
 // replace it with one that tracks which parts of the state have been
 // modified, to build more efficient Merkle proofs.
 
+/**
+ * @typedef {object} Mailbox
+ * @property {bigint} ack
+ * @property {Map<bigint, unknown>} outbox
+ */
+
+/**
+ * @typedef {object} MailboxExport
+ * @property {number} ack
+ * @property {Array<[number, unknown]>} outbox
+ */
+
+/**
+ * @param {MailboxExport} data
+ * @param {Partial<Mailbox>} [inout]
+ * @returns {Mailbox}
+ */
 export function importMailbox(data, inout = {}) {
   const outbox = new Map();
   for (const m of data.outbox) {
@@ -78,10 +95,15 @@ export function importMailbox(data, inout = {}) {
   }
   inout.ack = Nat(data.ack);
   inout.outbox = outbox;
-  return inout;
+  return /** @type {Mailbox} */ (inout);
 }
 
+/**
+ * @param {Mailbox} inout
+ * @returns {MailboxExport}
+ */
 export function exportMailbox(inout) {
+  /** @type {MailboxExport['outbox']} */
   const messages = [];
   for (const [msgnum, body] of inout.outbox) {
     messages.push([Number(msgnum), body]);
@@ -93,64 +115,75 @@ export function exportMailbox(inout) {
   };
 }
 
-export function buildMailboxStateMap(state = harden(new Map())) {
-  function getOrCreatePeer(peer) {
-    if (!state.has(peer)) {
-      const inout = {
-        outbox: harden(new Map()),
-        ack: 0n,
-      };
-      state.set(peer, inout);
-    }
-    return state.get(peer);
+/**
+ * @param {Map<string, Mailbox>} state
+ */
+export function exportMailboxData(state) {
+  /** @type {Record<string, {inboundAck: MailboxExport['ack'], outbox: MailboxExport['outbox']}>} */
+  const data = {};
+  for (const [peer, inout] of state.entries()) {
+    const exported = exportMailbox(inout);
+    data[peer] = {
+      inboundAck: exported.ack,
+      outbox: exported.outbox,
+    };
   }
+  return harden(data);
+}
 
-  function add(peer, msgnum, body) {
-    getOrCreatePeer(`${peer}`).outbox.set(Nat(msgnum), `${body}`);
+function getOrCreatePeer(state, peer) {
+  if (!state.has(peer)) {
+    const inout = {
+      outbox: harden(new Map()),
+      ack: 0n,
+    };
+    state.set(peer, inout);
   }
+  return state.get(peer);
+}
 
-  function remove(peer, msgnum) {
-    const messages = getOrCreatePeer(`${peer}`).outbox;
-    messages.delete(Nat(msgnum));
+/**
+ * @param {ReturnType<exportMailboxData>} data
+ * @returns {Map<string, Mailbox>}
+ */
+export function makeEphemeralMailboxStorage(data) {
+  const state = harden(new Map());
+  for (const peer of Object.getOwnPropertyNames(data)) {
+    const inout = getOrCreatePeer(state, peer);
+    const d = data[peer];
+    importMailbox(
+      {
+        ack: d.inboundAck,
+        outbox: d.outbox,
+      },
+      inout,
+    );
   }
+  return state;
+}
 
-  function setAcknum(peer, msgnum) {
-    getOrCreatePeer(`${peer}`).ack = Nat(msgnum);
+/**
+ * @template [T=unknown]
+ * @param {Pick<Map<string, T>, 'has' | 'get'> & {set: (key: string, value: T) => void}} [state]
+ */
+export function buildMailboxStateMap(state = harden(new Map())) {
+  function add(peer, msgnum, body) {
+    getOrCreatePeer(state, `${peer}`).outbox.set(Nat(msgnum), `${body}`);
   }
 
-  function exportToData() {
-    const data = {};
-    for (const [peer, inout] of state.entries()) {
-      const exported = exportMailbox(inout);
-      data[peer] = {
-        inboundAck: exported.ack,
-        outbox: exported.outbox,
-      };
-    }
-    return harden(data);
+  function remove(peer, msgnum) {
+    const messages = getOrCreatePeer(state, `${peer}`).outbox;
+    messages.delete(Nat(msgnum));
   }
 
-  function populateFromData(data) {
-    !state.size || Fail`cannot populateFromData: outbox is not empty`;
-    for (const peer of Object.getOwnPropertyNames(data)) {
-      const inout = getOrCreatePeer(peer);
-      const d = data[peer];
-      importMailbox(
-        {
-          ack: d.inboundAck,
-          outbox: d.outbox,
-        },
-        inout,
-      );
-    }
+  function setAcknum(peer, msgnum) {
+    getOrCreatePeer(state, `${peer}`).ack = Nat(msgnum);
   }
 
   return harden({
     add,
     remove,
     setAcknum,
-    exportToData,
-    populateFromData,
   });
 }
 

package/src/index.js

@@ -13,6 +13,8 @@ export { upgradeSwingset } from './controller/upgradeSwingset.js';
 export {
   buildMailboxStateMap,
   buildMailbox,
+  exportMailboxData,
+  makeEphemeralMailboxStorage,
 } from './devices/mailbox/mailbox.js';
 export { buildTimer } from './devices/timer/timer.js';
 export { buildBridge } from './devices/bridge/bridge.js';

package/src/types-external.js

@@ -283,6 +283,13 @@ export {};
  * @property { boolean } [restartWorkerOnSnapshot]     Reload worker immediately upon snapshot creation
  */
 
+/**
+ * @typedef { import('./devices/mailbox/mailbox.js').Mailbox } Mailbox
+ */
+/**
+ * @typedef { import('./devices/mailbox/mailbox.js').MailboxExport } MailboxExport
+ */
+
 /**
  * Vat Creation and Management
  *