Skip to content
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 LSP7 preset & extensions Natspec comments + add auto-generated docs #639

Merged
merged 2 commits into from
Aug 14, 2023

Conversation

CJ42
Copy link
Member

@CJ42 CJ42 commented Jul 18, 2023

What does this PR introduce?

📄 Documentation

Improve Natspec comments for LSP7DigitalAsset --> presets/ and extensions/ folder.

@github-actions
Copy link
Contributor

👋 Hello
⛽ I am the Gas Bot Reporter. I keep track of the gas costs of common interactions using Universal Profiles 🆙 !
📊 Here is a summary of the gas cost with the code introduced by this PR.

⛽📊 See Gas Benchmark report of Using UniversalProfile owned by an EOA

🔀 execute scenarios

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 44762
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 84838
Transfer 0.1 LYX to 3x EOA with 256 bytes of data 99934

🗄️ setData scenarios

setData scenarios - 👑 UP Owner ⛽ Gas Usage
Set a 20 bytes long value 49971
Set a 60 bytes long value 95269
Set a 160 bytes long value 164465
Set a 300 bytes long value 279676
Set a 600 bytes long value 484136
Change the value of a data key already set 32859
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 105133
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 and setData 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 and setData scenarios are executed on a fresh UniversalProfile and LSP6KeyManager smart contracts, deployed as standard contracts (not as proxy behind a base contract implementation).

@CJ42 CJ42 changed the title docs: improve Natspec comments for LSP7 preset & extensions + add auto-generated docs docs: improve LSP7 preset & extensions Natspec comments + add auto-generated docs Jul 18, 2023
@CJ42 CJ42 marked this pull request as draft August 2, 2023 16:11
@CJ42 CJ42 force-pushed the docs/lsp7-preset-extensions-natspec branch from 255723e to 152f8f0 Compare August 14, 2023 06:43
@CJ42 CJ42 marked this pull request as ready for review August 14, 2023 06:43
@github-actions
Copy link
Contributor

github-actions bot commented Aug 14, 2023

Changes to gas cost

Generated at commit: 5e3a9f93964bc14fb5d6c4d2dd7f8b9b5fd50ac3, compared to commit: 9db488aad9065f88cfc3c5f43f47b1fab35fc5f0

🧾 Summary (10% most significant diffs)

Contract Method Avg (+/-) %

Full diff report 👇
Contract Deployment Cost (+/-) Method Min (+/-) % Avg (+/-) % Median (+/-) % Max (+/-) % # Calls (+/-)
LSP6ExecuteRestrictedController 2,888,707 (+34,647)
LSP6ExecuteUnrestrictedController 2,888,707 (+34,647)
LSP6SetDataRestrictedController 2,873,483 (+34,638)
LSP6SetDataUnrestrictedController 2,873,483 (+34,638)

@CJ42 CJ42 force-pushed the docs/lsp7-preset-extensions-natspec branch from 152f8f0 to 7bd2d58 Compare August 14, 2023 15:15
@CJ42 CJ42 merged commit 3d9d893 into develop Aug 14, 2023
26 checks passed
@CJ42 CJ42 deleted the docs/lsp7-preset-extensions-natspec branch August 14, 2023 15:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants