feat: improve payment network types#1355
Merged
benjlevesque merged 3 commits intomasterfrom Feb 19, 2024
Merged
Conversation
benjlevesque
commented
Feb 15, 2024
Comment on lines
+31
to
+36
| if (!creationParameters.acceptedTokens) { | ||
| throw Error('acceptedTokens is required'); | ||
| } | ||
| if (creationParameters.acceptedTokens.length === 0) { | ||
| throw Error('acceptedTokens cannot be empty'); | ||
| } |
Contributor
Author
There was a problem hiding this comment.
just a change in error message to make it clearer
benjlevesque
commented
Feb 15, 2024
| */ | ||
| export abstract class AnyToAnyDetector< | ||
| TExtension extends ExtensionTypes.PnFeeReferenceBased.IFeeReferenceBased, | ||
| TExtension extends ExtensionTypes.PnFeeReferenceBased.IFeeReferenceBased<any>, |
Contributor
Author
There was a problem hiding this comment.
there are a few any introduced in the type constraints. I think they are fine, as they are only on abstract classes, and concrete implementations enforce a type.
benjlevesque
commented
Feb 15, 2024
Comment on lines
+9
to
+10
| network: EvmChainName; | ||
| acceptedTokens: string[]; |
Contributor
Author
There was a problem hiding this comment.
match what's expected by the PN! 🎉
benjlevesque
commented
Feb 15, 2024
| @@ -51,17 +46,27 @@ export interface IPaymentNetworkCreateParameters<T = any> { | |||
|
|
|||
| export type PaymentNetworkCreateParameters = | |||
Contributor
Author
There was a problem hiding this comment.
the "complexity" of the type prevented usage of Extract
Contributor
There was a problem hiding this comment.
Arg, I remembered struggling with this.
benjlevesque
commented
Feb 15, 2024
Comment on lines
+14
to
+15
| paymentNetworkCreationParameters: TCreationParameters, | ||
| ) => Promise<ExtensionTypes.IAction<any>>; |
Contributor
Author
There was a problem hiding this comment.
slightly more precise...
benjlevesque
commented
Feb 15, 2024
| /** Parameters for the creation action */ | ||
| export type ICreationParameters = PnAnyToAnyConversion.ICreationParameters; | ||
| export type ICreationParameters = Omit<PnAnyToAnyConversion.ICreationParameters, 'network'> & { | ||
| network: ChainName; |
Contributor
Author
There was a problem hiding this comment.
network is mandatory for AnyToEth
github-actions
bot
requested review from
MantisClone,
alexandre-abrioux,
leoslr and
olivier7delf
yomarion
approved these changes
Feb 16, 2024
| @@ -51,17 +46,27 @@ export interface IPaymentNetworkCreateParameters<T = any> { | |||
|
|
|||
| export type PaymentNetworkCreateParameters = | |||
Contributor
There was a problem hiding this comment.
Arg, I remembered struggling with this.
leoslr
approved these changes
Feb 16, 2024
olivier7delf
approved these changes
Feb 19, 2024
alexandre-abrioux
approved these changes
Feb 19, 2024
benjlevesque
force-pushed
the
feat/improve-payment-network-types
branch
from
2c5f8fb to
1381b85
Compare
benjlevesque
force-pushed
the
feat/improve-payment-network-types
branch
from
1381b85 to
0bdf46f
Compare
Member
|
Nice 👍 |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
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.
Make payment network parameters strongly typed, and more precise:
Example