@agoric/ertp 0.16.3-dev-7940ef4.0 → 0.16.3-dev-b232bfe.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/ertp",
-  "version": "0.16.3-dev-7940ef4.0+7940ef4",
+  "version": "0.16.3-dev-b232bfe.0+b232bfe",
   "description": "Electronic Rights Transfer Protocol (ERTP). A smart contract framework for exchanging electronic rights",
   "type": "module",
   "main": "src/index.js",
@@ -39,10 +39,10 @@
   },
   "homepage": "https://github.com/Agoric/agoric-sdk#readme",
   "dependencies": {
-    "@agoric/notifier": "0.6.3-dev-7940ef4.0+7940ef4",
-    "@agoric/store": "0.9.3-dev-7940ef4.0+7940ef4",
-    "@agoric/vat-data": "0.5.3-dev-7940ef4.0+7940ef4",
-    "@agoric/zone": "0.2.3-dev-7940ef4.0+7940ef4",
+    "@agoric/notifier": "0.6.3-dev-b232bfe.0+b232bfe",
+    "@agoric/store": "0.9.3-dev-b232bfe.0+b232bfe",
+    "@agoric/vat-data": "0.5.3-dev-b232bfe.0+b232bfe",
+    "@agoric/zone": "0.2.3-dev-b232bfe.0+b232bfe",
     "@endo/errors": "^1.2.5",
     "@endo/eventual-send": "^1.2.5",
     "@endo/far": "^1.1.5",
@@ -52,7 +52,7 @@
     "@endo/promise-kit": "^1.1.5"
   },
   "devDependencies": {
-    "@agoric/swingset-vat": "0.32.3-dev-7940ef4.0+7940ef4",
+    "@agoric/swingset-vat": "0.32.3-dev-b232bfe.0+b232bfe",
     "@endo/bundle-source": "^3.4.0",
     "@fast-check/ava": "^1.1.5",
     "ava": "^5.3.0",
@@ -79,5 +79,5 @@
   "typeCoverage": {
     "atLeast": 91.23
   },
-  "gitHead": "7940ef4c491777cfa333695f71a4767a8e5d4731"
+  "gitHead": "b232bfe00c337a0f2016c8af308261e14c19cb9a"
 }

package/src/types-index.d.ts

@@ -0,0 +1,2 @@
+// Export all the types this package provides
+export * 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,17 +1,21 @@
+import type { LatestTopic } from '@agoric/notifier';
+import type { ERef } from '@endo/far';
+import type { RemotableObject } from '@endo/pass-style';
+import type { CopyBag, CopySet, Key, Pattern } from '@endo/patterns';
 export type NatAmount = {
-    brand: Brand<"nat">;
+    brand: Brand<'nat'>;
     value: bigint;
 };
 export type SetAmount<K extends Key> = {
-    brand: Brand<"set">;
+    brand: Brand<'set'>;
     value: K[];
 };
 export type CopySetAmount<K extends Key> = {
-    brand: Brand<"copySet">;
+    brand: Brand<'copySet'>;
     value: CopySet<K>;
 };
 export type CopyBagAmount<K extends Key> = {
-    brand: Brand<"copyBag">;
+    brand: Brand<'copyBag'>;
     value: CopyBag<K>;
 };
 export type AnyAmount = {
@@ -27,7 +31,7 @@ export type AnyAmount = {
  * balance of 5 bucks. An empty purse has 0 bucks. AmountMath relies heavily
  * on polymorphic MathHelpers, which manipulate the unbranded portion.
  */
-export type Amount<K extends AssetKind = AssetKind, M extends Key = Key> = K extends "nat" ? NatAmount : K extends "set" ? SetAmount<M> : K extends "copySet" ? CopySetAmount<M> : K extends "copyBag" ? CopyBagAmount<M> : AnyAmount;
+export type Amount<K extends AssetKind = AssetKind, M extends Key = Key> = K extends 'nat' ? NatAmount : K extends 'set' ? SetAmount<M> : K extends 'copySet' ? CopySetAmount<M> : K extends 'copyBag' ? CopyBagAmount<M> : AnyAmount;
 /**
  * An `AmountValue` describes a set or quantity of assets that can be owned or
  * shared.
@@ -49,14 +53,15 @@ export type Amount<K extends AssetKind = AssetKind, M extends Key = Key> = K ext
  * once or more times, i.e., some positive bigint number of times,
  * representing that quantity of the asset represented by that key.
  */
-export type AmountValue = NatValue | SetValue | CopySet | import("@endo/patterns").CopyBag;
+export type AmountValue = NatValue | SetValue | CopySet | import('@endo/patterns').CopyBag;
 /**
  * See doc-comment
  *   for `AmountValue`.
  */
-export type AssetKind = "nat" | "set" | "copySet" | "copyBag";
-export type AssetValueForKind<K extends AssetKind, M extends Key = Key> = K extends "nat" ? NatValue : K extends "set" ? SetValue<M> : K extends "copySet" ? CopySet<M> : K extends "copyBag" ? CopyBag<M> : never;
-export type AssetKindForValue<V extends AmountValue> = V extends NatValue ? "nat" : V extends SetValue ? "set" : V extends CopySet ? "copySet" : V extends import("@endo/patterns").CopyBag ? "copyBag" : never;
+export type AssetKind = 'nat' | 'set' | 'copySet' | 'copyBag';
+export type AssetValueForKind<K extends AssetKind, M extends Key = Key> = K extends 'nat' ? NatValue : K extends 'set' ? SetValue<M> : K extends 'copySet' ? CopySet<M> : K extends 'copyBag' ? CopyBag<M> : never;
+export type AssetKindForValue<V extends AmountValue> = V extends NatValue ? 'nat' : V extends SetValue ? 'set' : V extends CopySet ? 'copySet' : V extends import('@endo/patterns').CopyBag ? 'copyBag' : never;
+/** @deprecated */
 export type DisplayInfo<K extends AssetKind = AssetKind> = {
     /**
      * Tells the display software how many
@@ -82,10 +87,7 @@ export type BrandMethods<K extends AssetKind> = {
      */
     isMyIssuer: (allegedIssuer: ERef<Issuer<K>>) => Promise<boolean>;
     getAllegedName: () => string;
-    /**
-     * Give information to UI on how
-     * to display the amount.
-     */
+    /** @deprecated look up in boardAux */
     getDisplayInfo: () => DisplayInfo<K>;
     getAmountShape: () => Pattern;
 };
@@ -153,10 +155,7 @@ export type IssuerMethods<K extends AssetKind, M extends Key> = {
      * Issuer.
      */
     getAssetKind: () => K;
-    /**
-     * Give information to UI on how
-     * to display amounts for this issuer.
-     */
+    /** @deprecated look up in boardAux */
     getDisplayInfo: () => DisplayInfo<K>;
     /**
      * Make an empty purse of this
@@ -242,7 +241,7 @@ export type Mint<K extends AssetKind = AssetKind, M extends Key = Key> = {
  * transition is needed, it can likely be supported in a future upgrade. File an
  * issue on github and explain what you need and why.
  */
-export type RecoverySetsOption = "hasRecoverySets" | "noRecoverySets";
+export type RecoverySetsOption = 'hasRecoverySets' | 'noRecoverySets';
 export type DepositFacetReceive = (payment: Payment, optAmountShape?: Pattern) => Amount;
 export type DepositFacet = {
     /**
@@ -403,9 +402,4 @@ export type MathHelpers<V extends AmountValue> = {
 };
 export type NatValue = bigint;
 export type SetValue<K extends Key = Key> = K[];
-import type { Key } from '@endo/patterns';
-import type { CopySet } from '@endo/patterns';
-import type { CopyBag } from '@endo/patterns';
-import type { RemotableObject } from '@endo/pass-style';
-import type { LatestTopic } from '@agoric/notifier';
 //# sourceMappingURL=types.d.ts.map

package/src/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["types.js"],"names":[],"mappings":"wBAYc;IAAE,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE;sBAEjC,CAAC,SAAP,GAAK,IACL;IAAE,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IAAC,KAAK,EAAE,CAAC,EAAE,CAAA;CAAE;0BAG7B,CAAC,SAAP,GAAK,IACL;IAAE,KAAK,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;IAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAA;CAAE;0BAGxC,CAAC,SAAP,GAAK,IACL;IAAE,KAAK,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;IAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAA;CAAE;wBAE7C;IAAE,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC;IAAC,KAAK,EAAE,GAAG,CAAA;CAAE;;;;;;;;;;mBAGrB,CAAC,SAAb,SAAU,cACJ,CAAC,SAAR,GAAK,UACL,CAAC,SAAS,KAAK,GACrB,SAAS,GACT,CAAC,SAAS,KAAK,GACb,SAAS,CAAC,CAAC,CAAC,GACZ,CAAC,SAAS,SAAS,GACjB,aAAa,CAAC,CAAC,CAAC,GAChB,CAAC,SAAS,SAAS,GACjB,aAAa,CAAC,CAAC,CAAC,GAChB,SAAS;;;;;;;;;;;;;;;;;;;;;;0BAWT,QAAQ,GAAG,QAAQ,GAAG,OAAO,GAAG,OAAO,gBAAgB,EAAE,OAAO;;;;;wBAuBhE,KAAK,GAAG,KAAK,GAAG,SAAS,GAAG,SAAS;8BAKzB,CAAC,SAAZ,SAAU,EACJ,CAAC,SAAR,GAAK,UACL,CAAC,SAAS,KAAK,GACrB,QAAQ,GACR,CAAC,SAAS,KAAK,GACb,QAAQ,CAAC,CAAC,CAAC,GACX,CAAC,SAAS,SAAS,GACjB,QAAQ,CAAC,CAAC,GACV,CAAC,SAAS,SAAS,GACjB,QAAQ,CAAC,CAAC,GACV,KAAK;8BAIS,CAAC,SAAd,WAAY,IACb,CAAC,SAAS,QAAQ,GACxB,KAAK,GACL,CAAC,SAAS,QAAQ,GAChB,KAAK,GACL,CAAC,SAAS,OAAO,GACf,SAAS,GACT,CAAC,SAAS,OAAO,gBAAgB,EAAE,OAAO,GACxC,SAAS,GACT,KAAK;wBAIQ,CAAC,SAAb,SAAU;;;;;;;;;;;;;;;;;eAWV,CAAC;;yBAMU,CAAC,SAAZ,SAAU;;;;gBAEV,CAAC,aAAa,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,OAAO,CAAC;oBAEpD,MAAM,MAAM;;;;;oBACZ,MAAM,WAAW,CAAC,CAAC,CAAC;oBAEpB,MAAM,OAAO;;;;;;;;;;;;;kBAID,CAAC,SAAb,SAAU,gBACX,eAAe,GAAG,YAAY,CAAC,CAAC,CAAC;;;;;;qCAiBnC,IAAI,CAAC,OAAO,CAAC,KACX,OAAO,CAAC,OAAO,CAAC;;;;;;;;8BAGJ,CAAC,SAAZ,SAAU,EACJ,CAAC,SAAR,GAAK,oBAMP,IAAI,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KACjB,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;;;;;;;;;;;;;;;;mCAiBvB,IAAI,CAAC,OAAO,CAAC,mBACb,OAAO,KACL,OAAO,CAAC,MAAM,CAAC;;;;0BAIH,CAAC,SAAZ,SAAU,EACL,CAAC,SAAP,GAAK;;;;;;;;cAEJ,MAAM,KAAK,CAAC,CAAC,CAAC;;;;;oBAKd,MAAM,MAAM;;;;;kBAEZ,MAAM,CAAC;;;;;oBAEP,MAAM,WAAW,CAAC,CAAC,CAAC;;;;;oBAEpB,MAAM,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;YAEjB,YAAY;iBACZ,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC;UACvB,UAAU;;;;;;;;;;mBAIE,CAAC,SAAb,SAAU,cACJ,CAAC,SAAR,GAAK,UACL,eAAe,GAAG,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC;0BASxB,CAAC,SAAb,SAAU;UAEV,IAAI,CAAC,CAAC,CAAC;;;;;;uBACP,KAAK,CAAC,CAAC,CAAC;YAGR,MAAM,CAAC,CAAC,CAAC;WACT,KAAK,CAAC,CAAC,CAAC;;sBAII,CAAC,SAAb,SAAU,cACJ,CAAC,SAAR,GAAK;UAEJ,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC;;;;;;uBACV,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;YAGX,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC;WACZ,KAAK,CAAC,CAAC,CAAC;iBACR,WAAW;;;;;;;;;;;;;;;;;;;;;iBAkBC,CAAC,SAAb,SAAU,cACJ,CAAC,SAAR,GAAK;;;;eAGJ,MAAM,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC;;;;;iBAClB,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC;;;;;;;;;;;;;;;iCAmBxC,iBAAiB,GAAG,gBAAgB;4CAOtC,OAAO,mBACP,OAAO,KACL,MAAM;;;;;;;;;;aAKL,mBAAmB;;;;;;;;;kBASP,CAAC,SAAb,SAAU,cACJ,CAAC,SAAR,GAAK,UACL,eAAe,GAAG,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC;;;;;;;yBAQvB,CAAC,SAAb,SAAU,cACJ,CAAC,SAAR,GAAK;;;;;qBAKJ,MAAM,KAAK,CAAC,CAAC,CAAC;;;;;sBAEd,MAAM,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC;;;;;8BAElB,MAAM,YAAY,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;;;;;;;;aAE/B,CAAC,CAAuB,SAAb,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,EACjC,OAAO,EAAE,CAAC,EACV,cAAc,CAAC,EAAE,OAAO,KACrB,CAAC,SAAS,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,KAAK;;;;;qBAMxC,MAAM,YAAY;;;;;cAElB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC;;;;;;;;;;;;;oBAEvC,MAAM,QAAQ,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;;;;;;;;;gBAU5B,MAAM,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC;;;;;;;;;;;;;;;;;;oBASN,CAAC,SAAb,SAAU,cACJ,CAAC,SAAR,GAAK,UACL,eAAe,GAAG,cAAc,CAAC,CAAC,CAAC;2BAiBtB,CAAC,SAAb,SAAU;;;;;;;qBAEV,MAAM,KAAK,CAAC,CAAC,CAAC;;;;;;;;;;;;;;wBASD,CAAC,SAAd,WAAY;;;;;cAWZ,CAAC,YAAY,EAAE,CAAC,KAAK,CAAC;;;;;iBAEtB,MAAM,CAAC;;;;;eAEP,CAAC,KAAK,EAAE,CAAC,KAAK,OAAO;;;;;aAErB,CAAC,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,KAAK,OAAO;;;;eAE9B,CAAC,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,KAAK,OAAO;;;;;WAC9B,CAAC,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,KAAK,CAAC;;;;;;gBAExB,CAAC,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,KAAK,CAAC;;uBAKxB,MAAM;qBAGA,CAAC,SAAR,GAAK,UACL,CAAC,EAAE;yBA1ZwB,gBAAgB;6BAAhB,gBAAgB;6BAAhB,gBAAgB;qCADZ,kBAAkB;iCAEhB,kBAAkB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["types.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACtC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAErE,MAAM,MAAM,SAAS,GAAG;IACtB,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IACpB,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AACF,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,GAAG,IAAI;IACrC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IACpB,KAAK,EAAE,CAAC,EAAE,CAAC;CACZ,CAAC;AACF,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,GAAG,IAAI;IACzC,KAAK,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;IACxB,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;CACnB,CAAC;AACF,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,GAAG,IAAI;IACzC,KAAK,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;IACxB,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;CACnB,CAAC;AACF,MAAM,MAAM,SAAS,GAAG;IACtB,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC;IAClB,KAAK,EAAE,GAAG,CAAC;CACZ,CAAC;AACF;;;;;;;;GAQG;AACH,MAAM,MAAM,MAAM,CAChB,CAAC,SAAS,SAAS,GAAG,SAAS,EAC/B,CAAC,SAAS,GAAG,GAAG,GAAG,IACjB,CAAC,SAAS,KAAK,GACf,SAAS,GACT,CAAC,SAAS,KAAK,GACb,SAAS,CAAC,CAAC,CAAC,GACZ,CAAC,SAAS,SAAS,GACjB,aAAa,CAAC,CAAC,CAAC,GAChB,CAAC,SAAS,SAAS,GACjB,aAAa,CAAC,CAAC,CAAC,GAChB,SAAS,CAAC;AACpB;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,MAAM,WAAW,GACnB,QAAQ,GACR,QAAQ,GACR,OAAO,GACP,OAAO,gBAAgB,EAAE,OAAO,CAAC;AACrC;;;GAGG;AACH,MAAM,MAAM,SAAS,GAAG,KAAK,GAAG,KAAK,GAAG,SAAS,GAAG,SAAS,CAAC;AAC9D,MAAM,MAAM,iBAAiB,CAC3B,CAAC,SAAS,SAAS,EACnB,CAAC,SAAS,GAAG,GAAG,GAAG,IACjB,CAAC,SAAS,KAAK,GACf,QAAQ,GACR,CAAC,SAAS,KAAK,GACb,QAAQ,CAAC,CAAC,CAAC,GACX,CAAC,SAAS,SAAS,GACjB,OAAO,CAAC,CAAC,CAAC,GACV,CAAC,SAAS,SAAS,GACjB,OAAO,CAAC,CAAC,CAAC,GACV,KAAK,CAAC;AAChB,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,WAAW,IAAI,CAAC,SAAS,QAAQ,GACrE,KAAK,GACL,CAAC,SAAS,QAAQ,GAChB,KAAK,GACL,CAAC,SAAS,OAAO,GACf,SAAS,GACT,CAAC,SAAS,OAAO,gBAAgB,EAAE,OAAO,GACxC,SAAS,GACT,KAAK,CAAC;AAChB,kBAAkB;AAClB,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS,IAAI;IACzD;;;;;;;;;;OAUG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC;;;OAGG;IACH,SAAS,EAAE,CAAC,CAAC;CACd,CAAC;AACF,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,SAAS,IAAI;IAC9C;;OAEG;IACH,UAAU,EAAE,CAAC,aAAa,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IACjE,cAAc,EAAE,MAAM,MAAM,CAAC;IAC7B,sCAAsC;IACtC,cAAc,EAAE,MAAM,WAAW,CAAC,CAAC,CAAC,CAAC;IACrC,cAAc,EAAE,MAAM,OAAO,CAAC;CAC/B,CAAC;AACF;;;;;;;;;;GAUG;AACH,MAAM,MAAM,KAAK,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS,IAAI,eAAe,GAClE,YAAY,CAAC,CAAC,CAAC,CAAC;AAClB;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;AACxE;;;;;;GAMG;AACH,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,SAAS,EAAE,CAAC,SAAS,GAAG,GAAG,GAAG,IAAI,CACxE,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KACzB,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAC3B;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,UAAU,GAAG,CACvB,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,EACtB,cAAc,CAAC,EAAE,OAAO,KACrB,OAAO,CAAC,MAAM,CAAC,CAAC;AACrB;;GAEG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,SAAS,EAAE,CAAC,SAAS,GAAG,IAAI;IAC9D;;;;;;OAMG;IACH,QAAQ,EAAE,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC;IACzB;;;OAGG;IACH,cAAc,EAAE,MAAM,MAAM,CAAC;IAC7B;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC,CAAC;IACtB,sCAAsC;IACtC,cAAc,EAAE,MAAM,WAAW,CAAC,CAAC,CAAC,CAAC;IACrC;;;OAGG;IACH,cAAc,EAAE,MAAM,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAClC,MAAM,EAAE,YAAY,CAAC;IACrB,WAAW,EAAE,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACrC,IAAI,EAAE,UAAU,CAAC;CAClB,CAAC;AACF;;;;;;;GAOG;AACH,MAAM,MAAM,MAAM,CAChB,CAAC,SAAS,SAAS,GAAG,SAAS,EAC/B,CAAC,SAAS,GAAG,GAAG,GAAG,IACjB,eAAe,GAAG,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAC1C,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS,IAAI;IAC3D,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;IACd;;;;OAIG;IACH,iBAAiB,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;IAC5B,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAClB,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;CACjB,CAAC;AACF,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS,EAAE,CAAC,SAAS,GAAG,GAAG,GAAG,IAAI;IAC5E,IAAI,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACjB;;;;OAIG;IACH,iBAAiB,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC/B,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACrB,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;IAChB,WAAW,EAAE,WAAW,CAAC;CAC1B,CAAC;AACF,MAAM,MAAM,qBAAqB,GAAG;IAClC;;;;;;;;;;OAUG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,SAAS,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;CACnC,CAAC;AACF;;;GAGG;AACH,MAAM,MAAM,IAAI,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS,EAAE,CAAC,SAAS,GAAG,GAAG,GAAG,IAAI;IACvE;;OAEG;IACH,SAAS,EAAE,MAAM,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC9B;;;OAGG;IACH,WAAW,EAAE,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;CACtD,CAAC;AACF;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,kBAAkB,GAAG,iBAAiB,GAAG,gBAAgB,CAAC;AACtE,MAAM,MAAM,mBAAmB,GAAG,CAChC,OAAO,EAAE,OAAO,EAChB,cAAc,CAAC,EAAE,OAAO,KACrB,MAAM,CAAC;AACZ,MAAM,MAAM,YAAY,GAAG;IACzB;;;;;;;OAOG;IACH,OAAO,EAAE,mBAAmB,CAAC;CAC9B,CAAC;AACF;;;;;;GAMG;AACH,MAAM,MAAM,KAAK,CACf,CAAC,SAAS,SAAS,GAAG,SAAS,EAC/B,CAAC,SAAS,GAAG,GAAG,GAAG,IACjB,eAAe,GAAG,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AACzC;;;;;GAKG;AACH,MAAM,MAAM,YAAY,CACtB,CAAC,SAAS,SAAS,GAAG,SAAS,EAC/B,CAAC,SAAS,GAAG,GAAG,GAAG,IACjB;IACF;;;OAGG;IACH,eAAe,EAAE,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC;IAChC;;;OAGG;IACH,gBAAgB,EAAE,MAAM,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACrC;;;OAGG;IACH,wBAAwB,EAAE,MAAM,WAAW,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAC1D;;;;;;OAMG;IACH,OAAO,EAAE,CAAC,CAAC,SAAS,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,EAC/B,OAAO,EAAE,CAAC,EACV,cAAc,CAAC,EAAE,OAAO,KACrB,CAAC,SAAS,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,KAAK,CAAC;IACpD;;;OAGG;IACH,eAAe,EAAE,MAAM,YAAY,CAAC;IACpC;;;OAGG;IACH,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAClD;;;;;;;;;;;OAWG;IACH,cAAc,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAC7C;;;;;;;OAOG;IACH,UAAU,EAAE,MAAM,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;CAChC,CAAC;AACF;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,OAAO,CACjB,CAAC,SAAS,SAAS,GAAG,SAAS,EAC/B,CAAC,SAAS,GAAG,GAAG,GAAG,IACjB,eAAe,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC;AACxC,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS,IAAI;IAC5D;;;;;OAKG;IACH,eAAe,EAAE,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC;CACjC,CAAC;AACF;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,WAAW,IAAI;IAC/C;;;OAGG;IACH,QAAQ,EAAE,CAAC,YAAY,EAAE,CAAC,KAAK,CAAC,CAAC;IACjC;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC,CAAC;IACrB;;;OAGG;IACH,SAAS,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,OAAO,CAAC;IACjC;;;OAGG;IACH,OAAO,EAAE,CAAC,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,KAAK,OAAO,CAAC;IACxC;;OAEG;IACH,SAAS,EAAE,CAAC,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,KAAK,OAAO,CAAC;IAC1C;;;OAGG;IACH,KAAK,EAAE,CAAC,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,KAAK,CAAC,CAAC;IAChC;;;;OAIG;IACH,UAAU,EAAE,CAAC,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,KAAK,CAAC,CAAC;CACtC,CAAC;AACF,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC;AAC9B,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,GAAG,GAAG,GAAG,IAAI,CAAC,EAAE,CAAC"}

package/src/types.ts

@@ -0,0 +1,464 @@
+/* eslint-disable no-use-before-define */
+import type { LatestTopic } from '@agoric/notifier';
+import type { ERef } from '@endo/far';
+import type { RemotableObject } from '@endo/pass-style';
+import type { CopyBag, CopySet, Key, Pattern } from '@endo/patterns';
+
+export type NatAmount = {
+  brand: Brand<'nat'>;
+  value: bigint;
+};
+export type SetAmount<K extends Key> = {
+  brand: Brand<'set'>;
+  value: K[];
+};
+export type CopySetAmount<K extends Key> = {
+  brand: Brand<'copySet'>;
+  value: CopySet<K>;
+};
+export type CopyBagAmount<K extends Key> = {
+  brand: Brand<'copyBag'>;
+  value: CopyBag<K>;
+};
+export type AnyAmount = {
+  brand: Brand<any>;
+  value: any;
+};
+/**
+ * Amounts are descriptions of digital assets, answering the questions "how
+ * much" and "of what kind". Amounts are values labeled with a brand.
+ * AmountMath executes the logic of how amounts are changed when digital
+ * assets are merged, separated, or otherwise manipulated. For example, a
+ * deposit of 2 bucks into a purse that already has 3 bucks gives a new purse
+ * balance of 5 bucks. An empty purse has 0 bucks. AmountMath relies heavily
+ * on polymorphic MathHelpers, which manipulate the unbranded portion.
+ */
+export type Amount<
+  K extends AssetKind = AssetKind,
+  M extends Key = Key,
+> = K extends 'nat'
+  ? NatAmount
+  : K extends 'set'
+    ? SetAmount<M>
+    : K extends 'copySet'
+      ? CopySetAmount<M>
+      : K extends 'copyBag'
+        ? CopyBagAmount<M>
+        : AnyAmount;
+/**
+ * An `AmountValue` describes a set or quantity of assets that can be owned or
+ * shared.
+ *
+ * A fungible `AmountValue` uses a non-negative bigint to represent a quantity
+ * of that many assets.
+ *
+ * A non-fungible `AmountValue` uses an array or CopySet of `Key`s to represent
+ * a set of whatever asset each key represents. A `Key` is a passable value
+ * that can be used as an element in a set (SetStore or CopySet) or as the key
+ * in a map (MapStore or CopyMap).
+ *
+ * `SetValue` is for the deprecated set representation, using an array directly
+ * to represent the array of its elements. `CopySet` is the proper
+ * representation using a CopySet.
+ *
+ * A semi-fungible `CopyBag` is represented as a `CopyBag` of `Key` objects.
+ * "Bag" is synonymous with MultiSet, where an element of a bag can be present
+ * once or more times, i.e., some positive bigint number of times,
+ * representing that quantity of the asset represented by that key.
+ */
+export type AmountValue =
+  | NatValue
+  | SetValue
+  | CopySet
+  | import('@endo/patterns').CopyBag;
+/**
+ * See doc-comment
+ *   for `AmountValue`.
+ */
+export type AssetKind = 'nat' | 'set' | 'copySet' | 'copyBag';
+export type AssetValueForKind<
+  K extends AssetKind,
+  M extends Key = Key,
+> = K extends 'nat'
+  ? NatValue
+  : K extends 'set'
+    ? SetValue<M>
+    : K extends 'copySet'
+      ? CopySet<M>
+      : K extends 'copyBag'
+        ? CopyBag<M>
+        : never;
+export type AssetKindForValue<V extends AmountValue> = V extends NatValue
+  ? 'nat'
+  : V extends SetValue
+    ? 'set'
+    : V extends CopySet
+      ? 'copySet'
+      : V extends import('@endo/patterns').CopyBag
+        ? 'copyBag'
+        : never;
+/** @deprecated */
+export type DisplayInfo<K extends AssetKind = AssetKind> = {
+  /**
+   * Tells the display software how many
+   * decimal places to move the decimal over to the left, or in other words,
+   * which position corresponds to whole numbers. We require fungible digital
+   * assets to be represented in integers, in the smallest unit (i.e. USD might
+   * be represented in mill, a thousandth of a dollar. In that case,
+   * `decimalPlaces` would be 3.) This property is optional, and for
+   * non-fungible digital assets, should not be specified. The decimalPlaces
+   * property should be used for _display purposes only_. Any other use is an
+   * anti-pattern.
+   */
+  decimalPlaces?: number | undefined;
+  /**
+   * - the kind of asset, either AssetKind.NAT (fungible)
+   * or AssetKind.SET or AssetKind.COPY_SET (non-fungible)
+   */
+  assetKind: K;
+};
+export type BrandMethods<K extends AssetKind> = {
+  /**
+   *   Should be used with `issuer.getBrand` to ensure an issuer and brand match.
+   */
+  isMyIssuer: (allegedIssuer: ERef<Issuer<K>>) => Promise<boolean>;
+  getAllegedName: () => string;
+  /** @deprecated look up in boardAux */
+  getDisplayInfo: () => DisplayInfo<K>;
+  getAmountShape: () => Pattern;
+};
+/**
+ * The brand identifies the
+ *   kind of issuer, and has a function to get the alleged name for the kind of
+ *   asset described. The alleged name (such as 'BTC' or 'moola') is provided by
+ *   the maker of the issuer and should not be trusted as accurate.
+ *
+ *   Every amount created by a particular issuer will share the same brand, but
+ *   recipients cannot rely on the brand to verify that a purported amount
+ *   represents the issuer they intended, since the same brand can be reused by
+ *   a misbehaving issuer.
+ */
+export type Brand<K extends AssetKind = AssetKind> = RemotableObject &
+  BrandMethods<K>;
+/**
+ * Return true if the payment continues to exist.
+ *
+ *   If the payment is a promise, the operation will proceed upon fulfillment.
+ */
+export type IssuerIsLive = (payment: ERef<Payment>) => Promise<boolean>;
+/**
+ * Get the amount of digital assets in the payment.
+ *   Because the payment is not trusted, we cannot call a method on it directly,
+ *   and must use the issuer instead.
+ *
+ *   If the payment is a promise, the operation will proceed upon fulfillment.
+ */
+export type IssuerGetAmountOf<K extends AssetKind, M extends Key = Key> = (
+  payment: ERef<Payment<K, M>>,
+) => Promise<Amount<K, M>>;
+/**
+ * Burn all of the digital assets in the payment.
+ *   `optAmountShape` is optional. If the `optAmountShape` pattern is present,
+ *   the amount of the digital assets in the payment must match
+ *   `optAmountShape`, to prevent sending the wrong payment and other
+ *   confusion.
+ *
+ *   If the payment is a promise, the operation will proceed upon fulfillment.
+ *
+ *   As always with optional `Pattern` arguments, keep in mind that technically
+ *   the value `undefined` itself is a valid `Key` and therefore a valid
+ *   `Pattern`. But in optional pattern position, a top level `undefined` will
+ *   be interpreted as absence. If you want to express a `Pattern` that will
+ *   match only `undefined`, use `M.undefined()` instead.
+ */
+export type IssuerBurn = (
+  payment: ERef<Payment>,
+  optAmountShape?: Pattern,
+) => Promise<Amount>;
+/**
+ * Work around JSDoc union handling
+ */
+export type IssuerMethods<K extends AssetKind, M extends Key> = {
+  /**
+   * Get the Brand for this Issuer. The Brand
+   * indicates the type of digital asset and is shared by the mint, the issuer,
+   * and any purses and payments of this particular kind. The brand is not
+   * closely held, so this function should not be trusted to identify an issuer
+   * alone. Fake digital assets and amount can use another issuer's brand.
+   */
+  getBrand: () => Brand<K>;
+  /**
+   * Get the allegedName for this
+   * mint/issuer
+   */
+  getAllegedName: () => string;
+  /**
+   * Get the kind of MathHelpers used by this
+   * Issuer.
+   */
+  getAssetKind: () => K;
+  /** @deprecated look up in boardAux */
+  getDisplayInfo: () => DisplayInfo<K>;
+  /**
+   * Make an empty purse of this
+   * brand.
+   */
+  makeEmptyPurse: () => Purse<K, M>;
+  isLive: IssuerIsLive;
+  getAmountOf: IssuerGetAmountOf<K, M>;
+  burn: IssuerBurn;
+};
+/**
+ * The issuer cannot
+ *   mint a new amount, but it can create empty purses and payments. The issuer
+ *   can also transform payments (splitting payments, combining payments,
+ *   burning payments, and claiming payments exclusively). The issuer should be
+ *   gotten from a trusted source and then relied upon as the decider of whether
+ *   an untrusted payment is valid.
+ */
+export type Issuer<
+  K extends AssetKind = AssetKind,
+  M extends Key = Key,
+> = RemotableObject & IssuerMethods<K, M>;
+export type PaymentLedger<K extends AssetKind = AssetKind> = {
+  mint: Mint<K>;
+  /**
+   * Externally useful only if this issuer
+   * uses recovery sets. Can be used to get the recovery set associated with
+   * minted payments that are still live.
+   */
+  mintRecoveryPurse: Purse<K>;
+  issuer: Issuer<K>;
+  brand: Brand<K>;
+};
+export type IssuerKit<K extends AssetKind = AssetKind, M extends Key = Key> = {
+  mint: Mint<K, M>;
+  /**
+   * Externally useful only if this
+   * issuer uses recovery sets. Can be used to get the recovery set associated
+   * with minted payments that are still live.
+   */
+  mintRecoveryPurse: Purse<K, M>;
+  issuer: Issuer<K, M>;
+  brand: Brand<K>;
+  displayInfo: DisplayInfo;
+};
+export type AdditionalDisplayInfo = {
+  /**
+   * Tells the display software how many
+   * decimal places to move the decimal over to the left, or in other words,
+   * which position corresponds to whole numbers. We require fungible digital
+   * assets to be represented in integers, in the smallest unit (i.e. USD might
+   * be represented in mill, a thousandth of a dollar. In that case,
+   * `decimalPlaces` would be 3.) This property is optional, and for
+   * non-fungible digital assets, should not be specified. The decimalPlaces
+   * property should be used for _display purposes only_. Any other use is an
+   * anti-pattern.
+   */
+  decimalPlaces?: number | undefined;
+  assetKind?: AssetKind | undefined;
+};
+/**
+ * Holding a Mint carries the right to issue new digital
+ *   assets. These assets all have the same kind, which is called a Brand.
+ */
+export type Mint<K extends AssetKind = AssetKind, M extends Key = Key> = {
+  /**
+   * Gets the Issuer for this mint.
+   */
+  getIssuer: () => Issuer<K, M>;
+  /**
+   * Creates a new
+   * Payment containing newly minted amount.
+   */
+  mintPayment: (newAmount: Amount<K>) => Payment<K, M>;
+};
+/**
+ * Issuers first became durable with mandatory recovery sets. Later they were
+ * made optional, but there is no support for converting from one state to the
+ * other. Thus, absence of a `RecoverySetsOption` state is equivalent to
+ * `'hasRecoverySets'`. In the absence of a `recoverySetsOption` parameter,
+ * upgradeIssuerKit defaults to the predecessor's `RecoverySetsOption` state, or
+ * `'hasRecoverySets'` if none.
+ *
+ * At this time, issuers started in one of the states (`'noRecoverySets'`, or
+ * `'hasRecoverySets'`) cannot be converted to the other on upgrade. If this
+ * transition is needed, it can likely be supported in a future upgrade. File an
+ * issue on github and explain what you need and why.
+ */
+export type RecoverySetsOption = 'hasRecoverySets' | 'noRecoverySets';
+export type DepositFacetReceive = (
+  payment: Payment,
+  optAmountShape?: Pattern,
+) => Amount;
+export type DepositFacet = {
+  /**
+   * Deposit all the contents of payment
+   * into the purse that made this facet, returning the amount. If the optional
+   * argument `optAmount` does not equal the amount of digital assets in the
+   * payment, throw an error.
+   *
+   * If payment is a promise, throw an error.
+   */
+  receive: DepositFacetReceive;
+};
+/**
+ * Purses hold amount of
+ *   digital assets of the same brand, but unlike Payments, they are not meant
+ *   to be sent to others. To transfer digital assets, a Payment should be
+ *   withdrawn from a Purse. The amount of digital assets in a purse can change
+ *   through the action of deposit() and withdraw().
+ */
+export type Purse<
+  K extends AssetKind = AssetKind,
+  M extends Key = Key,
+> = RemotableObject & PurseMethods<K, M>;
+/**
+ * The primary use for Purses and Payments is for
+ *   currency-like and goods-like digital assets, but they can also be used to
+ *   represent other kinds of rights, such as the right to participate in a
+ *   particular contract.
+ */
+export type PurseMethods<
+  K extends AssetKind = AssetKind,
+  M extends Key = Key,
+> = {
+  /**
+   * Get the alleged Brand for this
+   * Purse
+   */
+  getAllegedBrand: () => Brand<K>;
+  /**
+   * Get the amount contained in
+   * this purse.
+   */
+  getCurrentAmount: () => Amount<K, M>;
+  /**
+   * Get a
+   * lossy notifier for changes to this purse's balance.
+   */
+  getCurrentAmountNotifier: () => LatestTopic<Amount<K, M>>;
+  /**
+   *   Deposit all the contents of payment into this purse, returning the amount. If
+   *   the optional argument `optAmount` does not equal the amount of digital
+   *   assets in the payment, throw an error.
+   *
+   *   If payment is a promise, throw an error.
+   */
+  deposit: <P extends Payment<K, M>>(
+    payment: P,
+    optAmountShape?: Pattern,
+  ) => P extends Payment<K, M> ? Amount<K, M> : never;
+  /**
+   * Return an object whose
+   * `receive` method deposits to the current Purse.
+   */
+  getDepositFacet: () => DepositFacet;
+  /**
+   * Withdraw amount
+   * from this purse into a new Payment.
+   */
+  withdraw: (amount: Amount<K, M>) => Payment<K, M>;
+  /**
+   * The set of payments
+   * withdrawn from this purse that are still live. These are the payments that
+   * can still be recovered in emergencies by, for example, depositing into this
+   * purse. Such a deposit action is like canceling an outstanding check because
+   * you're tired of waiting for it. Once your cancellation is acknowledged, you
+   * can spend the assets at stake on other things. Afterwards, if the recipient
+   * of the original check finally gets around to depositing it, their deposit
+   * fails.
+   *
+   * Returns an empty set if this issuer does not support recovery sets.
+   */
+  getRecoverySet: () => CopySet<Payment<K, M>>;
+  /**
+   * For use in emergencies, such as
+   * coming back from a traumatic crash and upgrade. This deposits all the
+   * payments in this purse's recovery set into the purse itself, returning the
+   * total amount of assets recovered.
+   *
+   * Returns an empty amount if this issuer does not support recovery sets.
+   */
+  recoverAll: () => Amount<K, M>;
+};
+/**
+ * Payments hold amount
+ *   of digital assets of the same brand in transit. Payments can be deposited
+ *   in purses, split into multiple payments, combined, and claimed (getting an
+ *   exclusive payment). Payments are linear, meaning that either a payment has
+ *   the same amount of digital assets it started with, or it is used up
+ *   entirely. It is impossible to partially use a payment.
+ *
+ *   Payments are often received from other actors and therefore should not be
+ *   trusted themselves. To get the amount of digital assets in a payment, use
+ *   the trusted issuer: issuer.getAmountOf(payment),
+ *
+ *   Payments can be converted to Purses by getting a trusted issuer and calling
+ *   `issuer.makeEmptyPurse()` to create a purse, then
+ *   `purse.deposit(payment)`.
+ */
+export type Payment<
+  K extends AssetKind = AssetKind,
+  M extends Key = Key,
+> = RemotableObject & PaymentMethods<K>;
+export type PaymentMethods<K extends AssetKind = AssetKind> = {
+  /**
+   * Get the allegedBrand, indicating
+   * the type of digital asset this payment purports to be, and which issuer to
+   * use. Because payments are not trusted, any method calls on payments should
+   * be treated with suspicion and verified elsewhere.
+   */
+  getAllegedBrand: () => Brand<K>;
+};
+/**
+ * All of the difference in how digital asset
+ *   amount are manipulated can be reduced to the behavior of the math on
+ *   values. We extract this custom logic into mathHelpers. MathHelpers are
+ *   about value arithmetic, whereas AmountMath is about amounts, which are the
+ *   values labeled with a brand. AmountMath use mathHelpers to do their value
+ *   arithmetic, and then brand the results, making a new amount.
+ *
+ *   The MathHelpers are designed to be called only from AmountMath, and so all
+ *   methods but coerce can assume their inputs are valid. They only need to do
+ *   output validation, and only when there is a possibility of invalid output.
+ */
+export type MathHelpers<V extends AmountValue> = {
+  /**
+   * Check the kind of this value and
+   * throw if it is not the expected kind.
+   */
+  doCoerce: (allegedValue: V) => V;
+  /**
+   * Get the representation for the identity
+   * element (often 0 or an empty array)
+   */
+  doMakeEmpty: () => V;
+  /**
+   * Is the value the identity
+   * element?
+   */
+  doIsEmpty: (value: V) => boolean;
+  /**
+   * Is the left greater than
+   * or equal to the right?
+   */
+  doIsGTE: (left: V, right: V) => boolean;
+  /**
+   * Does left equal right?
+   */
+  doIsEqual: (left: V, right: V) => boolean;
+  /**
+   * Return the left combined with the
+   * right.
+   */
+  doAdd: (left: V, right: V) => V;
+  /**
+   * Return what remains after
+   * removing the right from the left. If something in the right was not in the
+   * left, we throw an error.
+   */
+  doSubtract: (left: V, right: V) => V;
+};
+export type NatValue = bigint;
+export type SetValue<K extends Key = Key> = K[];

package/src/types.js

@@ -1,420 +0,0 @@
-// @jessie-check
-
-// Ensure this is a module.
-export {};
-
-/// <reference types="ses" />
-/**
- * @import {Passable, RemotableObject} from '@endo/pass-style';
- * @import {CopyBag, CopySet, Key} from '@endo/patterns';
- * @import {LatestTopic, NotifierRecord} from '@agoric/notifier';
- */
-
-/** @typedef {{ brand: Brand<'nat'>; value: bigint }} NatAmount */
-/**
- * @template {Key} K
- * @typedef {{ brand: Brand<'set'>; value: K[] }} SetAmount
- */
-/**
- * @template {Key} K
- * @typedef {{ brand: Brand<'copySet'>; value: CopySet<K> }} CopySetAmount
- */
-/**
- * @template {Key} K
- * @typedef {{ brand: Brand<'copyBag'>; value: CopyBag<K> }} CopyBagAmount
- */
-/** @typedef {{ brand: Brand<any>; value: any }} AnyAmount */
-
-/**
- * @template {AssetKind} [K=AssetKind]
- * @template {Key} [M=Key]
- * @typedef {K extends 'nat'
- *   ? NatAmount
- *   : K extends 'set'
- *     ? SetAmount<M>
- *     : K extends 'copySet'
- *       ? CopySetAmount<M>
- *       : K extends 'copyBag'
- *         ? CopyBagAmount<M>
- *         : AnyAmount} Amount
- *   Amounts are descriptions of digital assets, answering the questions "how
- *   much" and "of what kind". Amounts are values labeled with a brand.
- *   AmountMath executes the logic of how amounts are changed when digital
- *   assets are merged, separated, or otherwise manipulated. For example, a
- *   deposit of 2 bucks into a purse that already has 3 bucks gives a new purse
- *   balance of 5 bucks. An empty purse has 0 bucks. AmountMath relies heavily
- *   on polymorphic MathHelpers, which manipulate the unbranded portion.
- */
-
-/**
- * @typedef {NatValue | SetValue | CopySet | import('@endo/patterns').CopyBag} AmountValue
- *   An `AmountValue` describes a set or quantity of assets that can be owned or
- *   shared.
- *
- *   A fungible `AmountValue` uses a non-negative bigint to represent a quantity
- *   of that many assets.
- *
- *   A non-fungible `AmountValue` uses an array or CopySet of `Key`s to represent
- *   a set of whatever asset each key represents. A `Key` is a passable value
- *   that can be used as an element in a set (SetStore or CopySet) or as the key
- *   in a map (MapStore or CopyMap).
- *
- *   `SetValue` is for the deprecated set representation, using an array directly
- *   to represent the array of its elements. `CopySet` is the proper
- *   representation using a CopySet.
- *
- *   A semi-fungible `CopyBag` is represented as a `CopyBag` of `Key` objects.
- *   "Bag" is synonymous with MultiSet, where an element of a bag can be present
- *   once or more times, i.e., some positive bigint number of times,
- *   representing that quantity of the asset represented by that key.
- */
-
-/**
- * @typedef {'nat' | 'set' | 'copySet' | 'copyBag'} AssetKind See doc-comment
- *   for `AmountValue`.
- */
-
-/**
- * @template {AssetKind} K
- * @template {Key} [M=Key] member kind, for Amounts that have member values
- * @typedef {K extends 'nat'
- *   ? NatValue
- *   : K extends 'set'
- *     ? SetValue<M>
- *     : K extends 'copySet'
- *       ? CopySet<M>
- *       : K extends 'copyBag'
- *         ? CopyBag<M>
- *         : never} AssetValueForKind
- */
-
-/**
- * @template {AmountValue} V
- * @typedef {V extends NatValue
- *   ? 'nat'
- *   : V extends SetValue
- *     ? 'set'
- *     : V extends CopySet
- *       ? 'copySet'
- *       : V extends import('@endo/patterns').CopyBag
- *         ? 'copyBag'
- *         : never} AssetKindForValue
- */
-
-/**
- * @template {AssetKind} [K=AssetKind]
- * @typedef {object} DisplayInfo
- * @property {number} [decimalPlaces] Tells the display software how many
- *   decimal places to move the decimal over to the left, or in other words,
- *   which position corresponds to whole numbers. We require fungible digital
- *   assets to be represented in integers, in the smallest unit (i.e. USD might
- *   be represented in mill, a thousandth of a dollar. In that case,
- *   `decimalPlaces` would be 3.) This property is optional, and for
- *   non-fungible digital assets, should not be specified. The decimalPlaces
- *   property should be used for _display purposes only_. Any other use is an
- *   anti-pattern.
- * @property {K} assetKind - the kind of asset, either AssetKind.NAT (fungible)
- *   or AssetKind.SET or AssetKind.COPY_SET (non-fungible)
- */
-
-// XXX hack around JSDoc union handling
-/**
- * @template {AssetKind} K
- * @typedef {object} BrandMethods
- * @property {(allegedIssuer: ERef<Issuer<K>>) => Promise<boolean>} isMyIssuer
- *   Should be used with `issuer.getBrand` to ensure an issuer and brand match.
- * @property {() => string} getAllegedName
- * @property {() => DisplayInfo<K>} getDisplayInfo Give information to UI on how
- *   to display the amount.
- * @property {() => Pattern} getAmountShape
- */
-
-/**
- * @template {AssetKind} [K=AssetKind]
- * @typedef {RemotableObject & BrandMethods<K>} Brand The brand identifies the
- *   kind of issuer, and has a function to get the alleged name for the kind of
- *   asset described. The alleged name (such as 'BTC' or 'moola') is provided by
- *   the maker of the issuer and should not be trusted as accurate.
- *
- *   Every amount created by a particular issuer will share the same brand, but
- *   recipients cannot rely on the brand to verify that a purported amount
- *   represents the issuer they intended, since the same brand can be reused by
- *   a misbehaving issuer.
- */
-
-// /////////////////////////// Issuer //////////////////////////////////////////
-
-/**
- * @callback IssuerIsLive Return true if the payment continues to exist.
- *
- *   If the payment is a promise, the operation will proceed upon fulfillment.
- * @param {ERef<Payment>} payment
- * @returns {Promise<boolean>}
- */
-/**
- * @template {AssetKind} K
- * @template {Key} [M=Key] member kind, for Amounts that have member values
- * @callback IssuerGetAmountOf Get the amount of digital assets in the payment.
- *   Because the payment is not trusted, we cannot call a method on it directly,
- *   and must use the issuer instead.
- *
- *   If the payment is a promise, the operation will proceed upon fulfillment.
- * @param {ERef<Payment<K, M>>} payment
- * @returns {Promise<Amount<K, M>>}
- */
-
-/**
- * @callback IssuerBurn Burn all of the digital assets in the payment.
- *   `optAmountShape` is optional. If the `optAmountShape` pattern is present,
- *   the amount of the digital assets in the payment must match
- *   `optAmountShape`, to prevent sending the wrong payment and other
- *   confusion.
- *
- *   If the payment is a promise, the operation will proceed upon fulfillment.
- *
- *   As always with optional `Pattern` arguments, keep in mind that technically
- *   the value `undefined` itself is a valid `Key` and therefore a valid
- *   `Pattern`. But in optional pattern position, a top level `undefined` will
- *   be interpreted as absence. If you want to express a `Pattern` that will
- *   match only `undefined`, use `M.undefined()` instead.
- * @param {ERef<Payment>} payment
- * @param {Pattern} [optAmountShape]
- * @returns {Promise<Amount>}
- */
-
-/**
- * @template {AssetKind} K
- * @template {Key} M
- * @typedef {object} IssuerMethods Work around JSDoc union handling
- * @property {() => Brand<K>} getBrand Get the Brand for this Issuer. The Brand
- *   indicates the type of digital asset and is shared by the mint, the issuer,
- *   and any purses and payments of this particular kind. The brand is not
- *   closely held, so this function should not be trusted to identify an issuer
- *   alone. Fake digital assets and amount can use another issuer's brand.
- * @property {() => string} getAllegedName Get the allegedName for this
- *   mint/issuer
- * @property {() => K} getAssetKind Get the kind of MathHelpers used by this
- *   Issuer.
- * @property {() => DisplayInfo<K>} getDisplayInfo Give information to UI on how
- *   to display amounts for this issuer.
- * @property {() => Purse<K, M>} makeEmptyPurse Make an empty purse of this
- *   brand.
- * @property {IssuerIsLive} isLive
- * @property {IssuerGetAmountOf<K, M>} getAmountOf
- * @property {IssuerBurn} burn
- */
-
-/**
- * @template {AssetKind} [K=AssetKind]
- * @template {Key} [M=Key] member kind, for Amounts that have member values
- * @typedef {RemotableObject & IssuerMethods<K, M>} Issuer The issuer cannot
- *   mint a new amount, but it can create empty purses and payments. The issuer
- *   can also transform payments (splitting payments, combining payments,
- *   burning payments, and claiming payments exclusively). The issuer should be
- *   gotten from a trusted source and then relied upon as the decider of whether
- *   an untrusted payment is valid.
- */
-
-/**
- * @template {AssetKind} [K=AssetKind]
- * @typedef {object} PaymentLedger
- * @property {Mint<K>} mint
- * @property {Purse<K>} mintRecoveryPurse Externally useful only if this issuer
- *   uses recovery sets. Can be used to get the recovery set associated with
- *   minted payments that are still live.
- * @property {Issuer<K>} issuer
- * @property {Brand<K>} brand
- */
-
-/**
- * @template {AssetKind} [K=AssetKind]
- * @template {Key} [M=Key] member kind, for Amounts that have member values
- * @typedef {object} IssuerKit
- * @property {Mint<K, M>} mint
- * @property {Purse<K, M>} mintRecoveryPurse Externally useful only if this
- *   issuer uses recovery sets. Can be used to get the recovery set associated
- *   with minted payments that are still live.
- * @property {Issuer<K, M>} issuer
- * @property {Brand<K>} brand
- * @property {DisplayInfo} displayInfo
- */
-
-/**
- * @typedef {object} AdditionalDisplayInfo
- * @property {number} [decimalPlaces] Tells the display software how many
- *   decimal places to move the decimal over to the left, or in other words,
- *   which position corresponds to whole numbers. We require fungible digital
- *   assets to be represented in integers, in the smallest unit (i.e. USD might
- *   be represented in mill, a thousandth of a dollar. In that case,
- *   `decimalPlaces` would be 3.) This property is optional, and for
- *   non-fungible digital assets, should not be specified. The decimalPlaces
- *   property should be used for _display purposes only_. Any other use is an
- *   anti-pattern.
- * @property {AssetKind} [assetKind]
- */
-
-/**
- * @template {AssetKind} [K=AssetKind]
- * @template {Key} [M=Key] member kind, for Amounts that have member values
- * @typedef {object} Mint Holding a Mint carries the right to issue new digital
- *   assets. These assets all have the same kind, which is called a Brand.
- * @property {() => Issuer<K, M>} getIssuer Gets the Issuer for this mint.
- * @property {(newAmount: Amount<K>) => Payment<K, M>} mintPayment Creates a new
- *   Payment containing newly minted amount.
- */
-
-// /////////////////////////// Purse / Payment /////////////////////////////////
-
-/**
- * Issuers first became durable with mandatory recovery sets. Later they were
- * made optional, but there is no support for converting from one state to the
- * other. Thus, absence of a `RecoverySetsOption` state is equivalent to
- * `'hasRecoverySets'`. In the absence of a `recoverySetsOption` parameter,
- * upgradeIssuerKit defaults to the predecessor's `RecoverySetsOption` state, or
- * `'hasRecoverySets'` if none.
- *
- * At this time, issuers started in one of the states (`'noRecoverySets'`, or
- * `'hasRecoverySets'`) cannot be converted to the other on upgrade. If this
- * transition is needed, it can likely be supported in a future upgrade. File an
- * issue on github and explain what you need and why.
- *
- * @typedef {'hasRecoverySets' | 'noRecoverySets'} RecoverySetsOption
- */
-
-// /////////////////////////// Purse / Payment /////////////////////////////////
-
-/**
- * @callback DepositFacetReceive
- * @param {Payment} payment
- * @param {Pattern} [optAmountShape]
- * @returns {Amount}
- */
-
-/**
- * @typedef {object} DepositFacet
- * @property {DepositFacetReceive} receive Deposit all the contents of payment
- *   into the purse that made this facet, returning the amount. If the optional
- *   argument `optAmount` does not equal the amount of digital assets in the
- *   payment, throw an error.
- *
- *   If payment is a promise, throw an error.
- */
-
-/**
- * @template {AssetKind} [K=AssetKind]
- * @template {Key} [M=Key] member kind, for Amounts that have member values
- * @typedef {RemotableObject & PurseMethods<K, M>} Purse Purses hold amount of
- *   digital assets of the same brand, but unlike Payments, they are not meant
- *   to be sent to others. To transfer digital assets, a Payment should be
- *   withdrawn from a Purse. The amount of digital assets in a purse can change
- *   through the action of deposit() and withdraw().
- */
-
-/**
- * @template {AssetKind} [K=AssetKind]
- * @template {Key} [M=Key] member kind, for Amounts that have member values
- * @typedef {object} PurseMethods The primary use for Purses and Payments is for
- *   currency-like and goods-like digital assets, but they can also be used to
- *   represent other kinds of rights, such as the right to participate in a
- *   particular contract.
- * @property {() => Brand<K>} getAllegedBrand Get the alleged Brand for this
- *   Purse
- * @property {() => Amount<K, M>} getCurrentAmount Get the amount contained in
- *   this purse.
- * @property {() => LatestTopic<Amount<K, M>>} getCurrentAmountNotifier Get a
- *   lossy notifier for changes to this purse's balance.
- * @property {<P extends Payment<K, M>>(
- *   payment: P,
- *   optAmountShape?: Pattern,
- * ) => P extends Payment<K, M> ? Amount<K, M> : never} deposit
- *   Deposit all the contents of payment into this purse, returning the amount. If
- *   the optional argument `optAmount` does not equal the amount of digital
- *   assets in the payment, throw an error.
- *
- *   If payment is a promise, throw an error.
- * @property {() => DepositFacet} getDepositFacet Return an object whose
- *   `receive` method deposits to the current Purse.
- * @property {(amount: Amount<K, M>) => Payment<K, M>} withdraw Withdraw amount
- *   from this purse into a new Payment.
- * @property {() => CopySet<Payment<K, M>>} getRecoverySet The set of payments
- *   withdrawn from this purse that are still live. These are the payments that
- *   can still be recovered in emergencies by, for example, depositing into this
- *   purse. Such a deposit action is like canceling an outstanding check because
- *   you're tired of waiting for it. Once your cancellation is acknowledged, you
- *   can spend the assets at stake on other things. Afterwards, if the recipient
- *   of the original check finally gets around to depositing it, their deposit
- *   fails.
- *
- *   Returns an empty set if this issuer does not support recovery sets.
- * @property {() => Amount<K, M>} recoverAll For use in emergencies, such as
- *   coming back from a traumatic crash and upgrade. This deposits all the
- *   payments in this purse's recovery set into the purse itself, returning the
- *   total amount of assets recovered.
- *
- *   Returns an empty amount if this issuer does not support recovery sets.
- */
-
-/**
- * @template {AssetKind} [K=AssetKind]
- * @template {Key} [M=Key] member kind, for Amounts that have member values
- * @typedef {RemotableObject & PaymentMethods<K>} Payment Payments hold amount
- *   of digital assets of the same brand in transit. Payments can be deposited
- *   in purses, split into multiple payments, combined, and claimed (getting an
- *   exclusive payment). Payments are linear, meaning that either a payment has
- *   the same amount of digital assets it started with, or it is used up
- *   entirely. It is impossible to partially use a payment.
- *
- *   Payments are often received from other actors and therefore should not be
- *   trusted themselves. To get the amount of digital assets in a payment, use
- *   the trusted issuer: issuer.getAmountOf(payment),
- *
- *   Payments can be converted to Purses by getting a trusted issuer and calling
- *   `issuer.makeEmptyPurse()` to create a purse, then
- *   `purse.deposit(payment)`.
- */
-
-/**
- * @template {AssetKind} [K=AssetKind]
- * @typedef {object} PaymentMethods
- * @property {() => Brand<K>} getAllegedBrand Get the allegedBrand, indicating
- *   the type of digital asset this payment purports to be, and which issuer to
- *   use. Because payments are not trusted, any method calls on payments should
- *   be treated with suspicion and verified elsewhere.
- */
-
-// /////////////////////////// MathHelpers /////////////////////////////////////
-
-/**
- * @template {AmountValue} V
- * @typedef {object} MathHelpers All of the difference in how digital asset
- *   amount are manipulated can be reduced to the behavior of the math on
- *   values. We extract this custom logic into mathHelpers. MathHelpers are
- *   about value arithmetic, whereas AmountMath is about amounts, which are the
- *   values labeled with a brand. AmountMath use mathHelpers to do their value
- *   arithmetic, and then brand the results, making a new amount.
- *
- *   The MathHelpers are designed to be called only from AmountMath, and so all
- *   methods but coerce can assume their inputs are valid. They only need to do
- *   output validation, and only when there is a possibility of invalid output.
- * @property {(allegedValue: V) => V} doCoerce Check the kind of this value and
- *   throw if it is not the expected kind.
- * @property {() => V} doMakeEmpty Get the representation for the identity
- *   element (often 0 or an empty array)
- * @property {(value: V) => boolean} doIsEmpty Is the value the identity
- *   element?
- * @property {(left: V, right: V) => boolean} doIsGTE Is the left greater than
- *   or equal to the right?
- * @property {(left: V, right: V) => boolean} doIsEqual Does left equal right?
- * @property {(left: V, right: V) => V} doAdd Return the left combined with the
- *   right.
- * @property {(left: V, right: V) => V} doSubtract Return what remains after
- *   removing the right from the left. If something in the right was not in the
- *   left, we throw an error.
- */
-
-/** @typedef {bigint} NatValue */
-
-/**
- * @template {Key} [K=Key]
- * @typedef {K[]} SetValue
- */