9220 deprecate getDisplayInfo #9221
Conversation
| @@ -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 | |||
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
why does the code look up getDisplayInfo if a nominal scaling factor suffices? Could this just skip the lookup and use DEFAULT_DECIMALS?
There was a problem hiding this comment.
I think a nominal factor would suffice. When this was built, I didn't think deeply enough to be sure that a nominal factor would be fine, and we had getDisplayInfo, much as I would have preferred that we didn't.
@michaelfig seems to have pointed to some places where he wanted to know what the actual "unit amounts" were. (i.e. "what is the unit of currency?") But for the auction's goals, it just needs to ensure it's not asking for pricing on an amount small enough that the answer won't have sufficient resolution. I think DEFAULT_DECIMALS is good enough for that.
| @@ -171,6 +171,7 @@ export const registerScaledPriceAuthority = async ( | |||
| ]), | |||
| ]); | |||
|
|
|||
| // FIXME can this work without decimalPlaces? if so, read from boardAux | |||
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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".
| @@ -171,6 +171,7 @@ export const registerScaledPriceAuthority = async ( | |||
| ]), | |||
| ]); | |||
|
|
|||
| // FIXME can this work without decimalPlaces? if so, read from boardAux | |||
There was a problem hiding this comment.
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".
turadg
force-pushed
the
9220-deprecate-getDisplayInfo
branch
from
f9e0b24 to
028bc5a
Compare
Deploying agoric-sdk with
|
| Latest commit: |
fff76f3
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://d382aa1b.agoric-sdk.pages.dev |
| Branch Preview URL: | https://9220-deprecate-getdisplayinf.agoric-sdk.pages.dev |
|
I've punted removal to #10235 and left this one as just about deprecation |
turadg
force-pushed
the
9220-deprecate-getDisplayInfo
branch
from
4413fb6 to
fff76f3
Compare
closes: #9220
Description
Deprecate
getDisplayInfoso we don't use it more.Point TODOs to removing it: #10235
Removes the use in auctionBook by using a fixed scaling factor
Also converts the JSDoc types to
.tsso@deprecatedcan be usedSecurity Considerations
None yet but #10235 will change the source of decimal places
Scaling Considerations
none
Documentation Considerations
https://docs.agoric.com/reference/ertp-api/brand.html#abrand-getdisplayinfo will need updating.
Testing Considerations
Upgrade Considerations