feat(ertp): add displayInfo.significantDecimals

Agoric · Nov 5, 2020 · c740a05 · c740a05
1 parent 2d1d425
commit c740a05
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/packages/ERTP/src/displayInfo.js b/packages/ERTP/src/displayInfo.js
@@ -43,7 +43,7 @@ export const assertDisplayInfo = allegedDisplayInfo => {
   if (allegedDisplayInfo === undefined) {
     return;
   }
-  const displayInfoKeys = harden(['decimalPlaces']);
+  const displayInfoKeys = harden(['decimalPlaces', 'significantDecimals']);
   assertKeysAllowed(displayInfoKeys, allegedDisplayInfo);
 };
 

diff --git a/packages/ERTP/src/types.js b/packages/ERTP/src/types.js
@@ -109,6 +109,10 @@
  *   should not be specified.
  *   The decimalPlaces property should be used for *display purposes only*. Any
  *   other use is an anti-pattern.
+ * @property {number=} significantDecimals
+ *   Tells the display software how many decimal places should be conventionally
+ *   shown.  So, if `significantDecimals` is 2, and the rendered value according to
+ *   `decimalPlaces` is '1.200', then this says to trim it to '1.20'.
  */
 
 /**