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: added assets guide #3189

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

docs: added assets guide #3189

wants to merge 4 commits into from

Conversation

petertonysmith94
Copy link
Contributor

Closes TS-658

Release notes

In this release, we:

  • Added documentation for using assets

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)

@petertonysmith94 petertonysmith94 added the docs Requests pertinent to documentation label Sep 19, 2024
@petertonysmith94 petertonysmith94 self-assigned this Sep 19, 2024
@vercel Vercel
Copy link

vercel bot commented Sep 19, 2024 •
edited
Loading

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

Name Status Preview Comments Updated (UTC)
create-fuels-template ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 19, 2024 4:44pm
ts-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 19, 2024 4:44pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
create-fuels-counter-example ⬜️ Ignored (Inspect) Sep 19, 2024 4:44pm

@codspeed-hq CodSpeed HQ
Copy link

codspeed-hq bot commented Sep 19, 2024 •
edited
Loading

CodSpeed Performance Report

Merging #3189 will improve performances by ×2.8

Comparing ps/docs/add-assets-guide (f11e495) with master (48db506)

Summary

⚡ 3 improvements
✅ 18 untouched benchmarks

Benchmarks breakdown

Benchmark master ps/docs/add-assets-guide Change
⚡ should successfully execute a contract deploy 186.6 ms 101.4 ms +84%
⚡ Instantiate a new Unlocked wallet 106.2 ms 38.3 ms ×2.8
⚡ Instantiate from an address 31.7 ms 28.5 ms +11.34%

maschad
maschad reviewed Sep 19, 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.

Nice work @petertonysmith94 , given getAssetFuel and getAssetEth return an amalgamation of the NetworkFuel and NetworkEthereum types respectively, do you think we should just link to those types in the docs as well?

apps/docs/src/guide/utilities/using-assets.md Outdated Show resolved Hide resolved
@petertonysmith94
Copy link
Contributor Author

@maschad like so?

f11e495

@github-actions GitHub Actions
Copy link
Contributor

Coverage Report:

Lines Branches Functions Statements
77.16%(+0%) 71.78%(-0.03%) 75.77%(+0%) 77.27%(+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%)

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

@LuizAsFight LuizAsFight LuizAsFight approved these changes

@maschad maschad maschad 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

@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

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

Assignees

@petertonysmith94 petertonysmith94

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

Successfully merging this pull request may close these issues.

Document assets usage
3 participants
@petertonysmith94 @LuizAsFight @maschad