@agoric/client-utils 0.1.1-dev-70182f8.0 → 0.1.1-dev-5761f40.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/client-utils",
-  "version": "0.1.1-dev-70182f8.0+70182f8",
+  "version": "0.1.1-dev-5761f40.0+5761f40",
   "description": "Utilities for building Agoric clients",
   "license": "Apache-2.0",
   "publishConfig": {
@@ -62,5 +62,5 @@
     ],
     "timeout": "20m"
   },
-  "gitHead": "70182f867f9b2091d383a2023655cc4748f9ad68"
+  "gitHead": "5761f4094a6458a9d2b379f231e6f07d7b757ab3"
 }

package/src/main.d.ts

@@ -1,5 +1,6 @@
 export { VBankAccount };
 export * from "./cli.js";
+export * from "./marshalTables.js";
 export * from "./network-config.js";
 export * from "./rpc.js";
 export * from "./smart-wallet-kit.js";

package/src/main.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["main.js"],"names":[],"mappings":";;;;;;;;;;6BAA6B,gCAAgC"}
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["main.js"],"names":[],"mappings":";;;;;;;;;;;6BAA6B,gCAAgC"}

package/src/main.js

@@ -2,6 +2,7 @@ import { VBankAccount } from '@agoric/internal/src/config.js';
 
 export { VBankAccount };
 export * from './cli.js';
+export * from './marshalTables.js';
 export * from './network-config.js';
 export * from './rpc.js';
 export * from './smart-wallet-kit.js';

package/src/marshalTables.d.ts

@@ -0,0 +1,11 @@
+export function makeClientMarshaller(valToSlot?: (v: unknown) => string): {
+    toCapData: import("@endo/marshal").ToCapData<string | null>;
+    fromCapData: import("@endo/marshal").FromCapData<string | null>;
+    serialize: import("@endo/marshal").ToCapData<string | null>;
+    unserialize: import("@endo/marshal").FromCapData<string | null>;
+};
+/**
+ * The null slot indicates that identity is not intended to be preserved.
+ */
+export type WildSlot = string | null;
+//# sourceMappingURL=marshalTables.d.ts.map

package/src/marshalTables.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"marshalTables.d.ts","sourceRoot":"","sources":["marshalTables.js"],"names":[],"mappings":"AA4EO,iDAFI,CAAC,CAAC,EAAE,OAAO,KAAK,MAAM;;;;;EAchC;;;;uBAzEa,MAAM,GAAG,IAAI"}

package/src/marshalTables.js

@@ -0,0 +1,89 @@
+// @ts-check
+/**
+ * @file marshal tools for vstorage clients
+ *
+ * TODO: integrate back into @agoric/rpc
+ *  - fixes: calls to makeClientMarshaller share static mutable state
+ *    https://github.com/Agoric/ui-kit/issues/73
+ *  - fits in this plain .js project
+ */
+/** global harden */
+import { Far, makeMarshal } from '@endo/marshal';
+
+/**
+ * The null slot indicates that identity is not intended to be preserved.
+ *
+ * @typedef { string | null } WildSlot
+ */
+
+/**
+ * Implement conventional parts of convertValToSlot, convertSlotToVal functions
+ * for use with makeMarshal based on a slot <-> value translation table,
+ * indexed in both directions. Caller supplies functions for making
+ * slots, values when not present in the table.
+ *
+ * @template Val
+ * @param {(val: Val, size: number) => string} makeSlot
+ * @param {(slot: WildSlot, iface: string | undefined) => Val} makeVal
+ */
+const makeTranslationTable = (makeSlot, makeVal) => {
+  /** @type {Map<Val, string>} */
+  const valToSlot = new Map();
+  /** @type {Map<string, Val>} */
+  const slotToVal = new Map();
+
+  /** @type {(val: Val) => string} */
+  const convertValToSlot = val => {
+    if (valToSlot.has(val)) {
+      // @ts-expect-error https://github.com/microsoft/TypeScript/issues/13086
+      return valToSlot.get(val);
+    }
+    const slot = makeSlot(val, valToSlot.size);
+    valToSlot.set(val, slot);
+    slotToVal.set(slot, val);
+    return slot;
+  };
+
+  /** @type {(slot: WildSlot, iface: string | undefined) => Val} */
+  const convertSlotToVal = (slot, iface) => {
+    if (slot === null) return makeVal(slot, iface);
+    if (slotToVal.has(slot)) {
+      // @ts-expect-error https://github.com/microsoft/TypeScript/issues/13086
+      return slotToVal.get(slot);
+    }
+    const val = makeVal(slot, iface);
+    valToSlot.set(val, slot);
+    slotToVal.set(slot, val);
+    return val;
+  };
+  // eslint-disable-next-line no-undef
+  return harden({ convertValToSlot, convertSlotToVal });
+};
+
+/** @type {(slot: string, iface: string | undefined) => any} */
+const synthesizeRemotable = (slot, iface) => {
+  const ifaceStr = iface ?? '';
+  const suffix = ifaceStr.endsWith(`#${slot}`) ? '' : `#${slot}`;
+  return Far(`${ifaceStr.replace(/^Alleged: /, '')}${suffix}`, {});
+};
+
+/**
+ * Make a marshaller that synthesizes a remotable the first
+ * time it sees a slot identifier, allowing clients to recognize
+ * object identity for brands, instances, etc.
+ *
+ * @param {(v: unknown) => string} [valToSlot]
+ */
+export const makeClientMarshaller = valToSlot => {
+  const noNewSlots = val => {
+    throw Error(`unknown value: ${val}`);
+  };
+  const { convertValToSlot, convertSlotToVal } = makeTranslationTable(
+    valToSlot || noNewSlots,
+    synthesizeRemotable,
+  );
+
+  return makeMarshal(convertValToSlot, convertSlotToVal, {
+    serializeBodyFormat: 'smallcaps',
+  });
+};