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

refactor!: remove LSP0Utils.sol in favour of moving the functions inside LSP1Utils.sol #683

Merged
merged 1 commit into from
Aug 22, 2023

Conversation

CJ42
Copy link
Member

@CJ42 CJ42 commented Aug 21, 2023

What does this PR introduce?

Currently, the LSP0Utils library creates blocker that preventing moving to a monorepo. This library creates a cyclic dependency between LSP0 and LSP1 for the following reasons:

  • LSP0Utils requires constants from the LSP1 package.
  • LSP1 in its current state requires constants from the LSP0 package.

Therefore, since there is this loop in the dependency, this prevents in the monorepo from running the build command.

This PR removes the LSP0Utils library completely, moving its functions inside the LSP1Utils library (since the functions are directly associated with querying an ERC725Y storage to fetch the values under the LSP1 data keys.

PR Checklist

  • Wrote Tests (N/A)
  • 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

@Hugoo
Copy link
Member

Hugoo commented Aug 21, 2023

@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 44855
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 164453
Set a 300 bytes long value 279664
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 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 60445
transfer LYX to a UP 62047
transfer tokens (LSP7) to an EOA (no data) 107168
transfer tokens (LSP7) to a UP (no data) 242740
transfer a NFT (LSP8) to a EOA (no data) 171015
transfer a NFT (LSP8) to a UP (no data) 289915

🛃 restricted controller

execute scenarios - 🛃 restricted controller ⛽ Gas Usage
transfer some LYXes to an EOA - restricted to 1 x allowed address only (TRANSFERVALUE + 1x AllowedCalls) 72654
transfers some tokens (LSP7) to an EOA - restricted to LSP7 + 2x allowed contracts only (CALL + 2x AllowedCalls) (no data) 122947
transfers some tokens (LSP7) to an other UP - restricted to LSP7 + 2x allowed contracts only (CALL + 2x AllowedCalls) (no data) 258519
transfers a NFT (LSP8) to an EOA - restricted to LSP8 + 2x allowed contracts only (CALL + 2x AllowedCalls) (no data) 186782
transfers a NFT (LSP8) to an other UP - restricted to LSP8 + 2x allowed contracts only (CALL + 2x AllowedCalls) (no data) 305682

🗄️ 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 102776
setData(bytes32[],bytes[]) -> updates 3x data keys (first x3) 161515
setData(bytes32[],bytes[]) -> updates 3x data keys (middle x3) 145669
setData(bytes32[],bytes[]) -> updates 3x data keys (last x3) 171002
setData(bytes32[],bytes[]) -> updates 2x data keys + add 3x new controllers (including setting the array length + indexes under AddressPermissions[index]) 249922

📝 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

Changes to gas cost

Generated at commit: 2581a5eb9308dc331484fdbc102dac0d02da62a4, compared to commit: 9db488aad9065f88cfc3c5f43f47b1fab35fc5f0

🧾 Summary (10% most significant diffs)

Contract Method Avg (+/-) %
LSP6SetDataRestrictedController execute +13 ❌ +0.05%
LSP6SetDataUnrestrictedController execute +13 ❌ +0.05%

Full diff report 👇
Contract Deployment Cost (+/-) Method Min (+/-) % Avg (+/-) % Median (+/-) % Max (+/-) % # Calls (+/-)
LSP6SetDataRestrictedController 2,877,091 (+38,246) execute 18,354 (0) 0.00% 28,466 (+13) +0.05% 28,466 (+13) +0.05% 38,578 (+25) +0.06% 2 (0)
LSP6SetDataUnrestrictedController 2,877,091 (+38,246) execute 18,354 (0) 0.00% 28,466 (+13) +0.05% 28,466 (+13) +0.05% 38,578 (+25) +0.06% 2 (0)
LSP6ExecuteRestrictedController 2,892,307 (+38,247)
LSP6ExecuteUnrestrictedController 2,892,307 (+38,247)

@CJ42 CJ42 merged commit ade0b2e into develop Aug 22, 2023
40 checks passed
@CJ42 CJ42 deleted the DEV-7944 branch August 22, 2023 07:50
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.

4 participants