chore: clean up

Author: katelynsills

packages/ERTP/src/amountMath.js

@@ -146,8 +146,9 @@ const assertAssetKind = assetKind =>
 /** @type {AmountMath} */
 const AmountMath = {
   make: (brand, allegedValue) => {
-    assertRemotable(brand);
+    assertRemotable(brand, 'brand');
     const h = assertValueGetHelpers(allegedValue);
+    // @ts-ignore Needs better typing to express Value to Helpers relationship
     const value = h.doCoerce(allegedValue);
     return harden({ brand, value });
   },
@@ -165,7 +166,7 @@ const AmountMath = {
   getValue: (brand, amount) => AmountMath.coerce(brand, amount).value,
   makeEmpty: (brand, assetKind = AssetKind.NAT) => {
     assertAssetKind(assetKind);
-    assertRemotable(brand);
+    assertRemotable(brand, 'brand');
     const value = helpers[assetKind].doMakeEmpty();
     return harden({ brand, value });
   },
@@ -204,5 +205,5 @@ const AmountMath = {
 };
 harden(AmountMath);
 
-const getAssetKind = assertValueGetAssetKind;
+const getAssetKind = amount => assertValueGetAssetKind(amount.value);
 export { AmountMath, AssetKind, getAssetKind };

packages/ERTP/src/types.js

@@ -51,51 +51,22 @@
  * @param {Value} allegedValue
  * @returns {Amount}
  *
- * TODO find out how to get this "deprecated" marking recognized,
- * or remove it.
- * @deprecated Use brand-first overload instead
- * @callback AmountMakeValueBrand
- * Please use the brand-first overload. The value-first overload
- * is deprecated and will go way.
- * @param {Value} brand
- * @param {Brand} allegedValue
- * @returns {Amount}
- *
- * @typedef {AmountMakeBrandValue & AmountMakeValueBrand} AmountMake
+ * @typedef {AmountMakeBrandValue} AmountMake
  *
  * @callback AmountCoerceBrandAmount
  * @param {Brand} brand
  * @param {Amount} allegedAmount
  * @returns {Amount}
  *
- * TODO find out how to get this "deprecated" marking recognized,
- * or remove it.
- * @deprecated Use brand-first overload instead
- * @callback AmountCoerceAmountBrand
- * Please use the brand-first overload. The amount-first overload
- * is deprecated and will go way.
- * @param {Amount} brand
- * @param {Brand} allegedAmount
- * @returns {Amount}
- *
- * @typedef {AmountCoerceBrandAmount & AmountCoerceAmountBrand} AmountCoerce
+ * @typedef {AmountCoerceBrandAmount} AmountCoerce
  *
  * @callback AmountGetValueBrandAmount
  * @param {Brand} brand
  * @param {Amount} allegedAmount
  * @returns {Value}
  *
- * TODO find out how to get this "deprecated" marking recognized,
- * or remove it.
- * @deprecated Use brand-first overload instead
- * @callback AmountGetValueAmountBrand
- * Please use the brand-first overload. The amount-first overload
- * is deprecated and will go way.
- * @param {Amount} brand
- * @param {Brand} allegedAmount
- * @returns {Value}
  *
- * @typedef {AmountGetValueBrandAmount & AmountGetValueAmountBrand} AmountGetValue
+ * @typedef {AmountGetValueBrandAmount} AmountGetValue
  */
 
 /**
@@ -110,19 +81,13 @@
  *
  * @property {AmountMake} make
  * Make an amount from a value by adding the brand.
- * Please use the brand-first overload. The value-first overload
- * is deprecated and will go way.
  *
  * @property {AmountCoerce} coerce
  * Make sure this amount is valid enough, and return a corresponding
  * valid amount if so.
- * Please use the brand-first overload. The amount-first overload
- * is deprecated and will go way.
  *
  * @property {AmountGetValue} getValue
  * Extract and return the value.
- * Please use the brand-first overload. The amount-first overload
- * is deprecated and will go way.
  *
  * @property {MakeEmpty} makeEmpty
  * Return the amount representing an empty amount. This is the

packages/ERTP/test/unitTests/mathHelpers/test-natMathHelpers.js

@@ -13,19 +13,21 @@ import { mockBrand } from './mockBrand.js';
 test('natMathHelpers make', t => {
   t.deepEqual(m.make(mockBrand, 4n), { brand: mockBrand, value: 4n });
   // @ts-ignore deliberate invalid arguments for testing
-  t.deepEqual(m.make(mockBrand, 4), { brand: mockBrand, value: 4n });
+  t.throws(() => m.make(mockBrand, 4), {
+    message: 'value 4 must be a bigint or an array, not "number"',
+  });
   t.throws(
     // @ts-ignore deliberate invalid arguments for testing
     () => m.make(mockBrand, 'abc'),
     {
-      message: /value .* must be a Nat or an array/,
+      message: 'value "abc" must be a bigint or an array, not "string"',
     },
     `'abc' is not a nat`,
   );
   t.throws(
     // @ts-ignore deliberate invalid arguments for testing
     () => m.make(mockBrand, -1),
-    { message: /value .* must be a Nat or an array/ },
+    { message: 'value -1 must be a bigint or an array, not "number"' },
     `- 1 is not a valid Nat`,
   );
 });
@@ -35,15 +37,15 @@ test('natMathHelpers make no brand', t => {
     // @ts-ignore deliberate invalid arguments for testing
     () => m.make(4n),
     {
-      message: /The brand "\[4n\]" doesn't look like a brand./,
+      message: '"brand" "[4n]" must be a remotable, not "bigint"',
     },
     `brand is required in make`,
   );
 });
 
 test('natMathHelpers coerce', t => {
   t.deepEqual(
-    m.coerce(mockBrand, { brand: mockBrand, value: 4n }),
+    m.coerce(mockBrand, harden({ brand: mockBrand, value: 4n })),
     {
       brand: mockBrand,
       value: 4n,
@@ -52,14 +54,17 @@ test('natMathHelpers coerce', t => {
   );
   t.throws(
     () =>
-      m.coerce(mockBrand, {
-        brand: Far('otherBrand', {
-          getAllegedName: () => 'somename',
-          isMyIssuer: async () => false,
-          getDisplayInfo: () => ({ assetKind: AssetKind.NAT }),
+      m.coerce(
+        mockBrand,
+        harden({
+          brand: Far('otherBrand', {
+            getAllegedName: () => 'somename',
+            isMyIssuer: async () => false,
+            getDisplayInfo: () => ({ assetKind: AssetKind.NAT }),
+          }),
+          value: 4n,
         }),
-        value: 4n,
-      }),
+      ),
     {
       message: /The brand in the allegedAmount .* in 'coerce' didn't match the specified brand/,
     },
@@ -69,7 +74,7 @@ test('natMathHelpers coerce', t => {
     // @ts-ignore deliberate invalid arguments for testing
     () => m.coerce(3n, mockBrand),
     {
-      message: /The amount .* doesn't look like an amount. Did you pass a value instead?/,
+      message: '"brand" "[3n]" must be a remotable, not "bigint"',
     },
     `coerce needs a brand`,
   );
@@ -80,7 +85,7 @@ test('natMathHelpers coerce no brand', t => {
     // @ts-ignore deliberate invalid arguments for testing
     () => m.coerce(m.make(4n, mockBrand)),
     {
-      message: /The brand {"brand":"\[Alleged: brand\]","value":"\[4n\]"} doesn't look like a brand./,
+      message: '"brand" "[4n]" must be a remotable, not "bigint"',
     },
     `brand is required in coerce`,
   );
@@ -89,15 +94,17 @@ test('natMathHelpers coerce no brand', t => {
 test('natMathHelpers getValue', t => {
   t.is(m.getValue(mockBrand, m.make(mockBrand, 4n)), 4n);
   // @ts-ignore deliberate invalid arguments for testing
-  t.is(m.getValue(mockBrand, m.make(mockBrand, 4)), 4n);
+  t.throws(() => m.getValue(mockBrand, m.make(mockBrand, 4)), {
+    message: 'value 4 must be a bigint or an array, not "number"',
+  });
 });
 
 test('natMathHelpers getValue no brand', t => {
   t.throws(
     // @ts-ignore deliberate invalid arguments for testing
     () => m.getValue(m.make(4n, mockBrand)),
     {
-      message: /The brand {"brand":"\[Alleged: brand\]","value":"\[4n\]"} doesn't look like a brand./,
+      message: '"brand" "[4n]" must be a remotable, not "bigint"',
     },
     `brand is required in getValue`,
   );
@@ -114,38 +121,44 @@ test('natMathHelpers makeEmpty no brand', t => {
     // @ts-ignore deliberate invalid arguments for testing
     () => m.makeEmpty(AssetKind.NAT),
     {
-      message: /The brand .* doesn't look like a brand./,
+      message: '"brand" "nat" must be a remotable, not "string"',
     },
     `make empty no brand`,
   );
 });
 
 test('natMathHelpers isEmpty', t => {
-  t.assert(m.isEmpty({ brand: mockBrand, value: 0n }), `isEmpty(0) is true`);
-  t.falsy(m.isEmpty({ brand: mockBrand, value: 6n }), `isEmpty(6) is false`);
+  t.assert(
+    m.isEmpty(harden({ brand: mockBrand, value: 0n })),
+    `isEmpty(0) is true`,
+  );
+  t.falsy(
+    m.isEmpty(harden({ brand: mockBrand, value: 6n })),
+    `isEmpty(6) is false`,
+  );
   t.assert(m.isEmpty(m.make(mockBrand, 0n)), `isEmpty(0) is true`);
   t.falsy(m.isEmpty(m.make(mockBrand, 6n)), `isEmpty(6) is false`);
   t.throws(
     // @ts-ignore deliberate invalid arguments for testing
     () => m.isEmpty('abc'),
     {
-      message: /The amount .* doesn't look like an amount. Did you pass a value instead?/,
+      message: '"amount" "abc" must be a pass-by-copy record, not "string"',
     },
     `isEmpty('abc') throws because it cannot be coerced`,
   );
   t.throws(
     // @ts-ignore deliberate invalid arguments for testing
-    () => m.isEmpty({ brand: mockBrand, value: 'abc' }),
+    () => m.isEmpty(harden({ brand: mockBrand, value: 'abc' })),
     {
-      message: /value .* must be a Nat or an array/,
+      message: 'value "abc" must be a bigint or an array, not "string"',
     },
     `isEmpty('abc') throws because it cannot be coerced`,
   );
   t.throws(
     // @ts-ignore deliberate invalid arguments for testing
     () => m.isEmpty(0n),
     {
-      message: /The amount .* doesn't look like an amount. Did you pass a value instead?/,
+      message: '"amount" "[0n]" must be a pass-by-copy record, not "bigint"',
     },
     `isEmpty(0) throws because it cannot be coerced`,
   );
@@ -155,7 +168,10 @@ test('natMathHelpers isGTE', t => {
   t.assert(m.isGTE(m.make(mockBrand, 5n), m.make(mockBrand, 3n)), `5 >= 3`);
   t.assert(m.isGTE(m.make(mockBrand, 3n), m.make(mockBrand, 3n)), `3 >= 3`);
   t.falsy(
-    m.isGTE({ brand: mockBrand, value: 3n }, { brand: mockBrand, value: 4n }),
+    m.isGTE(
+      harden({ brand: mockBrand, value: 3n }),
+      harden({ brand: mockBrand, value: 4n }),
+    ),
     `3 < 4`,
   );
 });