docs: document hidden tx summary methods #3408
Open
+35
−5
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Skipped Deployment
|
Dhaiwat10
changed the title
CodSpeed Performance ReportMerging #3408 will not alter performanceComparing Summary
|
Dhaiwat10
requested review from
digorithm,
arboleya,
Torres-ssf,
danielbate,
nedsalk,
petertonysmith94 and
maschad
as code owners
danielbate
reviewed
Nov 20, 2024
| /** @hidden */ | ||
| /** | ||
| * Gets transaction summaries for a given owner/address. | ||
| * @param params - The filters to apply to the query. |
There was a problem hiding this comment.
Missing return type here
| @@ -42,15 +42,24 @@ import type { | |||
| AbiMap, | |||
| } from './types'; | |||
|
|
|||
| /** @hidden */ | |||
| /** | |||
| * Extracts a specific type of receipts from a list of receipts. | |||
There was a problem hiding this comment.
Suggested change
| * Extracts a specific type of receipts from a list of receipts. | |
| * Extracts a specific type of receipt from a list of receipts. | |
| * |
| export function getReceiptsByType<T = TransactionResultReceipt>( | ||
| receipts: TransactionResultReceipt[], | ||
| type: ReceiptType | ||
| ) { | ||
| return (receipts ?? []).filter((r) => r.type === type) as T[]; | ||
| } | ||
|
|
||
| /** @hidden */ | ||
| /** | ||
| * Returns the transaction type's name based on the transaction type enum value. |
There was a problem hiding this comment.
Suggested change
| * Returns the transaction type's name based on the transaction type enum value. | |
| * Returns the transaction type's name based on the transaction type enum value. | |
| * |
| @@ -137,7 +137,10 @@ export interface GetTransactionsSummariesReturns { | |||
| pageInfo: PageInfo; | |||
| } | |||
|
|
|||
| /** @hidden */ | |||
| /** | |||
| * Gets transaction summaries for a given owner/address. | |||
There was a problem hiding this comment.
Suggested change
| * Gets transaction summaries for a given owner/address. | |
| * Gets transaction summaries for a given owner/address. | |
| * |
| @@ -356,7 +372,14 @@ export function getContractCallOperations({ | |||
| }); | |||
| } | |||
|
|
|||
| /** @hidden */ | |||
| /** | |||
| * Extracts a transfer operation from a transaction receipt, determining the addresses and types | |||
There was a problem hiding this comment.
Suggested change
| * Extracts a transfer operation from a transaction receipt, determining the addresses and types | |
| * Extracts a transfer operation from a transaction receipt, determining the addresses and types | |
| * |
|
Coverage Report:
Changed Files:Coverage values did not change👌. |
Torres-ssf
reviewed
Nov 21, 2024
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.
Summary
This PR adds some hidden tx summary methods to the API docs.
Checklist