refactor: improve LSP23 readability

[b00ste]

What does this PR introduce?

♻️ Refactor

This PR applies the following changes:

• Split the main contract in:
  1. main contract
  2. interface
  3. errors file
• Split deployContracts(...) in another 2 internal functions for better readability and separation of concern.
• Move the salt parameter into the ControlledContract struct because it is only used when deploying the initial contract. Makes it cluttered having it as a separate parameter.
• Move Natspec to the interface and inheriting it in the main contract.
• Natspec improvements. Added Natspec to structs and errors.
• Moved salt generation to internal overridable functions. Separating concern and less prone to errors.

With all these changes the tests were running good, no issues.

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]

👋 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	84850
Transfer 0.1 LYX to 3x EOA with 256 bytes of data	100042

🗄️ 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	279688
Set a 600 bytes long value	484124
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	260568
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	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).

[skimaharvey]

Thanks for the PR 🚀

• ✅ splitted contracts is better
• ✅ 2 internal functions witht the deployContracts function makes sense
• 🚫 would not split the event into different events it would be more difficult to retrieve them. The end goal is to make it easy to retrieve all infos at once
• ✔️ thats a good point, we use to have two different salts but its true than now salt is used only in the OwnerControlledContract so it may make sense to add it to the struct directly. Need to check with the rest of team

[CJ42]

Added first round of review

[CJ42]

Since the param of this event do not depend on the success and returnedData, we could emit it before the external to avoid out of order events in the logs.

I suggest move this emit statement before the external call.

[skimaharvey]

Would revert to single event for now

[skimaharvey]

Looks great! Thanks