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

Merged
merged 52 commits into from
Nov 28, 2024
Merged

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
  • Exported TypeScript recipes of Sway Programs

Summary

This PR adds further documentation on manually implementing a proxy contract upgrade. In order to not have multiple versions of the Src 14 contract in the SDK, we now have our own recipes package for Typegen implementations of Sway programs that we want to export. This way it could also be used in our own CLI, and exported from the umbrella.

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 Nov 28, 2024 4:18pm
ts-api-docs 🔄 Building (Inspect) Visit Preview 💬 Add feedback Nov 28, 2024 4:18pm
ts-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 28, 2024 4:18pm
ts-docs-api ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 28, 2024 4:18pm

Copy link

codspeed-hq bot commented Oct 5, 2024

CodSpeed Performance Report

Merging #3253 will not alter performance

Comparing db/chore/manual-proxy-contracts (f46fc0c) with master (165c49c)

Summary

✅ 18 untouched benchmarks

@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
danielbate and others added 2 commits November 28, 2024 16:06
Co-authored-by: Nedim Salkić <nedim.salkic@fuel.sh>
Co-authored-by: Nedim Salkić <nedim.salkic@fuel.sh>
Copy link
Contributor

Coverage Report:

Lines Branches Functions Statements
76.46%(-0.4%) 69.97%(-0.52%) 74.46%(-0.63%) 76.44%(-0.52%)
Changed Files:
Ok File (✨=New File) Lines Branches Functions Statements
🔴 packages/account/src/providers/transaction-request/transaction-request.ts 88.57%
(+0%)
78.08%
(+1.37%)
84%
(+0%)
88.81%
(+0%)
🔴 ✨ packages/recipes/scripts/build-recipes.ts 0%
(+0%)
0%
(+0%)
0%
(+0%)
0%
(+0%)
🔴 ✨ packages/recipes/src/types/Src14OwnedProxy.ts 0%
(+0%)
0%
(+0%)
0%
(+0%)
0%
(+0%)
🔴 ✨ packages/recipes/src/types/Src14OwnedProxyFactory.ts 0%
(+0%)
0%
(+0%)
0%
(+0%)
0%
(+0%)

@petertonysmith94 petertonysmith94 merged commit ef94263 into master Nov 28, 2024
25 checks passed
@petertonysmith94 petertonysmith94 deleted the db/chore/manual-proxy-contracts branch November 28, 2024 17:20
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
7 participants