-
Notifications
You must be signed in to change notification settings - Fork 50
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: improve LSP6 Natspec comments + add auto-generated docs #637
Conversation
👋 Hello ⛽📊 See Gas Benchmark report of Using UniversalProfile owned by an EOA🔀
|
execute scenarios - 👑 UP Owner |
⛽ Gas Usage |
---|---|
Transfer 1 LYX to an EOA without data | 37537 |
Transfer 1 LYX to a UP without data | 36639 |
Transfer 1 LYX to an EOA with 256 bytes of data | 42198 |
Transfer 1 LYX to a UP with 256 bytes of data | 44726 |
Transfer 0.1 LYX to 3x EOA without data | 70862 |
Transfer 0.1 LYX to 3x UP without data | 75680 |
Transfer 0.1 LYX to 3x EOA with 256 bytes of data | 84814 |
Transfer 0.1 LYX to 3x EOA with 256 bytes of data | 100042 |
🗄️ setData
scenarios
setData scenarios - 👑 UP Owner |
⛽ Gas Usage |
---|---|
Set a 20 bytes long value | 49971 |
Set a 60 bytes long value | 95293 |
Set a 160 bytes long value | 164429 |
Set a 300 bytes long value | 279700 |
Set a 600 bytes long value | 484136 |
Change the value of a data key already set | 32847 |
Remove the value of a data key already set | 27333 |
Set 2 data keys of 20 bytes long value | 78428 |
Set 2 data keys of 100 bytes long value | 260592 |
Set 3 data keys of 20 bytes long value | 105145 |
Change the value of three data keys already set of 20 bytes long value | 45445 |
Remove the value of three data keys already set | 41339 |
🗄️ Tokens
scenarios
Tokens scenarios - 👑 UP Owner |
⛽ Gas Usage |
---|---|
Minting a LSP7Token to a UP (No Delegate) from an EOA | 91241 |
Minting a LSP7Token to an EOA from an EOA | 59206 |
Transferring an LSP7Token from a UP to another UP (No Delegate) | 98689 |
Minting a LSP8Token to a UP (No Delegate) from an EOA | 158192 |
Minting a LSP8Token to an EOA from an EOA | 126157 |
Transferring an LSP8Token from a UP to another UP (No Delegate) | 147236 |
📝 Notes
- The
execute
andsetData
scenarios are executed on a fresh UniversalProfile smart contract, deployed as standard contracts (not as proxy behind a base contract implementation).
⛽📊 See Gas Benchmark report of Using UniversalProfile owned by an LSP6KeyManager
This document contains the gas usage for common interactions and scenarios when using UniversalProfile smart contracts.
🔀 execute
scenarios
👑 unrestricted controller
execute scenarios - 👑 main controller |
⛽ Gas Usage |
---|---|
transfer LYX to an EOA | 60439 |
transfer LYX to a UP | 62041 |
transfer tokens (LSP7) to an EOA (no data) | 107162 |
transfer tokens (LSP7) to a UP (no data) | 242734 |
transfer a NFT (LSP8) to a EOA (no data) | 171009 |
transfer a NFT (LSP8) to a UP (no data) | 289909 |
🛃 restricted controller
execute scenarios - 🛃 restricted controller |
⛽ Gas Usage |
---|---|
transfer some LYXes to an EOA - restricted to 1 x allowed address only (TRANSFERVALUE + 1x AllowedCalls) | 72648 |
transfers some tokens (LSP7) to an EOA - restricted to LSP7 + 2x allowed contracts only (CALL + 2x AllowedCalls) (no data) | 122941 |
transfers some tokens (LSP7) to an other UP - restricted to LSP7 + 2x allowed contracts only (CALL + 2x AllowedCalls) (no data) | 258513 |
transfers a NFT (LSP8) to an EOA - restricted to LSP8 + 2x allowed contracts only (CALL + 2x AllowedCalls) (no data) | 186776 |
transfers a NFT (LSP8) to an other UP - restricted to LSP8 + 2x allowed contracts only (CALL + 2x AllowedCalls) (no data) | 305676 |
🗄️ setData
scenarios
👑 unrestricted controller
setData scenarios - 👑 main controller |
⛽ Gas Usage |
---|---|
updates profile details (LSP3Profile metadata) | 136875 |
give permissions to a controller (AddressPermissions[] + AddressPermissions[index] + AddressPermissions:Permissions:) | 132906 |
restrict a controller to some specific ERC725Y Data Keys | 139282 |
restrict a controller to interact only with 3x specific addresses | 161986 |
remove a controller (its permissions + its address from the AddressPermissions[] array) | 67871 |
write 5x LSP12 Issued Assets | 233253 |
🛃 restricted controller
setData scenarios - 🛃 restricted controller |
⛽ Gas Usage |
---|---|
setData(bytes32,bytes) -> updates 1x data key |
102626 |
setData(bytes32[],bytes[]) -> updates 3x data keys (first x3) |
161440 |
setData(bytes32[],bytes[]) -> updates 3x data keys (middle x3) |
145519 |
setData(bytes32[],bytes[]) -> updates 3x data keys (last x3) |
170752 |
setData(bytes32[],bytes[]) -> updates 2x data keys + add 3x new controllers (including setting the array length + indexes under AddressPermissions[index]) |
249872 |
📝 Notes
- The
execute
andsetData
scenarios are executed on a fresh UniversalProfile and LSP6KeyManager smart contracts, deployed as standard contracts (not as proxy behind a base contract implementation).
8190457
to
ba550ec
Compare
Changes to gas cost
🧾 Summary (10% most significant diffs)
Full diff report 👇
|
* @param value the amount of native token to be transferred in the calldata payload. | ||
* @param selector the bytes4 function of the function to run in the calldata payload. | ||
* @param selector the bytes4 function of the function that was executed on the linked {target} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* @param selector the bytes4 function of the function that was executed on the linked {target} | |
* @param selector : the bytes4 function of the function that was executed on the linked {target} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe nice to add a semi colon between the variable and the description ? What do you think ?
* @dev the ERC725Account will return some data on successful call, or revert on failure | ||
* @param payload the payload to execute. Obtained in web3 via encodeABI() | ||
* @return the data being returned by the ERC725 Account | ||
* @notice execute the following payload on the linked contract: `payload` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* @notice execute the following payload on the linked contract: `payload` | |
* @notice Execute the payload `payload` on the linked contract. | |
`` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
FMI: what is the linked contract ? :)
Very cool |
ba550ec
to
e77458a
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Errors have no @notice
tag, maybe its worth adding them?
5c69338
to
4acefa7
Compare
@b00ste I have added |
4acefa7
to
906f4fd
Compare
906f4fd
to
8515bf0
Compare
What does this PR introduce?
📄 Documentation
Improve Natspec comments for
LSP6KeyManager
and its own modules + interfaces and add auto-generated docs.