feat(zoe): add type inference for issuerKeywordRecord in ZCF #9330
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- update ZCF type to accept a generic parameter for issuerKeywordRecord (IKR) - modify StandardTerms and related types to use the issuerKeywordRecord generic - preserve existing default of `<Keyword, <Issuer<any>>` when IKR parameter is undefined
Deploying agoric-sdk with
|
| Latest commit: |
b0e7088
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://4a6f47cb.agoric-sdk.pages.dev |
| Branch Preview URL: | https://pc-zcf-ikr-generic.agoric-sdk.pages.dev |
dckc
reviewed
May 7, 2024
| type ZCF<CT extends unknown = Record<string, unknown>> = { | ||
| type ZCF< | ||
| CT extends unknown = Record<string, unknown>, | ||
| IKR extends Record<Keyword, AssetKind> = Record<Keyword, any>, |
There was a problem hiding this comment.
I hope you'll add some docs.
(again, it sure would be nice to be able to re-use the examples from the tests as docs)
turadg
requested changes
May 8, 2024
Comment on lines
-16
to
-18
| * @typedef {Record<Keyword, Issuer<any>>} IssuerKeywordRecord | ||
| * @typedef {Record<Keyword, ERef<Issuer<any>>>} IssuerPKeywordRecord | ||
| * @typedef {Record<Keyword, Brand<any>>} BrandKeywordRecord |
There was a problem hiding this comment.
these types should be maintained.
when there is a more specific type, it's a concrete type that extends this more general one, not a parameterization of this.
| */ | ||
|
|
||
| /** | ||
| * @template {Record<Keyword, AssetKind>} [IKR=Record<Keyword, any>] |
There was a problem hiding this comment.
Suggested change
| * @template {Record<Keyword, AssetKind>} [IKR=Record<Keyword, any>] | |
| * @template {IssuerKeywordRecord} [IKR=IssuerKeywordRecord] |
| * @typedef {object} StandardTerms | ||
| * @property {IssuerKeywordRecord} issuers - record with | ||
| * @property {IssuerKeywordRecord<IKR>} issuers - record with |
There was a problem hiding this comment.
Suggested change
| * @property {IssuerKeywordRecord<IKR>} issuers - record with | |
| * @property {IKR} issuers - record with |
| * keywords keys, issuer values | ||
| * @property {BrandKeywordRecord} brands - record with keywords | ||
| * @property {BrandKeywordRecord<IKR>} brands - record with keywords |
There was a problem hiding this comment.
this one will take a little type-fu to make a BrandKeywordRecord from an IssuerKeywordRecord. that can be a utility type.
the upside is that brands will be the actual brands
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
closes: #XXXX
refs: #XXXX
Description
IKR(IssuerKeywordRecord) generic parameter toZCFto enable type inference forissuersandbrandsfrom contract termsCollateralorIn.Security Considerations
Scaling Considerations
Documentation Considerations
Testing Considerations
Upgrade Considerations