@agoric/internal 0.3.3-other-dev-fbe72e7.0.fbe72e7 → 0.3.3-other-dev-d15096d.0.d15096d

package/src/lib-chainStorage.js

@@ -8,11 +8,14 @@ import * as cb from './callback.js';
 
 /**
  * @import {ERef} from '@endo/far';
- * @import {PassableCap} from '@endo/marshal';
- * @import {TypedPattern} from './types.js';
+ * @import {Marshal, Passable} from '@endo/marshal';
+ * @import {Remote, ERemote, TypedPattern} from './types.js';
+ * @import {EMarshaller} from './marshal/wrap-marshaller.js';
+ * @import {Zone} from '@agoric/base-zone';
+ * @import {Callback} from './types.js';
  */
 
-/** @typedef {ReturnType<typeof import('@endo/marshal').makeMarshal>} Marshaller */
+/** @typedef {Marshal<unknown>} Marshaller */
 /** @typedef {Pick<Marshaller, 'fromCapData'>} Unserializer */
 
 /**
@@ -28,7 +31,8 @@ import * as cb from './callback.js';
 /**
  * @template [T=unknown]
  * @typedef StreamCell
- * @property {string} blockHeight decimal representation of a natural number
+ * @property {string} blockHeight corresponding with the write of `values`
+ *   (decimal representation of a natural number)
  * @property {T[]} values
  */
 
@@ -143,17 +147,15 @@ harden(assertPathSegment);
  */
 
 /**
- * @param {import('@agoric/base-zone').Zone} zone
+ * @param {Zone} zone
  */
 export const prepareChainStorageNode = zone => {
   /**
    * Create a storage node for a given backing storage interface and path.
    *
-   * @param {import('./types.js').Callback<
-   *   (message: StorageMessage) => any
-   * >} messenger
-   *   a callback for sending a storageMessage object to the storage
-   *   implementation (cf. golang/cosmos/x/vstorage/vstorage.go)
+   * @param {Callback<(message: StorageMessage) => any>} messenger a callback
+   *   for sending a storageMessage object to the storage implementation (cf.
+   *   golang/cosmos/x/vstorage/vstorage.go)
    * @param {string} path
    * @param {object} [options]
    * @param {boolean} [options.sequence] set values with `append` messages
@@ -166,9 +168,7 @@ export const prepareChainStorageNode = zone => {
     'ChainStorageNode',
     ChainStorageNodeI,
     /**
-     * @param {import('./types.js').Callback<
-     *   (message: StorageMessage) => any
-     * >} messenger
+     * @param {Callback<(message: StorageMessage) => any>} messenger
      * @param {string} path
      * @param {object} [options]
      * @param {boolean} [options.sequence]
@@ -281,9 +281,9 @@ const makeNullStorageNode = () => {
  * falling back to an inert object with the correct interface (but incomplete
  * behavior) when that is unavailable.
  *
- * @param {ERef<StorageNode?>} storageNodeRef
+ * @param {ERef<Remote<StorageNode> | null>} storageNodeRef
  * @param {string} childName
- * @returns {Promise<StorageNode>}
+ * @returns {Promise<Remote<StorageNode>>}
  */
 export async function makeStorageNodeChild(storageNodeRef, childName) {
   const existingStorageNode = await storageNodeRef;
@@ -294,9 +294,9 @@ harden(makeStorageNodeChild);
 
 // TODO find a better module for this
 /**
- * @param {ERef<StorageNode>} storageNode
- * @param {ERef<Marshaller>} marshaller
- * @returns {(value: PassableCap) => Promise<void>}
+ * @param {ERemote<StorageNode>} storageNode
+ * @param {ERemote<EMarshaller>} marshaller
+ * @returns {(value: Passable) => Promise<void>}
  */
 export const makeSerializeToStorage = (storageNode, marshaller) => {
   return async value => {

package/src/lib-nodejs/spawnSubprocessWorker.d.ts

@@ -10,6 +10,4 @@ export function startSubprocessWorker(execPath: any, procArgs?: any[], { netstri
     terminate: () => void;
     done: Promise<any>;
 };
-export type IOType = import("child_process").IOType;
-export type Writable = import("stream").Writable;
 //# sourceMappingURL=spawnSubprocessWorker.d.ts.map

package/src/lib-nodejs/spawnSubprocessWorker.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"spawnSubprocessWorker.d.ts","sourceRoot":"","sources":["spawnSubprocessWorker.js"],"names":[],"mappings":"AA8BA;;;;;;;;;;;EA0DC;qBApEa,OAAO,eAAe,EAAE,MAAM;uBAC9B,OAAO,QAAQ,EAAE,QAAQ"}
+{"version":3,"file":"spawnSubprocessWorker.d.ts","sourceRoot":"","sources":["spawnSubprocessWorker.js"],"names":[],"mappings":"AAgCA;;;;;;;;;;;EA0DC"}

package/src/lib-nodejs/spawnSubprocessWorker.js

@@ -8,6 +8,11 @@ import {
   netstringDecoderStream,
 } from '../netstring.js';
 
+/**
+ * @import {IOType} from 'child_process'
+ * @import {Writable} from 'stream'
+ */
+
 // Start a subprocess from a given executable, and arrange a bidirectional
 // message channel with a "supervisor" within that process. Return a {
 // toChild, fromChild } pair of Streams which accept/emit hardened Arrays of
@@ -18,9 +23,6 @@ function parentLog(first, ...args) {
   // console.error(`--parent: ${first}`, ...args);
 }
 
-/** @typedef {import('child_process').IOType} IOType */
-/** @typedef {import('stream').Writable} Writable */
-
 // we send on fd3, and receive on fd4. We pass fd1/2 (stdout/err) through, so
 // console log/err from the child shows up normally. We don't use Node's
 // built-in serialization feature ('ipc') because the child process won't

package/src/lib-nodejs/waitUntilQuiescent.d.ts

@@ -1,2 +1,5 @@
+/**
+ * @import {PromiseKit} from '@endo/promise-kit';
+ */
 export function waitUntilQuiescent(): Promise<void>;
 //# sourceMappingURL=waitUntilQuiescent.d.ts.map

package/src/lib-nodejs/waitUntilQuiescent.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"waitUntilQuiescent.d.ts","sourceRoot":"","sources":["waitUntilQuiescent.js"],"names":[],"mappings":"AAMA,oDAWC"}
+{"version":3,"file":"waitUntilQuiescent.d.ts","sourceRoot":"","sources":["waitUntilQuiescent.js"],"names":[],"mappings":"AAGA;;GAEG;AAKH,oDAWC"}

package/src/lib-nodejs/waitUntilQuiescent.js

@@ -1,6 +1,10 @@
 /* global setImmediate */
 import { makePromiseKit } from '@endo/promise-kit';
 
+/**
+ * @import {PromiseKit} from '@endo/promise-kit';
+ */
+
 // This can only be imported from the Start Compartment, where 'setImmediate'
 // is available.
 
@@ -11,7 +15,7 @@ export function waitUntilQuiescent() {
   // lower-priority than the Promise queue on browsers and Node 11, but on
   // Node 10 it is higher. So this trick requires Node 11.
   // https://jsblog.insiderattack.net/new-changes-to-timers-and-microtasks-from-node-v11-0-0-and-above-68d112743eb3
-  /** @type {import('@endo/promise-kit').PromiseKit<void>} */
+  /** @type {PromiseKit<void>} */
   const { promise: queueEmptyP, resolve } = makePromiseKit();
   setImmediate(() => resolve());
   return queueEmptyP;

package/src/marshal/board-client-utils.d.ts

@@ -0,0 +1,19 @@
+export function makeBoardRemote<BoardId = string | null>({ boardId, iface }: {
+    boardId: BoardId;
+    iface?: string;
+}): BoardRemote<BoardId>;
+export function slotToBoardRemote<BoardId = string>(boardId: BoardId, iface: string): BoardRemote<BoardId>;
+export function boardSlottingMarshaller<BoardId = string | null>(slotToVal?: (slot: BoardId, iface: string) => any): Omit<Marshal<BoardId>, "serialize" | "unserialize">;
+export function unmarshalFromVstorage(data: Map<string, string>, key: string, fromCapData: FromCapData<string>, index: number): any;
+export function makeHistoryReviver(entries: [string, string][], slotToVal?: (slot: string, iface?: string) => any): {
+    getItem: (key: string) => any;
+    children: (prefix: string) => string[];
+    has: (k: string) => boolean;
+};
+export type BoardRemote<BoardId = string | null> = {
+    getBoardId: () => BoardId;
+} & RemotableObject;
+import type { Marshal } from '@endo/marshal';
+import type { FromCapData } from '@endo/marshal';
+import type { RemotableObject } from '@endo/pass-style';
+//# sourceMappingURL=board-client-utils.d.ts.map

package/src/marshal/board-client-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"board-client-utils.d.ts","sourceRoot":"","sources":["board-client-utils.js"],"names":[],"mappings":"AAsBO,gCAJO,OAAO,sCACV;IAAE,OAAO,EAAE,OAAO,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,GAClC,WAAW,CAAC,OAAO,CAAC,CAKhC;AAOM,kCAJO,OAAO,oBACV,OAAO,SACP,MAAM,wBAGoB;AAsB9B,wCAJO,OAAO,8BACV,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,KAAK,GAAG,GACnC,IAAI,CAAC,QAAQ,OAAO,CAAC,EAAE,WAAW,GAAG,aAAa,CAAC,CAU/D;AAYM,4CAPI,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,OACnB,MAAM,eACN,YAAY,MAAM,CAAC,SACnB,MAAM,GAEJ,GAAG,CAwBf;AASM,4CAHI,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,cAClB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,KAAK,GAAG;mBAQlC,MAAM;uBAEN,MAAM;aAYN,MAAM;EAInB;wBArHa,OAAO,oBACR;IAAE,UAAU,EAAE,MAAM,OAAO,CAAA;CAAE,GAAG,eAAe;6BALM,eAAe;iCAAf,eAAe;qCAD/C,kBAAkB"}

package/src/{marshal.js → marshal/board-client-utils.js}

@@ -2,24 +2,23 @@
 import { Fail } from '@endo/errors';
 import { Far } from '@endo/far';
 import { makeMarshal } from '@endo/marshal';
-import { M } from '@endo/patterns';
-import { isStreamCell } from './lib-chainStorage.js';
+import { isStreamCell } from '../lib-chainStorage.js';
+import { assertCapData } from './cap-data.js';
 
 /**
- * @import {CapData} from '@endo/marshal';
- * @import {TypedPattern} from './types.js';
+ * @import {RemotableObject} from '@endo/pass-style';
+ * @import {CapData, FromCapData, ConvertValToSlot, Marshal} from '@endo/marshal';
  */
 
 /**
- * Should be a union with Remotable, but that's `any`, making this type
- * meaningless
- *
- * @typedef {{ getBoardId: () => string | null }} BoardRemote
+ * @template [BoardId=(string | null)]
+ * @typedef {{ getBoardId: () => BoardId } & RemotableObject} BoardRemote
  */
 
 /**
- * @param {{ boardId: string | null; iface?: string }} slotInfo
- * @returns {BoardRemote}
+ * @template [BoardId=(string | null)]
+ * @param {{ boardId: BoardId; iface?: string }} slotInfo
+ * @returns {BoardRemote<BoardId>}
  */
 export const makeBoardRemote = ({ boardId, iface }) => {
   const nonalleged = iface ? iface.replace(/^Alleged: /, '') : '';
@@ -27,13 +26,17 @@ export const makeBoardRemote = ({ boardId, iface }) => {
 };
 
 /**
- * @param {string} boardId
+ * @template [BoardId=string]
+ * @param {BoardId} boardId
  * @param {string} iface
  */
 export const slotToBoardRemote = (boardId, iface) =>
   makeBoardRemote({ boardId, iface });
 
-/** @param {BoardRemote | object} val */
+/**
+ * @param {BoardRemote<any> | object} val
+ * @returns {val extends BoardRemote<infer BoardId> ? BoardId : never}
+ */
 const boardValToSlot = val => {
   if ('getBoardId' in val) {
     return val.getBoardId();
@@ -46,47 +49,26 @@ const boardValToSlot = val => {
  * allows the caller to pick their slots. The deserializer is configurable: the
  * default cannot handle Remotable-bearing data.
  *
- * @param {(slot: string, iface: string) => any} [slotToVal]
- * @returns {Omit<
- *   import('@endo/marshal').Marshal<string | null>,
- *   'serialize' | 'unserialize'
- * >}
+ * @template [BoardId=(string | null)]
+ * @param {(slot: BoardId, iface: string) => any} [slotToVal]
+ * @returns {Omit<Marshal<BoardId>, 'serialize' | 'unserialize'>}
  */
 export const boardSlottingMarshaller = (slotToVal = undefined) => {
-  return makeMarshal(boardValToSlot, slotToVal, {
-    serializeBodyFormat: 'smallcaps',
-  });
-};
-
-// TODO move CapDataShape to Endo
-/**
- * @type {TypedPattern<CapData<any>>}
- */
-export const CapDataShape = { body: M.string(), slots: M.array() };
-harden(CapDataShape);
-
-/**
- * Assert that this is CapData
- *
- * @param {unknown} data
- * @returns {asserts data is CapData<unknown>}
- */
-export const assertCapData = data => {
-  assert.typeof(data, 'object');
-  assert(data);
-  typeof data.body === 'string' || Fail`data has non-string .body ${data.body}`;
-  Array.isArray(data.slots) || Fail`data has non-Array slots ${data.slots}`;
+  return makeMarshal(
+    /** @type {ConvertValToSlot<BoardId>} */ (boardValToSlot),
+    slotToVal,
+    {
+      serializeBodyFormat: 'smallcaps',
+    },
+  );
 };
-harden(assertCapData);
 
 /**
  * Read and unmarshal a value from a map representation of vstorage data
  *
  * @param {Map<string, string>} data
  * @param {string} key
- * @param {ReturnType<
- *   typeof import('@endo/marshal').makeMarshal
- * >['fromCapData']} fromCapData
+ * @param {FromCapData<string>} fromCapData
  * @param {number} index index of the desired value in a deserialized stream
  *   cell
  * @returns {any}
@@ -107,7 +89,7 @@ export const unmarshalFromVstorage = (data, key, fromCapData, index) => {
   const marshalled = values.at(index);
   assert.typeof(marshalled, 'string');
 
-  /** @type {import('@endo/marshal').CapData<string>} */
+  /** @type {CapData<string>} */
   const capData = harden(JSON.parse(marshalled));
   assertCapData(capData);
 
@@ -147,10 +129,3 @@ export const makeHistoryReviver = (entries, slotToVal = undefined) => {
 
   return harden({ getItem, children, has });
 };
-
-/** @param {import('@endo/marshal').CapData<unknown>} cap */
-const rejectOCap = cap => Fail`${cap} is not pure data`;
-export const pureDataMarshaller = makeMarshal(rejectOCap, rejectOCap, {
-  serializeBodyFormat: 'smallcaps',
-});
-harden(pureDataMarshaller);

package/src/marshal/cap-data.d.ts

@@ -0,0 +1,3 @@
+export function assertCapData(data: unknown): asserts data is CapData<unknown>;
+import type { CapData } from '@endo/marshal';
+//# sourceMappingURL=cap-data.d.ts.map

package/src/marshal/cap-data.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cap-data.d.ts","sourceRoot":"","sources":["cap-data.js"],"names":[],"mappings":"AAaO,oCAHI,OAAO,GACL,QAAQ,IAAI,IAAI,QAAQ,OAAO,CAAC,CAO5C;6BAdyB,eAAe"}

package/src/marshal/cap-data.js

@@ -0,0 +1,20 @@
+// @ts-check
+import { Fail } from '@endo/errors';
+
+/**
+ * @import {CapData} from '@endo/marshal';
+ */
+
+/**
+ * Assert that this is CapData
+ *
+ * @param {unknown} data
+ * @returns {asserts data is CapData<unknown>}
+ */
+export const assertCapData = data => {
+  assert.typeof(data, 'object');
+  assert(data);
+  typeof data.body === 'string' || Fail`data has non-string .body ${data.body}`;
+  Array.isArray(data.slots) || Fail`data has non-Array slots ${data.slots}`;
+};
+harden(assertCapData);

package/src/marshal/inaccessible-val.d.ts

@@ -0,0 +1,2 @@
+export function makeInaccessibleVal(iface: string | undefined): any;
+//# sourceMappingURL=inaccessible-val.d.ts.map

package/src/marshal/inaccessible-val.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"inaccessible-val.d.ts","sourceRoot":"","sources":["inaccessible-val.js"],"names":[],"mappings":"AASO,2CAHI,MAAM,GAAG,SAAS,GAChB,GAAG,CAOf"}

package/src/marshal/inaccessible-val.js

@@ -0,0 +1,15 @@
+// @ts-check
+import { Far } from '@endo/far';
+
+const ifaceAllegedPrefix = 'Alleged: ';
+const ifaceInaccessiblePrefix = 'SEVERED: ';
+/**
+ * @param {string | undefined} iface
+ * @returns {any}
+ */
+export const makeInaccessibleVal = iface => {
+  if (typeof iface === 'string' && iface.startsWith(ifaceAllegedPrefix)) {
+    iface = iface.slice(ifaceAllegedPrefix.length);
+  }
+  return Far(`${ifaceInaccessiblePrefix}${iface}`, {});
+};

package/src/marshal/pure-data.d.ts

@@ -0,0 +1,8 @@
+export const pureDataMarshaller: {
+    toCapData: import("@endo/marshal").ToCapData<CapData<unknown>>;
+    fromCapData: import("@endo/marshal").FromCapData<CapData<unknown>>;
+    serialize: import("@endo/marshal").ToCapData<CapData<unknown>>;
+    unserialize: import("@endo/marshal").FromCapData<CapData<unknown>>;
+};
+import type { CapData } from '@endo/marshal';
+//# sourceMappingURL=pure-data.d.ts.map

package/src/marshal/pure-data.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pure-data.d.ts","sourceRoot":"","sources":["pure-data.js"],"names":[],"mappings":"AAUA;;;;;EAEG;6BAPuB,eAAe"}

package/src/marshal/pure-data.js

@@ -0,0 +1,14 @@
+// @ts-check
+import { Fail } from '@endo/errors';
+import { makeMarshal } from '@endo/marshal';
+
+/**
+ * @import {CapData} from '@endo/marshal';
+ */
+
+/** @param {CapData<unknown>} cap */
+const rejectOCap = cap => Fail`${cap} is not pure data`;
+export const pureDataMarshaller = makeMarshal(rejectOCap, rejectOCap, {
+  serializeBodyFormat: 'smallcaps',
+});
+harden(pureDataMarshaller);

package/src/marshal/wrap-marshaller.d.ts

@@ -0,0 +1,33 @@
+export function wrapRemoteMarshallerSendSlotsOnly<Slot = unknown>(marshaller: ERemote<Pick<EMarshaller<Slot>, "fromCapData" | "toCapData">>, { serializeBodyFormat, errorTagging, ...otherMarshalOptions }?: MakeMarshalOptions, { valToSlot, slotToVal, cacheSeveredVal, }?: {
+    valToSlot?: WeakMapAPI<any, Slot> | null | undefined;
+    slotToVal?: WeakMapAPI<Slot, any> | null | undefined;
+    cacheSeveredVal?: boolean | undefined;
+}): ReturnType<typeof Far<EMarshaller<Slot>>>;
+export function wrapRemoteMarshallerDirectSend<Slot = unknown>(marshaller: ERemote<Pick<EMarshaller<Slot>, "fromCapData" | "toCapData">>): ReturnType<typeof Far<EMarshaller<Slot>>>;
+export function wrapRemoteMarshaller<Slot = unknown>(marshaller: ERemote<Pick<EMarshaller<Slot>, "fromCapData" | "toCapData">>, { serializeBodyFormat, errorTagging, ...otherMarshalOptions }?: MakeMarshalOptions, { valToSlot, slotToVal, cacheSeveredVal, }?: {
+    valToSlot?: WeakMapAPI<any, Slot> | null | undefined;
+    slotToVal?: WeakMapAPI<Slot, any> | null | undefined;
+    cacheSeveredVal?: boolean | undefined;
+}): ReturnType<typeof Far<EMarshaller<Slot>>>;
+/**
+ * A Marshaller which methods may be async. Use this type to indicate accepting
+ * either a sync or async marshaller, usually through `E` eventual-sends.
+ */
+export type EMarshaller<Slot = unknown> = Simplify<EOnly<Marshal<Slot>>>;
+export type SlotWrapper<Slot = unknown> = ReturnType<typeof slotToWrapper<Slot>>;
+import type { ERemote } from '../types.js';
+import type { MakeMarshalOptions } from '@endo/marshal';
+import type { WeakMapAPI } from '@endo/cache-map';
+import { Far } from '@endo/far';
+import type { Marshal } from '@endo/marshal';
+import type { EOnly } from '@endo/eventual-send';
+import type { Simplify } from '@endo/pass-style';
+declare function slotToWrapper<Slot = unknown>(slot: Slot, iface?: string): {
+    /** @type {Slot} */
+    "__#private@#slot": Slot;
+    /** @type {InterfaceSpec} */
+    [Symbol.toStringTag]: `Alleged: ${string}` | "Remotable";
+} & RemotableObject<`Alleged: ${string}` | "Remotable">;
+import type { RemotableObject } from '@endo/pass-style';
+export {};
+//# sourceMappingURL=wrap-marshaller.d.ts.map

package/src/marshal/wrap-marshaller.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"wrap-marshaller.d.ts","sourceRoot":"","sources":["wrap-marshaller.js"],"names":[],"mappings":"AA4HO,kDATO,IAAI,wBACP,QAAQ,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,aAAa,GAAG,WAAW,CAAC,CAAC,kEAC7D,kBAAkB,+CAE1B;IAAiD,SAAS;IACT,SAAS;IACjC,eAAe;CACxC,GAAU,UAAU,CAAC,OAAO,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CA4RrD;AAOM,+CAJO,IAAI,wBACP,QAAQ,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,aAAa,GAAG,WAAW,CAAC,CAAC,GAC3D,UAAU,CAAC,OAAO,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAyBrD;AAxTM,qCATO,IAAI,wBACP,QAAQ,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,aAAa,GAAG,WAAW,CAAC,CAAC,kEAC7D,kBAAkB,+CAE1B;IAAiD,SAAS;IACT,SAAS;IACjC,eAAe;CACxC,GAAU,UAAU,CAAC,OAAO,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CA4RrD;;;;;wBAjYa,IAAI,cACL,SAAS,MAAM,QAAQ,IAAI,CAAC,CAAC,CAAC;wBA+D7B,IAAI,cAAoB,UAAU,CAAC,OAAO,aAAa,CAAC,IAAI,CAAC,CAAC;6BAvElD,aAAa;wCAD0B,eAAe;gCAHnD,iBAAiB;oBAN1B,WAAW;6BASkC,eAAe;2BAFxD,qBAAqB;8BACD,kBAAkB;AA+D3C,+BAJD,IAAI,kBACP,IAAI,UACJ,MAAM,GAGJ;IA9Cb,mBAAmB;;IAGnB,4BAA4B;;IA2CK,mDAA8B,CAE5D;qCAlEqC,kBAAkB"}