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: migrate other half of the wallet snippets #3365

Open
wants to merge 14 commits into
base: master
Choose a base branch
from
Open

docs: migrate other half of the wallet snippets #3365

wants to merge 14 commits into from
+369 −348

Conversation

maschad
Copy link
Member

@maschad maschad commented Oct 29, 2024 •
edited
Loading

Summary

  • Migrate half the docs snippets for wallets
  • access.test.ts
  • checking-balances-and-coins.test.ts
  • checking-balances.test.ts
  • connectors.test.ts
  • encrypting-and-decrypting-json-wallets.test.ts

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)

@vercel Vercel
Copy link

vercel bot commented Oct 29, 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 Oct 30, 2024 5:33pm
ts-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 30, 2024 5:33pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
ts-docs-api ⬜️ Ignored (Inspect) Oct 30, 2024 5:33pm

@github-actions github-actions bot added the docs Requests pertinent to documentation label Oct 29, 2024
@codspeed-hq CodSpeed HQ
Copy link

codspeed-hq bot commented Oct 29, 2024 •
edited
Loading

CodSpeed Performance Report

Merging #3365 will degrade performances by 32.22%

Comparing mc/docs/update-snippets-wallet (787cb6b) with master (c009812)

Summary

❌ 1 regressions
✅ 17 untouched benchmarks

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

Benchmarks breakdown

Benchmark master mc/docs/update-snippets-wallet Change
❌ should successfully conduct a custom transfer between wallets (x20 times) 50.1 ms 73.9 ms -32.22%

@maschad maschad self-assigned this Oct 29, 2024
@maschad maschad marked this pull request as ready for review October 29, 2024 21:03
petertonysmith94
petertonysmith94 reviewed Oct 30, 2024
View reviewed changes
apps/docs-snippets2/src/wallets/connectors.ts
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we should separate this into connector-methods and fuel-sdk.

Copy link
Member Author

Choose a reason for hiding this comment

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

They are separate, look at the fuel-xyz files in the folder, unless you are referring to the class methods?

Copy link
Contributor

Choose a reason for hiding this comment

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

It was more about the full example for this one, and maybe separating them would help make it more useful.

Copy link
Member Author

Choose a reason for hiding this comment

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

Still not understanding, they are separated into the following files
Screenshot 2024-10-30 at 9 32 23 PM

and the full example unifies them.

Copy link
Contributor

Choose a reason for hiding this comment

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

I don't see the value in the following lines https://github.com/FuelLabs/fuels-ts/pull/3365/files#diff-61aee41fe3e5782171d22cc238b554bcb20ae8e36b76699bd919ecb38e83f369R3-R136 being in the full example.

So I was suggesting to have two separate files for:

apps/docs-snippets2/src/wallets/encrypting-and-decrypting-json-wallets-two.ts Outdated Show resolved Hide resolved
apps/docs-snippets2/src/wallets/encrypting-and-decrypting-wallets.ts Show resolved Hide resolved
apps/docs-snippets2/src/wallets/connectors.ts Outdated Show resolved Hide resolved
apps/docs-snippets2/src/wallets/connectors.ts Outdated Show resolved Hide resolved
apps/docs-snippets2/src/wallets/connectors.ts Outdated Show resolved Hide resolved
apps/docs-snippets2/src/wallets/encrypting-and-decrypting-wallets.ts Show resolved Hide resolved
apps/docs-snippets2/src/wallets/unlocked-to-locked.ts Outdated Show resolved Hide resolved
apps/docs-snippets2/src/wallets/wallet-optional-provider.ts Outdated Show resolved Hide resolved
maschad and others added 5 commits October 30, 2024 05:25
@maschad @petertonysmith94
remove old import
672a4f8 
Co-authored-by: Peter Smith <[email protected]>
@maschad @petertonysmith94
remove old import
a67635a 
Co-authored-by: Peter Smith <[email protected]>
@maschad @petertonysmith94
remove space
781d4f3 
Co-authored-by: Peter Smith <[email protected]>
@maschad @petertonysmith94
adjust imports in snippet
5ff9c3e 
Co-authored-by: Peter Smith <[email protected]>
@maschad @petertonysmith94
remove old import
c3cfbd9 
Co-authored-by: Peter Smith <[email protected]>
@github-actions GitHub Actions
Copy link
Contributor

Coverage Report:

Lines Branches Functions Statements
68.55%(-0.73%) 69.75%(-0.13%) 74.14%(-0.19%) 68.88%(-0.72%)
Changed Files:
Ok File (✨=New File) Lines Branches Functions Statements
🔴 ✨ apps/docs-snippets2/src/wallets/access.ts 0%
(+0%)		 100%
(+100%)		 0%
(+0%)		 0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/wallets/checking-balances-two.ts 0%
(+0%)		 100%
(+100%)		 100%
(+100%)		 0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/wallets/checking-balances.ts 0%
(+0%)		 100%
(+100%)		 100%
(+100%)		 0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/wallets/connectors.ts 0%
(+0%)		 0%
(+0%)		 0%
(+0%)		 0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/wallets/encrypting-and-decrypting-json-wallets-two.ts 0%
(+0%)		 100%
(+100%)		 100%
(+100%)		 0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/wallets/encrypting-and-decrypting-wallets.ts 0%
(+0%)		 100%
(+100%)		 100%
(+100%)		 0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/wallets/fuel-instantiation-one.ts 0%
(+0%)		 100%
(+100%)		 100%
(+100%)		 0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/wallets/fuel-instantiation-options.ts 0%
(+0%)		 100%
(+100%)		 0%
(+0%)		 0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/wallets/fuel-options-storage-local.ts 0%
(+0%)		 100%
(+100%)		 100%
(+100%)		 0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/wallets/fuel-options-storage-memory.ts 0%
(+0%)		 100%
(+100%)		 100%
(+100%)		 0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/wallets/fuel-options-target-object.ts 0%
(+0%)		 0%
(+0%)		 100%
(+100%)		 0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/wallets/locked-to-unlocked.ts 0%
(+0%)		 100%
(+100%)		 100%
(+100%)		 0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/wallets/unlocked-to-locked.ts 0%
(+0%)		 100%
(+100%)		 100%
(+100%)		 0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/wallets/wallet-optional-provider.ts 0%
(+0%)		 100%
(+100%)		 0%
(+0%)		 0%
(+0%)
🔴 packages/account/src/providers/transaction-request/transaction-request.ts 88.57%
(+0%)		 76.71%
(-1.37%)		 84%
(+0%)		 88.81%
(+0%)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

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

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

@Torres-ssf Torres-ssf Awaiting requested review from Torres-ssf Torres-ssf is a code owner

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

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

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

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

At least 3 approving reviews are required to merge this pull request.

Assignees

@maschad maschad

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

Successfully merging this pull request may close these issues.

Migrate snippets from guide/wallets
2 participants
@maschad @petertonysmith94