@agoric/vats 0.15.2-dev-857e650.0 → 0.15.2-dev-284e2db.0

package/src/core/utils.d.ts

@@ -1,7 +1,9 @@
 /**
  * We reserve these keys in name hubs.
  *
- * @type {{ [P in keyof WellKnownName]: { [P2 in WellKnownName[P]]: string } }}
+ * @type {{
+ *   [P in keyof WellKnownName]: { [P2 in WellKnownName[P]]: string };
+ * }}
  */
 export const agoricNamesReserved: {
     issuer: {
@@ -49,7 +51,7 @@ export const agoricNamesReserved: {
         VaultFactory: string;
     };
 };
-/** @type { FeeIssuerConfig } */
+/** @type {FeeIssuerConfig} */
 export const feeIssuerConfig: FeeIssuerConfig;
 export function addRemote(addr: string, { vats: { comms, vattp } }: {
     vats: {

package/src/core/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["utils.js"],"names":[],"mappings":"AAaA;;;;GAIG;AACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAwDG;AAEH,gCAAgC;AAChC,8BADY,eAAe,CAKzB;AAQK,gCAHI,MAAM,8BACN;IAAE,IAAI,EAAE;QAAE,KAAK,EAAE,QAAQ,CAAC;QAAC,KAAK,EAAE,YAAY,CAAA;KAAE,CAAA;CAAC,iBAK3D;AAQM,8DAJuB,OAAO,MAAM,EAAE,OAAO,CAAC,cACtC,OAAO,KACT,OAAO,MAAM,EAAE,OAAO,CAAC,CAG0B;AASvD,kCAJI,IAAI,GAAG,MAAM,GAAG,OAAO,MAAM,MAAI,YACjC,OAAO,oCAkCjB;AAOM,sCAHI,IAAI,GAAG,MAAM,GAAG,OAAO,MAAM,MAAI,aACjC,OAAO,OAYjB;AAUM;eALI,OAAO;eACP,OAAO,MAAM,EAAE,OAAO,CAAC;cACvB,OAAO,MAAM,EAAE,OAAO,MAAM,EAAE,OAAO,CAAC,CAAC;uBAC/B,MAAM,UAAU,OAAO,MAAM,EAAE,OAAO,CAAC,KAAK,OAAO;mBAwBrE;AAUM,sDAHI,KAAK,OAAO,UAAU,EAAE,SAAS,CAAC;;;4CAyB5C;AAOM,iDAJI,KAAK,OAAO,UAAU,EAAE,SAAS,CAAC;;;uEAsB5C;AAuBM;;;0BAfI,OAAO,MAAM,EAAE,OAAO,MAAM,EAAE,OAAO,CAAC,CAAC;iBAUhC,OAAO,aAAa,EAAE,OAAO;sBACxB,OAAO,aAAa,EAAE,SAAS;YACzC,eAAe;GAuB3B;AAOM,mDAJI,MAAM;;;EAkBhB;AAWM,kCARI,KAAK,WAAW,QAAQ,WAAW,CAAC,CAAC,uBAAuB,CAAC,CAAC,CAAC,kBAC/D,OAAO,mBACG,GAAG,KAAK,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAqDhC;;;;+BAlDY,OAAO,sBAAsB,EAAE,gBAAgB;uBAC/C,SAAS,MAAM,EAAE,gBAAgB,CAAC"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["utils.js"],"names":[],"mappings":"AAaA;;;;;;GAMG;AACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAwDG;AAEH,8BAA8B;AAC9B,8BADW,eAAe,CAKxB;AAQK,gCAHI,MAAM,8BACN;IAAE,IAAI,EAAE;QAAE,KAAK,EAAE,QAAQ,CAAC;QAAC,KAAK,EAAE,YAAY,CAAA;KAAE,CAAA;CAAE,iBAK5D;AAQM,8DAJkB,OAAO,MAAM,EAAE,OAAO,CAAC,cAClC,OAAO,KACR,OAAO,MAAM,EAAE,OAAO,CAAC,CAG0B;AAWvD,kCALI,IAAI,GAAG,MAAM,GAAG,OAAO,MAAM,EAAE,GAAG,CAAC,YAEnC,OAAO,oCAkCjB;AAQM,sCAJI,IAAI,GAAG,MAAM,GAAG,OAAO,MAAM,EAAE,GAAG,CAAC,aAEnC,OAAO,OAYjB;AAUM;eALI,OAAO;eACP,OAAO,MAAM,EAAE,OAAO,CAAC;cACvB,OAAO,MAAM,EAAE,OAAO,MAAM,EAAE,OAAO,CAAC,CAAC;uBAChC,MAAM,UAAU,OAAO,MAAM,EAAE,OAAO,CAAC,KAAK,OAAO;mBAwBpE;AASM,sDAHI,KAAK,OAAO,UAAU,EAAE,SAAS,CAAC;;;4CAyB5C;AAOM,iDAJI,KAAK,OAAO,UAAU,EAAE,SAAS,CAAC;;;uEAsB5C;AAoBM;;;0BAXI,OAAO,MAAM,EAAE,OAAO,MAAM,EAAE,OAAO,CAAC,CAAC;iBAMhC,OAAO,aAAa,EAAE,OAAO;sBACxB,OAAO,aAAa,EAAE,SAAS;YACzC,eAAe;GAuB3B;AAMM,mDAFI,MAAM;;;EAgBhB;AAaM,kCAVI,KAAK,WAAW,QAAQ,WAAW,CAAC,CAAC,uBAAuB,CAAC,CAAC,CAAC,kBAC/D,OAAO,mBACG,GAAG,KAAK,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAuDhC;;;;+BApDY,OAAO,sBAAsB,EAAE,gBAAgB;uBAG/C,SAAS,MAAM,EAAE,gBAAgB,CAAC"}

package/src/core/utils.js

@@ -14,7 +14,9 @@ const { Fail, quote: q } = assert;
 /**
  * We reserve these keys in name hubs.
  *
- * @type {{ [P in keyof WellKnownName]: { [P2 in WellKnownName[P]]: string } }}
+ * @type {{
+ *   [P in keyof WellKnownName]: { [P2 in WellKnownName[P]]: string };
+ * }}
  */
 export const agoricNamesReserved = harden({
   issuer: {
@@ -74,7 +76,7 @@ export const agoricNamesReserved = harden({
   },
 });
 
-/** @type { FeeIssuerConfig } */
+/** @type {FeeIssuerConfig} */
 export const feeIssuerConfig = {
   name: Stable.symbol,
   assetKind: Stable.assetKind,
@@ -85,7 +87,7 @@ export const feeIssuerConfig = {
  * Wire up a remote between the comms vat and vattp.
  *
  * @param {string} addr
- * @param {{ vats: { vattp: VattpVat, comms: CommsVatRoot }}} powers
+ * @param {{ vats: { vattp: VattpVat; comms: CommsVatRoot } }} powers
  */
 export const addRemote = async (addr, { vats: { comms, vattp } }) => {
   const { transmitter, setReceiver } = await E(vattp).addRemote(addr);
@@ -94,17 +96,19 @@ export const addRemote = async (addr, { vats: { comms, vattp } }) => {
 harden(addRemote);
 
 /**
- * @param {Array<(...args) => Record<string, unknown>>} builders
- * @param  {...unknown} args
+ * @param {((...args) => Record<string, unknown>)[]} builders
+ * @param {...unknown} args
  * @returns {Record<string, unknown>}
  */
 export const callProperties = (builders, ...args) =>
   fromEntries(builders.map(fn => entries(fn(...args))).flat());
 
 /**
- * Attenuate `specimen` to only allow acccess to properties specified in `template`
+ * Attenuate `specimen` to only allow acccess to properties specified in
+ * `template`
  *
- * @param {true | string | Record<string, *>} template true or vat name string or recursive object
+ * @param {true | string | Record<string, any>} template true or vat name string
+ *   or recursive object
  * @param {unknown} specimen
  * @param {string[]} [path]
  */
@@ -143,7 +147,8 @@ export const extract = (template, specimen, path = []) => {
 harden(extract);
 
 /**
- * @param {true | string | Record<string, *>} permit the permit supplied by the manifest
+ * @param {true | string | Record<string, any>} permit the permit supplied by
+ *   the manifest
  * @param {unknown} allPowers the powers to attenuate
  */
 export const extractPowers = (permit, allPowers) => {
@@ -164,7 +169,7 @@ harden(extractPowers);
  * @param {unknown} opts.allPowers
  * @param {Record<string, unknown>} opts.behaviors
  * @param {Record<string, Record<string, unknown>>} opts.manifest
- * @param { (name: string, permit: Record<string, unknown>) => unknown} opts.makeConfig
+ * @param {(name: string, permit: Record<string, unknown>) => unknown} opts.makeConfig
  */
 export const runModuleBehaviors = ({
   allPowers,
@@ -194,7 +199,6 @@ harden(runModuleBehaviors);
 const noop = harden(() => {});
 
 /**
- *
  * @param {ERef<import('../types').NameAdmin>} nameAdmin
  * @param {typeof console.log} [log]
  */
@@ -241,7 +245,7 @@ export const makeWellKnownSpaces = async (
     }),
   );
   const spaces = Object.fromEntries(spaceEntries);
-  const typedSpaces = /** @type { WellKnownSpaces } */ (
+  const typedSpaces = /** @type {WellKnownSpaces} */ (
     /** @type {any} */ (spaces)
   );
   return typedSpaces;
@@ -249,23 +253,20 @@ export const makeWellKnownSpaces = async (
 
 /**
  * Make the well-known agoricNames namespace so that we can
- * E(home.agoricNames).lookup('issuer', 'IST') and likewise
- * for brand, installation, instance, etc.
- *
- * @param {typeof console.log} [log]
- * @param {Record<string, Record<string, unknown>>} reserved a property
- *   for each of issuer, brand, etc. with a value whose keys are names
- *   to reserve.
- *
- * For static typing and integrating with the bootstrap permit system,
- * return { produce, consume } spaces rather than NameAdmins.
+ * E(home.agoricNames).lookup('issuer', 'IST') and likewise for brand,
+ * installation, instance, etc.
  *
  * @deprecated use vat-agoricNames, makeWellKnownSpaces
+ * @param {typeof console.log} [log]
+ * @param {Record<string, Record<string, unknown>>} reserved a property for each
+ *   of issuer, brand, etc. with a value whose keys are names to reserve.
  *
+ *   For static typing and integrating with the bootstrap permit system, return {
+ *   produce, consume } spaces rather than NameAdmins.
  * @returns {Promise<{
- *   agoricNames: import('../types.js').NameHub,
- *   agoricNamesAdmin: import('../types.js').NameAdmin,
- *   spaces: WellKnownSpaces,
+ *   agoricNames: import('../types.js').NameHub;
+ *   agoricNamesAdmin: import('../types.js').NameAdmin;
+ *   spaces: WellKnownSpaces;
  * }>}
  */
 export const makeAgoricNamesAccess = async (
@@ -280,7 +281,7 @@ export const makeAgoricNamesAccess = async (
     Object.keys(reserved),
   );
 
-  const typedSpaces = /** @type { WellKnownSpaces } */ (
+  const typedSpaces = /** @type {WellKnownSpaces} */ (
     /** @type {any} */ (spaces)
   );
   return {
@@ -291,9 +292,8 @@ export const makeAgoricNamesAccess = async (
 };
 
 /**
- * @param {string} address
- *
  * @deprecated use nameAdmin.provideChild() instead
+ * @param {string} address
  */
 export const makeMyAddressNameAdminKit = address => {
   // Create a name hub for this address.
@@ -317,7 +317,9 @@ export const makeMyAddressNameAdminKit = address => {
  * @param {(...args: any) => void} [log]
  * @param {string} [label]
  *
- * @typedef {import('@agoric/swingset-vat').CreateVatResults} CreateVatResults as from createVatByName
+ * @typedef {import('@agoric/swingset-vat').CreateVatResults} CreateVatResults
+ *   as from createVatByName
+ *
  * @typedef {MapStore<string, CreateVatResults>} VatStore
  */
 export const makeVatSpace = (

package/src/crc.d.ts

@@ -18,13 +18,9 @@ export class CRC {
     crcShift: number;
     shiftedXorIn: number;
     table: Int32Array;
-    /**
-     * @param {Data} data
-     */
+    /** @param {Data} data */
     calculate(data: Data): number;
-    /**
-     * @param {Data} data
-     */
+    /** @param {Data} data */
     calculateNoTable(data: Data): number;
     genTable(): Int32Array;
 }

package/src/crc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"crc.d.ts","sourceRoot":"","sources":["crc.js"],"names":[],"mappings":"AAuDA;IACE;;;;;;OAMG;IACH,mBANW,MAAM,QACN,MAAM,SACN,MAAM,UACN,MAAM,WACN,OAAO,EA8BjB;IA3BC,cAAkB;IAClB,aAAgB;IAChB,cAAkB;IAClB,uBAA0C;IAC1C,eAAoB;IACpB,iBAAsB;IACtB,gBAAoC;IACpC,aAAyC;IACzC,iBAAmD;IACnD,qBAA+C;IAG/C,kBAAkB;IAiBpB;;OAEG;IACH,gBAFW,IAAI,UAwBd;IAED;;OAEG;IACH,uBAFW,IAAI,UAmBd;IAED,uBAqBC;CACF;AAED,uBAAwD;AACxD,uBAAwD;AACxD,uBAAwD;AACxD,wBAA+D;AAC/D,wBAA+D;AAC/D,wBAAsE;AACtE,wBAA2E;AAC3E,yBAA4E;;;;;;;;;;;mBAjK/D,MAAM,GAAG,MAAM,GAAG,UAAU,GAAG,WAAW"}
+{"version":3,"file":"crc.d.ts","sourceRoot":"","sources":["crc.js"],"names":[],"mappings":"AAmDA;IACE;;;;;;OAMG;IACH,mBANW,MAAM,QACN,MAAM,SACN,MAAM,UACN,MAAM,WACN,OAAO,EA4BjB;IAzBC,cAAkB;IAClB,aAAgB;IAChB,cAAkB;IAClB,uBAA0C;IAC1C,eAAoB;IACpB,iBAAsB;IACtB,gBAAoC;IACpC,aAAyC;IACzC,iBAAmD;IACnD,qBAA+C;IAG/C,kBAAkB;IAepB,yBAAyB;IACzB,gBADY,IAAI,UAuBf;IAED,yBAAyB;IACzB,uBADY,IAAI,UAkBf;IAED,uBAqBC;CACF;AAED,uBAAwD;AACxD,uBAAwD;AACxD,uBAAwD;AACxD,wBAA+D;AAC/D,wBAA+D;AAC/D,wBAAsE;AACtE,wBAA2E;AAC3E,yBAA4E;;;;;;;;;;;mBAxJ9D,MAAM,GAAG,MAAM,GAAG,UAAU,GAAG,WAAW"}

package/src/crc.js

@@ -9,15 +9,11 @@
 // @ts-check
 /* eslint-disable no-bitwise */
 
-/**
- * @typedef {string | number | Uint8Array | ArrayBuffer} Data
- */
+/** @typedef {string | number | Uint8Array | ArrayBuffer} Data */
 
 const encoder = new TextEncoder();
 
-/**
- * @param {Data} data
- */
+/** @param {Data} data */
 function convert(data) {
   if (typeof data === 'number') {
     const bytes = [];
@@ -77,9 +73,7 @@ export class CRC {
     this.table = table;
 
     if (this.width === 8 && !this.xorIn && !this.xorOut && !this.reflect) {
-      /**
-       * @param {Data} data
-       */
+      /** @param {Data} data */
       this.calculate = function calculate(data) {
         const buffer = convert(data);
         let crc = 0;
@@ -91,9 +85,7 @@ export class CRC {
     }
   }
 
-  /**
-   * @param {Data} data
-   */
+  /** @param {Data} data */
   calculate(data) {
     const buffer = convert(data);
     let crc;
@@ -118,9 +110,7 @@ export class CRC {
     return crc >>> 0;
   }
 
-  /**
-   * @param {Data} data
-   */
+  /** @param {Data} data */
   calculateNoTable(data) {
     const buffer = convert(data);
     let crc = this.xorIn;

package/src/ibc.d.ts

@@ -1,9 +1,9 @@
-/**
- * @typedef {import('./types.js').BridgeHandler} BridgeHandler
- */
+/** @typedef {import('./types.js').BridgeHandler} BridgeHandler */
 /**
  * @typedef {string} IBCPortID
+ *
  * @typedef {string} IBCChannelID
+ *
  * @typedef {string} IBCConnectionID
  */
 /**
@@ -15,8 +15,8 @@
  * @property {IBCPortID} destination_port
  */
 /**
- * Create a handler for the IBC protocol, both from the network
- * and from the bridge.
+ * Create a handler for the IBC protocol, both from the network and from the
+ * bridge.
  *
  * @param {typeof import('@endo/far').E} E
  * @param {(method: string, params: any) => Promise<any>} rawCallIBCDevice

package/src/ibc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ibc.d.ts","sourceRoot":"","sources":["ibc.js"],"names":[],"mappings":"AAuBA;;GAEG;AAEH;;;;GAIG;AAEH;;;;;;;GAOG;AAEH;;;;;;;GAOG;AACH,0CAJW,cAAc,WAAW,EAAE,CAAC,6BACnB,MAAM,UAAU,GAAG,KAAK,QAAQ,GAAG,CAAC,GAC3C,eAAe,GAAG,aAAa,CAyhB3C;4BAjjBY,OAAO,YAAY,EAAE,aAAa;wBAIlC,MAAM;2BACN,MAAM;8BACN,MAAM;;;oBAML,YAAY;iBACZ,SAAS;yBACT,YAAY;sBACZ,SAAS"}
+{"version":3,"file":"ibc.d.ts","sourceRoot":"","sources":["ibc.js"],"names":[],"mappings":"AAuBA,kEAAkE;AAElE;;;;;;GAMG;AAEH;;;;;;;GAOG;AAEH;;;;;;;GAOG;AACH,0CAJW,cAAc,WAAW,EAAE,CAAC,6BACnB,MAAM,UAAU,GAAG,KAAK,QAAQ,GAAG,CAAC,GAC3C,eAAe,GAAG,aAAa,CAugB3C;4BAhiBa,OAAO,YAAY,EAAE,aAAa;wBAGnC,MAAM;2BAEN,MAAM;8BAEN,MAAM;;;oBAML,YAAY;iBACZ,SAAS;yBACT,YAAY;sBACZ,SAAS"}

package/src/ibc.js

@@ -21,13 +21,13 @@ const DEFAULT_ACKNOWLEDGEMENT = '\x00';
 // Default timeout after 10 minutes.
 const DEFAULT_PACKET_TIMEOUT_NS = 10n * 60n * 1_000_000_000n;
 
-/**
- * @typedef {import('./types.js').BridgeHandler} BridgeHandler
- */
+/** @typedef {import('./types.js').BridgeHandler} BridgeHandler */
 
 /**
  * @typedef {string} IBCPortID
+ *
  * @typedef {string} IBCChannelID
+ *
  * @typedef {string} IBCConnectionID
  */
 
@@ -41,8 +41,8 @@ const DEFAULT_PACKET_TIMEOUT_NS = 10n * 60n * 1_000_000_000n;
  */
 
 /**
- * Create a handler for the IBC protocol, both from the network
- * and from the bridge.
+ * Create a handler for the IBC protocol, both from the network and from the
+ * bridge.
  *
  * @param {typeof import('@endo/far').E} E
  * @param {(method: string, params: any) => Promise<any>} rawCallIBCDevice
@@ -56,9 +56,7 @@ export function makeIBCProtocolHandler(E, rawCallIBCDevice) {
     console.info('IBC downcall', method, params);
     return rawCallIBCDevice(method, params);
   };
-  /**
-   * @type {MapStore<string, Promise<Connection>>}
-   */
+  /** @type {MapStore<string, Promise<Connection>>} */
   const channelKeyToConnP = makeScalarMapStore('CHANNEL:PORT');
 
   /**
@@ -67,7 +65,7 @@ export function makeIBCProtocolHandler(E, rawCallIBCDevice) {
    * @property {string} channel_id
    *
    * @typedef {object} ConnectingInfo
-   * @property {'ORDERED'|'UNORDERED'} order
+   * @property {'ORDERED' | 'UNORDERED'} order
    * @property {string[]} connectionHops
    * @property {string} portID
    * @property {string} channelID
@@ -75,31 +73,25 @@ export function makeIBCProtocolHandler(E, rawCallIBCDevice) {
    * @property {string} version
    *
    * @typedef {PromiseRecord<AttemptDescription>} OnConnectP
+   *
    * @typedef {Omit<ConnectingInfo, 'counterparty' | 'channelID'> & {
-   *   localAddr: Endpoint, onConnectP: OnConnectP
-   *   counterparty: { port_id: string },
+   *   localAddr: Endpoint;
+   *   onConnectP: OnConnectP;
+   *   counterparty: { port_id: string };
    * }} Outbound
    */
 
-  /**
-   * @type {LegacyMap<string, Array<Outbound>>}
-   */
+  /** @type {LegacyMap<string, Outbound[]>} */
   // Legacy because it holds a mutable Javascript Array
   const srcPortToOutbounds = makeLegacyMap('SRC-PORT');
 
-  /**
-   * @type {MapStore<string, ConnectingInfo>}
-   */
+  /** @type {MapStore<string, ConnectingInfo>} */
   const channelKeyToInfo = makeScalarMapStore('CHANNEL:PORT');
 
-  /**
-   * @type {MapStore<string, Promise<InboundAttempt>>}
-   */
+  /** @type {MapStore<string, Promise<InboundAttempt>>} */
   const channelKeyToAttemptP = makeScalarMapStore('CHANNEL:PORT');
 
-  /**
-   * @type {LegacyMap<string, LegacyMap<number, PromiseRecord<Bytes>>>}
-   */
+  /** @type {LegacyMap<string, LegacyMap<number, PromiseRecord<Bytes>>>} */
   // Legacy because it holds a LegacyMap
   const channelKeyToSeqAck = makeLegacyMap('CHANNEL:PORT');
 
@@ -124,9 +116,7 @@ export function makeIBCProtocolHandler(E, rawCallIBCDevice) {
     // Extract the actual sequence number from the return.
     const { sequence } = fullPacket;
 
-    /**
-     * @type {PromiseRecord<Bytes>}
-     */
+    /** @type {PromiseRecord<Bytes>} */
     const ackDeferred = makePromiseKit();
 
     // Register the ack resolver/rejector with this sequence number.
@@ -139,7 +129,7 @@ export function makeIBCProtocolHandler(E, rawCallIBCDevice) {
    * @param {string} portID
    * @param {string} rChannelID
    * @param {string} rPortID
-   * @param {'ORDERED'|'UNORDERED'} order
+   * @param {'ORDERED' | 'UNORDERED'} order
    * @returns {ConnectionHandler}
    */
   function makeIBCConnectionHandler(
@@ -213,9 +203,7 @@ export function makeIBCProtocolHandler(E, rawCallIBCDevice) {
     });
   }
 
-  /**
-   * @param {string} localAddr
-   */
+  /** @param {string} localAddr */
   const localAddrToPortID = localAddr => {
     const m = localAddr.match(/^\/ibc-port\/([-a-zA-Z0-9._+#[\]<>]+)$/);
     if (!m) {
@@ -226,29 +214,23 @@ export function makeIBCProtocolHandler(E, rawCallIBCDevice) {
     return m[1];
   };
 
-  /**
-   * @type {ProtocolImpl}
-   */
+  /** @type {ProtocolImpl} */
   let protocolImpl;
 
   /**
    * @typedef {object} OutboundCircuitRecord
    * @property {IBCConnectionID} dst
-   * @property {'ORDERED'|'UNORDERED'} order
+   * @property {'ORDERED' | 'UNORDERED'} order
    * @property {string} version
    * @property {IBCPacket} packet
    * @property {PromiseRecord<ConnectionHandler>} deferredHandler
    */
 
-  /**
-   * @type {LegacyMap<Port, Set<PromiseRecord<ConnectionHandler>>>}
-   */
+  /** @type {LegacyMap<Port, Set<PromiseRecord<ConnectionHandler>>>} */
   // Legacy because it holds a raw JavaScript Set
   const portToPendingConns = makeLegacyMap('Port');
 
-  /**
-   * @type {ProtocolHandler}
-   */
+  /** @type {ProtocolHandler} */
   const protocol = Far('IBCProtocolHandler', {
     async onCreate(impl, _protocolHandler) {
       console.debug('IBC onCreate');

package/src/lib-board.d.ts

@@ -8,13 +8,13 @@ export function prepareBoardKit(baggage: MapStore<string, unknown>): (args_0?: n
         /**
          * Provide an ID for a value, generating one if not already present.
          *
-         * Each board ID includes a CRC so that the last part is well-distributed,
-         * which mitigates typo risks.
+         * Each board ID includes a CRC so that the last part is
+         * well-distributed, which mitigates typo risks.
          *
-         * Scaling Consideration: since we cannot know when consumers
-         * are no longer interested in an ID, a board holds a strong reference
-         * to `value` for its entire lifetime. For a well-known board, this
-         * is essentially forever.
+         * Scaling Consideration: since we cannot know when consumers are no
+         * longer interested in an ID, a board holds a strong reference to
+         * `value` for its entire lifetime. For a well-known board, this is
+         * essentially forever.
          *
          * @param {Key} value
          * @throws if `value` is not a Key in the @agoric/store sense
@@ -26,22 +26,22 @@ export function prepareBoardKit(baggage: MapStore<string, unknown>): (args_0?: n
          */
         getValue(id: BoardId): any;
         /**
-         * Convenience method for recursively traversing boards and
-         * board-like remotables to get data associated with a sequence of ids
-         * corresponding to each successive board.
-         * For example, `lookup("foo", "bar")` gets the value associated with
-         * id "foo" and returns the result of invoking `lookup("bar")` upon it
-         * to get the value it associates with id "bar".
+         * Convenience method for recursively traversing boards and board-like
+         * remotables to get data associated with a sequence of ids
+         * corresponding to each successive board. For example, `lookup("foo",
+         * "bar")` gets the value associated with id "foo" and returns the
+         * result of invoking `lookup("bar")` upon it to get the value it
+         * associates with id "bar".
          *
-         * @param  {...string} path
+         * @param {...string} path
          */
         lookup(...path: string[]): Promise<any>;
         /** @param {Key} val */
         has(val: Key): boolean;
         ids(): string[];
         /**
-         * Get a marshaller that implements the convertValToSlot hook using getId(),
-         * "publishing" previously un-mapped objects.
+         * Get a marshaller that implements the convertValToSlot hook using
+         * getId(), "publishing" previously un-mapped objects.
          */
         getPublishingMarshaller(): {
             toCapData(val: any): import("@endo/marshal").CapData<string>;
@@ -50,12 +50,12 @@ export function prepareBoardKit(baggage: MapStore<string, unknown>): (args_0?: n
             unserialize(data: any): any;
         };
         /**
-         * Get a marshaller that implements the convertValToSlot hook using getId(),
-         * only for objects that the board has().
+         * Get a marshaller that implements the convertValToSlot hook using
+         * getId(), only for objects that the board has().
          *
          * For other objects, we don't throw, but we emit a null slot.
-         * Un-serializing a null slot always produces a fresh object
-         * rather than preserving object identity.
+         * Un-serializing a null slot always produces a fresh object rather than
+         * preserving object identity.
          */
         getReadonlyMarshaller(): {
             toCapData(val: any): import("@endo/marshal").CapData<string | null>;
@@ -81,13 +81,13 @@ export function prepareBoardKit(baggage: MapStore<string, unknown>): (args_0?: n
         /**
          * Provide an ID for a value, generating one if not already present.
          *
-         * Each board ID includes a CRC so that the last part is well-distributed,
-         * which mitigates typo risks.
+         * Each board ID includes a CRC so that the last part is
+         * well-distributed, which mitigates typo risks.
          *
-         * Scaling Consideration: since we cannot know when consumers
-         * are no longer interested in an ID, a board holds a strong reference
-         * to `value` for its entire lifetime. For a well-known board, this
-         * is essentially forever.
+         * Scaling Consideration: since we cannot know when consumers are no
+         * longer interested in an ID, a board holds a strong reference to
+         * `value` for its entire lifetime. For a well-known board, this is
+         * essentially forever.
          *
          * @param {Key} value
          * @throws if `value` is not a Key in the @agoric/store sense
@@ -99,22 +99,22 @@ export function prepareBoardKit(baggage: MapStore<string, unknown>): (args_0?: n
          */
         getValue(id: BoardId): any;
         /**
-         * Convenience method for recursively traversing boards and
-         * board-like remotables to get data associated with a sequence of ids
-         * corresponding to each successive board.
-         * For example, `lookup("foo", "bar")` gets the value associated with
-         * id "foo" and returns the result of invoking `lookup("bar")` upon it
-         * to get the value it associates with id "bar".
+         * Convenience method for recursively traversing boards and board-like
+         * remotables to get data associated with a sequence of ids
+         * corresponding to each successive board. For example, `lookup("foo",
+         * "bar")` gets the value associated with id "foo" and returns the
+         * result of invoking `lookup("bar")` upon it to get the value it
+         * associates with id "bar".
          *
-         * @param  {...string} path
+         * @param {...string} path
          */
         lookup(...path: string[]): Promise<any>;
         /** @param {Key} val */
         has(val: Key): boolean;
         ids(): string[];
         /**
-         * Get a marshaller that implements the convertValToSlot hook using getId(),
-         * "publishing" previously un-mapped objects.
+         * Get a marshaller that implements the convertValToSlot hook using
+         * getId(), "publishing" previously un-mapped objects.
          */
         getPublishingMarshaller(): {
             toCapData(val: any): import("@endo/marshal").CapData<string>;
@@ -123,12 +123,12 @@ export function prepareBoardKit(baggage: MapStore<string, unknown>): (args_0?: n
             unserialize(data: any): any;
         };
         /**
-         * Get a marshaller that implements the convertValToSlot hook using getId(),
-         * only for objects that the board has().
+         * Get a marshaller that implements the convertValToSlot hook using
+         * getId(), only for objects that the board has().
          *
          * For other objects, we don't throw, but we emit a null slot.
-         * Un-serializing a null slot always produces a fresh object
-         * rather than preserving object identity.
+         * Un-serializing a null slot always produces a fresh object rather than
+         * preserving object identity.
          */
         getReadonlyMarshaller(): {
             toCapData(val: any): import("@endo/marshal").CapData<string | null>;
@@ -152,29 +152,27 @@ export function prepareBoardKit(baggage: MapStore<string, unknown>): (args_0?: n
 }>;
 export function prepareRecorderFactory(zone: import('@agoric/zone').Zone): (label: string, marshaller: Marshaller) => <T>(storageNode: StorageNode, valueShape?: import("@agoric/zoe/src/contractSupport/recorder.js").TypedMatcher<T> | undefined) => import("@agoric/zoe/src/contractSupport/recorder.js").RecorderKit<T>;
 /**
- * For a value with a known id in the board, we can use
- * that board id as a slot to preserve identity when marshaling.
+ * For a value with a known id in the board, we can use that board id as a slot
+ * to preserve identity when marshaling.
  *
  * The contents of the string depend on the `prefix` and `crcDigits` options:
- *    \`${prefix}${crc}${seq}\`
+ * `${prefix}${crc}${seq}`
  *
  * For example, 'board0371' for prefix: 'board0', seq: 1, 2 digits crc.
  */
 export type BoardId = string;
 /**
- * // TODO: use Key from
+ * // TODO: use
+ *   Key from
  */
 export type BoardState = ReturnType<typeof initDurableBoardState>;
 export type Key = import('@endo/marshal').Passable;
 /**
+ * @typedef {ReturnType<typeof initDurableBoardState>} BoardState // TODO: use
+ *   Key from @agoric/store when available
  * @see {prepareExoClassKit}
- * @see {@link ../../SwingSet/docs/virtual-objects.md|SwingSet Virtual Objects}
+ * @see {@link ../../SwingSet/docs/virtual-objects.md|SwingSet Virtual Objects} Hoisting this function makes defining the state type concise.
  *
- * Hoisting this function makes defining the state type concise.
- * @typedef {ReturnType<typeof initDurableBoardState>} BoardState
- *
- *
- * // TODO: use Key from @agoric/store when available
  * @typedef {import('@endo/marshal').Passable} Key
  */
 /**
@@ -183,7 +181,8 @@ export type Key = import('@endo/marshal').Passable;
  * @param {bigint | number} [initSequence]
  * @param {object} [options]
  * @param {string} [options.prefix] prefix for all ids generated
- * @param {number} [options.crcDigits] count of digits to use in CRC at end of the id
+ * @param {number} [options.crcDigits] count of digits to use in CRC at end of
+ *   the id
  */
 declare function initDurableBoardState(initSequence?: number | bigint | undefined, { prefix, crcDigits }?: {
     prefix?: string | undefined;

package/src/lib-board.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"lib-board.d.ts","sourceRoot":"","sources":["lib-board.js"],"names":[],"mappings":"AAmBA,mCAAoC;AACpC,sCAAuC;AAwOhC;;;;;QAQC;;;;;;;;;;;;;WAaG;qBAFQ,GAAG;QAMd;;;WAGG;qBAFQ,OAAO;QAMlB;;;;;;;;;WASG;wBADY,MAAM;QAgBrB,uBAAuB;iBAAX,GAAG;;QASf;;;WAGG;;;;;;;QAIH;;;;;;;WAOG;;;;;;;;;;;;;;;;;;;;;;QAvEH;;;;;;;;;;;;;WAaG;qBAFQ,GAAG;QAMd;;;WAGG;qBAFQ,OAAO;QAMlB;;;;;;;;;WASG;wBADY,MAAM;QAgBrB,uBAAuB;iBAAX,GAAG;;QASf;;;WAGG;;;;;;;QAIH;;;;;;;WAOG;;;;;;;;;;;;;;;;;;;;GAuCV;AAKM,6CAFI,OAAO,cAAc,EAAE,IAAI,WAUzB,MAAM,cACN,UAAU,2MAYtB;;;;;;;;;;sBAlVY,MAAM;;;;yBAuBN,WAAW,4BAA4B,CAAC;kBAIxC,OAAO,eAAe,EAAE,QAAQ;AAT7C;;;;;;;;;;GAUG;AAGH;;;;;;;GAOG;AACH;;;;;;;;;EA0BC"}
+{"version":3,"file":"lib-board.d.ts","sourceRoot":"","sources":["lib-board.js"],"names":[],"mappings":"AAkBA,mCAAoC;AACpC,sCAAuC;AAoOhC;;;;;QAQC;;;;;;;;;;;;;WAaG;qBAFQ,GAAG;QAMd;;;WAGG;qBAFQ,OAAO;QAMlB;;;;;;;;;WASG;wBADW,MAAM;QAgBpB,uBAAuB;iBAAX,GAAG;;QASf;;;WAGG;;;;;;;QAIH;;;;;;;WAOG;;;;;;;;;;;;;;;;;;;;;;QAvEH;;;;;;;;;;;;;WAaG;qBAFQ,GAAG;QAMd;;;WAGG;qBAFQ,OAAO;QAMlB;;;;;;;;;WASG;wBADW,MAAM;QAgBpB,uBAAuB;iBAAX,GAAG;;QASf;;;WAGG;;;;;;;QAIH;;;;;;;WAOG;;;;;;;;;;;;;;;;;;;;GAuCV;AAGM,6CADK,OAAO,cAAc,EAAE,IAAI,WAS1B,MAAM,cACN,UAAU,2MAYtB;;;;;;;;;;sBA5UY,MAAM;;;;;yBAmBN,WAAW,4BAA4B,CAAC;kBAKxC,OAAO,eAAe,EAAE,QAAQ;AAN7C;;;;;;;GAOG;AAGH;;;;;;;;GAQG;AACH;;;;;;;;;EA0BC"}