Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: document hidden tx summary methods #3408

Merged
merged 7 commits into from
Nov 25, 2024
Merged

docs: document hidden tx summary methods #3408

merged 7 commits into from
Nov 25, 2024

Conversation

Dhaiwat10
Copy link
Member

@Dhaiwat10 Dhaiwat10 commented Nov 20, 2024 •
edited by arboleya
Loading

Summary

This PR adds some hidden tx summary methods to the API docs.

Checklist

  • All changes are covered by tests (or not applicable)
  • All changes are documented (or not applicable)
  • I reviewed the entire PR myself (preferably, on GH UI)
  • I described all Breaking Changes (or there's none)

@Dhaiwat10 Dhaiwat10 self-assigned this Nov 20, 2024
@vercel Vercel
Copy link

vercel bot commented Nov 20, 2024 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
fuels-template ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 25, 2024 0:40am
ts-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 25, 2024 0:40am
ts-docs-api ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 25, 2024 0:40am

@Dhaiwat10 Dhaiwat10 changed the title Dp/tx summary docs docs: document hidden tx summary methods Nov 20, 2024
@github-actions github-actions bot added the docs Requests pertinent to documentation label Nov 20, 2024
@codspeed-hq CodSpeed HQ
Copy link

codspeed-hq bot commented Nov 20, 2024 •
edited
Loading

CodSpeed Performance Report

Merging #3408 will degrade performances by 14.85%

Comparing dp/tx-summary-docs (c78e49b) with master (6061481)

Summary

❌ 1 regressions
✅ 17 untouched benchmarks

⚠️ Please fix the performance issues or acknowledge them on CodSpeed.

Benchmarks breakdown

Benchmark master dp/tx-summary-docs Change
❌ should successfully transfer a single asset between wallets (x20 times) 61.1 ms 71.8 ms -14.85%

@Dhaiwat10 Dhaiwat10 marked this pull request as ready for review November 20, 2024 10:54
danielbate
danielbate reviewed Nov 20, 2024
View reviewed changes
Copy link
Contributor

@danielbate danielbate left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nits

packages/account/src/providers/transaction-summary/get-transaction-summary.ts Show resolved Hide resolved
packages/account/src/providers/transaction-summary/operations.ts Outdated Show resolved Hide resolved
packages/account/src/providers/transaction-summary/operations.ts Show resolved Hide resolved
packages/account/src/providers/transaction-summary/get-transaction-summary.ts Show resolved Hide resolved
packages/account/src/providers/transaction-summary/operations.ts Show resolved Hide resolved
Torres-ssf
Torres-ssf reviewed Nov 21, 2024
View reviewed changes
Copy link
Contributor

@Torres-ssf Torres-ssf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Aside @danielbate suggestions, this looks good to me

maschad
maschad reviewed Nov 22, 2024
View reviewed changes
Copy link
Member

@maschad maschad left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good just one comment

packages/account/src/providers/transaction-summary/operations.ts Outdated Show resolved Hide resolved
Dhaiwat10 and others added 2 commits November 25, 2024 16:26
@Dhaiwat10 @maschad
reword
2a84e1d 
Co-authored-by: Chad Nehemiah <[email protected]>
@Dhaiwat10 @danielbate
add space
398709d 
Co-authored-by: Daniel Bate <[email protected]>
@github-actions GitHub Actions
Copy link
Contributor

Coverage Report:

Lines Branches Functions Statements
76.86%(+0%) 70.49%(-0.03%) 75.09%(+0%) 76.96%(+0%)
Changed Files:
Ok File (✨=New File) Lines Branches Functions Statements
🔴 packages/account/src/providers/transaction-request/transaction-request.ts 88.57%
(+0%)		 76.71%
(-1.37%)		 84%
(+0%)		 88.81%
(+0%)

@petertonysmith94 petertonysmith94 merged commit 1f010a8 into master Nov 25, 2024
22 of 25 checks passed
@petertonysmith94 petertonysmith94 deleted the dp/tx-summary-docs branch November 25, 2024 12:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Torres-ssf Torres-ssf Torres-ssf approved these changes

@petertonysmith94 petertonysmith94 petertonysmith94 approved these changes

@danielbate danielbate danielbate approved these changes

@digorithm digorithm Awaiting requested review from digorithm digorithm is a code owner

@arboleya arboleya Awaiting requested review from arboleya arboleya is a code owner

@nedsalk nedsalk Awaiting requested review from nedsalk nedsalk is a code owner

@maschad maschad Awaiting requested review from maschad maschad is a code owner

Assignees

@Dhaiwat10 Dhaiwat10

Labels
docs Requests pertinent to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Document hidden transaction summary methods
5 participants
@Dhaiwat10 @danielbate @maschad @petertonysmith94 @Torres-ssf