chore: adjust Natspec comments + use mixedCase name for modifier
#786
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
CJ42
changed the title
modifermodifier
|
👋 Hello ⛽📊 Gas Benchmark ReportDeployment Costs
Runtime CostsUniversalProfile owned by an 🔑 EOA🔀
|
execute scenarios - UP owned by 🔑 EOA |
⛽ Gas Usage |
|---|---|
| Transfer 1 LYX to an EOA without data | 37560 (0 ) |
| Transfer 1 LYX to a UP without data | 46253 (0 ) |
| Transfer 1 LYX to an EOA with 256 bytes of data | 42233 (24 📈❌) |
| Transfer 1 LYX to a UP with 256 bytes of data | 57162 (0 ) |
| Transfer 0.1 LYX to 3x EOA without data | 70862 (0 ) |
| Transfer 0.1 LYX to 3x UP without data | 104453 (0 ) |
| Transfer 0.1 LYX to 3x EOA with 256 bytes of data | 84826 (24 📈❌) |
| Transfer 0.1 LYX to 3x UPs with 256 bytes of data | 137245 (72 📈❌) |
🗄️ setData scenarios
setData scenarios - UP owned by 🔑 EOA |
⛽ Gas Usage |
|---|---|
| Set a 20 bytes long value | 49973 (0 ) |
| Set a 60 bytes long value | 95295 (0 ) |
| Set a 160 bytes long value | 164467 (12 📈❌) |
| Set a 300 bytes long value | 279678 (0 ) |
| Set a 600 bytes long value | 484114 (0 ) |
| Change the value of a data key already set | 32849 (-12 📉✅) |
| Remove the value of a data key already set | 27335 (0 ) |
| Set 2 data keys of 20 bytes long value | 78444 (-12 📉✅) |
| Set 2 data keys of 100 bytes long value | 260620 (12 📈❌) |
| Set 3 data keys of 20 bytes long value | 105174 (0 ) |
| Change the value of three data keys already set of 20 bytes long value | 45474 (0 ) |
| Remove the value of three data keys already set | 41362 (0 ) |
🗄️ Tokens scenarios
Tokens scenarios - UP owned by 🔑 EOA |
⛽ Gas Usage |
|---|---|
| Minting a LSP7Token to a UP (No Delegate) from an EOA | 92724 (0 ) |
| Minting a LSP7Token to an EOA from an EOA | 59377 (0 ) |
| Transferring an LSP7Token from a UP to another UP (No Delegate) | 101577 (0 ) |
| Minting a LSP8Token to a UP (No Delegate) from an EOA | 159593 (0 ) |
| Minting a LSP8Token to an EOA from an EOA | 126247 (0 ) |
| Transferring an LSP8Token from a UP to another UP (No Delegate) | 150271 (0 ) |
UniversalProfile owned by a 🔒📄 LSP6KeyManager
🔀 execute scenarios
execute scenarios |
👑 main controller | 🛃 restricted controller |
|---|---|---|
| LYX transfer --> to an EOA | 64337 (0 ) | 75288 (0 ) |
| LYX transfer --> to a UP | 78488 (0 ) | 93385 (0 ) |
| LSP7 token transfer --> to an EOA | 116373 (0 ) | 131123 (0 ) |
| LSP7 token transfer --> to a UP | 249647 (0 ) | 264397 (0 ) |
| LSP8 NFT transfer --> to an EOA | 180460 (0 ) | 195210 (0 ) |
| LSP8 NFT transfer --> to a UP | 296936 (0 ) | 311686 (0 ) |
🗄️ setData scenarios
setData scenarios |
👑 main controller | 🛃 restricted controller |
|---|---|---|
| Update Profile details (LSP3Profile Metadata) | 67338 (0 ) | 77360 (0 ) |
Add a new controller with permission to SET_DATA + 3x allowed data keys: AddressPermissions[] + AddressPermissions[index] + AddressPermissions:Permissions:<controller> + AddressPermissions:AllowedERC725YDataKeys:<controller) |
209614 (0 ) | 219771 (0 ) |
Update permissions of previous controller. Allow it now to SUPER_SETDATA |
52366 (0 ) | 55372 (0 ) |
| Remove a controller: 1. decrease AddressPermissions[] Array length 2. remove the controller address at AddressPermissions[index] 3. set "0x" for the controller permissions under AddressPermissions:Permissions: |
78844 (0 ) | 90142 (0 ) |
| Write 5x new LSP12 Issued Assets | 67033 (0 ) | 101660 (0 ) |
| Update 3x data keys (first 3) | 125479 (0 ) | 159583 (0 ) |
| Update 3x data keys (middle 3) | 105567 (0 ) | 143737 (0 ) |
| Update 3x data keys (last 3) | 125479 (0 ) | 169070 (0 ) |
| Set 2 x new data keys + add 3x new controllers | 810459 (0 ) | 872259 (0 ) |
Changes to gas cost
🧾 Summary (10% most significant diffs)
Full diff report 👇
|
CJ42
force-pushed
the
chore/review
branch
3 times, most recently
from
80a8d74
to
9a06b57
Compare
Comment on lines
1227
to
1229
| Update the status from `false` to `true` and checks if | ||
| the status is `true` in order to revert the call unless the caller has the `REENTRANCY` permission | ||
| Used in the beginning of the [`lsp20VerifyCall`](#`lsp20verifycall`), [`_execute`](#`_execute`) and [`_executeRelayCall`](#`_executerelaycall`) functions, before the methods execution starts. |
There was a problem hiding this comment.
Suggestions written for contracts/LSP6KeyManager/LSP6KeyManagerCore.sol apply here as well.
There was a problem hiding this comment.
@jenea This Markdown document is auto-generated from the Natspec comment in the .sol file.
So updating the .sol file will update automatically this file.
For your info, so that you don't have to review the same twice for any future code review :)
YamenMerhi
approved these changes
Nov 6, 2023
b00ste
approved these changes
Nov 6, 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.
No description provided.