Price Authority updates #1022
Price Authority updates #1022
Conversation
Deploying documentation with
|
| Latest commit: |
d5e8189
|
| Status: | ⚡️ Build in progress... |
dckc
requested review from
Chris-Hibbert,
turadg,
0xpatrickdev and
kbennett2000
|
This uses typedoc for @agoric/time ; LMK if that should be a separate PR or something. I ran |
|
Can we split out @agoric/time? Once it's separate, I'd like to ask for a half-hour to add some descriptions around |
dckc
force-pushed
the
dc-price-authority
branch
from
80c066c to
c6c9bdd
Compare
dckc
changed the title
ok: #1024 |
| ## E(PriceAuthorityRegistryAdmin).registerPriceAuthority(priceAuthority, brandIn, brandOut, force) | ||
|
|
||
| • **registerPriceAuthority**: (`pa`: `ERef`\<`PriceAuthority`\>, `brandIn`: `Brand`\<`AssetKind`\>, `brandOut`: `Brand`\<`AssetKind`\>, `force?`: `boolean`) => `Promise`\<`Deleter`\> |
There was a problem hiding this comment.
Should this be on a separate page or have a more prominent separator to show that it's different from the PriceAuthority methods?
There was a problem hiding this comment.
ok; moving to separate page
| ##### Returns | ||
|
|
||
| `Promise`\<`Deleter`\> | ||
|
|
||
| #### Defined in | ||
|
|
||
| [priceAuthorityRegistry.js:27](https://github.com/Agoric/agoric-sdk/blob/a8c322206/packages/vats/src/priceAuthorityRegistry.js#L27) |
There was a problem hiding this comment.
These are formatted very differently than the above. Let's make them more similar.
There was a problem hiding this comment.
This formatting comes from typedoc. I'd rather not mess with it. I hope it's less of a problem now that it's on a different page.
There was a problem hiding this comment.
It's enough less obvious.
|
|
||
| [priceAuthorityRegistry.js:27](https://github.com/Agoric/agoric-sdk/blob/a8c322206/packages/vats/src/priceAuthorityRegistry.js#L27) | ||
|
|
||
| ## E(Deleter).delete() |
There was a problem hiding this comment.
This needs some verbiage around it.
I presume it goes on whatever page gets registerPriceAuthority().
There was a problem hiding this comment.
If it needed more verbiage, I would think someone would have added some in the last 4 years...
In fact, I don't even see any tests.
Maybe we should demote it to undocumented?
There was a problem hiding this comment.
I don't think this belongs under Zoe. PriceQuote, too. PriceAuthorities could be under Deployed Zoe Contracts. As far as I'm concerned, it doesn't need a slot in the sidebar, it just has to be linkable.
Hmm. There's a page for RatioMath but it's blank. I wonder what happened there.
There was a problem hiding this comment.
I don't think this belongs under Zoe.
agreed.
PriceAuthorities could be under
Deployed Zoe Contracts.
Good idea! I added it there and changed the navigation around.
I didn't move zoe-api/price-authority.md because that involves redirects and stuff; we can do that later, perhaps.
- PriceAuthorityRegistryAdmin reference - selected BootstrapPermissions += priceAuthority - prune chainlink integration; dup API - prune out-dated / redundant Board docs - refine price authority API link - nav: move price authority under deployed contracts - move price quote data types from zoe to price-authority - add vats to deployed contracts; esp priceAuthority
dckc
force-pushed
the
dc-price-authority
branch
from
f78b8b6 to
d5e8189
Compare
closes #949