@agoric/client-utils 0.1.1-upgrade-21-dev-07d4845.0 → 0.1.1-ymax-v0.2-alpha-dev-a527ef4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/client-utils",
-  "version": "0.1.1-upgrade-21-dev-07d4845.0+07d4845",
+  "version": "0.1.1-ymax-v0.2-alpha-dev-a527ef4.0+a527ef4",
   "description": "Utilities for building Agoric clients",
   "license": "Apache-2.0",
   "publishConfig": {
@@ -62,5 +62,5 @@
     ],
     "timeout": "20m"
   },
-  "gitHead": "07d4845c9599083aecbf807668443865d0de0498"
+  "gitHead": "a527ef456b970107c2395833dce9abd87689959e"
 }

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":"AA0EO,iDAFI,CAAC,CAAC,EAAE,OAAO,KAAK,MAAM;;;;;EAchC;;;;uBAxEa,MAAM,GAAG,IAAI"}

package/src/marshalTables.js

@@ -0,0 +1,87 @@
+/**
+ * @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;
+  };
+  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',
+  });
+};

package/src/smart-wallet-kit.d.ts

@@ -1,6 +1,7 @@
-export function makeSmartWalletKit({ fetch, delay }: {
+export function makeSmartWalletKit({ fetch, delay, names }: {
     fetch: typeof globalThis.fetch;
     delay: (ms: number) => Promise<void>;
+    names?: boolean | undefined;
 }, networkConfig: MinimalNetworkConfig): Promise<{
     agoricNames: import("@agoric/vats/tools/board-utils.js").AgoricNamesRemotes;
     networkConfig: MinimalNetworkConfig;

package/src/smart-wallet-kit.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"smart-wallet-kit.d.ts","sourceRoot":"","sources":["smart-wallet-kit.js"],"names":[],"mappings":"AAqBO,qDAJJ;IAAuC,KAAK,EAApC,OAAO,UAAU,CAAC,KAAK;IACc,KAAK,EAA1C,CAAC,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC;CACrC,iBAAQ,oBAAoB;;;0BAoElB,MAAM,KACJ,OAAO,CAAC,YAAY,CAAC;mCAOvB,MAAM,KACJ,OAAO,CAAC,mBAAmB,CAAC;8BAnE9B,MAAM,cACN,MAAM,GAAC,MAAM;;;;;;;;;sBA0Bb,MAAM,MACN,MAAM,GAAC,MAAM,aACb,MAAM,GAAC,MAAM,2BACb,OAAO;;;;;;;;;;;;;;;;;;;;GAqDnB;6BACa,QAAQ,OAAO,kBAAkB,CAAC;0CAxGT,qBAAqB;kCADR,yCAAyC;yCAAzC,yCAAyC;2BAD7D,2BAA2B;4BAA3B,2BAA2B;6BADjC,WAAW"}
+{"version":3,"file":"smart-wallet-kit.d.ts","sourceRoot":"","sources":["smart-wallet-kit.js"],"names":[],"mappings":"AAsBO,4DALJ;IAAuC,KAAK,EAApC,OAAO,UAAU,CAAC,KAAK;IACc,KAAK,EAA1C,CAAC,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC;IACb,KAAK;CAC7B,iBAAQ,oBAAoB;;;0BAyElB,MAAM,KACJ,OAAO,CAAC,YAAY,CAAC;mCAOvB,MAAM,KACJ,OAAO,CAAC,mBAAmB,CAAC;8BAnE9B,MAAM,cACN,MAAM,GAAC,MAAM;;;;;;;;;sBA0Bb,MAAM,MACN,MAAM,GAAC,MAAM,aACb,MAAM,GAAC,MAAM,2BACb,OAAO;;;;;;;;;;;;;;;;;;;;GAqDnB;6BACa,QAAQ,OAAO,kBAAkB,CAAC;0CA9GT,qBAAqB;kCADR,yCAAyC;yCAAzC,yCAAyC;2BAD7D,2BAA2B;4BAA3B,2BAA2B;6BADjC,WAAW"}

package/src/smart-wallet-kit.js

@@ -17,14 +17,20 @@ import { makeAgoricNames, makeVstorageKit } from './vstorage-kit.js';
  * @param {object} root0
  * @param {typeof globalThis.fetch} root0.fetch
  * @param {(ms: number) => Promise<void>} root0.delay
+ * @param {boolean} [root0.names]
  * @param {MinimalNetworkConfig} networkConfig
  */
-export const makeSmartWalletKit = async ({ fetch, delay }, networkConfig) => {
+export const makeSmartWalletKit = async (
+  { fetch, delay, names = true },
+  networkConfig,
+) => {
   const vsk = makeVstorageKit({ fetch }, networkConfig);
 
   const client = await makeStargateClient(networkConfig, { fetch });
 
-  const agoricNames = await makeAgoricNames(vsk.fromBoard, vsk.vstorage);
+  const agoricNames = await (names
+    ? makeAgoricNames(vsk.fromBoard, vsk.vstorage)
+    : /** @type {import('@agoric/vats/tools/board-utils.js').AgoricNamesRemotes} */ ({}));
 
   /**
    * @param {string} from

package/src/types.d.ts

@@ -1,4 +1,4 @@
-import type { Brand } from '@agoric/ertp';
+import type { Brand, Issuer } from '@agoric/ertp';
 import type { ContractRecord, FeeConfig, PoolMetrics, TransactionRecord } from '@agoric/fast-usdc';
 import type { OutcomeRecord, QuestionDetails } from '@agoric/governance/src/types.js';
 import type { BookDataNotification } from '@agoric/inter-protocol/src/auction/auctionBook.js';
@@ -6,6 +6,7 @@ import type { AuctionParamRecord } from '@agoric/inter-protocol/src/auction/para
 import type { ScheduleNotification } from '@agoric/inter-protocol/src/auction/scheduler.js';
 import type { MetricsNotification as VaultDirectorMetrics } from '@agoric/inter-protocol/src/vaultFactory/vaultDirector.js';
 import type { CurrentWalletRecord, UpdateRecord } from '@agoric/smart-wallet/src/smartWallet.js';
+import type { AssetInfo } from '@agoric/vats/src/vat-bank.js';
 import type { Instance } from '@agoric/zoe/src/zoeService/types.js';
 type PublishedTypeMap = {
     'auction.governance': {
@@ -15,6 +16,8 @@ type PublishedTypeMap = {
     'vaultFactory.metrics': VaultDirectorMetrics;
     'agoricNames.instance': Array<[string, Instance]>;
     'agoricNames.brand': Array<[string, Brand]>;
+    'agoricNames.issuer': Array<[string, Issuer]>;
+    'agoricNames.vbankAsset': Array<[string, AssetInfo]>;
     fastUsdc: ContractRecord;
     'fastUsdc.feeConfig': FeeConfig;
     'fastUsdc.poolMetrics': PoolMetrics;

package/src/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["types.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,KAAK,EACV,cAAc,EACd,SAAS,EACT,WAAW,EACX,iBAAiB,EAClB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EACV,aAAa,EACb,eAAe,EAChB,MAAM,iCAAiC,CAAC;AACzC,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,mDAAmD,CAAC;AAC9F,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,8CAA8C,CAAC;AACvF,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,iDAAiD,CAAC;AAC5F,OAAO,KAAK,EAAE,mBAAmB,IAAI,oBAAoB,EAAE,MAAM,0DAA0D,CAAC;AAC5H,OAAO,KAAK,EACV,mBAAmB,EACnB,YAAY,EACb,MAAM,yCAAyC,CAAC;AACjD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,qCAAqC,CAAC;AAGpE,KAAK,gBAAgB,GAAG;IACtB,oBAAoB,EAAE;QAAE,OAAO,EAAE,kBAAkB,CAAA;KAAE,CAAC;IACtD,kBAAkB,EAAE,oBAAoB,CAAC;IACzC,sBAAsB,EAAE,oBAAoB,CAAC;IAC7C,sBAAsB,EAAE,KAAK,CAAC,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;IAClD,mBAAmB,EAAE,KAAK,CAAC,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;IAC5C,QAAQ,EAAE,cAAc,CAAC;IACzB,oBAAoB,EAAE,SAAS,CAAC;IAChC,sBAAsB,EAAE,WAAW,CAAC;CACrC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,MAAM,IAAI,CAAC,SAAS,MAAM,gBAAgB,GAC3E,gBAAgB,CAAC,CAAC,CAAC,GACnB,CAAC,SAAS,UAAU,MAAM,UAAU,GAClC,mBAAmB,GACnB,CAAC,SAAS,UAAU,MAAM,EAAE,GAC1B,YAAY,GACZ,CAAC,SAAS,cAAc,MAAM,iBAAiB,GAC7C,eAAe,GACf,CAAC,SAAS,cAAc,MAAM,gBAAgB,GAC5C,aAAa,GACb,CAAC,SAAS,gCAAgC,MAAM,UAAU,GACxD,oBAAoB,GACpB,CAAC,SAAS,iBAAiB,MAAM,EAAE,GACjC,iBAAiB,GACjB,CAAC,SAAS,eAAe,MAAM,EAAE,GAC/B,oBAAoB,GACpB,OAAO,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["types.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAClD,OAAO,KAAK,EACV,cAAc,EACd,SAAS,EACT,WAAW,EACX,iBAAiB,EAClB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EACV,aAAa,EACb,eAAe,EAChB,MAAM,iCAAiC,CAAC;AACzC,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,mDAAmD,CAAC;AAC9F,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,8CAA8C,CAAC;AACvF,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,iDAAiD,CAAC;AAC5F,OAAO,KAAK,EAAE,mBAAmB,IAAI,oBAAoB,EAAE,MAAM,0DAA0D,CAAC;AAC5H,OAAO,KAAK,EACV,mBAAmB,EACnB,YAAY,EACb,MAAM,yCAAyC,CAAC;AACjD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAC9D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,qCAAqC,CAAC;AAGpE,KAAK,gBAAgB,GAAG;IACtB,oBAAoB,EAAE;QAAE,OAAO,EAAE,kBAAkB,CAAA;KAAE,CAAC;IACtD,kBAAkB,EAAE,oBAAoB,CAAC;IACzC,sBAAsB,EAAE,oBAAoB,CAAC;IAC7C,sBAAsB,EAAE,KAAK,CAAC,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;IAClD,mBAAmB,EAAE,KAAK,CAAC,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;IAC5C,oBAAoB,EAAE,KAAK,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAC9C,wBAAwB,EAAE,KAAK,CAAC,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC;IACrD,QAAQ,EAAE,cAAc,CAAC;IACzB,oBAAoB,EAAE,SAAS,CAAC;IAChC,sBAAsB,EAAE,WAAW,CAAC;CACrC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,MAAM,IAAI,CAAC,SAAS,MAAM,gBAAgB,GAC3E,gBAAgB,CAAC,CAAC,CAAC,GACnB,CAAC,SAAS,UAAU,MAAM,UAAU,GAClC,mBAAmB,GACnB,CAAC,SAAS,UAAU,MAAM,EAAE,GAC1B,YAAY,GACZ,CAAC,SAAS,cAAc,MAAM,iBAAiB,GAC7C,eAAe,GACf,CAAC,SAAS,cAAc,MAAM,gBAAgB,GAC5C,aAAa,GACb,CAAC,SAAS,gCAAgC,MAAM,UAAU,GACxD,oBAAoB,GACpB,CAAC,SAAS,iBAAiB,MAAM,EAAE,GACjC,iBAAiB,GACjB,CAAC,SAAS,eAAe,MAAM,EAAE,GAC/B,oBAAoB,GACpB,OAAO,CAAC"}

package/src/types.ts

@@ -1,7 +1,7 @@
 // @file types for the client-utils package
 // NB: this doesn't follow best practices for TS in JS because this package will likely soon be written in TS
 
-import type { Brand } from '@agoric/ertp';
+import type { Brand, Issuer } from '@agoric/ertp';
 import type {
   ContractRecord,
   FeeConfig,
@@ -20,6 +20,7 @@ import type {
   CurrentWalletRecord,
   UpdateRecord,
 } from '@agoric/smart-wallet/src/smartWallet.js';
+import type { AssetInfo } from '@agoric/vats/src/vat-bank.js';
 import type { Instance } from '@agoric/zoe/src/zoeService/types.js';
 
 // For static string key types. String template matching has to be in the ternary below.
@@ -29,6 +30,8 @@ type PublishedTypeMap = {
   'vaultFactory.metrics': VaultDirectorMetrics;
   'agoricNames.instance': Array<[string, Instance]>;
   'agoricNames.brand': Array<[string, Brand]>;
+  'agoricNames.issuer': Array<[string, Issuer]>;
+  'agoricNames.vbankAsset': Array<[string, AssetInfo]>;
   fastUsdc: ContractRecord;
   'fastUsdc.feeConfig': FeeConfig;
   'fastUsdc.poolMetrics': PoolMetrics;

package/src/wallet-utils.d.ts

@@ -1,8 +1,9 @@
 /** @typedef {import('./smart-wallet-kit.js').SmartWalletKit} WalletUtils  */
 /** @deprecated use `makeSmartWalletKit` */
-export const makeWalletUtils: ({ fetch, delay }: {
+export const makeWalletUtils: ({ fetch, delay, names }: {
     fetch: typeof globalThis.fetch;
     delay: (ms: number) => Promise<void>;
+    names?: boolean | undefined;
 }, networkConfig: import("./network-config.js").MinimalNetworkConfig) => Promise<{
     agoricNames: import("@agoric/vats/tools/board-utils.js").AgoricNamesRemotes;
     networkConfig: import("./network-config.js").MinimalNetworkConfig;

package/src/wallet-utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"wallet-utils.d.ts","sourceRoot":"","sources":["wallet-utils.js"],"names":[],"mappings":"AAIA,6EAA6E;AAE7E,2CAA2C;AAC3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAAkD;0BAHpC,OAAO,uBAAuB,EAAE,cAAc"}
+{"version":3,"file":"wallet-utils.d.ts","sourceRoot":"","sources":["wallet-utils.js"],"names":[],"mappings":"AAIA,6EAA6E;AAE7E,2CAA2C;AAC3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAAkD;0BAHpC,OAAO,uBAAuB,EAAE,cAAc"}