@agoric/ertp 0.16.3-dev-5dc325b.0 → 0.16.3-getting-started-dev-26244e8.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/ertp",
-  "version": "0.16.3-dev-5dc325b.0+5dc325b",
+  "version": "0.16.3-getting-started-dev-26244e8.0+26244e8",
   "description": "Electronic Rights Transfer Protocol (ERTP). A smart contract framework for exchanging electronic rights",
   "type": "module",
   "main": "src/index.js",
@@ -9,7 +9,7 @@
   },
   "scripts": {
     "build": "exit 0",
-    "prepack": "echo \"export {}; \" | cat - src/types-ambient.js > src/types.js && tsc --build --clean tsconfig.build.json",
+    "prepack": "echo \"export {}; \" | cat - src/types-ambient.js > src/types.js && tsc --build jsconfig.build.json",
     "postpack": "git clean -f '*.d.ts*' src/types.js",
     "test": "ava",
     "test:c8": "c8 $C8_OPTIONS ava",
@@ -19,7 +19,7 @@
     "lint-fix": "yarn lint:eslint --fix",
     "lint": "run-s --continue-on-error lint:*",
     "lint:eslint": "eslint .",
-    "lint:types": "tsc"
+    "lint:types": "tsc -p jsconfig.json"
   },
   "repository": {
     "type": "git",
@@ -39,22 +39,21 @@
   },
   "homepage": "https://github.com/Agoric/agoric-sdk#readme",
   "dependencies": {
-    "@agoric/assert": "0.6.1-dev-5dc325b.0+5dc325b",
-    "@agoric/notifier": "0.6.3-dev-5dc325b.0+5dc325b",
-    "@agoric/store": "0.9.3-dev-5dc325b.0+5dc325b",
-    "@agoric/vat-data": "0.5.3-dev-5dc325b.0+5dc325b",
-    "@endo/eventual-send": "^0.17.5",
-    "@endo/far": "^0.2.21",
-    "@endo/marshal": "^0.8.8",
-    "@endo/nat": "^4.1.30",
-    "@endo/patterns": "^0.2.5",
-    "@endo/promise-kit": "^0.2.59"
+    "@agoric/assert": "0.6.1-getting-started-dev-26244e8.0+26244e8",
+    "@agoric/notifier": "0.6.3-getting-started-dev-26244e8.0+26244e8",
+    "@agoric/store": "0.9.3-getting-started-dev-26244e8.0+26244e8",
+    "@agoric/swingset-vat": "0.32.3-getting-started-dev-26244e8.0+26244e8",
+    "@agoric/vat-data": "0.5.3-getting-started-dev-26244e8.0+26244e8",
+    "@endo/eventual-send": "0.17.2",
+    "@endo/far": "0.2.18",
+    "@endo/marshal": "0.8.5",
+    "@endo/nat": "4.1.27",
+    "@endo/promise-kit": "0.2.56"
   },
   "devDependencies": {
-    "@agoric/swingset-vat": "0.32.3-dev-5dc325b.0+5dc325b",
-    "@endo/bundle-source": "^2.7.0",
-    "@fast-check/ava": "^1.1.5",
-    "ava": "^5.3.0",
+    "@endo/bundle-source": "2.5.2-upstream-rollup",
+    "@fast-check/ava": "^1.1.3",
+    "ava": "^5.2.0",
     "tsd": "^0.28.1"
   },
   "files": [
@@ -75,16 +74,10 @@
     "files": [
       "test/**/test-*.js"
     ],
-    "require": [
-      "@endo/init/debug.js"
-    ],
     "timeout": "5m"
   },
   "publishConfig": {
     "access": "public"
   },
-  "typeCoverage": {
-    "atLeast": 90.37
-  },
-  "gitHead": "5dc325b8cc1d94f46ecc18a7c67a14989feade11"
+  "gitHead": "26244e821f1a83cd5868f0c7d54aa480c8c17e5e"
 }

package/src/amountMath.d.ts

@@ -0,0 +1,53 @@
+export function assertValueGetHelpers<V extends AmountValue>(value: V): MathHelpers<V>;
+export namespace AmountMath {
+    export function make<K extends AssetKind>(brand: Brand<K>, allegedValue: AssetValueForKind<K>): Amount<K>;
+    export function coerce<K extends AssetKind>(brand: Brand<K>, allegedAmount: Amount<K>): Amount<K>;
+    export function getValue<K extends AssetKind>(brand: Brand<K>, amount: Amount<K>): AssetValueForKind<K>;
+    export const makeEmpty: {
+        (brand: Brand<AssetKind>): Amount<"nat">;
+        <K extends AssetKind>(brand: Brand<AssetKind>, assetKind: K): Amount<K>;
+    };
+    export function makeEmptyFromAmount<K extends AssetKind>(amount: Amount<K>): Amount<K>;
+    export function isEmpty(amount: Amount<AssetKind>, brand?: Brand<AssetKind> | undefined): boolean;
+    export { isGTE };
+    export function isEqual<K extends AssetKind>(leftAmount: Amount<K>, rightAmount: Amount<K>, brand?: Brand<K> | undefined): boolean;
+    export function add<K extends AssetKind>(leftAmount: Amount<K>, rightAmount: Amount<K>, brand?: Brand<K> | undefined): Amount<K>;
+    export function subtract<K extends AssetKind>(leftAmount: Amount<K>, rightAmount: Amount<K>, brand?: Brand<K> | undefined): Amount<K>;
+    export function min<K extends AssetKind>(x: Amount<K>, y: Amount<K>, brand?: Brand<K> | undefined): Amount<K>;
+    export function max<K extends AssetKind>(x: Amount<K>, y: Amount<K>, brand?: Brand<K> | undefined): Amount<K>;
+}
+/**
+ * Constants for the kinds of assets we support.
+ *
+ * @type {{ NAT: 'nat', SET: 'set', COPY_SET: 'copySet', COPY_BAG: 'copyBag' }}
+ */
+export const AssetKind: {
+    NAT: 'nat';
+    SET: 'set';
+    COPY_SET: 'copySet';
+    COPY_BAG: 'copyBag';
+};
+/**
+ * @param {Amount} amount
+ */
+export function getAssetKind(amount: Amount): AssetKindForValue<V>;
+/**
+ * @param {AssetKind} allegedAK
+ */
+export function assertAssetKind(allegedAK: AssetKind): void;
+/**
+ * Returns true if the leftAmount is greater than or equal to the
+ * rightAmount. The notion of "greater than or equal to" depends
+ * on the kind of amount, as defined by the MathHelpers. For example,
+ * whether rectangle A is greater than rectangle B depends on whether rectangle
+ * A includes rectangle B as defined by the logic in MathHelpers.
+ *
+ * @template {AssetKind} K
+ * @param {Amount<K>} leftAmount
+ * @param {Amount<K>} rightAmount
+ * @param {Brand<K>} [brand]
+ * @returns {boolean}
+ */
+declare function isGTE<K extends AssetKind>(leftAmount: Amount<K>, rightAmount: Amount<K>, brand?: Brand<K> | undefined): boolean;
+export {};
+//# sourceMappingURL=amountMath.d.ts.map

package/src/amountMath.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"amountMath.d.ts","sourceRoot":"","sources":["amountMath.js"],"names":[],"mappings":"AAuHO,uFAEkC;;IAyFjC,0GAKL;IAUO,kGAQP;IASS,wGAAyD;;;;;IAwB9C,uFAOpB;IAQQ,kGAOR;;IAYQ,mIAGR;IAcI,iIAIJ;IAeS,sIAIT;IAUI,8GAMqC;IAUrC,8GAMqC;;AA1W5C;;;;GAIG;AACH,wBAFU;IAAE,GAAG,EAAE,KAAK,CAAC;IAAC,GAAG,EAAE,KAAK,CAAC;IAAC,QAAQ,EAAE,SAAS,CAAC;IAAC,QAAQ,EAAE,SAAS,CAAA;CAAE,CAO3E;AAoWH;;GAEG;AACH,qCAFW,MAAM,wBAOhB;AAzWD;;GAEG;AACH,2CAFW,SAAS,QAKnB;AAgJD;;;;;;;;;;;;GAYG;AACH,0HAFa,OAAO,CAKnB"}

package/src/amountMath.js

@@ -11,12 +11,7 @@ const { quote: q, Fail } = assert;
 /**
  * Constants for the kinds of assets we support.
  *
- * @type {{
- *   NAT: 'nat';
- *   SET: 'set';
- *   COPY_SET: 'copySet';
- *   COPY_BAG: 'copyBag';
- * }}
+ * @type {{ NAT: 'nat', SET: 'set', COPY_SET: 'copySet', COPY_BAG: 'copyBag' }}
  */
 const AssetKind = harden({
   NAT: 'nat',
@@ -26,7 +21,9 @@ const AssetKind = harden({
 });
 const assetKindNames = harden(Object.values(AssetKind).sort());
 
-/** @param {AssetKind} allegedAK */
+/**
+ * @param {AssetKind} allegedAK
+ */
 const assertAssetKind = allegedAK => {
   assetKindNames.includes(allegedAK) ||
     Fail`The assetKind ${allegedAK} must be one of ${q(assetKindNames)}`;
@@ -34,37 +31,42 @@ const assertAssetKind = allegedAK => {
 harden(assertAssetKind);
 
 /**
- * Amounts describe digital assets. From an amount, you can learn the brand of
- * digital asset as well as "how much" or "how many". Amounts have two parts: a
- * brand (loosely speaking, the type of digital asset) and the value (the answer
- * to "how much"). For example, in the phrase "5 bucks", "bucks" takes the role
- * of the brand and the value is 5. Amounts can describe fungible and
- * non-fungible digital assets. Amounts are pass-by-copy and can be made by and
- * sent to anyone.
+ * Amounts describe digital assets. From an amount, you can learn the
+ * brand of digital asset as well as "how much" or "how many". Amounts
+ * have two parts: a brand (loosely speaking, the type of digital
+ * asset) and the value (the answer to "how much"). For example, in
+ * the phrase "5 bucks", "bucks" takes the role of the brand and the
+ * value is 5. Amounts can describe fungible and non-fungible digital
+ * assets. Amounts are pass-by-copy and can be made by and sent to
+ * anyone.
  *
- * The issuer is the authoritative source of the amount in payments and purses.
- * The issuer must be able to do things such as add digital assets to a purse
- * and withdraw digital assets from a purse. To do so, it must know how to add
- * and subtract digital assets. Rather than hard-coding a particular solution,
- * we chose to parameterize the issuer with a collection of polymorphic
- * functions, which we call `AmountMath`. These math functions include concepts
+ * The issuer is the authoritative source of the amount in payments
+ * and purses. The issuer must be able to do things such as add
+ * digital assets to a purse and withdraw digital assets from a purse.
+ * To do so, it must know how to add and subtract digital assets.
+ * Rather than hard-coding a particular solution, we chose to
+ * parameterize the issuer with a collection of polymorphic functions,
+ * which we call `AmountMath`. These math functions include concepts
  * like addition, subtraction, and greater than or equal to.
  *
- * We also want to make sure there is no confusion as to what kind of asset we
- * are using. Thus, AmountMath includes checks of the `brand`, the unique
- * identifier for the type of digital asset. If the wrong brand is used in
- * AmountMath, an error is thrown and the operation does not succeed.
+ * We also want to make sure there is no confusion as to what kind of
+ * asset we are using. Thus, AmountMath includes checks of the
+ * `brand`, the unique identifier for the type of digital asset. If
+ * the wrong brand is used in AmountMath, an error is thrown and the
+ * operation does not succeed.
  *
- * AmountMath uses mathHelpers to do most of the work, but then adds the brand
- * to the result. The function `value` gets the value from the amount by
- * removing the brand (amount -> value), and the function `make` adds the brand
- * to produce an amount (value -> amount). The function `coerce` takes an amount
- * and checks it, returning an amount (amount -> amount).
+ * AmountMath uses mathHelpers to do most of the work, but then adds
+ * the brand to the result. The function `value` gets the value from
+ * the amount by removing the brand (amount -> value), and the
+ * function `make` adds the brand to produce an amount (value ->
+ * amount). The function `coerce` takes an amount and checks it,
+ * returning an amount (amount -> amount).
  *
- * Each issuer of digital assets has an associated brand in a one-to-one
- * mapping. In untrusted contexts, such as in analyzing payments and amounts, we
- * can get the brand and find the issuer which matches the brand. The issuer and
- * the brand mutually validate each other.
+ * Each issuer of digital assets has an associated brand in a
+ * one-to-one mapping. In untrusted contexts, such as in analyzing
+ * payments and amounts, we can get the brand and find the issuer
+ * which matches the brand. The issuer and the brand mutually validate
+ * each other.
  */
 
 const helpers = {
@@ -135,7 +137,7 @@ const optionalBrandCheck = (allegedBrand, brand) => {
  * @param {Amount<K>} leftAmount
  * @param {Amount<K>} rightAmount
  * @param {Brand<K> | undefined} brand
- * @returns {MathHelpers<any>}
+ * @returns {MathHelpers<*>}
  */
 const checkLRAndGetHelpers = (leftAmount, rightAmount, brand = undefined) => {
   assertRecord(leftAmount, 'leftAmount');
@@ -170,11 +172,11 @@ const coerceLR = (h, leftAmount, rightAmount) => {
 };
 
 /**
- * Returns true if the leftAmount is greater than or equal to the rightAmount.
- * The notion of "greater than or equal to" depends on the kind of amount, as
- * defined by the MathHelpers. For example, whether rectangle A is greater than
- * rectangle B depends on whether rectangle A includes rectangle B as defined by
- * the logic in MathHelpers.
+ * Returns true if the leftAmount is greater than or equal to the
+ * rightAmount. The notion of "greater than or equal to" depends
+ * on the kind of amount, as defined by the MathHelpers. For example,
+ * whether rectangle A is greater than rectangle B depends on whether rectangle
+ * A includes rectangle B as defined by the logic in MathHelpers.
  *
  * @template {AssetKind} K
  * @param {Amount<K>} leftAmount
@@ -192,8 +194,9 @@ const isGTE = (leftAmount, rightAmount, brand = undefined) => {
  *
  * Amounts are the canonical description of tradable goods. They are manipulated
  * by issuers and mints, and represent the goods and currency carried by purses
- * and payments. They can be used to represent things like currency, stock, and
- * the abstract right to participate in a particular exchange.
+ * and
+ * payments. They can be used to represent things like currency, stock, and the
+ * abstract right to participate in a particular exchange.
  */
 const AmountMath = {
   /**
@@ -212,8 +215,8 @@ const AmountMath = {
     return harden({ brand, value });
   },
   /**
-   * Make sure this amount is valid enough, and return a corresponding valid
-   * amount if so.
+   * Make sure this amount is valid enough, and return a corresponding
+   * valid amount if so.
    *
    * @template {AssetKind} K
    * @param {Brand<K>} brand
@@ -239,8 +242,8 @@ const AmountMath = {
    */
   getValue: (brand, amount) => AmountMath.coerce(brand, amount).value,
   /**
-   * Return the amount representing an empty amount. This is the identity
-   * element for MathHelpers.add and MatHelpers.subtract.
+   * Return the amount representing an empty amount. This is the
+   * identity element for MathHelpers.add and MatHelpers.subtract.
    *
    * @type {{
    *   (brand: Brand): Amount<'nat'>;
@@ -254,8 +257,8 @@ const AmountMath = {
     return harden({ brand, value });
   },
   /**
-   * Return the amount representing an empty amount, using another amount as the
-   * template for the brand and assetKind.
+   * Return the amount representing an empty amount, using another
+   * amount as the template for the brand and assetKind.
    *
    * @template {AssetKind} K
    * @param {Amount<K>} amount
@@ -286,8 +289,8 @@ const AmountMath = {
   },
   isGTE,
   /**
-   * Returns true if the leftAmount equals the rightAmount. We assume that if
-   * isGTE is true in both directions, isEqual is also true
+   * Returns true if the leftAmount equals the rightAmount. We assume
+   * that if isGTE is true in both directions, isEqual is also true
    *
    * @template {AssetKind} K
    * @param {Amount<K>} leftAmount
@@ -303,8 +306,8 @@ const AmountMath = {
    * Returns a new amount that is the union of both leftAmount and rightAmount.
    *
    * For fungible amount this means adding the values. For other kinds of
-   * amount, it usually means including all of the elements from both left and
-   * right.
+   * amount, it usually means including all of the elements from both
+   * left and right.
    *
    * @template {AssetKind} K
    * @param {Amount<K>} leftAmount
@@ -318,11 +321,12 @@ const AmountMath = {
     return harden({ brand: leftAmount.brand, value });
   },
   /**
-   * Returns a new amount that is the leftAmount minus the rightAmount (i.e.
-   * everything in the leftAmount that is not in the rightAmount). If leftAmount
-   * doesn't include rightAmount (subtraction results in a negative), throw an
-   * error. Because the left amount must include the right amount, this is NOT
-   * equivalent to set subtraction.
+   * Returns a new amount that is the leftAmount minus the rightAmount
+   * (i.e. everything in the leftAmount that is not in the
+   * rightAmount). If leftAmount doesn't include rightAmount
+   * (subtraction results in a negative), throw  an error. Because the
+   * left amount must include the right amount, this is NOT equivalent
+   * to set subtraction.
    *
    * @template {AssetKind} K
    * @param {Amount<K>} leftAmount
@@ -370,7 +374,9 @@ const AmountMath = {
 };
 harden(AmountMath);
 
-/** @param {Amount} amount */
+/**
+ * @param {Amount} amount
+ */
 const getAssetKind = amount => {
   assertRecord(amount, 'amount');
   const { value } = amount;

package/src/displayInfo.d.ts

@@ -0,0 +1,2 @@
+export function coerceDisplayInfo(allegedDisplayInfo: AdditionalDisplayInfo, assetKind: AssetKind): DisplayInfo;
+//# sourceMappingURL=displayInfo.d.ts.map

package/src/displayInfo.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"displayInfo.d.ts","sourceRoot":"","sources":["displayInfo.js"],"names":[],"mappings":"AAYO,sDAJI,qBAAqB,aACrB,SAAS,GACP,WAAW,CAiBvB"}

package/src/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./amountMath.js";
+export * from "./issuerKit.js";
+export * from "./typeGuards.js";
+//# sourceMappingURL=index.d.ts.map

package/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.js"],"names":[],"mappings":""}

package/src/issuerKit.d.ts

@@ -0,0 +1,19 @@
+export function prepareIssuerKit<K extends AssetKind>(issuerBaggage: MapStore<string, unknown>, optShutdownWithFailure?: import("@agoric/swingset-vat").ShutdownWithFailure | undefined): IssuerKit<K>;
+export function hasIssuer(baggage: MapStore<string, unknown>): any;
+export function makeDurableIssuerKit<K extends AssetKind>(issuerBaggage: MapStore<string, unknown>, name: string, assetKind?: K | undefined, displayInfo?: AdditionalDisplayInfo | undefined, optShutdownWithFailure?: import("@agoric/swingset-vat").ShutdownWithFailure | undefined, { elementShape }?: Partial<{
+    elementShape: Pattern;
+}> | undefined): IssuerKit<K>;
+export function makeIssuerKit<K extends AssetKind = "nat">(name: string, assetKind?: K | undefined, displayInfo?: AdditionalDisplayInfo | undefined, optShutdownWithFailure?: import("@agoric/swingset-vat").ShutdownWithFailure | undefined, { elementShape }?: Partial<{
+    elementShape: Pattern;
+}> | undefined): IssuerKit<K>;
+export type Baggage = import('@agoric/vat-data').Baggage;
+export type IssuerRecord<K extends AssetKind> = {
+    name: string;
+    assetKind: K;
+    displayInfo: AdditionalDisplayInfo;
+    elementShape: Pattern;
+};
+export type IssuerOptionsRecord = Partial<{
+    elementShape: Pattern;
+}>;
+//# sourceMappingURL=issuerKit.d.ts.map

package/src/issuerKit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"issuerKit.d.ts","sourceRoot":"","sources":["issuerKit.js"],"names":[],"mappings":"AA2FO,uMAMN;AASM,mEAAsD;AAmCtD,0GAbI,MAAM;kBAnBmB,OAAO;8BA4C1C;AA+BM,iEAbI,MAAM;kBA9DmB,OAAO;8BA0FxC;sBA3LW,OAAO,kBAAkB,EAAE,OAAO;;UAKlC,MAAM;eACN,CAAC;iBACD,qBAAqB;kBACrB,OAAO;;kCAyFR,QAAQ;IAAC,YAAY,EAAE,OAAO,CAAA;CAAC,CAAC"}