fix(ERTP): now that {} is data, always return a displayInfo object

Agoric · Apr 28, 2021 · fcc0cc4 · fcc0cc4
1 parent 547de45
commit fcc0cc4
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 9 deletions.
diff --git a/packages/ERTP/src/displayInfo.js b/packages/ERTP/src/displayInfo.js
@@ -37,9 +37,6 @@ export const assertKeysAllowed = (allowedKeys, record) => {
 };
 
 export const assertDisplayInfo = allegedDisplayInfo => {
-  if (allegedDisplayInfo === undefined) {
-    return;
-  }
   assert(
     passStyleOf(allegedDisplayInfo) === 'copyRecord',
     X`A displayInfo can only be a pass-by-copy record: ${allegedDisplayInfo}`,
@@ -48,7 +45,11 @@ export const assertDisplayInfo = allegedDisplayInfo => {
   assertKeysAllowed(displayInfoKeys, allegedDisplayInfo);
 };
 
-export const coerceDisplayInfo = allegedDisplayInfo => {
+/**
+ * @param {any} [allegedDisplayInfo={}]
+ * @returns {DisplayInfo}
+ */
+export const coerceDisplayInfo = (allegedDisplayInfo = {}) => {
   allegedDisplayInfo = pureCopy(allegedDisplayInfo);
   assertDisplayInfo(allegedDisplayInfo);
   return allegedDisplayInfo;

diff --git a/packages/ERTP/src/issuer.js b/packages/ERTP/src/issuer.js
@@ -22,10 +22,10 @@ import './types';
 function makeIssuerKit(
   allegedName,
   amountMathKind = MathKind.NAT,
-  displayInfo = undefined,
+  rawDisplayInfo = harden({}),
 ) {
   assert.typeof(allegedName, 'string');
-  displayInfo = coerceDisplayInfo(displayInfo);
+  const displayInfo = coerceDisplayInfo(rawDisplayInfo);
 
   /** @type {Brand} */
   const brand = Far(makeFarName(allegedName, ERTPKind.BRAND), {

diff --git a/packages/ERTP/src/types.js b/packages/ERTP/src/types.js
@@ -289,7 +289,7 @@
  * @callback MakeIssuerKit
  * @param {string} allegedName
  * @param {AmountMathKind} [amountMathKind=MathKind.NAT]
- * @param {DisplayInfo=} [displayInfo=undefined]
+ * @param {DisplayInfo} [displayInfo={}]
  * @returns {IssuerKit}
  *
  * The allegedName becomes part of the brand in asset descriptions. The

diff --git a/packages/ERTP/test/unitTests/test-issuerObj.js b/packages/ERTP/test/unitTests/test-issuerObj.js
@@ -16,7 +16,7 @@ test('issuer.getBrand, brand.isMyIssuer', t => {
   );
   t.is(issuer.getAllegedName(), myBrand.getAllegedName());
   t.is(issuer.getAllegedName(), 'fungible');
-  t.is(brand.getDisplayInfo(), undefined);
+  t.deepEqual(brand.getDisplayInfo(), {});
 });
 
 test('brand.getDisplayInfo()', t => {

diff --git a/packages/zoe/test/unitTests/zcf/test-zcf.js b/packages/zoe/test/unitTests/zcf/test-zcf.js
@@ -378,7 +378,7 @@ test(`zcf.makeZCFMint - NAT`, async t => {
   };
   await testTerms(t, zcf, expected);
   t.is(issuerRecord.mathKind, MathKind.NAT);
-  t.is(issuerRecord.brand.getDisplayInfo(), undefined);
+  t.deepEqual(issuerRecord.brand.getDisplayInfo(), {});
 });
 
 test(`zcf.makeZCFMint - SET`, async t => {