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

chore: [C4] Add first batch of QA fixes #693

Merged
merged 8 commits into from
Sep 27, 2023
Merged

chore: [C4] Add first batch of QA fixes #693

merged 8 commits into from
Sep 27, 2023

Conversation

YamenMerhi
Copy link
Member

@YamenMerhi YamenMerhi commented Aug 30, 2023

What does this PR introduce?

Add some of the QA fixes

PR Checklist

  • Wrote Tests
  • Wrote & Generated Documentation (readme/natspec/dodoc)
  • Ran npm run lint && npm run lint:solidity (solhint)
  • Ran npm run format (prettier)
  • Ran npm run build
  • Ran npm run test

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

🗄️ 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 279688
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 78454
Set 2 data keys of 100 bytes long value 260618
Set 3 data keys of 20 bytes long value 105171
Change the value of three data keys already set of 20 bytes long value 45471
Remove the value of three data keys already set 41360

🗄️ 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 60431
transfer LYX to a UP 62033
transfer tokens (LSP7) to an EOA (no data) 107196
transfer tokens (LSP7) to a UP (no data) 242704
transfer a NFT (LSP8) to a EOA (no data) 171043
transfer a NFT (LSP8) to a UP (no data) 289777

🛃 restricted controller

execute scenarios - 🛃 restricted controller ⛽ Gas Usage
transfer some LYXes to an EOA - restricted to 1 x allowed address only (TRANSFERVALUE + 1x AllowedCalls) 71623
transfers some tokens (LSP7) to an EOA - restricted to LSP7 + 2x allowed contracts only (CALL + 2x AllowedCalls) (no data) 121847
transfers some tokens (LSP7) to an other UP - restricted to LSP7 + 2x allowed contracts only (CALL + 2x AllowedCalls) (no data) 257355
transfers a NFT (LSP8) to an EOA - restricted to LSP8 + 2x allowed contracts only (CALL + 2x AllowedCalls) (no data) 185682
transfers a NFT (LSP8) to an other UP - restricted to LSP8 + 2x allowed contracts only (CALL + 2x AllowedCalls) (no data) 304416

🗄️ setData scenarios

👑 unrestricted controller

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

🛃 restricted controller

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

📝 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 30, 2023

Changes to gas cost

Generated at commit: 04a66bcc12af34b88911edb3e921d9c9726b1db5, compared to commit: b8eca3c5696acf85239130ef67edec9e8c134bfa

🧾 Summary (10% most significant diffs)

Contract Method Avg (+/-) %
LSP6ExecuteRestrictedController lsp20VerifyCall
transferLYXToEOA
transferLYXToUP
transferTokensToRandomEOA
-214 ✅
-147 ✅
-147 ✅
-157 ✅
-1.26%
-0.26%
-0.47%
-0.21%
LSP6ExecuteUnrestrictedController lsp20VerifyCall
transferLYXToEOA
transferLYXToUP
transferTokensToRandomEOA
-214 ✅
-147 ✅
-147 ✅
-157 ✅
-1.26%
-0.26%
-0.44%
-0.22%
LSP6SetDataRestrictedController execute
givePermissionsToController
restrictControllerToERC725YKeys
-160 ✅
+192 ❌
+192 ❌
-0.56%
+0.16%
+0.14%
LSP6SetDataUnrestrictedController execute
givePermissionsToController
-160 ✅
+192 ❌
-0.56%
+0.15%

Full diff report 👇
Contract Deployment Cost (+/-) Method Min (+/-) % Avg (+/-) % Median (+/-) % Max (+/-) % # Calls (+/-)
LSP6ExecuteRestrictedController 2,858,486 (-17,205) lsp20VerifyCall
transferLYXToEOA
transferLYXToUP
transferNFTToRandomEOA
transferNFTToRandomUP
transferTokensToRandomEOA
transferTokensToRandomUP
14,619 (-277)
56,018 (-147)
31,349 (-147)
130,724 (-45)
239,224 (-90)
73,535 (-157)
208,947 (-212)
-1.86%
-0.26%
-0.47%
-0.03%
-0.04%
-0.21%
-0.10%
16,818 (-214)
56,018 (-147)
31,349 (-147)
130,724 (-45)
239,224 (-90)
73,535 (-157)
208,947 (-212)
-1.26%
-0.26%
-0.47%
-0.03%
-0.04%
-0.21%
-0.10%
17,551 (-194)
56,018 (-147)
31,349 (-147)
130,724 (-45)
239,224 (-90)
73,535 (-157)
208,947 (-212)
-1.09%
-0.26%
-0.47%
-0.03%
-0.04%
-0.21%
-0.10%
17,551 (-194)
56,018 (-147)
31,349 (-147)
130,724 (-45)
239,224 (-90)
73,535 (-157)
208,947 (-212)
-1.09%
-0.26%
-0.47%
-0.03%
-0.04%
-0.21%
-0.10%
8 (0)
1 (0)
1 (0)
1 (0)
1 (0)
1 (0)
1 (0)
LSP6ExecuteUnrestrictedController 2,858,486 (-17,205) lsp20VerifyCall
transferLYXToEOA
transferLYXToUP
transferNFTToRandomEOA
transferNFTToRandomUP
transferTokensToRandomEOA
transferTokensToRandomUP
14,619 (-277)
56,648 (-147)
33,349 (-147)
129,472 (-46)
237,973 (-90)
71,971 (-157)
207,383 (-212)
-1.86%
-0.26%
-0.44%
-0.04%
-0.04%
-0.22%
-0.10%
16,818 (-214)
56,648 (-147)
33,349 (-147)
129,472 (-46)
237,973 (-90)
71,971 (-157)
207,383 (-212)
-1.26%
-0.26%
-0.44%
-0.04%
-0.04%
-0.22%
-0.10%
17,551 (-194)
56,648 (-147)
33,349 (-147)
129,472 (-46)
237,973 (-90)
71,971 (-157)
207,383 (-212)
-1.09%
-0.26%
-0.44%
-0.04%
-0.04%
-0.22%
-0.10%
17,551 (-194)
56,648 (-147)
33,349 (-147)
129,472 (-46)
237,973 (-90)
71,971 (-157)
207,383 (-212)
-1.09%
-0.26%
-0.44%
-0.04%
-0.04%
-0.22%
-0.10%
8 (0)
1 (0)
1 (0)
1 (0)
1 (0)
1 (0)
1 (0)
LSP6SetDataRestrictedController 2,843,270 (-17,198) execute
givePermissionsToController
restrictControllerToERC725YKeys
18,343 (-147)
120,826 (+192)
139,076 (+192)
-0.80%
+0.16%
+0.14%
28,375 (-160)
120,826 (+192)
139,076 (+192)
-0.56%
+0.16%
+0.14%
28,375 (-160)
120,826 (+192)
139,076 (+192)
-0.56%
+0.16%
+0.14%
38,408 (-173)
120,826 (+192)
139,076 (+192)
-0.45%
+0.16%
+0.14%
2 (0)
1 (0)
1 (0)
LSP6SetDataUnrestrictedController 2,843,270 (-17,198) execute
givePermissionsToController
restrictControllerToERC725YKeys
18,343 (-147)
126,826 (+192)
147,576 (+192)
-0.80%
+0.15%
+0.13%
28,375 (-160)
126,826 (+192)
147,576 (+192)
-0.56%
+0.15%
+0.13%
28,375 (-160)
126,826 (+192)
147,576 (+192)
-0.56%
+0.15%
+0.13%
38,408 (-173)
126,826 (+192)
147,576 (+192)
-0.45%
+0.15%
+0.13%
2 (0)
1 (0)
1 (0)

@YamenMerhi YamenMerhi marked this pull request as draft August 31, 2023 17:18
@YamenMerhi YamenMerhi marked this pull request as ready for review September 26, 2023 08:22
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.

added some small review comments

contracts/LSP20CallVerification/LSP20Errors.sol Outdated Show resolved Hide resolved
contracts/LSP20CallVerification/LSP20Errors.sol Outdated Show resolved Hide resolved
contracts/LSP0ERC725Account/LSP0ERC725AccountCore.sol Outdated Show resolved Hide resolved
@CJ42 CJ42 merged commit ec58800 into develop Sep 27, 2023
26 checks passed
@CJ42 CJ42 deleted the c4/QA branch September 27, 2023 10:12
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.

3 participants