9220 deprecate getDisplayInfo #9221

turadg · 2024-04-10T21:17:32Z

closes: #9220

Description

get input from @Chris-Hibbert before pursuing further
address FIXMEs (read from boardAux instead)

Security Considerations

Scaling Considerations

Documentation Considerations

Testing Considerations

Upgrade Considerations

erights · 2024-04-10T21:35:21Z

packages/smart-wallet/src/smartWallet.js

-            E(issuer).getDisplayInfo(),
-            E(issuer).makeEmptyPurse(),
-          ]);
+          const [purse] = await Promise.all([E(issuer).makeEmptyPurse()]);


Suggested change

const [purse] = await Promise.all([E(issuer).makeEmptyPurse()]);

const [purse] = await E(issuer).makeEmptyPurse();

I doubt there is ever any point to a singleton call to Promise.all

yeah, this was just a draft. I'm looking for feedback on the approach and consequences. wrt syntax,

Suggested change

const [purse] = await Promise.all([E(issuer).makeEmptyPurse()]);

const purse = await E(issuer).makeEmptyPurse();

I like the overall approach. I love that you moved the ERTP types, with comments, from types.js to types.d.ts. typedoc FTW!

Beyond that, I like all the changes outside ERTP, including the FIXME question. I'm curious about the answer. Because I'm not sure that deprecating brand.getDisplayInfo() is the right thing to do. But I find it plausible.

I recommend proceeding forward. Thanks.

I doubt there is ever any point to a singleton call to Promise.all

I think of it as akin to the dangling comma on single-argument method calls, i.e. to reduce churn in formatting in places were there were multiple operands, and might be again. Do people believe that automated reformatting makes that concern moot?

moot enough, yes. The only remaining gotcha is git's text-line based diff and merge algorithms. But IMO we should not distort our programs too much to accommodate these algos being at the wrong abstraction level. Focus on the human reader/reviewer first.

erights · 2024-04-10T21:36:01Z

packages/smart-wallet/src/walletFactory.js

-          issuerP,
-          E(brand).getDisplayInfo(),
-        ]);
+        const [issuer] = await Promise.all([issuerP]);


Suggested change

const [issuer] = await Promise.all([issuerP]);

const issuer = await issuerP;

Chris-Hibbert

I'm in favor of dropping decimalPlaces from Brands.

Chris-Hibbert · 2024-04-12T18:53:53Z

packages/ERTP/src/types.d.ts

+};
+/**


Is the lack of blank lines between def'ns intentional?

Suggested change

};

/**

};

/**

Chris-Hibbert · 2024-04-12T19:05:00Z

packages/inter-protocol/src/auction/auctionBook.js

@@ -470,6 +470,7 @@ export const prepareAuctionBook = (baggage, zcf, makeRecorderKit) => {
          trace('observing');

          void E.when(
+            // FIXME can this work without decimalPlaces? if so, read from boardAux


This doesn't need decimalPlaces, but would need some scaling factor to replace it. It could use BASIS_POINTS or MILLIONS instead. It just needs something so the resolution of the response is at least nominal. Asking for price quotes on Satoshis or smallest fraction of BLD wouldn't be workable.

Chris-Hibbert · 2024-04-12T21:16:58Z

packages/inter-protocol/src/proposals/addAssetToVault.js

@@ -171,6 +171,7 @@ export const registerScaledPriceAuthority = async (
    ]),
  ]);

+  // FIXME can this work without decimalPlaces? if so, read from boardAux


I suspect this usage requires decimalPlaces. (cc @michaelfig)

// FIXME can this work without decimalPlaces? if so, read from boardAux

This seems backwards. If it can work w/o dp, then it should. If it can't, then it needs an alternative source like boardAux.

I think my description of "unit amounts" as decimalPlaces is causing confusion. I wrote that description when the only source of "unit amount" information was getDisplayInfo().decimalPlaces. The code below can be made to work without getDisplayInfo(), if some alternative like boardAux conveys the same information. But the functionality provided by the code needs some source of "unit amounts".

michaelfig · 2024-04-15T02:01:38Z

packages/inter-protocol/src/proposals/addAssetToVault.js

@@ -171,6 +171,7 @@ export const registerScaledPriceAuthority = async (
    ]),
  ]);

+  // FIXME can this work without decimalPlaces? if so, read from boardAux


I think my description of "unit amounts" as decimalPlaces is causing confusion. I wrote that description when the only source of "unit amount" information was getDisplayInfo().decimalPlaces. The code below can be made to work without getDisplayInfo(), if some alternative like boardAux conveys the same information. But the functionality provided by the code needs some source of "unit amounts".

michaelfig · 2024-04-15T02:02:25Z

packages/inter-protocol/src/proposals/addAssetToVault.js

@@ -171,6 +171,7 @@ export const registerScaledPriceAuthority = async (
    ]),
  ]);

+  // FIXME can this work without decimalPlaces? if so, read from boardAux
  // We need "unit amounts" of each brand in order to get the ratios right.  You
  // can ignore decimalPlaces when adding and subtracting a brand with itself,


Suggested change

// can ignore decimalPlaces when adding and subtracting a brand with itself,

// can ignore "unit amounts" when adding and subtracting a brand with itself,

turadg added 3 commits April 10, 2024 14:02

refactor(types): types.js to .ts

c9a861a

chore: deprecate getDisplayInfo()

d9ff22c

BREAKING CHANGE: omit displayInfo

f9e0b24

erights reviewed Apr 10, 2024

View reviewed changes

Chris-Hibbert reviewed Apr 12, 2024

View reviewed changes

michaelfig reviewed Apr 15, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

9220 deprecate getDisplayInfo #9221

9220 deprecate getDisplayInfo #9221

turadg commented Apr 10, 2024 •

edited

erights Apr 10, 2024

turadg Apr 10, 2024 •

edited

erights Apr 10, 2024

Chris-Hibbert Apr 12, 2024

erights Apr 12, 2024

erights Apr 10, 2024 •

edited

Chris-Hibbert left a comment

Chris-Hibbert Apr 12, 2024

Chris-Hibbert Apr 12, 2024

Chris-Hibbert Apr 12, 2024

michaelfig Apr 15, 2024

michaelfig Apr 15, 2024

michaelfig Apr 15, 2024

	const [purse] = await Promise.all([E(issuer).makeEmptyPurse()]);
	const [purse] = await E(issuer).makeEmptyPurse();

	const [purse] = await Promise.all([E(issuer).makeEmptyPurse()]);
	const purse = await E(issuer).makeEmptyPurse();

	const [issuer] = await Promise.all([issuerP]);
	const issuer = await issuerP;

-};
-/**
+};
+/**

	// can ignore decimalPlaces when adding and subtracting a brand with itself,
	// can ignore "unit amounts" when adding and subtracting a brand with itself,

9220 deprecate getDisplayInfo #9221

Are you sure you want to change the base?

9220 deprecate getDisplayInfo #9221

Conversation

turadg commented Apr 10, 2024 • edited

Description

Security Considerations

Scaling Considerations

Documentation Considerations

Testing Considerations

Upgrade Considerations

Choose a reason for hiding this comment

turadg Apr 10, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

erights Apr 10, 2024 • edited

Choose a reason for hiding this comment

Chris-Hibbert left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

turadg commented Apr 10, 2024 •

edited

turadg Apr 10, 2024 •

edited

erights Apr 10, 2024 •

edited