rework precompile tutorial #1231
Merged
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
Deploying with
|
| Latest commit: |
8d03198
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://261ef9e4.avalanche-docs.pages.dev |
| Branch Preview URL: | https://precompile-improvements.avalanche-docs.pages.dev |
…he-docs into precompile-improvements
anusha-ctrl
reviewed
Feb 21, 2023
anusha-ctrl
reviewed
Feb 21, 2023
anusha-ctrl
reviewed
Feb 21, 2023
anusha-ctrl
reviewed
Feb 21, 2023
anusha-ctrl
reviewed
Feb 21, 2023
anusha-ctrl
reviewed
Feb 21, 2023
| [`./precompile/params.go`](https://github.com/ava-labs/subnet-evm/blob/HelloWorldOfficialTutorial/precompile/params.go) | ||
| and modify the default value to be the next user available stateful precompile address. For forks of | ||
| We can see the `ContractAddress` is set to some default value. | ||
| You should change that default value to a suitable address for your precompile. |
There was a problem hiding this comment.
Should we be consistent between we and you and what person we are using?
There was a problem hiding this comment.
changed some places
anusha-ctrl
reviewed
Feb 21, 2023
anusha-ctrl
reviewed
Feb 21, 2023
anusha-ctrl
reviewed
Feb 21, 2023
Comment on lines
574
to
576
| `Verify()` is called on startup and an error is treated as fatal. Generated code contains a call | ||
| to `AllowListConfig.Verify()` to verify the `AllowListConfig`. You can leave that as is, and start | ||
| adding your own custom verify code after that. |
There was a problem hiding this comment.
Suggested change
| `Verify()` is called on startup and an error is treated as fatal. Generated code contains a call | |
| to `AllowListConfig.Verify()` to verify the `AllowListConfig`. You can leave that as is, and start | |
| adding your own custom verify code after that. | |
| `Verify()` is called on startup and an error is treated as fatal. Generated code contains a call | |
| to `AllowListConfig.Verify()` to verify the `AllowListConfig.` You can leave that as is and start | |
| adding your own custom verify code after that. |
There was a problem hiding this comment.
I prefer to keep . outside of ticks.
anusha-ctrl
reviewed
Feb 21, 2023
anusha-ctrl
reviewed
Feb 21, 2023
anusha-ctrl
reviewed
Feb 21, 2023
| By default these are added to the default gas costs to the state-change functions (SetGreeting) | ||
| of the precompile. Meaning that these functions will cost an additional `ReadAllowListGasCost` in order | ||
| to read permissions from the storage. If you don't plan to read permissions from the storage then | ||
| you can omit these. | ||
|
|
There was a problem hiding this comment.
Should we talk about the dangers of not accurately putting the correct gas costs?
anusha-ctrl
reviewed
Feb 21, 2023
| _ "github.com/ava-labs/subnet-evm/precompile/contracts/helloworld" | ||
| // ADD YOUR PRECOMPILE HERE | ||
| // _ "github.com/ava-labs/subnet-evm/precompile/contracts/yourprecompile" | ||
| ) | ||
| ``` |
anusha-ctrl
reviewed
Feb 21, 2023
Comment on lines
930
to
935
| Let's add some unit tests to make sure our precompile is configured correctly. Config tests will | ||
| be under `/precompile/contracts/helloworld/config_test.go`. There are mainly 2 functions we need | ||
| to test: `Verify` and `Equal`. `Verify` checks if the precompile is configured correctly. `Equal` | ||
| checks if the precompile is equal to another precompile. You can check other `config_test.go` files | ||
| in the `/precompile/contracts` directory for examples. For the `HelloWorld` precompile, you can | ||
| check the code in [here](https://github.com/ava-labs/subnet-evm/blob/helloworld-official-tutorial-v2/precompile/contracts/helloworld/config_test.go) |
There was a problem hiding this comment.
Suggested change
| Let's add some unit tests to make sure our precompile is configured correctly. Config tests will | |
| be under `/precompile/contracts/helloworld/config_test.go`. There are mainly 2 functions we need | |
| to test: `Verify` and `Equal`. `Verify` checks if the precompile is configured correctly. `Equal` | |
| checks if the precompile is equal to another precompile. You can check other `config_test.go` files | |
| in the `/precompile/contracts` directory for examples. For the `HelloWorld` precompile, you can | |
| check the code in [here](https://github.com/ava-labs/subnet-evm/blob/helloworld-official-tutorial-v2/precompile/contracts/helloworld/config_test.go) | |
| Let's add some unit tests to ensure our precompile is configured correctly. Config tests will | |
| be under `/precompile/contracts/helloworld/config_test.go`. We need to test mainly two functions: `Verify` and `Equal.` `Verify` checks if the precompile is configured correctly. `Equal` | |
| checks if the precompile is equal to another precompile. For example, you can check other `config_test.go` files | |
| in the `/precompile/contracts` directory. For the `HelloWorld` precompile, you can | |
| check the code [here](https://github.com/ava-labs/subnet-evm/blob/helloworld-official-tutorial-v2/precompile/contracts/helloworld/config_test.go) |
There was a problem hiding this comment.
Is this a whitespace diff suggestion? I intentionally split those lines to comfort the enforced MD rules.
There was a problem hiding this comment.
sorry for the big suggestion but it was mainly for 2 - >two
There was a problem hiding this comment.
ah thanks. changed it.
anusha-ctrl
reviewed
Feb 21, 2023
anusha-ctrl
reviewed
Feb 21, 2023
| > Enter [BeforeSuite] TOP-LEVEL - /Users/aaronbuchwald/go/src/github.com/ava-labs/subnet-evm/tests/precompile/precompile_test.go:31 @ 01/27/23 10:33:51.001 | ||
| INFO [01-27|10:33:51.002] Starting AvalancheGo node wd=/Users/aaronbuchwald/go/src/github.com/ava-labs/subnet-evm | ||
| [BeforeSuite] | ||
| /Users/avalabs/go/src/github.com/ava-labs/subnet-evm/tests/precompile/precompile_test.go:31 |
…he-docs into precompile-improvements
yulin-dong
requested changes
Feb 24, 2023
yulin-dong
reviewed
Feb 24, 2023
yulin-dong
reviewed
Feb 24, 2023
yulin-dong
reviewed
Feb 24, 2023
yulin-dong
reviewed
Feb 24, 2023
yulin-dong
reviewed
Feb 24, 2023
yulin-dong
reviewed
Feb 24, 2023
Co-authored-by: Yulin Dong <yulin.dong@avalabs.org>
Co-authored-by: Yulin Dong <yulin.dong@avalabs.org>
…he-docs into precompile-improvements
yulin-dong
reviewed
Feb 24, 2023
yulin-dong
reviewed
Feb 24, 2023
yulin-dong
reviewed
Feb 24, 2023
yulin-dong
reviewed
Feb 24, 2023
yulin-dong
reviewed
Feb 24, 2023
darioush
previously approved these changes
Feb 24, 2023
| precompile, the address of the precompile and a configurator. This file is located at | ||
| [`./precompile/helloworld/module.go`](https://github.com/ava-labs/subnet-evm/blob/helloworld-official-tutorial-v2/precompile/contracts/helloworld/module.go). | ||
|
|
||
| It defines the module for the precompile. The module is used to register the precompile to the |
There was a problem hiding this comment.
Suggested change
| It defines the module for the precompile. The module is used to register the precompile to the | |
| This file defines the module for the precompile. The module is used to register the precompile to the |
| // This function is called by the EVM once per precompile contract activation. | ||
| // You can use this function to set up your precompile contract's initial state, | ||
| // by using the [cfg] config and [state] stateDB. | ||
| // Configure configures [state] with the initial configuration. |
There was a problem hiding this comment.
this seems like a duplicate comment?
There was a problem hiding this comment.
yep removed it, thanks
| @@ -1128,31 +1412,33 @@ Compilation finished successfully | |||
|
|
|||
| ExampleHelloWorld | |||
| Contract deployed to: 0x52C84043CD9c865236f11d9Fc9F56aa003c1f922 | |||
| ✓ should getHello properly | |||
| ✓ should setGreeting and getHello (4103ms) | |||
| ✓ should getHello properly | |||
There was a problem hiding this comment.
i think it was a tab, fixed it.
Co-authored-by: Yulin Dong <yulin.dong@avalabs.org>
…he-docs into precompile-improvements
yulin-dong
approved these changes
Feb 25, 2023
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.
Reworks precompile generator tutorial for recent upcoming changes in ava-labs/subnet-evm#389
Also adde AllowList capability to tutorial precompile.