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

docs: proxy contract cookbook #3253

Draft
wants to merge 23 commits into
base: master
Choose a base branch
from

Conversation

danielbate
Copy link
Contributor

@danielbate danielbate commented Oct 5, 2024

Release notes

In this release, we:

  • Added a cookbook for deploying and manually upgrading by proxy contract

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)

@danielbate danielbate added the docs Requests pertinent to documentation label Oct 5, 2024
@danielbate danielbate self-assigned this Oct 5, 2024
Copy link

vercel bot commented Oct 5, 2024

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

Copy link

codspeed-hq bot commented Oct 5, 2024

CodSpeed Performance Report

Merging #3253 will degrade performances by 30.59%

Comparing db/chore/manual-proxy-contracts (3eccadc) with master (64598d6)

Summary

❌ 1 regressions
✅ 17 untouched benchmarks

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

Benchmarks breakdown

Benchmark master db/chore/manual-proxy-contracts Change
should successfully conduct a custom transfer between wallets (x20 times) 49 ms 70.6 ms -30.59%

@danielbate danielbate changed the base branch from next to master October 9, 2024 06:40
Copy link
Member

@Dhaiwat10 Dhaiwat10 left a comment

Choose a reason for hiding this comment

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

Awesome work mate, just some typos:

apps/docs/src/guide/contracts/proxy-contracts.md Outdated Show resolved Hide resolved
apps/docs/src/guide/contracts/proxy-contracts.md Outdated Show resolved Hide resolved
Torres-ssf
Torres-ssf previously approved these changes Oct 17, 2024
@Torres-ssf Torres-ssf marked this pull request as draft October 21, 2024 13:28
Copy link
Contributor

Coverage Report:

Lines Branches Functions Statements
70.74%(-2.13%) 70.03%(-0.21%) 74.52%(-0.11%) 71.07%(-2.06%)
Changed Files:
Ok File (✨=New File) Lines Branches Functions Statements
🔴 ✨ apps/docs-snippets2/src/contracts/proxy-contracts.ts 0%
(+0%)
100%
(+100%)
100%
(+100%)
0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/create-fuels/decrement-counter.ts 0%
(+0%)
100%
(+100%)
100%
(+100%)
0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/encoding/encode-and-decode.ts 0%
(+0%)
100%
(+100%)
0%
(+0%)
0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/encoding/working-with-bytes.ts 0%
(+0%)
100%
(+100%)
100%
(+100%)
0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/scripts/deploying-scripts.ts 0%
(+0%)
100%
(+100%)
100%
(+100%)
0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/scripts/script-custom-transaction.ts 0%
(+0%)
100%
(+100%)
100%
(+100%)
0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/scripts/script-with-configurable.ts 0%
(+0%)
100%
(+100%)
100%
(+100%)
0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/testing/launching-a-test-node.ts 0%
(+0%)
100%
(+100%)
100%
(+100%)
0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/testing/tweaking-the-blockchain.ts 0%
(+0%)
0%
(+0%)
100%
(+100%)
0%
(+0%)
🔴 apps/docs-snippets2/src/typegend/contracts/Counter.ts 83.33%
(+16.67%)
100%
(+0%)
50%
(+50%)
83.33%
(+16.67%)
🔴 ✨ apps/docs-snippets2/src/typegend/contracts/CounterV2.ts 83.33%
(+83.33%)
100%
(+100%)
50%
(+50%)
83.33%
(+83.33%)
✨ apps/docs-snippets2/src/typegend/contracts/CounterV2Factory.ts 100%
(+100%)
100%
(+100%)
100%
(+100%)
100%
(+100%)
🔴 ✨ apps/docs-snippets2/src/typegend/contracts/Proxy.ts 83.33%
(+83.33%)
100%
(+100%)
75%
(+75%)
91.66%
(+91.66%)
🔴 ✨ apps/docs-snippets2/src/typegend/contracts/ProxyFactory.ts 66.66%
(+66.66%)
0%
(+0%)
66.66%
(+66.66%)
66.66%
(+66.66%)
🔴 ✨ apps/docs-snippets2/src/typegend/predicates/SimplePredicateLoader.ts 80%
(+80%)
100%
(+100%)
0%
(+0%)
80%
(+80%)
apps/docs-snippets2/src/typegend/scripts/ScriptSum.ts 100%
(+20%)
100%
(+0%)
100%
(+100%)
100%
(+20%)
✨ apps/docs-snippets2/src/typegend/scripts/ScriptSumLoader.ts 100%
(+100%)
100%
(+100%)
100%
(+100%)
100%
(+100%)
🔴 ✨ apps/docs-snippets2/src/typegend/scripts/ScriptTransferToContract.ts 80%
(+80%)
100%
(+100%)
0%
(+0%)
80%
(+80%)
🔴 ✨ apps/docs-snippets2/src/typegend/scripts/ScriptTransferToContractLoader.ts 80%
(+80%)
100%
(+100%)
0%
(+0%)
80%
(+80%)
🔴 ✨ apps/docs-snippets2/src/utilities/unit-conversion.ts 0%
(+0%)
100%
(+100%)
100%
(+100%)
0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/wallet-manager/getting-started-with-wallet-manager.ts 0%
(+0%)
100%
(+100%)
100%
(+100%)
0%
(+0%)
🔴 ✨ apps/docs-snippets2/src/wallet-manager/locking-and-unlocking-wallet-manager.ts 0%
(+0%)
100%
(+100%)
100%
(+100%)
0%
(+0%)
🔴 packages/account/src/providers/transaction-request/transaction-request.ts 88.57%
(+0%)
76.71%
(-1.37%)
84%
(+0%)
88.81%
(+0%)

@danielbate
Copy link
Contributor Author

Going to delay this till after #3369 to not impede snippet finalisation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Requests pertinent to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs on manually upgrading by proxy
5 participants