docs: Improve natspec for LSP0 #794
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
|
👋 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 (12 📈❌) |
| Transfer 1 LYX to a UP with 256 bytes of data | 57186 (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 | 84862 (24 📈❌) |
| Transfer 0.1 LYX to 3x UPs with 256 bytes of data | 137245 (0 ) |
🗄️ setData scenarios
setData scenarios - UP owned by 🔑 EOA |
⛽ Gas Usage |
|---|---|
| Set a 20 bytes long value | 49951 (0 ) |
| Set a 60 bytes long value | 95273 (12 📈❌) |
| Set a 160 bytes long value | 164445 (12 📈❌) |
| Set a 300 bytes long value | 279668 (12 📈❌) |
| Set a 600 bytes long value | 484140 (12 📈❌) |
| Change the value of a data key already set | 32839 (0 ) |
| Remove the value of a data key already set | 27313 (0 ) |
| Set 2 data keys of 20 bytes long value | 78500 (12 📈❌) |
| Set 2 data keys of 100 bytes long value | 260652 (12 📈❌) |
| Set 3 data keys of 20 bytes long value | 105218 (0 ) |
| Change the value of three data keys already set of 20 bytes long value | 45518 (0 ) |
| Remove the value of three data keys already set | 41397 (0 ) |
🗄️ Tokens scenarios
Tokens scenarios - UP owned by 🔑 EOA |
⛽ Gas Usage |
|---|---|
| Minting a LSP7Token to a UP (No Delegate) from an EOA | 92680 (0 ) |
| Minting a LSP7Token to an EOA from an EOA | 59355 (0 ) |
| Transferring an LSP7Token from a UP to another UP (No Delegate) | 101556 (0 ) |
| Minting a LSP8Token to a UP (No Delegate) from an EOA | 159571 (0 ) |
| Minting a LSP8Token to an EOA from an EOA | 126247 (0 ) |
| Transferring an LSP8Token from a UP to another UP (No Delegate) | 150249 (0 ) |
UniversalProfile owned by a 🔒📄 LSP6KeyManager
🔀 execute scenarios
execute scenarios |
👑 main controller | 🛃 restricted controller |
|---|---|---|
| LYX transfer --> to an EOA | 64356 (0 ) | 75306 (0 ) |
| LYX transfer --> to a UP | 78489 (0 ) | 93386 (0 ) |
| LSP7 token transfer --> to an EOA | 116353 (0 ) | 131103 (0 ) |
| LSP7 token transfer --> to a UP | 249583 (0 ) | 264333 (0 ) |
| LSP8 NFT transfer --> to an EOA | 180461 (0 ) | 195188 (0 ) |
| LSP8 NFT transfer --> to a UP | 296915 (0 ) | 311642 (0 ) |
🗄️ setData scenarios
setData scenarios |
👑 main controller | 🛃 restricted controller |
|---|---|---|
| Update Profile details (LSP3Profile Metadata) | 67294 (0 ) | 77316 (0 ) |
Add a new controller with permission to SET_DATA + 3x allowed data keys: AddressPermissions[] + AddressPermissions[index] + AddressPermissions:Permissions:<controller> + AddressPermissions:AllowedERC725YDataKeys:<controller) |
209636 (0 ) | 219793 (0 ) |
Update permissions of previous controller. Allow it now to SUPER_SETDATA |
52322 (0 ) | 55328 (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: |
78861 (0 ) | 90160 (0 ) |
| Write 5x new LSP12 Issued Assets | 66989 (0 ) | 101616 (0 ) |
| Update 3x data keys (first 3) | 125501 (0 ) | 159605 (0 ) |
| Update 3x data keys (middle 3) | 105589 (0 ) | 143759 (0 ) |
| Update 3x data keys (last 3) | 125501 (0 ) | 169092 (0 ) |
| Set 2 x new data keys + add 3x new controllers | 810481 (0 ) | 872281 (0 ) |
Changes to gas cost
🧾 Summary (10% most significant diffs)
Full diff report 👇
|
CJ42
requested changes
Nov 6, 2023
| @@ -120,6 +128,8 @@ abstract contract LSP0ERC725AccountCore is | |||
| * | |||
| * 2. If the data sent to this function is of length less than 4 bytes (not a function selector), return. | |||
| * | |||
| * Whenever the call is associated with native tokens, the function will delegate internally the handling of native tokens to the {universalReceiver} function passing `_TYPEID_LSP0_VALUE_RECEIVED` as typeId and the calldata as received data, except when the native token will be sent directly to the extension. | |||
There was a problem hiding this comment.
Also worth mentioning when receiving less than 4 bytes of data.
There was a problem hiding this comment.
except when the native token will be sent directly to the extension.
This last sentence makes it hard to understand. The only exception according to the code is when:
- you receive some native tokens
- you receive some data that is more than 4 bytes.
In this case, the associated LSP17 extension is called.
There was a problem hiding this comment.
This is generic saying all the time when native token is associated (even when data is less than 4 bytes), the universalReceiver is invoked, unless the native token is being forwarded to the extension, but happy to add a suggestion if you have one
Whenever the call is associated with native tokens, the function will delegate internally the handling of native tokens to the {universalReceiver} function passing
_TYPEID_LSP0_VALUE_RECEIVEDas typeId and the calldata as received data, except when the native token will be sent directly to the extension.
CJ42
approved these changes
Nov 7, 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.
What does this PR introduce?
📄 Documentation
docs: Improve natspec for LSP0
PR Checklist
npm run lint&&npm run lint:solidity(solhint)npm run format(prettier)npm run buildnpm run test