@agoric/internal 0.4.0 → 0.4.1-upgrade-23-dev-bd79330.0.bd79330

package/src/storage-test-utils.d.ts

@@ -1,4 +1,4 @@
-export function slotToRemotable(_slotId: string, iface?: string): import("@endo/pass-style").RemotableObject<string> & import("@endo/eventual-send").RemotableBrand<{}, {}>;
+export function slotToRemotable(_slotId: string, iface?: string): import("@endo/marshal").RemotableObject<string> & import("@endo/eventual-send").RemotableBrand<{}, {}>;
 /**
  * A basic marshaller whose unserializer produces Remotables. It can only
  * serialize plain data, not Remotables.
@@ -14,7 +14,16 @@ export namespace defaultSerializer {
     let stringify: (obj: any) => string;
 }
 export const slotStringUnserialize: (capData: any) => any;
-export function makeFakeStorageKit(rootPath: string, rootOptions?: Parameters<typeof makeChainStorageRoot>[2]): {
+export function makeAsyncQueue<T>(): {
+    enqueue: (data: T) => void;
+    iterable: {
+        [Symbol.asyncIterator](): AsyncGenerator<Awaited<T> | undefined, void, unknown>;
+    };
+    cancel: () => boolean;
+};
+export function makeFakeStorageKit(rootPath: string, rootOptions?: Parameters<typeof makeChainStorageRoot>[2], { eachMessage }?: {
+    eachMessage?: (m: StorageMessage) => void;
+}): {
     rootNode: import("@endo/exo").Guarded<{
         getPath(): string;
         getStoreKey(): Promise<VStorageKey>;
@@ -30,13 +39,13 @@ export function makeFakeStorageKit(rootPath: string, rootOptions?: Parameters<ty
     toStorage: ((message: StorageMessage) => string | number | true | any[] | {
         storeName: string;
         storeSubkey: string;
-    } | null) & import("@endo/pass-style").RemotableObject<`Alleged: ${string}`> & import("@endo/eventual-send").RemotableBrand<{}, (message: StorageMessage) => string | number | true | any[] | {
+    } | null) & import("@endo/marshal").RemotableObject<`Alleged: ${string}`> & import("@endo/eventual-send").RemotableBrand<{}, (message: StorageMessage) => string | number | true | any[] | {
         storeName: string;
         storeSubkey: string;
     } | null>;
 };
 export function makeMockChainStorageRoot(): MockChainStorageRoot;
-export function documentStorageSchema(t: import("ava").ExecutionContext<unknown>, storage: MockChainStorageRoot | FakeStorageKit, opts: ({
+export function documentStorageSchema(t: ExecutionContext<unknown>, storage: MockChainStorageRoot | FakeStorageKit, opts: ({
     note: string;
 } | {
     node: string;
@@ -60,7 +69,8 @@ export type MockChainStorageRootMethods = {
 };
 export type MockChainStorageRoot = StorageNode & MockChainStorageRootMethods;
 import { makeChainStorageRoot } from './lib-chainStorage.js';
-import type { StorageNode } from './lib-chainStorage.js';
 import type { StorageMessage } from './lib-chainStorage.js';
+import type { StorageNode } from './lib-chainStorage.js';
+import type { ExecutionContext } from 'ava';
 import type { Marshaller } from './lib-chainStorage.js';
 //# sourceMappingURL=storage-test-utils.d.ts.map

package/src/storage-test-utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"storage-test-utils.d.ts","sourceRoot":"","sources":["storage-test-utils.js"],"names":[],"mappings":"AAyBO,yCAHI,MAAM,UACN,MAAM,6GAGC;AAElB;;;GAGG;AACH;;;;;EAEG;;eAMU,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO;mBAEzB,CAAC,GAAG,EAAE,GAAG,KAAK,MAAM;;AA8CjC,8CAtBuB,GAAG,KAAK,GAAG,CAsB+B;AAU1D,6CAHI,MAAM,gBACN,UAAU,CAAC,OAAO,oBAAoB,CAAC,CAAC,CAAC,CAAC;;;;;oBAuFhB,CAAC;;;;UAwDjB,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC;;sBAd3B,MAAM,KACJ,MAAM,EAAE;;0BA9FP,cAAc;;;8IAAd,cAAc;;;;EAiH7B;AAoBM,4CADO,oBAAoB,CA6BjC;AAUM,yCAPI,OAAO,KAAK,EAAE,gBAAgB,CAAC,OAAO,CAAC,WACvC,oBAAoB,GAAG,cAAc,QACrC,CAAC;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC,GAC9D,CAAK;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,MAAM,CAAA;CAAE,GAAG,EAAE,CAAC,GAAG;IAChD,SAAS,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC;CACpC,iBAkDL;6BAxGa,UAAU,CAAC,OAAO,kBAAkB,CAAC;;;;;;;;aAIrC,CACT,IAAI,EAAE,MAAM,EACZ,UAAU,CAAC,EAAE,UAAU,EACvB,KAAK,CAAC,EAAE,MAAM,KACX,OAAO;UAKD,MAAM,MAAM,EAAE;;mCAEd,WAAW,GAAG,2BAA2B;qCAhQJ,uBAAuB;iCAOU,uBAAuB;oCAAvB,uBAAuB;gCAAvB,uBAAuB"}
+{"version":3,"file":"storage-test-utils.d.ts","sourceRoot":"","sources":["storage-test-utils.js"],"names":[],"mappings":"AA0BO,yCAHI,MAAM,UACN,MAAM,0GAGC;AAElB;;;GAGG;AACH;;;;;EAEG;;eAMU,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO;mBAEzB,CAAC,GAAG,EAAE,GAAG,KAAK,MAAM;;AA8CjC,8CAtBuB,GAAG,KAAK,GAAG,CAsB+B;AAa1D,+BAFM,CAAC;oBASA,CAAC;;;;;EA6Bd;AAWM,6CAJI,MAAM,gBACN,UAAU,CAAC,OAAO,oBAAoB,CAAC,CAAC,CAAC,CAAC,oBAC1C;IAAE,WAAW,CAAC,EAAE,CAAC,CAAC,EAAE,cAAc,KAAK,IAAI,CAAA;CAAE;;;;;oBAwD3B,CAAC;;;;UA4FT,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC;;sBAd3B,MAAM,KACJ,MAAM,EAAE;;0BA/FP,cAAc;;;2IAAd,cAAc;;;;EAkH7B;AAoBM,4CADO,oBAAoB,CA2BjC;AAUM,yCAPI,iBAAiB,OAAO,CAAC,WACzB,oBAAoB,GAAG,cAAc,QACrC,CAAC;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC,GAC9D,CAAK;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,MAAM,CAAA;CAAE,GAAG,EAAE,CAAC,GAAG;IAChD,SAAS,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC;CACpC,iBAkDL;6BAtGa,UAAU,CAAC,OAAO,kBAAkB,CAAC;;;;;;;;aAIrC,CACT,IAAI,EAAE,MAAM,EACZ,UAAU,CAAC,EAAE,UAAU,EACvB,KAAK,CAAC,EAAE,MAAM,KACX,OAAO;UAKD,MAAM,MAAM,EAAE;;mCAEd,WAAW,GAAG,2BAA2B;qCAxTJ,uBAAuB;oCAOU,uBAAuB;iCAAvB,uBAAuB;sCACxE,KAAK;gCAD4C,uBAAuB"}

package/src/storage-test-utils.js

@@ -5,13 +5,14 @@ import { makeMarshal, Remotable } from '@endo/marshal';
 import { makeTracer } from './debug.js';
 import { NonNullish } from './errors.js';
 import { isStreamCell, makeChainStorageRoot } from './lib-chainStorage.js';
-import { unmarshalFromVstorage } from './marshal.js';
+import { unmarshalFromVstorage } from './marshal/board-client-utils.js';
 import { bindAllMethods } from './method-tools.js';
 import { eventLoopIteration } from './testing-utils.js';
 
 /**
  * @import {TotalMap} from './types.js';
  * @import {Marshaller, StorageEntry, StorageMessage, StorageNode, StreamCell} from './lib-chainStorage.js';
+ * @import {ExecutionContext} from 'ava';
  */
 
 const trace = makeTracer('StorTU', false);
@@ -88,6 +89,55 @@ const makeSlotStringUnserialize = () => {
 };
 export const slotStringUnserialize = makeSlotStringUnserialize();
 
+/**
+ * @example to iterate over storage messages
+ *
+ * ```js
+ * const q = makeAsyncQueue<StorageMessage>();
+ * const storage = makeFakeStorageKit('published', undefined, { eachMessage: q.enqueue });
+ * for (const message of q.iterable) { ... }
+ * ```
+ *
+ * @template T
+ */
+export const makeAsyncQueue = () => {
+  /** @type {T[]} */
+  const queue = [];
+  /** @type {null | ((r: undefined) => void)} */
+  let resolve = null;
+  let done = false;
+
+  /** @param {T} data */
+  const enqueue = data => {
+    queue.push(data);
+    if (resolve) {
+      resolve(undefined);
+      resolve = null;
+    }
+  };
+
+  let alreadyIterating = false;
+  const iterable = {
+    async *[Symbol.asyncIterator]() {
+      assert(!alreadyIterating, `AsyncQueue is already iterating`);
+      alreadyIterating = true;
+      await null;
+      while (!done) {
+        if (queue.length === 0) {
+          await new Promise(r => (resolve = r));
+        }
+
+        while (queue.length > 0) {
+          yield queue.shift();
+        }
+      }
+    },
+  };
+
+  const cancel = () => (done = true);
+  return harden({ enqueue, iterable, cancel });
+};
+
 /**
  * For testing, creates a chainStorage root node over an in-memory map and
  * exposes both the map and the sequence of received messages. The `sequence`
@@ -95,8 +145,13 @@ export const slotStringUnserialize = makeSlotStringUnserialize();
  *
  * @param {string} rootPath
  * @param {Parameters<typeof makeChainStorageRoot>[2]} [rootOptions]
+ * @param {{ eachMessage?: (m: StorageMessage) => void }} [spyOpts]
  */
-export const makeFakeStorageKit = (rootPath, rootOptions) => {
+export const makeFakeStorageKit = (
+  rootPath,
+  rootOptions,
+  { eachMessage } = {},
+) => {
   const resolvedOptions = { sequence: true, ...rootOptions };
   /** @type {TotalMap<string, string>} */
   const data = new Map();
@@ -133,6 +188,7 @@ export const makeFakeStorageKit = (rootPath, rootOptions) => {
     /** @param {StorageMessage} message */
     message => {
       messages.push(message);
+      eachMessage?.(message);
       switch (message.method) {
         case 'getStoreKey': {
           const [key] = message.args;
@@ -183,7 +239,7 @@ export const makeFakeStorageKit = (rootPath, rootOptions) => {
               try {
                 streamCell = JSON.parse(oldVal);
                 assert(isStreamCell(streamCell));
-              } catch (_err) {
+              } catch {
                 streamCell = undefined;
               }
               // StreamCells reset at block boundaries.
@@ -236,7 +292,7 @@ export const makeFakeStorageKit = (rootPath, rootOptions) => {
 
   return {
     rootNode,
-    // eslint-disable-next-line object-shorthand
+
     data: /** @type {Map<string, string>} */ (data),
     updateNewCellBlockHeight,
     getValues,
@@ -281,9 +337,7 @@ export const makeMockChainStorageRoot = () => {
     getBody: (path, marshaller = defaultMarshaller, index = -1) => {
       data.size || Fail`no data in storage`;
       /**
-       * @type {ReturnType<
-       *   typeof import('@endo/marshal').makeMarshal
-       * >['fromCapData']}
+       * @type {ReturnType<typeof makeMarshal>['fromCapData']}
        */
       const fromCapData = (...args) =>
         Reflect.apply(marshaller.fromCapData, marshaller, args);
@@ -294,7 +348,7 @@ export const makeMockChainStorageRoot = () => {
 };
 
 /**
- * @param {import('ava').ExecutionContext<unknown>} t
+ * @param {ExecutionContext<unknown>} t
  * @param {MockChainStorageRoot | FakeStorageKit} storage
  * @param {({ note: string } | { node: string; owner: string }) &
  *   ({ pattern: string; replacement: string } | {}) & {

package/src/tagged.d.ts

@@ -3,7 +3,24 @@
 // different name to avoid confusion with pass-style "tagged"
 export { Tagged as TypeTag };
 
-declare const tag: unique symbol;
+/**
+ * CAVEAT: We use a constant string here to avoid exposing a `unique symbol`
+ * type publicly, such as with:
+ *
+ * @example
+ *   declare const mySymbol: unique symbol;
+ *
+ * Without this workaround, we've observed errors when using at least
+ * `typescript@5.9.3`'s `tsc` to generate declaration files (.d.ts) for
+ * consumers of modules that in turn import the declaration:
+ *
+ * @example
+ *   error TS9006: Declaration emit for this file requires using private name
+ *   'tag' from module '.../internal/src/tagged"'. An explicit
+ *   type annotation may unblock declaration emit.
+ */
+// declare const tag: unique symbol;
+declare const tag: 'Symbol(tag)';
 
 export type TagContainer<Token> = {
   readonly [tag]: Token;

package/src/testing-utils.d.ts

@@ -1,4 +1,8 @@
 export function eventLoopIteration(): Promise<any>;
 export function inspectMapStore(store: MapStore): object;
+export function testInterruptedSteps<Input = any, Context = unknown>(t: AvaT<Context>, allSteps: readonly TestStep<Input>[], doInterrupt?: (t: AvaT<Context>) => ERef<void>): Promise<void>;
+export type TestStep<Input = any> = readonly [stepName: string, fn: (input: Partial<Input>, label: string) => Partial<Input> | PromiseLike<Partial<Input>>];
 import type { MapStore } from '@agoric/store';
+import type { ExecutionContext as AvaT } from 'ava';
+import type { ERef } from '@endo/eventual-send';
 //# sourceMappingURL=testing-utils.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"testing-utils.d.ts","sourceRoot":"","sources":["testing-utils.js"],"names":[],"mappings":"AAeO,mDACwC;AAgBxC,uCAHI,QAAQ,GACN,MAAM,CAqBlB;8BA7C2B,eAAe"}
+{"version":3,"file":"testing-utils.d.ts","sourceRoot":"","sources":["testing-utils.js"],"names":[],"mappings":"AAmBO,mDACwC;AAgBxC,uCAHI,QAAQ,GACN,MAAM,CAsBlB;AAqBM,qCANO,KAAK,QACL,OAAO,eACV,KAAK,OAAO,CAAC,YACb,SAAS,QAAQ,CAAC,KAAK,CAAC,EAAE,gBAC1B,CAAC,CAAC,EAAE,KAAK,OAAO,CAAC,KAAK,KAAK,IAAI,CAAC,iBA8D1C;qBA7Ea,KAAK,UACN,SAAS,CACjB,QAAQ,EAAE,MAAM,EAChB,EAAE,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,KAAK,CAAC,GAAG,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAC3F;8BAzDuB,eAAe;8CACC,KAAK;0BACzB,qBAAqB"}

package/src/testing-utils.js

@@ -4,7 +4,11 @@
  *   https://github.com/Agoric/agoric-sdk/issues/7503
  */
 /* global setImmediate */
-/** @import {MapStore} from '@agoric/store'; */
+/**
+ * @import {MapStore} from '@agoric/store';
+ * @import {ExecutionContext as AvaT} from 'ava';
+ * @import {ERef} from '@endo/eventual-send';
+ */
 
 /**
  * A workaround for some issues with fake time in tests.
@@ -35,7 +39,8 @@ export const inspectMapStore = store => {
   const obj = {};
   for (const key of store.keys()) {
     const value = store.get(key);
-    const hasKeys = typeof value === 'object' && 'keys' in value;
+    const hasKeys =
+      typeof value === 'object' && value != null && 'keys' in value;
     const index = stringOrTag(key);
     if (hasKeys && 'get' in value) {
       obj[index] = inspectMapStore(value);
@@ -51,3 +56,84 @@ export const inspectMapStore = store => {
   return obj;
 };
 harden(inspectMapStore);
+
+/**
+ * @template [Input=any]
+ * @typedef {readonly [
+ *   stepName: string,
+ *   fn: (input: Partial<Input>, label: string) => Partial<Input> | PromiseLike<Partial<Input>>,
+ * ]} TestStep
+ */
+
+/**
+ * For each step, run to just before that point and pause for continuation after
+ * interrupt.
+ *
+ * @template [Input=any]
+ * @template [Context=unknown]
+ * @param {AvaT<Context>} t
+ * @param {readonly TestStep<Input>[]} allSteps
+ * @param {(t: AvaT<Context>) => ERef<void>} [doInterrupt]
+ */
+export const testInterruptedSteps = async (t, allSteps, doInterrupt) => {
+  /**
+   * @typedef {{
+   *   label: string;
+   *   accum: Partial<Input>;
+   * }} RunState
+   */
+
+  /**
+   * @param {string} label
+   * @param {readonly TestStep<Input>[]} steps
+   * @param {RunState} [runState]
+   * @returns {Promise<RunState>}
+   */
+  const runSteps = async (label, steps, runState = { label, accum: {} }) => {
+    await null;
+    let accum = runState.accum;
+    const runLabel = runState.label;
+    for (const [stepName, fn] of steps) {
+      await t.notThrowsAsync(async () => {
+        accum = await fn(accum, runLabel);
+      }, `${label} ${stepName} must complete successfully`);
+    }
+    return { label: runLabel, accum };
+  };
+
+  // Sanity check
+  await runSteps('pre-interrupt', allSteps);
+  if (!doInterrupt) {
+    return;
+  }
+
+  /**
+   * @type {{
+   *   runState: RunState;
+   *   remainingSteps: readonly TestStep<Input>[];
+   * }[]}
+   */
+  const pausedRuns = [];
+  for (let i = 0; i < allSteps.length; i += 1) {
+    const [beforeStepName] = allSteps[i];
+    const runState = await runSteps(
+      `pre-${beforeStepName}`,
+      allSteps.slice(0, i),
+      { label: `pause-before-${beforeStepName}`, accum: {} },
+    );
+    pausedRuns.push({ runState, remainingSteps: allSteps.slice(i) });
+  }
+
+  // Run the user code that interrupts the steps.
+  await doInterrupt(t);
+
+  // Verify a complete run post-interrupt.
+  await runSteps('post-interrupt', allSteps);
+
+  // Verify completion of each paused step.
+  for (const { runState, remainingSteps } of pausedRuns) {
+    const [beforeStepName] = remainingSteps[0];
+    await runSteps(`resumed-${beforeStepName}`, remainingSteps, runState);
+  }
+};
+harden(testInterruptedSteps);

package/src/typeGuards.d.ts

@@ -1,3 +1,6 @@
+/**
+ * @import {TypedPattern} from './types.js';
+ */
 export const StorageNodeShape: import("@endo/patterns").Matcher;
 /** To be used only for 'helper' facets where the calls are from trusted code. */
 export const UnguardedHelperI: import("@endo/patterns").InterfaceGuard<any>;
@@ -7,13 +10,14 @@ export const UnguardedHelperI: import("@endo/patterns").InterfaceGuard<any>;
  *   either a JS number or a stringified JS bigint.
  */
 /**
- * @type {import('./types.js').TypedPattern<BridgeBigInt>}
+ * @type {TypedPattern<BridgeBigInt>}
  */
-export const BridgeBigIntShape: import("./types.js").TypedPattern<BridgeBigInt>;
+export const BridgeBigIntShape: TypedPattern<BridgeBigInt>;
 /**
  * Ensure that callees passed a
  *   bridge message that was serialised from a Golang int64 or uint64 accept
  *   either a JS number or a stringified JS bigint.
  */
 export type BridgeBigInt = number | `${bigint}`;
+import type { TypedPattern } from './types.js';
 //# sourceMappingURL=typeGuards.d.ts.map

package/src/typeGuards.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"typeGuards.d.ts","sourceRoot":"","sources":["typeGuards.js"],"names":[],"mappings":"AAKA,gEAA2D;AAE3D,iFAAiF;AACjF,4EAKE;AAEF;;;;GAIG;AAEH;;GAEG;AACH,gCAFU,OAAO,YAAY,EAAE,YAAY,CAAC,YAAY,CAAC,CAEK;;;;;;2BARjD,MAAM,GAAG,GAAG,MAAM,EAAE"}
+{"version":3,"file":"typeGuards.d.ts","sourceRoot":"","sources":["typeGuards.js"],"names":[],"mappings":"AAIA;;GAEG;AAEH,gEAA2D;AAE3D,iFAAiF;AACjF,4EAKE;AAEF;;;;GAIG;AAEH;;GAEG;AACH,gCAFU,aAAa,YAAY,CAAC,CAE0B;;;;;;2BARjD,MAAM,GAAG,GAAG,MAAM,EAAE;kCAdF,YAAY"}

package/src/typeGuards.js

@@ -1,16 +1,19 @@
-// @jessie-check
 // @ts-check
 
 import { M } from '@endo/patterns';
 
+/**
+ * @import {TypedPattern} from './types.js';
+ */
+
 export const StorageNodeShape = M.remotable('StorageNode');
 
 /** To be used only for 'helper' facets where the calls are from trusted code. */
 export const UnguardedHelperI = M.interface(
   'helper',
   {},
-  // not exposed so sloppy okay
-  { sloppy: true },
+  // not exposed so using `defaultGuards` is fine.
+  { defaultGuards: 'passable' },
 );
 
 /**
@@ -20,6 +23,6 @@ export const UnguardedHelperI = M.interface(
  */
 
 /**
- * @type {import('./types.js').TypedPattern<BridgeBigInt>}
+ * @type {TypedPattern<BridgeBigInt>}
  */
 export const BridgeBigIntShape = M.or(M.number(), M.string());

package/src/types-index.d.ts

@@ -1 +1,2 @@
 export type * from './types.js';
+export type * from './build-cache-types.js';

package/src/types.d.ts

@@ -1,7 +1,20 @@
 import type { ERef, RemotableBrand } from '@endo/eventual-send';
-import type { Primitive } from '@endo/pass-style';
+import type { Primitive, RemotableObject } from '@endo/pass-style';
 import type { Pattern } from '@endo/patterns';
 import type { Callable } from './ses-utils.js';
+/**
+ * A mapping of a tuple type (as from `Parameters<...>`) into a corresponding
+ * object type with named fields.
+ *
+ * @example
+ * ```
+ * RecordFromTuple<[string, bigint], ['denom', 'amount']>
+ * //=> { denom: string, amount: bigint }
+ * ```
+ */
+export type RecordFromTuple<Types extends readonly unknown[], Names extends Record<Exclude<keyof Types, keyof unknown[]>, string>> = {
+    [K in Exclude<keyof Types, keyof any[]> as Names[K]]: Types[K];
+};
 /**
  * A map corresponding with a total function such that `get(key)` is assumed to
  * always succeed.
@@ -35,21 +48,22 @@ export declare class SyncCallback<I extends (...args: unknown[]) => any> extends
     isSync: true;
 }
 /**
-Returns a boolean for whether the given type is primitive value or primitive type.
- 
-@example
-```
-IsPrimitive<'string'>
-//=> true
- 
-IsPrimitive<string>
-//=> true
- 
-IsPrimitive<Object>
-//=> false
-```
+ * Returns a boolean for whether the given type is a primitive value or
+ * primitive type.
+ *
+ * @example
+ * ```
+ * IsPrimitive<'string'>
+ * //=> true
+ *
+ * IsPrimitive<string>
+ * //=> true
+ *
+ * IsPrimitive<Object>
+ * //=> false
  */
 export type IsPrimitive<T> = [T] extends [Primitive] ? true : false;
+export type IsRemotable<T> = T extends RemotableObject ? true : T extends RemotableBrand<any, any> ? true : false;
 /** Recursively extract the non-callable properties of T */
 export type DataOnly<T> = IsPrimitive<T> extends true ? T : T extends Callable ? never : {
     [P in keyof T as T[P] extends Callable ? never : P]: DataOnly<T[P]>;
@@ -61,10 +75,11 @@ export type DataOnly<T> = IsPrimitive<T> extends true ? T : T extends Callable ?
  */
 export type Remote<Primary, Local = DataOnly<Primary>> = Primary | RemotableBrand<Local, Primary>;
 /**
- * Potentially remote promises or settled references.
+ * A type that accepts either resolved or promised references that may be either
+ * near or marshalled. @see {ERef} and @see {Remote}.
  */
-export type FarRef<Primary, Local = DataOnly<Primary>> = ERef<Remote<Primary, Local>>;
-declare const validatedType: unique symbol;
+export type ERemote<Primary, Local = DataOnly<Primary>> = ERef<Remote<Primary, Local>>;
+declare const validatedType: 'Symbol(validatedType)';
 /**
  * Tag a pattern with the static type it represents.
  */
@@ -78,8 +93,8 @@ export declare type PatternType<TM extends TypedPattern<any>> = TM extends Typed
  *
  * Note: remotables can only be matched as "remotable", not the specific kind.
  *
- * @see {import('@endo/patterns').mustMatch} for the implementation. This one has a type annotation to narrow if the pattern is a TypedPattern.
+ * @see {endoMustMatch} for the implementation. This one has a type annotation to narrow if the pattern is a TypedPattern.
  */
 export declare type MustMatch = <P extends Pattern>(specimen: unknown, pattern: P, label?: string | number) => asserts specimen is P extends TypedPattern<any> ? PatternType<P> : unknown;
-export {};
+export type { TraceLogger } from './debug.js';
 //# sourceMappingURL=types.d.ts.map

package/src/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["types.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE/C;;;GAGG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,GAAG;IACpD,6EAA6E;IAC7E,GAAG,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC;CACpB,CAAC;AACF,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,IAC9C,CAAC,SAAS,GAAG,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,KAAK,CAAC;AAE3D;;;;;GAKG;AACH,MAAM,MAAM,MAAM,CAAC,CAAC,IAChB,IAAI,GACJ,MAAM,GACN,OAAO,CAAC;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,SAAS,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK;CAAE,CAAC,CAAC;AAEzE,MAAM,MAAM,UAAU,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,MAAM,GAC7D;KACG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,SAAS,MAAM,CAAC,GAC7B,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GACvB,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,GACtB,KAAK,GACP,KAAK;CACV,GACD,CAAC,CAAC;AAEN,MAAM,CAAC,OAAO,OAAO,QAAQ,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG;IAC7D,OAAO,CAAC,KAAK,CAAI;IAEV,MAAM,EAAE,GAAG,CAAC;IAEZ,UAAU,CAAC,EAAE,WAAW,CAAC;IAEzB,KAAK,EAAE,OAAO,EAAE,CAAC;IAEjB,MAAM,EAAE,OAAO,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,OAAO,YAAY,CAC/B,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,GAAG,CACrC,SAAQ,QAAQ,CAAC,CAAC,CAAC;IACnB,OAAO,CAAC,SAAS,CAAI;IAEd,MAAM,EAAE,IAAI,CAAC;CACrB;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,GAAG,IAAI,GAAG,KAAK,CAAC;AAEpE,2DAA2D;AAC3D,MAAM,MAAM,QAAQ,CAAC,CAAC,IACpB,WAAW,CAAC,CAAC,CAAC,SAAS,IAAI,GACvB,CAAC,GACD,CAAC,SAAS,QAAQ,GAChB,KAAK,GACL;KAAG,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,QAAQ,GAAG,KAAK,GAAG,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAAE,CAAC;AAEhF;;;;GAIG;AACH,MAAM,MAAM,MAAM,CAAC,OAAO,EAAE,KAAK,GAAG,QAAQ,CAAC,OAAO,CAAC,IACjD,OAAO,GACP,cAAc,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;AAGnC;;GAEG;AACH,MAAM,MAAM,MAAM,CAAC,OAAO,EAAE,KAAK,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,IAAI,CAC3D,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,CACvB,CAAC;AAQF,OAAO,CAAC,MAAM,aAAa,EAAE,OAAO,MAAM,CAAC;AAC3C;;GAEG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI,OAAO,GAAG;IAAE,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,CAAA;CAAE,CAAC;AAEhE,MAAM,CAAC,OAAO,MAAM,WAAW,CAAC,EAAE,SAAS,YAAY,CAAC,GAAG,CAAC,IAC1D,EAAE,SAAS,YAAY,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AAG/C;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,MAAM,SAAS,GAAG,CAAC,CAAC,SAAS,OAAO,EAChD,QAAQ,EAAE,OAAO,EACjB,OAAO,EAAE,CAAC,EACV,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,KACpB,OAAO,CAAC,QAAQ,IAAI,CAAC,SAAS,YAAY,CAAC,GAAG,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["types.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,KAAK,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAGnE,OAAO,KAAK,EAA8B,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAC1E,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE/C;;;;;;;;;GASG;AACH,MAAM,MAAM,eAAe,CACzB,KAAK,SAAS,SAAS,OAAO,EAAE,EAChC,KAAK,SAAS,MAAM,CAAC,OAAO,CAAC,MAAM,KAAK,EAAE,MAAM,OAAO,EAAE,CAAC,EAAE,MAAM,CAAC,IACjE;KAAG,CAAC,IAAI,OAAO,CAAC,MAAM,KAAK,EAAE,MAAM,GAAG,EAAE,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC;CAAE,CAAC;AAEvE;;;GAGG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,GAAG;IACpD,6EAA6E;IAC7E,GAAG,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC;CACpB,CAAC;AACF,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,IAC9C,CAAC,SAAS,GAAG,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,KAAK,CAAC;AAE3D;;;;;GAKG;AACH,MAAM,MAAM,MAAM,CAAC,CAAC,IAChB,IAAI,GACJ,MAAM,GACN,OAAO,CAAC;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,SAAS,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK;CAAE,CAAC,CAAC;AAEzE,MAAM,MAAM,UAAU,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,MAAM,GAC7D;KACG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,SAAS,MAAM,CAAC,GAC7B,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GACvB,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,GACtB,KAAK,GACP,KAAK;CACV,GACD,CAAC,CAAC;AAEN,MAAM,CAAC,OAAO,OAAO,QAAQ,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG;IAC7D,OAAO,CAAC,KAAK,CAAI;IAEV,MAAM,EAAE,GAAG,CAAC;IAEZ,UAAU,CAAC,EAAE,WAAW,CAAC;IAEzB,KAAK,EAAE,OAAO,EAAE,CAAC;IAEjB,MAAM,EAAE,OAAO,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,OAAO,YAAY,CAC/B,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,GAAG,CACrC,SAAQ,QAAQ,CAAC,CAAC,CAAC;IACnB,OAAO,CAAC,SAAS,CAAI;IAEd,MAAM,EAAE,IAAI,CAAC;CACrB;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,GAAG,IAAI,GAAG,KAAK,CAAC;AAGpE,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS,eAAe,GAClD,IAAI,GACJ,CAAC,SAAS,cAAc,CAAC,GAAG,EAAE,GAAG,CAAC,GAChC,IAAI,GACJ,KAAK,CAAC;AAEZ,2DAA2D;AAC3D,MAAM,MAAM,QAAQ,CAAC,CAAC,IACpB,WAAW,CAAC,CAAC,CAAC,SAAS,IAAI,GACvB,CAAC,GACD,CAAC,SAAS,QAAQ,GAChB,KAAK,GACL;KAAG,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,QAAQ,GAAG,KAAK,GAAG,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAAE,CAAC;AAEhF;;;;GAIG;AACH,MAAM,MAAM,MAAM,CAAC,OAAO,EAAE,KAAK,GAAG,QAAQ,CAAC,OAAO,CAAC,IACjD,OAAO,GACP,cAAc,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;AAGnC;;;GAGG;AACH,MAAM,MAAM,OAAO,CAAC,OAAO,EAAE,KAAK,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,IAAI,CAC5D,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,CACvB,CAAC;AAwBF,OAAO,CAAC,MAAM,aAAa,EAAE,uBAAuB,CAAC;AAErD;;GAEG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI,OAAO,GAAG;IAAE,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,CAAA;CAAE,CAAC;AAEhE,MAAM,CAAC,OAAO,MAAM,WAAW,CAAC,EAAE,SAAS,YAAY,CAAC,GAAG,CAAC,IAC1D,EAAE,SAAS,YAAY,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AAG/C;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,MAAM,SAAS,GAAG,CAAC,CAAC,SAAS,OAAO,EAChD,QAAQ,EAAE,OAAO,EACjB,OAAO,EAAE,CAAC,EACV,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,KACpB,OAAO,CAAC,QAAQ,IAAI,CAAC,SAAS,YAAY,CAAC,GAAG,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC;AAEhF,YAAY,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC"}