@agoric/internal 0.3.3-dev-6c8bf5c.0 → 0.3.3-dev-35d20eb.0

package/src/utils.d.ts

@@ -1,27 +1,32 @@
 export const BASIS_POINTS: 10000n;
-/** @import { ERef } from '@endo/far' */
+/** @import {ERef} from '@endo/far' */
 /**
  * @template T
- * @typedef {{[KeyType in keyof T]: T[KeyType]} & {}} Simplify
- * flatten the type output to improve type hints shown in editors
- * https://github.com/sindresorhus/type-fest/blob/main/source/simplify.d.ts
+ * @typedef {{ [KeyType in keyof T]: T[KeyType] } & {}} Simplify flatten the
+ *   type output to improve type hints shown in editors
+ *   https://github.com/sindresorhus/type-fest/blob/main/source/simplify.d.ts
  */
 /**
  * @typedef {(...args: any[]) => any} Callable
  */
 /**
  * @template {{}} T
- * @typedef {{ [K in keyof T]: T[K] extends Callable ? T[K] : DeeplyAwaited<T[K]> }} DeeplyAwaitedObject
+ * @typedef {{
+ *   [K in keyof T]: T[K] extends Callable ? T[K] : DeeplyAwaited<T[K]>;
+ * }} DeeplyAwaitedObject
  */
 /**
  * @template T
- * @typedef {T extends PromiseLike<any> ? Awaited<T> : T extends {} ? Simplify<DeeplyAwaitedObject<T>> : Awaited<T>} DeeplyAwaited
+ * @typedef {T extends PromiseLike<any>
+ *     ? Awaited<T>
+ *     : T extends {}
+ *       ? Simplify<DeeplyAwaitedObject<T>>
+ *       : Awaited<T>} DeeplyAwaited
  */
 /**
  * A more constrained version of {deeplyFulfilled} for type safety until
- * https://github.com/endojs/endo/issues/1257
- * Useful in starting contracts that need all terms to be fulfilled
- * in order to be durable.
+ * https://github.com/endojs/endo/issues/1257 Useful in starting contracts that
+ * need all terms to be fulfilled in order to be durable.
  *
  * @type {<T extends {}>(unfulfilledTerms: T) => Promise<DeeplyAwaited<T>>}
  */
@@ -34,7 +39,7 @@ export function PromiseAllOrErrors<T>(items: readonly (T | PromiseLike<T>)[]): P
 /**
  * @type {<T>(
  *   trier: () => Promise<T>,
- *  finalizer: (error?: unknown) => Promise<void>,
+ *   finalizer: (error?: unknown) => Promise<void>,
  * ) => Promise<T>}
  */
 export const aggregateTryFinally: <T>(trier: () => Promise<T>, finalizer: (error?: unknown) => Promise<void>) => Promise<T>;
@@ -42,14 +47,19 @@ export function assertAllDefined<T extends Record<string, unknown>>(obj: T): ass
 export const forever: AsyncIterable<undefined>;
 export function whileTrue<T>(produce: () => T): AsyncIterable<Awaited<T>>;
 export function untilTrue<T>(produce: () => T): AsyncIterable<Awaited<T>>;
-/** @type { <X, Y>(xs: X[], ys: Y[]) => [X, Y][]} */
+/** @type {<X, Y>(xs: X[], ys: Y[]) => [X, Y][]} */
 export const zip: <X, Y>(xs: X[], ys: Y[]) => [X, Y][];
-/** @type { <T extends Record<string, ERef<any>>>(obj: T) => Promise<{ [K in keyof T]: Awaited<T[K]>}> } */
+/**
+ * @type {<T extends Record<string, ERef<any>>>(
+ *   obj: T,
+ * ) => Promise<{ [K in keyof T]: Awaited<T[K]> }>}
+ */
 export const allValues: <T extends Record<string, any>>(obj: T) => Promise<{ [K in keyof T]: Awaited<T[K]>; }>;
 export function synchronizedTee<T = unknown>(sourceStream: AsyncIterator<T, void, void>, readerCount: number): AsyncGenerator<T, void, void>[];
 /**
- * flatten the type output to improve type hints shown in editors
- * https://github.com/sindresorhus/type-fest/blob/main/source/simplify.d.ts
+ * flatten the
+ *   type output to improve type hints shown in editors
+ *   https://github.com/sindresorhus/type-fest/blob/main/source/simplify.d.ts
  */
 export type Simplify<T> = { [KeyType in keyof T]: T[KeyType]; } & {};
 export type Callable = (...args: any[]) => any;

package/src/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["utils.js"],"names":[],"mappings":"AAYA,kCAAoC;AAEpC,wCAAwC;AAExC;;;;;GAKG;AAEH;;GAEG;AAEH;;;GAGG;AAEH;;;GAGG;AAEH;;;;;;;GAOG;AACH,oCAFU,CAAC,CAAC,SAAS,EAAE,EAAE,gBAAgB,EAA8B,CAAC,AAA5B,KAAK,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAKxE;AAUK,wDAHI,cAAc,YAAY,EAAE,WAAW,CAAC,GAAG,GACzC,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC;IAAE,MAAM,EAAE,CAAC,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC,CAWjF;AAOM,mCAFc,CAAC,SADX,SAAS,CACC,CAAC,AADA,GAAG,WAAW,CACf,CAAC,AADgB,CAAC,CAAC,EAAE,GAC7B,OAAO,CAAC,CAAC,EAAE,CAAC,CAiBxB;AAED;;;;;GAKG;AACH,kCALU,CAAC,CAAC,EACX,KAAS,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,EAC3B,SAAY,EAAE,CAAC,KAAK,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,KACzC,OAAO,CAAC,CAAC,CAAC,CAYd;AAgBG,iCAFgC,CAAC,uCAAD,CAAC,AAF5B,GAEC,OAAO,CAAC,GAAG,IAAI,UAAU,CAAC,CAAC,CAAC,CAYxC;AAQD,+CAAoD;AAU7C,0BAF4B,CAAC,WAJzB,MAIwB,CAAC,AAJlB,GAIL,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAYlC;AAUG,0BAF4B,CAAC,WAJzB,MAIwB,CAAC,AAJlB,GAIL,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAelC;AAEJ,oDAAoD;AACpD,kBADY,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EAAoB,CAAC,AAAlB,EAAE,EAAE,EAAE,EAAc,CAAC,AAAZ,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CACqB;AAErE,2GAA2G;AAC3G,yBAD+F,CAAC,mCAAD,CAAC,AAAxC,KAAK,OAAO,CAAC,GAAG,CAAC,IAAI,MAAkB,CAAC,AAAZ,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAC,CAAC,CAKpG;AAWK,gCAHkB,CAAC,0BAAf,aAAa,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,eAC5B,MAAM,mCA4FhB;;;;;qBArRmC,CAAC,IAAxB,GAAE,OAAO,IAAI,MAAU,CAAC,AAAJ,GAAG,CAAC,CAAC,OAAO,CAAC,GAAC,GAAG,EAAE;uBAMvC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG;gCAKwC,CAAC,eAAhE,GAAG,CAAC,IAAI,MAAuD,CAAC,AAAjD,GAAgD,CAAC,AAA7C,CAA8C,CAAC,AAA7C,CAAC,SAAS,QAAQ,GAAwB,CAAC,AAArB,CAAsB,CAAC,AAArB,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAE;0BAK8B,CAAC,IAAD,CAAC,AAApG,SAAS,WAAW,CAAC,GAAG,CAAC,GAAG,OAAO,CAAgE,CAAC,AAA/D,CAAC,GAA6D,CAAC,AAA1D,SAAS,EAAE,GAAG,QAAQ,CAAC,mBAAmB,CAAe,CAAC,AAAd,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;uBA6E7E,CAAC,oCAA1B,GAAE,CAAC,IAAI,MAAkB,CAAC,AAAZ,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,GAAE"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["utils.js"],"names":[],"mappings":"AAYA,kCAAoC;AAEpC,sCAAsC;AAEtC;;;;;GAKG;AAEH;;GAEG;AAEH;;;;;GAKG;AAEH;;;;;;;GAOG;AAEH;;;;;;GAMG;AACH,oCAFU,CAAC,CAAC,SAAS,EAAE,EAAE,gBAAgB,EAA8B,CAAC,AAA5B,KAAK,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAKxE;AAYK,wDALI,cAAc,YAAY,EAAE,WAAW,CAAC,GAAG,GACzC,CAAC,CAAC,EACd,EAAM,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,KACjB,OAAO,CAAC;IAAE,MAAM,EAAE,CAAC,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC,CAW/C;AAOM,mCAFc,CAAC,SADX,SAAS,CACC,CAAC,AADA,GAAG,WAAW,CACf,CAAC,AADgB,CAAC,CAAC,EAAE,GAC7B,OAAO,CAAC,CAAC,EAAE,CAAC,CAiBxB;AAED;;;;;GAKG;AACH,kCALU,CAAC,CAAC,EACX,KAAS,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,EAC3B,SAAa,EAAE,CAAC,KAAK,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,KAC1C,OAAO,CAAC,CAAC,CAAC,CAYd;AAgBG,iCAHgC,CAAC,uCAAD,CAAC,AAD5B,GACC,OAAO,CAAC,GAAG,IAAI,UAAU,CAAC,CAAC,CAAC,CAaxC;AAQD,+CAAoD;AAS7C,0BAF4B,CAAC,WAHzB,MAGwB,CAAC,AAHlB,GAGL,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAYlC;AASG,0BAF4B,CAAC,WAHzB,MAGwB,CAAC,AAHlB,GAGL,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAelC;AAEJ,mDAAmD;AACnD,kBADW,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EAAoB,CAAC,AAAlB,EAAE,EAAE,EAAE,EAAc,CAAC,AAAZ,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CACsB;AAErE;;;;GAIG;AACH,yBAF0C,CAAC,mCAAD,CAAC,AADhC,KACH,OAAO,CAAC,GAAG,CAAC,IAAI,MAAkB,CAAC,AAAZ,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAE,CAAC,CAMhD;AAWK,gCAHkB,CAAC,0BAAf,aAAa,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,eAC5B,MAAM,mCAwGhB;;;;;;qBA1SoC,CAAC,IAAzB,GAAG,OAAO,IAAI,MAAU,CAAC,AAAJ,GAAG,CAAC,CAAC,OAAO,CAAC,GAAE,GAAG,EAAE;uBAMzC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG;gCAM8B,CAAC,eADtD,GACP,CAAC,IAAI,MAAuD,CAAC,AAAjD,GAAgD,CAAC,AAA7C,CAA8C,CAAC,AAA7C,CAAC,SAAS,QAAQ,GAAwB,CAAC,AAArB,CAAsB,CAAC,AAArB,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GACnE;0BASe,CAAC,IAAD,CAAC,AAJN,SAAS,WAAW,CAAC,GAAG,CAAC,GAC9B,OAAO,CAGG,CAAC,AAHF,CAAC,GAGA,CAAC,AAFV,SAAS,EAAE,GACV,QAAQ,CAAC,mBAAmB,CACpB,CAAC,AADqB,CAAC,CAAC,GAChC,OAAO,CAAC,CAAC,CAAC;uBA8EkB,CAAC,oCAA3B,GAAG,CAAC,IAAI,MAAkB,CAAC,AAAZ,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,GAAE"}

package/src/utils.js

@@ -12,13 +12,13 @@ const { quote: q, Fail } = assert;
 
 export const BASIS_POINTS = 10_000n;
 
-/** @import { ERef } from '@endo/far' */
+/** @import {ERef} from '@endo/far' */
 
 /**
  * @template T
- * @typedef {{[KeyType in keyof T]: T[KeyType]} & {}} Simplify
- * flatten the type output to improve type hints shown in editors
- * https://github.com/sindresorhus/type-fest/blob/main/source/simplify.d.ts
+ * @typedef {{ [KeyType in keyof T]: T[KeyType] } & {}} Simplify flatten the
+ *   type output to improve type hints shown in editors
+ *   https://github.com/sindresorhus/type-fest/blob/main/source/simplify.d.ts
  */
 
 /**
@@ -27,19 +27,24 @@ export const BASIS_POINTS = 10_000n;
 
 /**
  * @template {{}} T
- * @typedef {{ [K in keyof T]: T[K] extends Callable ? T[K] : DeeplyAwaited<T[K]> }} DeeplyAwaitedObject
+ * @typedef {{
+ *   [K in keyof T]: T[K] extends Callable ? T[K] : DeeplyAwaited<T[K]>;
+ * }} DeeplyAwaitedObject
  */
 
 /**
  * @template T
- * @typedef {T extends PromiseLike<any> ? Awaited<T> : T extends {} ? Simplify<DeeplyAwaitedObject<T>> : Awaited<T>} DeeplyAwaited
+ * @typedef {T extends PromiseLike<any>
+ *     ? Awaited<T>
+ *     : T extends {}
+ *       ? Simplify<DeeplyAwaitedObject<T>>
+ *       : Awaited<T>} DeeplyAwaited
  */
 
 /**
  * A more constrained version of {deeplyFulfilled} for type safety until
- * https://github.com/endojs/endo/issues/1257
- * Useful in starting contracts that need all terms to be fulfilled
- * in order to be durable.
+ * https://github.com/endojs/endo/issues/1257 Useful in starting contracts that
+ * need all terms to be fulfilled in order to be durable.
  *
  * @type {<T extends {}>(unfulfilledTerms: T) => Promise<DeeplyAwaited<T>>}
  */
@@ -54,7 +59,9 @@ export const deeplyFulfilledObject = async obj => {
  * and report the result in seconds to match our telemetry standard.
  *
  * @param {typeof import('perf_hooks').performance.now} currentTimeMillisec
- * @returns {<T>(fn: () => Promise<T>) => Promise<{ result: T, duration: number }>}
+ * @returns {<T>(
+ *   fn: () => Promise<T>,
+ * ) => Promise<{ result: T; duration: number }>}
  */
 export const makeMeasureSeconds = currentTimeMillisec => {
   /** @param {() => any} fn */
@@ -92,7 +99,7 @@ export const PromiseAllOrErrors = async items => {
 /**
  * @type {<T>(
  *   trier: () => Promise<T>,
- *  finalizer: (error?: unknown) => Promise<void>,
+ *   finalizer: (error?: unknown) => Promise<void>,
  * ) => Promise<T>}
  */
 export const aggregateTryFinally = async (trier, finalizer) =>
@@ -109,7 +116,7 @@ export const aggregateTryFinally = async (trier, finalizer) =>
 
 /**
  * @template {Record<string, unknown>} T
- * @typedef {{[P in keyof T]: Exclude<T[P], undefined>;}} AllDefined
+ * @typedef {{ [P in keyof T]: Exclude<T[P], undefined> }} AllDefined
  */
 
 /**
@@ -118,8 +125,8 @@ export const aggregateTryFinally = async (trier, finalizer) =>
  *
  * @template {Record<string, unknown>} T
  * @param {T} obj
- * @throws if any value in the object entries is not defined
  * @returns {asserts obj is AllDefined<T>}
+ * @throws if any value in the object entries is not defined
  */
 export const assertAllDefined = obj => {
   const missing = [];
@@ -143,10 +150,9 @@ export const forever = asyncGenerate(() => notDone);
 
 /**
  * @template T
- * @param {() => T} produce
- * The value of `await produce()` is used for its truthiness vs falsiness.
- * IOW, it is coerced to a boolean so the caller need not bother doing this
- * themselves.
+ * @param {() => T} produce The value of `await produce()` is used for its
+ *   truthiness vs falsiness. IOW, it is coerced to a boolean so the caller need
+ *   not bother doing this themselves.
  * @returns {AsyncIterable<Awaited<T>>}
  */
 export const whileTrue = produce =>
@@ -163,10 +169,9 @@ export const whileTrue = produce =>
 
 /**
  * @template T
- * @param {() => T} produce
- * The value of `await produce()` is used for its truthiness vs falsiness.
- * IOW, it is coerced to a boolean so the caller need not bother doing this
- * themselves.
+ * @param {() => T} produce The value of `await produce()` is used for its
+ *   truthiness vs falsiness. IOW, it is coerced to a boolean so the caller need
+ *   not bother doing this themselves.
  * @returns {AsyncIterable<Awaited<T>>}
  */
 export const untilTrue = produce =>
@@ -184,10 +189,14 @@ export const untilTrue = produce =>
     });
   });
 
-/** @type { <X, Y>(xs: X[], ys: Y[]) => [X, Y][]} */
+/** @type {<X, Y>(xs: X[], ys: Y[]) => [X, Y][]} */
 export const zip = (xs, ys) => harden(xs.map((x, i) => [x, ys[+i]]));
 
-/** @type { <T extends Record<string, ERef<any>>>(obj: T) => Promise<{ [K in keyof T]: Awaited<T[K]>}> } */
+/**
+ * @type {<T extends Record<string, ERef<any>>>(
+ *   obj: T,
+ * ) => Promise<{ [K in keyof T]: Awaited<T[K]> }>}
+ */
 export const allValues = async obj => {
   const resolved = await Promise.all(values(obj));
   // @ts-expect-error cast
@@ -195,9 +204,9 @@ export const allValues = async obj => {
 };
 
 /**
- * A tee implementation where all readers are synchronized with each other.
- * They all consume the source stream in lockstep, and any one returning or
- * throwing early will affect the others.
+ * A tee implementation where all readers are synchronized with each other. They
+ * all consume the source stream in lockstep, and any one returning or throwing
+ * early will affect the others.
  *
  * @template [T=unknown]
  * @param {AsyncIterator<T, void, void>} sourceStream
@@ -207,7 +216,11 @@ export const synchronizedTee = (sourceStream, readerCount) => {
   /** @type {IteratorReturnResult<void> | undefined} */
   let doneResult;
 
-  /** @typedef {IteratorResult<(value: PromiseLike<IteratorResult<T>>) => void>} QueuePayload */
+  /**
+   * @typedef {IteratorResult<
+   *   (value: PromiseLike<IteratorResult<T>>) => void
+   * >} QueuePayload
+   */
   /** @type {import('@endo/stream').AsyncQueue<QueuePayload>[]} */
   const queues = [];
 
@@ -267,13 +280,21 @@ export const synchronizedTee = (sourceStream, readerCount) => {
     /** @type {AsyncGenerator<T, void, void>} */
     const reader = harden({
       async next() {
-        /** @type {import('@endo/promise-kit').PromiseKit<IteratorResult<T>>} */
+        /**
+         * @type {import('@endo/promise-kit').PromiseKit<
+         *   IteratorResult<T>
+         * >}
+         */
         const { promise, resolve } = makePromiseKit();
         queue.put({ value: resolve, done: false });
         return promise;
       },
       async return() {
-        /** @type {import('@endo/promise-kit').PromiseKit<IteratorResult<T>>} */
+        /**
+         * @type {import('@endo/promise-kit').PromiseKit<
+         *   IteratorResult<T>
+         * >}
+         */
         const { promise, resolve } = makePromiseKit();
         queue.put({ value: resolve, done: true });
         return promise;