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

package/src/tmpDir.js

@@ -0,0 +1,17 @@
+/**
+ * Create a `tmpDir` function that synchronously creates a temporary directory
+ * and a function for deleting it along with any added contents.
+ *
+ * @param {Pick<import('tmp'), 'dirSync'>} tmp
+ */
+export const makeTempDirFactory = tmp => {
+  /** @type {(prefix?: string) => [dirName: string, cleanup: () => void]} */
+  const tmpDir = prefix => {
+    const { name, removeCallback } = tmp.dirSync({
+      prefix,
+      unsafeCleanup: true,
+    });
+    return [name, removeCallback];
+  };
+  return tmpDir;
+};

package/src/tokens.d.ts

@@ -0,0 +1,34 @@
+export namespace Stable {
+    export let symbol: "IST";
+    export let denom: "uist";
+    export let proposedName: "Agoric stable token";
+    export { NAT as assetKind };
+    export namespace displayInfo {
+        export let decimalPlaces: 6;
+        export { NAT as assetKind };
+    }
+}
+export namespace Stake {
+    let symbol_1: "BLD";
+    export { symbol_1 as symbol };
+    let denom_1: "ubld";
+    export { denom_1 as denom };
+    let proposedName_1: "Agoric staking token";
+    export { proposedName_1 as proposedName };
+    export { NAT as assetKind };
+    export namespace displayInfo_1 {
+        let decimalPlaces_1: 6;
+        export { decimalPlaces_1 as decimalPlaces };
+        export { NAT as assetKind };
+    }
+    export { displayInfo_1 as displayInfo };
+}
+export type TokenKeyword = "IST" | "BLD";
+/** @typedef {'IST' | 'BLD'} TokenKeyword */
+/**
+ * This is defined by ERTP. For dependency pragmatism it's repeated here. We
+ * rely on the static type check and unit tests to detect any incompatibility.
+ */
+declare const NAT: "nat";
+export {};
+//# sourceMappingURL=tokens.d.ts.map

package/src/tokens.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tokens.d.ts","sourceRoot":"","sources":["tokens.js"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;2BAEc,KAAK,GAAG,KAAK;AAA3B,4CAA4C;AAE5C;;;GAGG;AACH,mBAAY,KAAK,CAAC"}

package/src/tokens.js

@@ -0,0 +1,35 @@
+// @ts-check
+
+/** @typedef {'IST' | 'BLD'} TokenKeyword */
+
+/**
+ * This is defined by ERTP. For dependency pragmatism it's repeated here. We
+ * rely on the static type check and unit tests to detect any incompatibility.
+ */
+const NAT = 'nat';
+
+export const Stable = harden(
+  /** @type {const} */ ({
+    symbol: 'IST',
+    denom: 'uist',
+    proposedName: 'Agoric stable token',
+    assetKind: NAT,
+    displayInfo: {
+      decimalPlaces: 6,
+      assetKind: NAT,
+    },
+  }),
+);
+
+export const Stake = harden(
+  /** @type {const} */ ({
+    symbol: 'BLD',
+    denom: 'ubld',
+    proposedName: 'Agoric staking token',
+    assetKind: NAT,
+    displayInfo: {
+      decimalPlaces: 6,
+      assetKind: NAT,
+    },
+  }),
+);

package/src/typeCheck.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @import {MustMatch, PatternType, TypedPattern} from './types.js';
+ */
+/** @type {MustMatch} */
+export const mustMatch: MustMatch;
+export function cast<M>(specimen: unknown, patt: TypedPattern<M>): M;
+import type { MustMatch } from './types.js';
+import type { TypedPattern } from './types.js';
+//# sourceMappingURL=typeCheck.d.ts.map

package/src/typeCheck.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"typeCheck.d.ts","sourceRoot":"","sources":["typeCheck.js"],"names":[],"mappings":"AAGA;;GAEG;AAEH,wBAAwB;AACxB,wBADW,SAAS,CACuB;AAQpC,qBALM,CAAC,YACH,OAAO,QACP,aAAa,CAAC,CAAC,GACb,CAAC,CAQb;+BAlBsD,YAAY;kCAAZ,YAAY"}

package/src/typeCheck.js

@@ -0,0 +1,23 @@
+// @ts-check
+import { mustMatch as typelessMustMatch } from '@endo/patterns';
+
+/**
+ * @import {MustMatch, PatternType, TypedPattern} from './types.js';
+ */
+
+/** @type {MustMatch} */
+export const mustMatch = typelessMustMatch;
+
+/**
+ * @template M
+ * @param {unknown} specimen
+ * @param {TypedPattern<M>} patt
+ * @returns {M}
+ */
+export const cast = (specimen, patt) => {
+  // mustMatch throws if they don't, which means that `cast` also narrows the
+  // type but a function can't both narrow and return a type. That is by design:
+  // https://github.com/microsoft/TypeScript/issues/34636#issuecomment-545025916
+  mustMatch(specimen, patt);
+  return specimen;
+};

package/src/typeGuards.d.ts

@@ -1,2 +1,19 @@
 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>;
+/**
+ * @typedef {number | `${bigint}`} 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.
+ */
+/**
+ * @type {import('./types.js').TypedPattern<BridgeBigInt>}
+ */
+export const BridgeBigIntShape: import("./types.js").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}`;
 //# 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":"AAIA,gEAA2D"}
+{"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"}

package/src/typeGuards.js

@@ -1,5 +1,25 @@
 // @jessie-check
+// @ts-check
 
 import { M } from '@endo/patterns';
 
 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 },
+);
+
+/**
+ * @typedef {number | `${bigint}`} 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.
+ */
+
+/**
+ * @type {import('./types.js').TypedPattern<BridgeBigInt>}
+ */
+export const BridgeBigIntShape = M.or(M.number(), M.string());

package/src/types-index.d.ts

@@ -0,0 +1 @@
+export type * from './types.js';

package/src/types-index.js

@@ -0,0 +1,2 @@
+// Empty JS file to correspond with its .d.ts twin
+export {};

package/src/types.d.ts

@@ -1,20 +1,85 @@
-/* eslint-disable max-classes-per-file */
-export declare class Callback<I extends (...args: unknown[]) => any> {
-  private iface: I;
-
-  public target: any;
-
-  public methodName?: PropertyKey;
-
-  public bound: unknown[];
-
-  public isSync: boolean;
+import type { ERef, RemotableBrand } from '@endo/eventual-send';
+import type { Primitive } from '@endo/pass-style';
+import type { Pattern } from '@endo/patterns';
+import type { Callable } from './ses-utils.js';
+/**
+ * A map corresponding with a total function such that `get(key)` is assumed to
+ * always succeed.
+ */
+export type TotalMap<K, V> = Omit<Map<K, V>, 'get'> & {
+    /** Returns the element associated with the specified key in the TotalMap. */
+    get: (key: K) => V;
+};
+export type TotalMapFrom<M extends Map<any, any>> = M extends Map<infer K, infer V> ? TotalMap<K, V> : never;
+/**
+ * A permit is either `true` or a string (both meaning no attenuation, with a
+ * string serving as a grouping label for convenience and/or diagram
+ * generation), or an object whose keys identify child properties and whose
+ * corresponding values are theirselves (recursive) Permits.
+ */
+export type Permit<T> = true | string | Partial<{
+    [K in keyof T]: K extends string ? Permit<T[K]> : never;
+}>;
+export type Attenuated<T, P extends Permit<T>> = P extends object ? {
+    [K in keyof P]: K extends keyof T ? P[K] extends Permit<T[K]> ? Attenuated<T[K], P[K]> : never : never;
+} : T;
+export declare class Callback<I extends (...args: any[]) => any> {
+    private iface;
+    target: any;
+    methodName?: PropertyKey;
+    bound: unknown[];
+    isSync: boolean;
 }
-
-export declare class SyncCallback<
-  I extends (...args: unknown[]) => any,
-> extends Callback<I> {
-  private syncIface: I;
-
-  public isSync: true;
+export declare class SyncCallback<I extends (...args: unknown[]) => any> extends Callback<I> {
+    private syncIface;
+    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
+```
+ */
+export type IsPrimitive<T> = [T] extends [Primitive] ? 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]>;
+};
+/**
+ * A type that doesn't assume its parameter is local, but is satisfied with both
+ * local and remote references. It accepts both near and marshalled references
+ * that were returned from `Remotable` or `Far`.
+ */
+export type Remote<Primary, Local = DataOnly<Primary>> = Primary | RemotableBrand<Local, Primary>;
+/**
+ * Potentially remote promises or settled references.
+ */
+export type FarRef<Primary, Local = DataOnly<Primary>> = ERef<Remote<Primary, Local>>;
+declare const validatedType: unique symbol;
+/**
+ * Tag a pattern with the static type it represents.
+ */
+export type TypedPattern<T> = Pattern & {
+    [validatedType]?: T;
+};
+export declare type PatternType<TM extends TypedPattern<any>> = TM extends TypedPattern<infer T> ? T : never;
+/**
+ * Returning normally indicates success. Match failure is indicated by
+ * throwing.
+ *
+ * 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.
+ */
+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 {};
+//# sourceMappingURL=types.d.ts.map

package/src/types.d.ts.map

@@ -0,0 +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"}

package/src/types.ts

@@ -0,0 +1,129 @@
+/* eslint-disable max-classes-per-file */
+import type { ERef, RemotableBrand } from '@endo/eventual-send';
+import type { Primitive } from '@endo/pass-style';
+import type { Pattern } from '@endo/patterns';
+import type { Callable } from './ses-utils.js';
+
+/**
+ * A map corresponding with a total function such that `get(key)` is assumed to
+ * always succeed.
+ */
+export type TotalMap<K, V> = Omit<Map<K, V>, 'get'> & {
+  /** Returns the element associated with the specified key in the TotalMap. */
+  get: (key: K) => V;
+};
+export type TotalMapFrom<M extends Map<any, any>> =
+  M extends Map<infer K, infer V> ? TotalMap<K, V> : never;
+
+/**
+ * A permit is either `true` or a string (both meaning no attenuation, with a
+ * string serving as a grouping label for convenience and/or diagram
+ * generation), or an object whose keys identify child properties and whose
+ * corresponding values are theirselves (recursive) Permits.
+ */
+export type Permit<T> =
+  | true
+  | string
+  | Partial<{ [K in keyof T]: K extends string ? Permit<T[K]> : never }>;
+
+export type Attenuated<T, P extends Permit<T>> = P extends object
+  ? {
+      [K in keyof P]: K extends keyof T
+        ? P[K] extends Permit<T[K]>
+          ? Attenuated<T[K], P[K]>
+          : never
+        : never;
+    }
+  : T;
+
+export declare class Callback<I extends (...args: any[]) => any> {
+  private iface: I;
+
+  public target: any;
+
+  public methodName?: PropertyKey;
+
+  public bound: unknown[];
+
+  public isSync: boolean;
+}
+
+export declare class SyncCallback<
+  I extends (...args: unknown[]) => any,
+> extends Callback<I> {
+  private syncIface: I;
+
+  public 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
+```
+ */
+export type IsPrimitive<T> = [T] extends [Primitive] ? 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]> };
+
+/**
+ * A type that doesn't assume its parameter is local, but is satisfied with both
+ * local and remote references. It accepts both near and marshalled references
+ * that were returned from `Remotable` or `Far`.
+ */
+export type Remote<Primary, Local = DataOnly<Primary>> =
+  | Primary
+  | RemotableBrand<Local, Primary>;
+
+// TODO: Add type tests for FarRef and Remote.
+/**
+ * Potentially remote promises or settled references.
+ */
+export type FarRef<Primary, Local = DataOnly<Primary>> = ERef<
+  Remote<Primary, Local>
+>;
+
+/*
+ * Stop-gap until https://github.com/Agoric/agoric-sdk/issues/6160
+ * explictly specify the type that the Pattern will verify through a match.
+ *
+ * TODO move all this pattern typing stuff to @endo/patterns
+ */
+declare const validatedType: unique symbol;
+/**
+ * Tag a pattern with the static type it represents.
+ */
+export type TypedPattern<T> = Pattern & { [validatedType]?: T };
+
+export declare type PatternType<TM extends TypedPattern<any>> =
+  TM extends TypedPattern<infer T> ? T : never;
+
+// TODO make Endo's mustMatch do this
+/**
+ * Returning normally indicates success. Match failure is indicated by
+ * throwing.
+ *
+ * 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.
+ */
+export declare type MustMatch = <P extends Pattern>(
+  specimen: unknown,
+  pattern: P,
+  label?: string | number,
+) => asserts specimen is P extends TypedPattern<any> ? PatternType<P> : unknown;

package/src/upgrade-api.d.ts

@@ -1,7 +1,17 @@
-export function makeUpgradeDisconnection(upgradeMessage: string, toIncarnationNumber: number): DisconnectionObject;
-export function isUpgradeDisconnection(err: any): err is DisconnectionObject;
-export type DisconnectionObject = {
-    name: string;
+export namespace UpgradeDisconnectionShape {
+    let name: string;
+    let upgradeMessage: import("@endo/patterns").Matcher;
+    let incarnationNumber: import("@endo/patterns").Matcher;
+}
+export function makeUpgradeDisconnection(upgradeMessage: string, toIncarnationNumber: number): UpgradeDisconnection;
+export function isUpgradeDisconnection(reason: any): reason is UpgradeDisconnection;
+export function isAbandonedError(reason: any): reason is Error;
+/**
+ * An Error-like object for use as the rejection reason of promises abandoned by
+ * upgrade.
+ */
+export type UpgradeDisconnection = {
+    name: "vatUpgraded";
     upgradeMessage: string;
     incarnationNumber: number;
 };

package/src/upgrade-api.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"upgrade-api.d.ts","sourceRoot":"","sources":["upgrade-api.js"],"names":[],"mappings":"AAgBO,yDAJI,MAAM,uBACN,MAAM,GACJ,mBAAmB,CAO5B;AAcG,4CAHI,GAAG,8BAO6B;kCAlC9B;IAAE,MAAM,MAAM,CAAC;IAAC,cAAc,EAAE,MAAM,CAAC;IAAC,iBAAiB,EAAE,MAAM,CAAA;CAAE"}
+{"version":3,"file":"upgrade-api.d.ts","sourceRoot":"","sources":["upgrade-api.js"],"names":[],"mappings":";;;;;AAgCO,yDAJI,MAAM,uBACN,MAAM,GACJ,oBAAoB,CAO7B;AASG,+CALI,GAAG,GAGD,MAAM,IAAI,oBAAoB,CAKC;AAgBrC,yCAHI,GAAG,GACD,MAAM,IAAI,KAAK,CAQS;;;;;mCA5DxB;IACR,IAAI,EAAE,aAAa,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;IACvB,iBAAiB,EAAE,MAAM,CAAC;CAC3B"}

package/src/upgrade-api.js

@@ -1,18 +1,34 @@
 // @ts-check
 // @jessie-check
-import { isObject } from '@endo/marshal';
+
+import { M, matches } from '@endo/patterns';
+
+const { isFrozen } = Object;
 
 /**
- * @typedef {{ name: string, upgradeMessage: string, incarnationNumber: number }} DisconnectionObject
+ * An Error-like object for use as the rejection reason of promises abandoned by
+ * upgrade.
+ *
+ * @typedef {{
+ *   name: 'vatUpgraded';
+ *   upgradeMessage: string;
+ *   incarnationNumber: number;
+ * }} UpgradeDisconnection
  */
 
+export const UpgradeDisconnectionShape = harden({
+  name: 'vatUpgraded',
+  upgradeMessage: M.string(),
+  incarnationNumber: M.number(),
+});
+
 /**
- * Makes an Error-like object for use as the rejection value of promises
+ * Makes an Error-like object for use as the rejection reason of promises
  * abandoned by upgrade.
  *
  * @param {string} upgradeMessage
  * @param {number} toIncarnationNumber
- * @returns {DisconnectionObject}
+ * @returns {UpgradeDisconnection}
  */
 export const makeUpgradeDisconnection = (upgradeMessage, toIncarnationNumber) =>
   harden({
@@ -22,20 +38,36 @@ export const makeUpgradeDisconnection = (upgradeMessage, toIncarnationNumber) =>
   });
 harden(makeUpgradeDisconnection);
 
-// TODO: Simplify once we have @endo/patterns (or just export the shape).
-// const upgradeDisconnectionShape = harden({
-//   name: 'vatUpgraded',
-//   upgradeMessage: M.string(),
-//   incarnationNumber: M.number(),
-// });
-// const isUpgradeDisconnection = err => matches(err, upgradeDisconnectionShape);
 /**
- * @param {any} err
- * @returns {err is DisconnectionObject}
+ * @param {any} reason If `reason` is not frozen, it cannot be an
+ *   UpgradeDisconnection, so returns false without even checking against the
+ *   shape.
+ * @returns {reason is UpgradeDisconnection}
  */
-export const isUpgradeDisconnection = err =>
-  isObject(err) &&
-  err.name === 'vatUpgraded' &&
-  typeof err.upgradeMessage === 'string' &&
-  typeof err.incarnationNumber === 'number';
+export const isUpgradeDisconnection = reason =>
+  reason != null && // eslint-disable-line eqeqeq
+  isFrozen(reason) &&
+  matches(reason, UpgradeDisconnectionShape);
 harden(isUpgradeDisconnection);
+
+/**
+ * Returns whether a reason is a 'vat terminated' error generated when an object
+ * is abandoned by a vat during an upgrade.
+ *
+ * Normally we do not want to rely on the `message` of an error object, but this
+ * is a pragmatic solution to the current state of vat upgrade errors. In the
+ * future we'd prefer having an error with a cause referencing a disconnection
+ * object like for promise rejections. See
+ * https://github.com/Agoric/agoric-sdk/issues/9582
+ *
+ * @param {any} reason
+ * @returns {reason is Error}
+ */
+export const isAbandonedError = reason =>
+  reason != null && // eslint-disable-line eqeqeq
+  isFrozen(reason) &&
+  matches(reason, M.error()) &&
+  // We're not using a constant here since this special value is already
+  // sprinkled throughout the SDK
+  reason.message === 'vat terminated';
+harden(isAbandonedError);

package/CHANGELOG.md

@@ -1,106 +0,0 @@
-# Change Log
-
-All notable changes to this project will be documented in this file.
-See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
-
-### [0.3.3-u11.0](https://github.com/Agoric/agoric-sdk/compare/@agoric/internal@0.3.2...@agoric/internal@0.3.3-u11.0) (2023-08-24)
-
-**Note:** Version bump only for package @agoric/internal
-
-
-
-
-
-### [0.3.2](https://github.com/Agoric/agoric-sdk/compare/@agoric/internal@0.3.1...@agoric/internal@0.3.2) (2023-06-02)
-
-**Note:** Version bump only for package @agoric/internal
-
-
-
-
-
-### [0.3.1](https://github.com/Agoric/agoric-sdk/compare/@agoric/internal@0.3.0...@agoric/internal@0.3.1) (2023-05-24)
-
-**Note:** Version bump only for package @agoric/internal
-
-
-
-
-
-## [0.3.0](https://github.com/Agoric/agoric-sdk/compare/@agoric/internal@0.2.1...@agoric/internal@0.3.0) (2023-05-19)
-
-
-### ⚠ BREAKING CHANGES
-
-* emit smallcaps-format data in all marshallers
-
-### Features
-
-* Add SwingSet configuration to purge vstorage within (re-)bootstrap ([f248e91](https://github.com/Agoric/agoric-sdk/commit/f248e9116512374fb95f789b26e27b66cd5c34ca)), closes [#7681](https://github.com/Agoric/agoric-sdk/issues/7681)
-* **auction:** add an auctioneer to manage vault liquidation ([#7000](https://github.com/Agoric/agoric-sdk/issues/7000)) ([398b70f](https://github.com/Agoric/agoric-sdk/commit/398b70f7e028f957afc1582f0ee31eb2574c94d0)), closes [#6992](https://github.com/Agoric/agoric-sdk/issues/6992) [#7047](https://github.com/Agoric/agoric-sdk/issues/7047) [#7074](https://github.com/Agoric/agoric-sdk/issues/7074)
-* **casting:** handle noData value encoding ([530bc41](https://github.com/Agoric/agoric-sdk/commit/530bc41854cc7f5e5749e97e87fabc6163a17864))
-* **cosmic-swingset:** add after-commit action ([970a53f](https://github.com/Agoric/agoric-sdk/commit/970a53f827ded21b27525f6b0042bbc124c62d48))
-* **internal:** makeFakeStorageKit supports "get" and "entries" ([6a69aab](https://github.com/Agoric/agoric-sdk/commit/6a69aab5cb54faae5af631bbc2281e4fc4ede8e0))
-* **internal:** new `prepareAttenuator` leveraging callbacks ([55599df](https://github.com/Agoric/agoric-sdk/commit/55599dfe7ec43a27387ca64e8bae57be13a38115))
-* emit smallcaps-format data in all marshallers ([1753df8](https://github.com/Agoric/agoric-sdk/commit/1753df83465785b5ee71b250770c9b012d750ffc)), closes [#6822](https://github.com/Agoric/agoric-sdk/issues/6822)
-* **core:** HighPrioritySendersManager ([7b382e4](https://github.com/Agoric/agoric-sdk/commit/7b382e49a1521d367c5b8db18fa7efa2b77ef7e3))
-* **cosmic-swingset:** basic snapshot wiring ([b1072d8](https://github.com/Agoric/agoric-sdk/commit/b1072d8b1ddabbb5f2835eb503c945fed3b6b080))
-* **cosmic-swingset:** export swingStore kvData to vstorage ([be68431](https://github.com/Agoric/agoric-sdk/commit/be684315dc68ecf0cb603a8eb38ddd5418e996a6))
-* **cosmic-swingset:** process highPriorityQueue actions ([182a96e](https://github.com/Agoric/agoric-sdk/commit/182a96e169c8cac7f31fbce014783fd6db72b64c))
-* **cosmic-swingset:** remove unnecessary explicit activityhash ([5dcc44d](https://github.com/Agoric/agoric-sdk/commit/5dcc44d31be0c8a95a5749d768791fa35b72dbd3))
-* **internal:** add BufferLineTransform ([6e7db7a](https://github.com/Agoric/agoric-sdk/commit/6e7db7af7d93500caf71d817afbb358d33ef01f6))
-* **internal:** add sync tee util ([#7560](https://github.com/Agoric/agoric-sdk/issues/7560)) ([0f800a6](https://github.com/Agoric/agoric-sdk/commit/0f800a622b81c61101d96b0ad620ab3065f4b146))
-* **internal:** build `chainStorage` from `zone` ([74c62da](https://github.com/Agoric/agoric-sdk/commit/74c62dae7964b488bfdf7c7ee8a9bd930074cea8))
-* **internal:** iterable produces values and can be async ([cf4110f](https://github.com/Agoric/agoric-sdk/commit/cf4110f59c228e42e09254b271209a66b9faf3e0))
-* **internal:** new `callback` module for durable classless callbacks ([b94d600](https://github.com/Agoric/agoric-sdk/commit/b94d60052e1043fd6fb1ce39530a6072e38ef0d9))
-* **internal:** shutdown informs of interrupt signal ([2ce1e89](https://github.com/Agoric/agoric-sdk/commit/2ce1e892eb381a28c31805f48ba65511896ef406))
-* assertAllDefined ([d4d6cbd](https://github.com/Agoric/agoric-sdk/commit/d4d6cbd798eee051a8a699c85cc620c6a8298258))
-* board-utils ([4f80ad3](https://github.com/Agoric/agoric-sdk/commit/4f80ad3cac3e47a89834f7f98330a47141b6e235))
-* type assertion for assertAllDefined ([afa7b5b](https://github.com/Agoric/agoric-sdk/commit/afa7b5bfaf4558a38bdba2c44bf91691f6db26b8))
-* **store:** M.splitArray and M.splitRecord ([#6597](https://github.com/Agoric/agoric-sdk/issues/6597)) ([e7427e3](https://github.com/Agoric/agoric-sdk/commit/e7427e386bcbfbe99312b41342b1fa2e722c57c7))
-* **vats:** harmonise core/boot.js and boot-psm.js ([4f6635e](https://github.com/Agoric/agoric-sdk/commit/4f6635e550b926d3ca43d9075f26fef3b810817d))
-
-
-### Bug Fixes
-
-* **internal:** add typing to makeWithQueue ([5b1539b](https://github.com/Agoric/agoric-sdk/commit/5b1539bfc61ea4f937e2f85cbe93c7bccfc84a40))
-* **internal:** Make makeFakeStorageKit value auto-wrapping depend upon `sequence: true` ([2751e76](https://github.com/Agoric/agoric-sdk/commit/2751e7626e0ca617cdb2b1d92e5d4d9315b5674a))
-* **internal:** more callback typing ([e78e14d](https://github.com/Agoric/agoric-sdk/commit/e78e14d60a78d2e5f9fb9a899053bf778bb51360))
-* **internal:** properly inherit from `chainStorageNode` ([134a977](https://github.com/Agoric/agoric-sdk/commit/134a977f7bc4a2fc6eff3868d4d415c8c9714b4b))
-* **internal:** Restore support for passable-symbol method keys ([54271af](https://github.com/Agoric/agoric-sdk/commit/54271af10adb144fe6d562193afa473d74425854))
-* **internal:** shutdown beforeExit avoids forced exit ([34c9f44](https://github.com/Agoric/agoric-sdk/commit/34c9f442f124cd7181b538cf8754c6180c863b32))
-* **internal:** Validate Callback targets ([8880ada](https://github.com/Agoric/agoric-sdk/commit/8880ada791d70dd487770e8a0fa4b6b725aa8769))
-* **notifier:** Add a makeDurablePublishKit "onAdvance" option ([4c62b52](https://github.com/Agoric/agoric-sdk/commit/4c62b52b94cbc9ccb3c7388f5e94589809e6d7fd)), closes [#7303](https://github.com/Agoric/agoric-sdk/issues/7303)
-* adapt to deeplyFulfilled being async ([#6816](https://github.com/Agoric/agoric-sdk/issues/6816)) ([ec315e1](https://github.com/Agoric/agoric-sdk/commit/ec315e1634f6d5cdef1cddafc18777de7c04fecc))
-* **telemetry:** partially undo [#6684](https://github.com/Agoric/agoric-sdk/issues/6684) ([b9fa85b](https://github.com/Agoric/agoric-sdk/commit/b9fa85b7307124e50cc3a84d3b694307cde55f54))
-* avoid using top-level `require` ([57ca2db](https://github.com/Agoric/agoric-sdk/commit/57ca2dbfbadb373f97d43b2fb4e90302c9149976))
-* **types:** type assertion for assertAllDefined ([25f16b2](https://github.com/Agoric/agoric-sdk/commit/25f16b2e935931b81313d2ee1d491b305088bb7a))
-* track endo 1382 fix to 6570 ([#6612](https://github.com/Agoric/agoric-sdk/issues/6612)) ([7897761](https://github.com/Agoric/agoric-sdk/commit/7897761d6e19e6bbba42e7bd0bd5befb507afa08))
-
-
-
-### [0.2.1](https://github.com/Agoric/agoric-sdk/compare/@agoric/internal@0.2.0...@agoric/internal@0.2.1) (2022-10-05)
-
-
-### Bug Fixes
-
-* protect zoe from keyword collision ([#6370](https://github.com/Agoric/agoric-sdk/issues/6370)) ([02af4a0](https://github.com/Agoric/agoric-sdk/commit/02af4a07ad1f99b545d0bf525bd1ea97d74639d1))
-
-
-
-## 0.2.0 (2022-09-20)
-
-
-### ⚠ BREAKING CHANGES
-
-* **SwingSet:** Representatives inherit bound methods (#5970)
-
-### Features
-
-* **internal:** add async utils from loadgen ([5d9f411](https://github.com/Agoric/agoric-sdk/commit/5d9f411a124e4028cd88764084999fb1fd791609))
-* **internal:** deeplyFulfilledObject ([11fd071](https://github.com/Agoric/agoric-sdk/commit/11fd071005741719286ae6a1bb6bb9a7fd1f65b7))
-
-
-### Bug Fixes
-
-* **SwingSet:** Representatives inherit bound methods ([#5970](https://github.com/Agoric/agoric-sdk/issues/5970)) ([ba1ed62](https://github.com/Agoric/agoric-sdk/commit/ba1ed62062a63862e2eecb598b0bd1d2ac828e1f))