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: add postdeployment module to docs #685

Merged
merged 3 commits into from
Aug 23, 2023
Merged

Conversation

skimaharvey
Copy link
Member

What does this PR introduce?

  • Add nastpec to IPostDeploymentModule

@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 42210
Transfer 1 LYX to a UP with 256 bytes of data 44867
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 100285

🗄️ 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 164465
Set a 300 bytes long value 279664
Set a 600 bytes long value 484112
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 78416
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 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 60443
transfer LYX to a UP 62045
transfer tokens (LSP7) to an EOA (no data) 107208
transfer tokens (LSP7) to a UP (no data) 242774
transfer a NFT (LSP8) to a EOA (no data) 171055
transfer a NFT (LSP8) to a UP (no data) 289949

🛃 restricted controller

execute scenarios - 🛃 restricted controller ⛽ Gas Usage
transfer some LYXes to an EOA - restricted to 1 x allowed address only (TRANSFERVALUE + 1x AllowedCalls) 71635
transfers some tokens (LSP7) to an EOA - restricted to LSP7 + 2x allowed contracts only (CALL + 2x AllowedCalls) (no data) 121859
transfers some tokens (LSP7) to an other UP - restricted to LSP7 + 2x allowed contracts only (CALL + 2x AllowedCalls) (no data) 257425
transfers a NFT (LSP8) to an EOA - restricted to LSP8 + 2x allowed contracts only (CALL + 2x AllowedCalls) (no data) 185694
transfers a NFT (LSP8) to an other UP - restricted to LSP8 + 2x allowed contracts only (CALL + 2x AllowedCalls) (no data) 304588

🗄️ setData scenarios

👑 unrestricted controller

setData scenarios - 👑 main controller ⛽ Gas Usage
updates profile details (LSP3Profile metadata) 136869
give permissions to a controller (AddressPermissions[] + AddressPermissions[index] + AddressPermissions:Permissions:) 132900
restrict a controller to some specific ERC725Y Data Keys 139276
restrict a controller to interact only with 3x specific addresses 161980
remove a controller (its permissions + its address from the AddressPermissions[] array) 67865
write 5x LSP12 Issued Assets 233247

🛃 restricted controller

setData scenarios - 🛃 restricted controller ⛽ Gas Usage
setData(bytes32,bytes) -> updates 1x data key 102770
setData(bytes32[],bytes[]) -> updates 3x data keys (first x3) 161509
setData(bytes32[],bytes[]) -> updates 3x data keys (middle x3) 145663
setData(bytes32[],bytes[]) -> updates 3x data keys (last x3) 170996
setData(bytes32[],bytes[]) -> updates 2x data keys + add 3x new controllers (including setting the array length + indexes under AddressPermissions[index]) 249916

📝 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).

@github-actions
Copy link
Contributor

github-actions bot commented Aug 23, 2023

Changes to gas cost

Generated at commit: f6194fee853c07f333c10d8d7e52e3b6d590dab5, compared to commit: 9db488aad9065f88cfc3c5f43f47b1fab35fc5f0

🧾 Summary (10% most significant diffs)

Contract Method Avg (+/-) %
LSP6SetDataRestrictedController supportsInterface +55 ❌ +10.24%
LSP6SetDataUnrestrictedController supportsInterface +55 ❌ +10.24%
LSP6ExecuteRestrictedController supportsInterface +55 ❌ +9.82%
LSP6ExecuteUnrestrictedController supportsInterface +55 ❌ +9.82%

Full diff report 👇
Contract Deployment Cost (+/-) Method Min (+/-) % Avg (+/-) % Median (+/-) % Max (+/-) % # Calls (+/-)
LSP6SetDataRestrictedController 2,860,468 (+21,623) execute
givePermissionsToController
restrictControllerToERC725YKeys
supportsInterface
18,490 (+136)
120,634 (+107)
138,884 (+55)
592 (+55)
+0.74%
+0.09%
+0.04%
+10.24%
28,535 (+82)
120,634 (+107)
138,884 (+55)
592 (+55)
+0.29%
+0.09%
+0.04%
+10.24%
28,535 (+82)
120,634 (+107)
138,884 (+55)
592 (+55)
+0.29%
+0.09%
+0.04%
+10.24%
38,581 (+28)
120,634 (+107)
138,884 (+55)
592 (+55)
+0.07%
+0.09%
+0.04%
+10.24%
2 (0)
1 (0)
1 (0)
4 (0)
LSP6SetDataUnrestrictedController 2,860,468 (+21,623) execute
givePermissionsToController
restrictControllerToERC725YKeys
supportsInterface
18,490 (+136)
126,634 (+107)
147,384 (+55)
592 (+55)
+0.74%
+0.08%
+0.04%
+10.24%
28,535 (+82)
126,634 (+107)
147,384 (+55)
592 (+55)
+0.29%
+0.08%
+0.04%
+10.24%
28,535 (+82)
126,634 (+107)
147,384 (+55)
592 (+55)
+0.29%
+0.08%
+0.04%
+10.24%
38,581 (+28)
126,634 (+107)
147,384 (+55)
592 (+55)
+0.07%
+0.08%
+0.04%
+10.24%
2 (0)
1 (0)
1 (0)
4 (0)
LSP6ExecuteRestrictedController 2,875,691 (+21,631) lsp20VerifyCall
supportsInterface
transferLYXToEOA
transferLYXToUP
transferNFTToRandomEOA
transferNFTToRandomUP
transferTokensToRandomEOA
transferTokensToRandomUP
14,896 (-3)
615 (+55)
56,165 (-998)
31,496 (+31)
130,008 (-856)
237,855 (-857)
76,025 (-1,066)
210,610 (-1,069)
-0.02%
+9.82%
-1.75%
+0.10%
-0.65%
-0.36%
-1.38%
-0.51%
17,032 (-3)
615 (+55)
56,165 (-998)
31,496 (+31)
130,008 (-856)
237,855 (-857)
76,025 (-1,066)
210,610 (-1,069)
-0.02%
+9.82%
-1.75%
+0.10%
-0.65%
-0.36%
-1.38%
-0.51%
17,745 (-3)
615 (+55)
56,165 (-998)
31,496 (+31)
130,008 (-856)
237,855 (-857)
76,025 (-1,066)
210,610 (-1,069)
-0.02%
+9.82%
-1.75%
+0.10%
-0.65%
-0.36%
-1.38%
-0.51%
17,745 (-3)
615 (+55)
56,165 (-998)
31,496 (+31)
130,008 (-856)
237,855 (-857)
76,025 (-1,066)
210,610 (-1,069)
-0.02%
+9.82%
-1.75%
+0.10%
-0.65%
-0.36%
-1.38%
-0.51%
8 (0)
24 (0)
1 (0)
1 (0)
1 (0)
1 (0)
1 (0)
1 (0)
LSP6ExecuteUnrestrictedController 2,875,691 (+21,631) lsp20VerifyCall
supportsInterface
transferLYXToEOA
transferLYXToUP
transferNFTToRandomEOA
transferNFTToRandomUP
transferTokensToRandomEOA
transferTokensToRandomUP
14,896 (-3)
615 (+55)
56,795 (+31)
33,496 (+31)
128,757 (+57)
236,604 (+55)
74,461 (+74)
209,046 (+71)
-0.02%
+9.82%
+0.05%
+0.09%
+0.04%
+0.02%
+0.10%
+0.03%
17,032 (-3)
615 (+55)
56,795 (+31)
33,496 (+31)
128,757 (+57)
236,604 (+55)
74,461 (+74)
209,046 (+71)
-0.02%
+9.82%
+0.05%
+0.09%
+0.04%
+0.02%
+0.10%
+0.03%
17,745 (-3)
615 (+55)
56,795 (+31)
33,496 (+31)
128,757 (+57)
236,604 (+55)
74,461 (+74)
209,046 (+71)
-0.02%
+9.82%
+0.05%
+0.09%
+0.04%
+0.02%
+0.10%
+0.03%
17,745 (-3)
615 (+55)
56,795 (+31)
33,496 (+31)
128,757 (+57)
236,604 (+55)
74,461 (+74)
209,046 (+71)
-0.02%
+9.82%
+0.05%
+0.09%
+0.04%
+0.02%
+0.10%
+0.03%
8 (0)
24 (0)
1 (0)
1 (0)
1 (0)
1 (0)
1 (0)
1 (0)

Copy link
Member

@CJ42 CJ42 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@CJ42 CJ42 merged commit fc3c7b2 into develop Aug 23, 2023
26 checks passed
@CJ42 CJ42 deleted the docs/post-deployment-module branch August 23, 2023 15:16
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