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.

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

chore: move gas and timeout details to Engine FAQ #4914

Merged
merged 1 commit into from
Oct 3, 2024

Conversation

arcoraven
Copy link
Contributor

@arcoraven arcoraven commented Oct 3, 2024

PR-Codex overview

This PR updates the documentation in page.mdx files related to transaction overrides in the Engine. It includes changes to the JSON format and adds new sections on sending native currency, overriding gas settings, and setting transaction timeouts.

Detailed summary

  • Changed JSON keys from unquoted to quoted in txOverrides.
  • Added a section on sending native currency with txOverrides.value.
  • Added instructions for overriding gas settings with examples.
  • Introduced a warning about transaction timeouts and how to set them with txOverrides.timeoutSeconds.

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

Copy link

changeset-bot bot commented Oct 3, 2024

⚠️ No Changeset found

Latest commit: b2276e9

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

vercel bot commented Oct 3, 2024

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

Name Status Preview Comments Updated (UTC)
docs-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 3, 2024 10:01pm
3 Skipped Deployments
Name Status Preview Comments Updated (UTC)
thirdweb_playground ⬜️ Skipped (Inspect) Oct 3, 2024 10:01pm
thirdweb-www ⬜️ Skipped (Inspect) Oct 3, 2024 10:01pm
wallet-ui ⬜️ Skipped (Inspect) Oct 3, 2024 10:01pm

Copy link

graphite-app bot commented Oct 3, 2024

Your org has enabled the Graphite merge queue for merging into main

Add the label “merge-queue” to the PR and Graphite will automatically add it to the merge queue when it’s ready to merge. Or use the label “hotfix” to add to the merge queue as a hot fix.

You must have a Graphite account and log in to Graphite in order to use the merge queue. Sign up using this link.

@github-actions github-actions bot added the Portal Involves changes to the Portal (docs) codebase. label Oct 3, 2024
@arcoraven arcoraven enabled auto-merge (squash) October 3, 2024 19:47
Copy link

codecov bot commented Oct 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 47.61%. Comparing base (b31ab5a) to head (b2276e9).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #4914   +/-   ##
=======================================
  Coverage   47.61%   47.61%           
=======================================
  Files        1057     1057           
  Lines       57221    57221           
  Branches     3924     3924           
=======================================
  Hits        27246    27246           
  Misses      29286    29286           
  Partials      689      689           
Flag Coverage Δ *Carryforward flag
legacy_packages 65.68% <ø> (ø) Carriedforward from b31ab5a
packages 43.37% <ø> (ø)

*This pull request uses carry forward flags. Click here to find out more.

Copy link
Contributor

github-actions bot commented Oct 3, 2024

size-limit report 📦

Path Size Loading time (3g) Running time (snapdragon) Total time
thirdweb (esm) 41.95 KB (0%) 840 ms (0%) 270 ms (+218.48% 🔺) 1.2 s
thirdweb (cjs) 101.63 KB (0%) 2.1 s (0%) 311 ms (+52.29% 🔺) 2.4 s
thirdweb (minimal + tree-shaking) 4.82 KB (0%) 97 ms (0%) 38 ms (+465.68% 🔺) 135 ms
thirdweb/chains (tree-shaking) 498 B (0%) 10 ms (0%) 59 ms (+1463.38% 🔺) 69 ms
thirdweb/react (minimal + tree-shaking) 17.23 KB (0%) 345 ms (0%) 127 ms (+678.36% 🔺) 472 ms

Copy link

graphite-app bot commented Oct 3, 2024

Merge activity

<!-- start pr-codex -->

## PR-Codex overview
This PR focuses on updating the documentation for transaction settings in the `Engine` feature. It clarifies the structure and usage of `txOverrides` for sending native currency and overriding gas settings, including examples and warnings about transaction timeouts.

### Detailed summary
- Changed keys in `txOverrides` from unquoted to quoted strings in the JSON structure.
- Added a section on sending native currency with examples.
- Introduced a section on overriding gas settings with examples.
- Included a warning about setting a timeout for transactions.
- Added a section on specifying transaction timeouts with examples.

> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your question}`

<!-- end pr-codex -->
@vercel vercel bot temporarily deployed to Preview – thirdweb-www October 3, 2024 21:56 Inactive
@vercel vercel bot temporarily deployed to Preview – thirdweb_playground October 3, 2024 21:56 Inactive
@vercel vercel bot temporarily deployed to Preview – wallet-ui October 3, 2024 21:56 Inactive
@graphite-app graphite-app bot merged commit b2276e9 into main Oct 3, 2024
31 checks passed
@graphite-app graphite-app bot deleted the ph/moveGasTimeoutToFAQ branch October 3, 2024 22:01
@vercel vercel bot temporarily deployed to Production – wallet-ui October 3, 2024 22:01 Inactive
@vercel vercel bot temporarily deployed to Production – thirdweb-www October 3, 2024 22:01 Inactive
@vercel vercel bot temporarily deployed to Production – thirdweb_playground October 3, 2024 22:01 Inactive
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Portal Involves changes to the Portal (docs) codebase.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants