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

fix: add receive() function in LSP7 & LSP8 to silent compiler warning #711

Merged
merged 3 commits into from
Sep 27, 2023

Conversation

b00ste
Copy link
Member

@b00ste b00ste commented Sep 11, 2023

What does this PR introduce?

♻️ Refactor

This PR introduces the following changes:

  • New error in both LSP7 & LSP8 for not allowing sending native tokens to LSP7 & LSP8 contracts.
  • Add receive() that reverts in LSP7 & LSP8

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

@b00ste b00ste force-pushed the add-receive-in-tokens branch from ca66353 to 38de47f Compare September 11, 2023 14:49
@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 42186
Transfer 1 LYX to a UP with 256 bytes of data 44843
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 100321

🗄️ setData scenarios

setData scenarios - 👑 UP Owner ⛽ Gas Usage
Set a 20 bytes long value 49971
Set a 60 bytes long value 95281
Set a 160 bytes long value 164441
Set a 300 bytes long value 279688
Set a 600 bytes long value 484148
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 105145
Change the value of three data keys already set of 20 bytes long value 45433
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 92016
Minting a LSP7Token to an EOA from an EOA 59323
Transferring an LSP7Token from a UP to another UP (No Delegate) 100102
Minting a LSP8Token to a UP (No Delegate) from an EOA 158946
Minting a LSP8Token to an EOA from an EOA 126253
Transferring an LSP8Token from a UP to another UP (No Delegate) 148671

📝 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 60449
transfer LYX to a UP 62051
transfer tokens (LSP7) to an EOA (no data) 107969
transfer tokens (LSP7) to a UP (no data) 244399
transfer a NFT (LSP8) to a EOA (no data) 171838
transfer a NFT (LSP8) to a UP (no data) 291515

🛃 restricted controller

execute scenarios - 🛃 restricted controller ⛽ Gas Usage
transfer some LYXes to an EOA - restricted to 1 x allowed address only (TRANSFERVALUE + 1x AllowedCalls) 71641
transfers some tokens (LSP7) to an EOA - restricted to LSP7 + 2x allowed contracts only (CALL + 2x AllowedCalls) (no data) 122660
transfers some tokens (LSP7) to an other UP - restricted to LSP7 + 2x allowed contracts only (CALL + 2x AllowedCalls) (no data) 259090
transfers a NFT (LSP8) to an EOA - restricted to LSP8 + 2x allowed contracts only (CALL + 2x AllowedCalls) (no data) 186494
transfers a NFT (LSP8) to an other UP - restricted to LSP8 + 2x allowed contracts only (CALL + 2x AllowedCalls) (no data) 306171

🗄️ setData scenarios

👑 unrestricted controller

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

🛃 restricted controller

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

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

@b00ste b00ste force-pushed the add-receive-in-tokens branch 2 times, most recently from 678a3ca to 2860b26 Compare September 18, 2023 12:38
@b00ste b00ste force-pushed the add-receive-in-tokens branch from 2860b26 to f098c82 Compare September 26, 2023 09:09
@github-actions
Copy link
Contributor

github-actions bot commented Sep 26, 2023

Changes to gas cost

Generated at commit: 4b2a2b43dea48f2002c36807eace1d674e548c64, 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)

@CJ42 CJ42 changed the title refactor: add receive() in LSP7 & LSP8 fix: add receive() function in LSP7 & LSP8 to silent compiler warning Sep 26, 2023
@b00ste b00ste force-pushed the add-receive-in-tokens branch 3 times, most recently from f5f0987 to 9ef792e Compare September 27, 2023 08:27
@b00ste b00ste force-pushed the add-receive-in-tokens branch from 9ef792e to c631370 Compare September 27, 2023 10:14
@CJ42 CJ42 merged commit e6fb55d into develop Sep 27, 2023
26 checks passed
@CJ42 CJ42 deleted the add-receive-in-tokens branch September 27, 2023 10: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