refactor: rename fetch to get, object arguments for >2 args methods #93
Conversation
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
…getExecutionReceipts
with >2 arguments, specially if some have same type, it's more descriptive and unambiguous to have them fully specified by name be callers in an object argument, instead of positional arguments
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Coverage Report |
aelmanaa
reviewed
Dec 26, 2025
aelmanaa
reviewed
Dec 26, 2025
| router, | ||
| destChainSelector, | ||
| message, | ||
| }: Parameters<Chain['getFee']>[0]): Promise<bigint> { |
Collaborator
There was a problem hiding this comment.
Why don't you directly reference SendMessageOpts?
Collaborator
Author
There was a problem hiding this comment.
As I had mentioned in message, I want the SoT to be the actual method declarations; in this case, for example, getFee could chose to omit some property from the required type (which is kinda common between getFee, generateUnsignedSendMessage and sendMessage), so referencing the actual method allows that to always stay in sync. The explicit type is used only for docs purpose
Collaborator
Author
There was a problem hiding this comment.
You can even see this now, where getFee omits approveMax, which is common to generateUnsignedSendMessage and sendMessage
aelmanaa
reviewed
Dec 26, 2025
aelmanaa
reviewed
Dec 26, 2025
aelmanaa
reviewed
Dec 26, 2025
aelmanaa
reviewed
Dec 26, 2025
| /** | ||
| * Common options for [[generateUnsignedSendMessage]] and [[sendMessage]] Chain methods | ||
| */ | ||
| export type SendMessageOpts = { |
Collaborator
There was a problem hiding this comment.
Are we reexporting SendMessageOpts and ExecuteReportOpts from index?
Collaborator
Author
There was a problem hiding this comment.
Nope, because I said, I don't want them to be used/referred directly, and instead the actual declarations to be the reference point
aelmanaa
reviewed
Dec 26, 2025
aelmanaa
reviewed
Dec 26, 2025
aelmanaa
reviewed
Dec 26, 2025
| commit?: CCIPCommit, | ||
| hints?: Pick<LogFilter, 'page' | 'watch'>, | ||
| ): AsyncIterableIterator<CCIPExecution> { | ||
| async *getExecutionReceipts({ |
Collaborator
There was a problem hiding this comment.
why we don't use name types for consistency with the other methods?
Collaborator
Author
There was a problem hiding this comment.
Because I don't want those named types to be used, much less these with a single use: I don't want to pollute namespace with type(aliases) which are used only once.
Those 2 which I named (SendMessageOpts, ExecuteReportOpts), are only because they're used (locally) multiple times.
aelmanaa
reviewed
Dec 26, 2025
andrevmatos
force-pushed
the
refactor/get
branch
from
7039eed to
50ff549
Compare
for consistency with other method names
andrevmatos
force-pushed
the
refactor/get
branch
from
4295bb4 to
c6c6e75
Compare
AndresJulia
approved these changes
Dec 26, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
fetch*toget*methods