fix: make brand optional in the types of getAmountAllocated (#1760)

* fix: make brand optional in the types of `getAmountAllocated` * fix: add assert to fix the types * chore: fix error message in test * chore: change error message in brand assertion Co-authored-by: Chris Hibbert <Chris-Hibbert@users.noreply.github.com> * chore: fix error message Co-authored-by: Chris Hibbert <Chris-Hibbert@users.noreply.github.com>
Agoric · Sep 15, 2020 · 3a98491 · 3a98491
1 parent 1c8aa00
commit 3a98491
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 5 deletions.
diff --git a/packages/zoe/src/contractFacet/seat.js b/packages/zoe/src/contractFacet/seat.js
@@ -73,6 +73,7 @@ export const makeZcfSeatAdminKit = (
       if (currentAllocation[keyword] !== undefined) {
         return currentAllocation[keyword];
       }
+      assert(brand, `A brand must be supplied when the keyword is not defined`);
       return getAmountMath(brand).getEmpty();
     },
     getCurrentAllocation: () => {

diff --git a/packages/zoe/src/contractFacet/types.js b/packages/zoe/src/contractFacet/types.js
@@ -143,7 +143,7 @@
  * @property {() => Notifier<Allocation>} getNotifier
  * @property {() => boolean} hasExited
  * @property {() => ProposalRecord} getProposal
- * @property {(keyword: Keyword, brand: Brand) => Amount} getAmountAllocated
+ * @property {(keyword: Keyword, brand: Brand=) => Amount} getAmountAllocated
  * The brand is used for filling in an empty amount if the `keyword`
  * is not present in the allocation
  * @property {() => Allocation} getCurrentAllocation

diff --git a/packages/zoe/test/unitTests/zcf/test-zcf.js b/packages/zoe/test/unitTests/zcf/test-zcf.js
@@ -795,8 +795,6 @@ test(`zcfSeat.getAmountAllocated from zcf.makeEmptySeatKit`, async t => {
   // Again, mint some gains to change the allocation.
   const { brand: brand2 } = await allocateEasy(zcf, 'Stuff2', zcfSeat, 'B', 6);
 
-  // TODO: make brand optional
-  // https://github.com/Agoric/agoric-sdk/issues/1725
   t.deepEqual(zcfSeat.getAmountAllocated('B'), {
     brand: brand2,
     value: 6,
@@ -807,9 +805,8 @@ test(`zcfSeat.getAmountAllocated from zcf.makeEmptySeatKit`, async t => {
     value: 6,
   });
 
-  // @ts-ignore
   t.throws(() => zcfSeat.getAmountAllocated('DoesNotExist'), {
-    message: `"brand" not found: (an undefined)\nSee console for error data.`,
+    message: `A brand must be supplied when the keyword is not defined`,
   });
 });