feat: create and deploy a reference proxy contract for contracts with [proxy] enabled
#6069
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kayagokalp
added
enhancement
Benchmark for 946beecClick to view benchmark
|
Benchmark for 52d495eClick to view benchmark
|
sdankel
reviewed
May 29, 2024
Benchmark for 6828faaClick to view benchmark
|
kayagokalp
force-pushed
the
kayagokalp/deploy-default-proxy
branch
from
07910ec
to
7d3613e
Compare
Benchmark for 82fee6fClick to view benchmark
|
Benchmark for 1101331Click to view benchmark
|
sdankel
reviewed
May 31, 2024
Benchmark for c157f2bClick to view benchmark
|
Benchmark for 126ba37Click to view benchmark
|
K1-R1
reviewed
Jun 3, 2024
Benchmark for 5318cffClick to view benchmark
|
Benchmark for 0fb629aClick to view benchmark
|
sdankel
approved these changes
Aug 6, 2024
Benchmark for 09d598fClick to view benchmark
|
IGI-111
approved these changes
Aug 7, 2024
Benchmark for d89ec7fClick to view benchmark
|
bitzoic
reviewed
Aug 7, 2024
|
|
||
| To create a wallet you can use `forc wallet new`. It will ask you to choose a password to encrypt your wallet. After the initialization is done you will have your mnemonic phrase. | ||
| The easiest and recommended way to interact with deployed networks such as our testnets is option 1, using `forc-client` to sign your transactions which reads your default `forc-wallet` vault. For interacting with local node, we recommend using the second option, which leads `forc-client` to sign transactions with the a private key that comes pre-funded in local environments. |
There was a problem hiding this comment.
Suggested change
| The easiest and recommended way to interact with deployed networks such as our testnets is option 1, using `forc-client` to sign your transactions which reads your default `forc-wallet` vault. For interacting with local node, we recommend using the second option, which leads `forc-client` to sign transactions with the a private key that comes pre-funded in local environments. | |
| The easiest and recommended way to interact with deployed networks such as our testnets is option 1, using `forc-client` to sign your transactions which reads your default `forc-wallet` vault. For interacting with local node, we recommend using the second option, which leads `forc-client` to sign transactions with the private key that comes pre-funded in local environments. |
There was a problem hiding this comment.
Oh looks like it got auto merged, I'll address these with the follow-up, thanks!
| @@ -1,26 +1,62 @@ | |||
| # `forc-client` | |||
|
|
|||
| Forc plugin for interacting with a Fuel node. | |||
| Forc plugin for interacting with a Fuel node. Since transactions are going to require some gas, you need to sign them with an account that has enough tokens to pay for them. | |||
There was a problem hiding this comment.
Suggested change
| Forc plugin for interacting with a Fuel node. Since transactions are going to require some gas, you need to sign them with an account that has enough tokens to pay for them. | |
| The forc plugin for interacting with a Fuel node. | |
| Since transactions are going to require some gas, you need to sign them with an account that has enough coins to pay for them. |
Should be assets or coins as there are no tokens on Fuel 🙂
https://docs.fuel.network/docs/sway/blockchain-development/native_assets/#asset-vs-coin-vs-token
|
|
||
| To install `forc-wallet` please refer to `forc-wallet`'s [GitHub repo](https://github.com/FuelLabs/forc-wallet#forc-wallet). | ||
| If you are not interacting with a deployed network, such as testnets, your local `fuel-core` environment can be structured such that it funds an account by default. Using `--default-signer` flag with `forc-client` binaries (run, deploy) will instruct `forc-client` to sign transactions with this pre-funded account. Which makes it a useful command while working against a local node. |
There was a problem hiding this comment.
Suggested change
| If you are not interacting with a deployed network, such as testnets, your local `fuel-core` environment can be structured such that it funds an account by default. Using `--default-signer` flag with `forc-client` binaries (run, deploy) will instruct `forc-client` to sign transactions with this pre-funded account. Which makes it a useful command while working against a local node. | |
| If you are not interacting with a deployed network, such as testnets, your local `fuel-core` environment can be structured such that it funds an account by default. Using `--default-signer` flag with `forc-client` binaries (run, deploy) will instruct `forc-client` to sign transactions with this pre-funded account. This makes it a useful command while working against a local node. |
|
|
||
| ## Option 3: Manually signing through forc-wallet (Deprecated) | ||
|
|
||
| This option is for creating the transaction first, signing it manually and supplying the signed transaction back to forc-client. Since it requires multiple steps, it is more error-prone and not recommended for general use case. Also this will be deprecated soon. |
There was a problem hiding this comment.
Suggested change
| This option is for creating the transaction first, signing it manually and supplying the signed transaction back to forc-client. Since it requires multiple steps, it is more error-prone and not recommended for general use case. Also this will be deprecated soon. | |
| This option is for creating the transaction first, signing it manually, and supplying the signed transaction back to forc-client. Since it requires multiple steps, it is more error-prone and not recommended for general use cases. Also this will be deprecated soon. |
| enabled = true | ||
| ``` | ||
|
|
||
| If there is no `address` field present under the proxy table, like the example above, `forc` will automatically create a proxy contract based on the [SRC-14](https://github.com/FuelLabs/sway-standards/blob/master/docs/src/src-14-simple-upgradeable-proxies.md) implementation from [sway-standards](https://github.com/FuelLabs/sway-standards). After generating and deploying the proxy contract, the target is set to the current contract, and owner of the proxy is set to the account that is signing the transaction for deployment. |
There was a problem hiding this comment.
Suggested change
| If there is no `address` field present under the proxy table, like the example above, `forc` will automatically create a proxy contract based on the [SRC-14](https://github.com/FuelLabs/sway-standards/blob/master/docs/src/src-14-simple-upgradeable-proxies.md) implementation from [sway-standards](https://github.com/FuelLabs/sway-standards). After generating and deploying the proxy contract, the target is set to the current contract, and owner of the proxy is set to the account that is signing the transaction for deployment. | |
| If there is no `address` field present under the proxy table, like the example above, `forc` will automatically create a proxy contract based on the [SRC-14](https://github.com/FuelLabs/sway-standards/blob/master/docs/src/src-14-simple-upgradeable-proxies.md) implementation from [sway-standards](https://github.com/FuelLabs/sway-standards). After generating and deploying the proxy contract, the target is set to the current contract, and the owner of the proxy is set to the account that is signing the transaction for deployment. |
|
|
||
| If there is no `address` field present under the proxy table, like the example above, `forc` will automatically create a proxy contract based on the [SRC-14](https://github.com/FuelLabs/sway-standards/blob/master/docs/src/src-14-simple-upgradeable-proxies.md) implementation from [sway-standards](https://github.com/FuelLabs/sway-standards). After generating and deploying the proxy contract, the target is set to the current contract, and owner of the proxy is set to the account that is signing the transaction for deployment. | ||
|
|
||
| This means that if you simply enable proxy in the `Forc.toml`, forc will automatically deploy a proxy contract for you and you do not need to do anything manually aside from signing the deployment transactions for the proxy contract. After deploying the proxy contract, the its address is added into the `address` field of the proxy table. |
There was a problem hiding this comment.
Suggested change
| This means that if you simply enable proxy in the `Forc.toml`, forc will automatically deploy a proxy contract for you and you do not need to do anything manually aside from signing the deployment transactions for the proxy contract. After deploying the proxy contract, the its address is added into the `address` field of the proxy table. | |
| This means that if you simply enable proxy in the `Forc.toml`, forc will automatically deploy a proxy contract for you and you do not need to do anything manually aside from signing the deployment transactions for the proxy contract. After deploying the proxy contract, the address is added into the `address` field of the proxy table. |
Benchmark for 887d855Click to view benchmark
|
|
8 tasks
sdankel
added a commit
that referenced
this pull request
Aug 7, 2024
## Description Apply @bitzoic 's comments from #6069 ## Checklist - [ ] I have linked to any relevant issues. - [ ] I have commented my code, particularly in hard-to-understand areas. - [ ] I have updated the documentation where relevant (API docs, the reference, and the Sway book). - [ ] If my change requires substantial documentation changes, I have [requested support from the DevRel team](https://github.com/FuelLabs/devrel-requests/issues/new/choose) - [ ] I have added tests that prove my fix is effective or that my feature works. - [ ] I have added (or requested a maintainer to add) the necessary `Breaking*` or `New Feature` labels where relevant. - [ ] I have done my best to ensure that my PR adheres to [the Fuel Labs Code Review Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md). - [ ] I have requested a review from the relevant team or maintainers.
esdrubal
pushed a commit
that referenced
this pull request
Aug 13, 2024
… `[proxy]` enabled (#6069) Part of #6068. This PR adds couple of things: 1. A default proxy contract implementation taken from [sway standards](https://github.com/FuelLabs/sway-standards/blob/master/standards/src/src14.sw). 2. Infra for creating, building and deploying the reference implementation for proxy contracts. 3. Deployment procedure such that proxy contract is deployed while working on a contract which enables the `[proxy]` in its forc.toml. In a way that it is owned by the deployer and the target initially points to implementation contract. 4. Infra for making a contract call into the already deployed proxy contracts to update their targets. 5. Adds a `Building` text to the all forc build invocations to better inform the user about what forc is doing behind the scenes. 6. Removes duplicate forc-wallet password prompts which was very frustrating for the users. Now forc-wallet deployment path only asks for password once. 7. Refactors around how secret_key is selected based on user input 8. Updated docs around forc-client 9. Docs around how to use the proxy feature If the user does not have a proxy table in their forc.toml, nothing changes, same old deployment procedure is followed. Only difference is that this PR improves the ux by removing the need of providing the password multiple times. If the user has a contract with a proxy table but without an address like: ```TOML [project] authors = ["kaya"] entry = "main.sw" license = "Apache-2.0" name = "impl-contract" [dependencies] [proxy] enabled = true ``` Forc automatically creates a proxy contract based on the reference implementation at [SRC14](https://github.com/FuelLabs/sway-standard-implementations/tree/61fd4ad8f69d21cec0d5cd8135bdc4495e0c125c). Sets its target to the implementation contract, whichever contract enabled the proxy and the owner to the deployer (signing account of the transaction). If the user has a contract with a proxy table and an address specified like: ```TOML [project] authors = ["kaya"] entry = "main.sw" license = "Apache-2.0" name = "impl-contract" [dependencies] [proxy] enabled = true address = "........." ``` Forc automatically makes a set target conract call to update the proxy contract's target. Pointing it to the newly deployed impl contract which defines the proxy table. Generated proxy contract abi and bins are stored at `~/.forc/.generated_proxy_contracts/project_name` for housekeeping.
esdrubal
pushed a commit
that referenced
this pull request
Aug 13, 2024
## Description Apply @bitzoic 's comments from #6069 ## Checklist - [ ] I have linked to any relevant issues. - [ ] I have commented my code, particularly in hard-to-understand areas. - [ ] I have updated the documentation where relevant (API docs, the reference, and the Sway book). - [ ] If my change requires substantial documentation changes, I have [requested support from the DevRel team](https://github.com/FuelLabs/devrel-requests/issues/new/choose) - [ ] I have added tests that prove my fix is effective or that my feature works. - [ ] I have added (or requested a maintainer to add) the necessary `Breaking*` or `New Feature` labels where relevant. - [ ] I have done my best to ensure that my PR adheres to [the Fuel Labs Code Review Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md). - [ ] I have requested a review from the relevant team or maintainers.
esdrubal
pushed a commit
that referenced
this pull request
Aug 13, 2024
… `[proxy]` enabled (#6069) Part of #6068. This PR adds couple of things: 1. A default proxy contract implementation taken from [sway standards](https://github.com/FuelLabs/sway-standards/blob/master/standards/src/src14.sw). 2. Infra for creating, building and deploying the reference implementation for proxy contracts. 3. Deployment procedure such that proxy contract is deployed while working on a contract which enables the `[proxy]` in its forc.toml. In a way that it is owned by the deployer and the target initially points to implementation contract. 4. Infra for making a contract call into the already deployed proxy contracts to update their targets. 5. Adds a `Building` text to the all forc build invocations to better inform the user about what forc is doing behind the scenes. 6. Removes duplicate forc-wallet password prompts which was very frustrating for the users. Now forc-wallet deployment path only asks for password once. 7. Refactors around how secret_key is selected based on user input 8. Updated docs around forc-client 9. Docs around how to use the proxy feature If the user does not have a proxy table in their forc.toml, nothing changes, same old deployment procedure is followed. Only difference is that this PR improves the ux by removing the need of providing the password multiple times. If the user has a contract with a proxy table but without an address like: ```TOML [project] authors = ["kaya"] entry = "main.sw" license = "Apache-2.0" name = "impl-contract" [dependencies] [proxy] enabled = true ``` Forc automatically creates a proxy contract based on the reference implementation at [SRC14](https://github.com/FuelLabs/sway-standard-implementations/tree/61fd4ad8f69d21cec0d5cd8135bdc4495e0c125c). Sets its target to the implementation contract, whichever contract enabled the proxy and the owner to the deployer (signing account of the transaction). If the user has a contract with a proxy table and an address specified like: ```TOML [project] authors = ["kaya"] entry = "main.sw" license = "Apache-2.0" name = "impl-contract" [dependencies] [proxy] enabled = true address = "........." ``` Forc automatically makes a set target conract call to update the proxy contract's target. Pointing it to the newly deployed impl contract which defines the proxy table. Generated proxy contract abi and bins are stored at `~/.forc/.generated_proxy_contracts/project_name` for housekeeping.
kayagokalp
added a commit
that referenced
this pull request
Aug 17, 2024
… and loader generation (#6250) ## Description This PR adds chunk deployment based on LDC. Contracts larger than 100 kb size, is split into chunks and chunks are deployed as `blobs`. Out of these blobs we create a loader contract, which loads all the blobs using `LDC` opcode. One important thing is that this feature works nicely with the proxy feature introduced in #6069, so a large contract, with proxy can be deployed directly. Large contract will be split into chunks, chunks will get deployed, loader will get get generated and deployed, after all these a proxy contract is deployed and pointed to the loader contract deployed. Simple chunked deploy, chunked deployment re routing the call, chunked deployment behind a proxy re routes the call is tested. --------- Co-authored-by: Sophie Dankel <47993817+sdankel@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Part of #6068.
This PR adds couple of things:
[proxy]in its forc.toml. In a way that it is owned by the deployer and the target initially points to implementation contract.Buildingtext to the all forc build invocations to better inform the user about what forc is doing behind the scenes.How this works
If the user does not have a proxy table in their forc.toml, nothing changes, same old deployment procedure is followed. Only difference is that this PR improves the ux by removing the need of providing the password multiple times.
If the user has a contract with a proxy table but without an address like:
Forc automatically creates a proxy contract based on the reference implementation at SRC14. Sets its target to the implementation contract, whichever contract enabled the proxy and the owner to the deployer (signing account of the transaction).
If the user has a contract with a proxy table and an address specified like:
Forc automatically makes a set target conract call to update the proxy contract's target. Pointing it to the newly deployed impl contract which defines the proxy table.
Generated proxy contracts are stored at
~/.forc/.generated_proxy_contracts/project_namefor housekeeping.