governance types inferred by start functions #7469
Conversation
| * @property {(name: string) => Amount} getAmount | ||
| * @property {(name: string) => Brand} getBrand | ||
| * @property {(name: string) => Instance} getInstance | ||
| * @property {(name: string) => Installation} getInstallation | ||
| * @property {(name: string) => Amount} getInvitationAmount | ||
| * @property {(name: string) => bigint} getNat | ||
| * @property {(name: string) => Ratio} getRatio | ||
| * @property {(name: string) => string} getString | ||
| * @property {(name: string) => any} getUnknown |
There was a problem hiding this comment.
These were a fiction? Or they come back some other way? still reading...
| @@ -304,6 +309,8 @@ const start = async (zcf, privateArgs) => { | |||
| }); | |||
| }; | |||
|
|
|||
| /** @type {GovernorCreatorFacet<SF>} */ | |||
| // @ts-expect-error cast | |||
There was a problem hiding this comment.
this error is a little surprising; aren't we supplying exactly what the type requires?
There was a problem hiding this comment.
It surprised me too. Apparently within the function TS will only trust the minimum of the parameter (what SF is said to extend) which is {}. I tried doing this without an error but timed out
| * @property {() => CF} getLimitedCreatorFacet - the creator | ||
| * @property {() => ERef<CF>} getLimitedCreatorFacet - the creator |
There was a problem hiding this comment.
this was a bug that was hidden behind an any somewhere?
There was a problem hiding this comment.
it's just not exercised. the code calling it never assumed it to be a presence but this is more accurate
| * Akin to StartedInstanceKit but designed for the results of starting governed contracts | ||
| * Akin to StartedInstanceKit but designed for the results of starting governed contracts. Used in bootstrap space. |
| * @typedef {object} AuctioneerKit | ||
| * @property {Awaited<ReturnType<import('../auction/auctioneer.js').start>>['creatorFacet']} creatorFacet | ||
| * @property {Awaited<ReturnType<import('../auction/auctioneer.js').start>>['publicFacet']} publicFacet | ||
| * @property {GovernedContractFacetAccess<{},{}>} governorCreatorFacet | ||
| * @property {AdminFacet} adminFacet | ||
| * @typedef {GovernanceFacetKit<import('../auction/auctioneer.js').start>} AuctioneerKit |
| * governorCreatorFacet: GovernedContractFacetAccess<VaultFactoryPublicFacet, VaultFactoryCreatorFacet>, | ||
| * adminFacet: AdminFacet, | ||
| * }, | ||
| * reserveKit: GovernanceFacetKit<import('../reserve/assetReserve.js')['start']>, |
| reserveKit: { reserveCreatorFacet }, | ||
| reserveKit: { creatorFacet: reserveCreatorFacet }, |
There was a problem hiding this comment.
this was to change less in the test file when renaming reserveCreatorFacet in reserveKit
EDIT: oh but that was erroneous https://github.com/Agoric/agoric-sdk/actions/runs/4759091407/jobs/8458009082?pr=7469
| */ | ||
|
|
||
| /** | ||
| * @see {StartedInstanceKit} | ||
| * @template {GovernableStartFn} SF | ||
| * @typedef GovernanceFacetKit | ||
| * Akin to StartedInstanceKit but designed for the results of starting governed contracts |
unnecessary for legibility
turadg
force-pushed
the
7178-governance-sf
branch
from
0c1bdb1 to
9ffde73
Compare
turadg
added
the
automerge:no-update
refs: #7178
Description
Working on PSM upgrade I got tripped up on some governance facet naming and went down a rabbit hole.
This largely addresses #7178 but I don't want to close that until I'm more confident and have types regression tests.
It also removes
getContractGovernorfrom the governed creatorFacet, per an earlier discussionSecurity Considerations
n/a
Scaling Considerations
n/a
Documentation Considerations
n/a
Testing Considerations
CI and some manual spot checking that errors aren't gone due to
any