Publish Reserve econ data: mint & burn #5753
Conversation
Chris-Hibbert
added
enhancement
| * @property {Amount<'nat'>} mintedRUN total RUN minted to date | ||
| * @property {Amount<'nat'>} burnedRUN total RUN burned to date |
There was a problem hiding this comment.
let's use Fee instead of RUN per #4800
and per
minted should be second.
"total" helps convey that this is "minted ever" not any other time window.
| * @property {Amount<'nat'>} mintedRUN total RUN minted to date | |
| * @property {Amount<'nat'>} burnedRUN total RUN burned to date | |
| * @property {Amount<'nat'>} totalFeeMinted total Fee minted to date | |
| * @property {Amount<'nat'>} totalFeeBurned total Fee burned to date |
| let mintedRUN = AmountMath.makeEmpty(runBrand); | ||
| let burnedRUN = AmountMath.makeEmpty(runBrand); |
There was a problem hiding this comment.
just noting the variable names should continue to match the metric names
| export const reserveInitialState = emptyRun => ({ | ||
| allocations: {}, | ||
| shortfallBalance: emptyRun, | ||
| burnedRUN: emptyRun, | ||
| mintedRUN: emptyRun, | ||
| }); |
There was a problem hiding this comment.
this is valid only for test-reserve.js so please keep it there
There was a problem hiding this comment.
I hoisted it when the vault test needed it as well. I didn't want the vault test to have to be updated if we add more to the record. I didn't see a better place to put it, and metrics.js is at least under test.
There was a problem hiding this comment.
ah, my mistake that it's used only in test-reserve.js.
| @@ -316,6 +325,7 @@ const start = async (zcf, privateArgs) => { | |||
| }), | |||
| ); | |||
| zcf.reallocate(offerToSeat, collateralSeat); | |||
| updateMetrics(); | |||
There was a problem hiding this comment.
why is this needed here but not after burnedRUN change?
There was a problem hiding this comment.
It is already called in burnRUNToReduceShortfall, because that calls increaseLiquidationShortfall. addLiquiditytoAmmPool mints, but doesn't adjust the shortfall. The shortfall is increased by other contracts that get a shortfallReportingInvitation.
* feature: publish Reserve econ data: mint & burn closes: #4651 * chore: standardize names Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
closes: #4651
Description
Publish key economic data (minting and burning) from the Reserve contract.
Security Considerations
publishing data that should be public. No security concerns.
Documentation Considerations
None.
Testing Considerations
Tested that the values were published.