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: write manual Natspec docs for 4337Extension.sol to fix Docusaurus build error #800

Merged
merged 2 commits into from
Nov 24, 2023

Conversation

CJ42
Copy link
Member

@CJ42 CJ42 commented Nov 9, 2023

What does this PR introduce?

📄 Documentation

Docs pages generated by the latest Docusaurus 3 version cannot parse Markdown that contains characters like < or {.
This was the case in docs.lukso.tech.

This problem occurs for the docs of the 4337Extension.sol contract, where the Natspecs from the validateUserOps function are fetched from IAccount.sol. Fixes this by:

  • re-writing the same Natspec comments in this contract
  • encapsulate the special characters < between back ticks to fix the docusaurus build error.
  • add extra note about permissions for this extension.

image

Also fix a small broken link in LSP6 Natspecs.

Copy link
Contributor

github-actions bot commented Nov 9, 2023

👋 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.

⛽📊 Gas Benchmark Report

Deployment Costs

Deployed contracts ⛽ Deployment cost
UniversalProfile 3185468 (0 )
KeyManager 3659015 (0 )
LSP1DelegateUP 1637510 (0 )
LSP7Mintable 2333123 (0 )
LSP8Mintable 2423070 (0 )

Runtime Costs

UniversalProfile owned by an 🔑 EOA

🔀 execute scenarios

execute scenarios - UP owned by 🔑 EOA ⛽ Gas Usage
Transfer 1 LYX to an EOA without data 37560 (0 )
Transfer 1 LYX to a UP without data 46253 (0 )
Transfer 1 LYX to an EOA with 256 bytes of data 42233 (12 📈❌)
Transfer 1 LYX to a UP with 256 bytes of data 57162 (-12 📉✅)
Transfer 0.1 LYX to 3x EOA without data 70862 (0 )
Transfer 0.1 LYX to 3x UP without data 104453 (0 )
Transfer 0.1 LYX to 3x EOA with 256 bytes of data 84802 (0 )
Transfer 0.1 LYX to 3x UPs with 256 bytes of data 137245 (72 📈❌)

🗄️ setData scenarios

setData scenarios - UP owned by 🔑 EOA ⛽ Gas Usage
Set a 20 bytes long value 49951 (0 )
Set a 60 bytes long value 95273 (12 📈❌)
Set a 160 bytes long value 164421 (-24 📉✅)
Set a 300 bytes long value 279668 (12 📈❌)
Set a 600 bytes long value 484128 (24 📈❌)
Change the value of a data key already set 32839 (0 )
Remove the value of a data key already set 27313 (0 )
Set 2 data keys of 20 bytes long value 78500 (0 )
Set 2 data keys of 100 bytes long value 260652 (-12 📉✅)
Set 3 data keys of 20 bytes long value 105218 (0 )
Change the value of three data keys already set of 20 bytes long value 45518 (0 )
Remove the value of three data keys already set 41397 (0 )

🗄️ Tokens scenarios

Tokens scenarios - UP owned by 🔑 EOA ⛽ Gas Usage
Minting a LSP7Token to a UP (No Delegate) from an EOA 92680 (0 )
Minting a LSP7Token to an EOA from an EOA 59355 (0 )
Transferring an LSP7Token from a UP to another UP (No Delegate) 101556 (0 )
Minting a LSP8Token to a UP (No Delegate) from an EOA 159571 (0 )
Minting a LSP8Token to an EOA from an EOA 126247 (0 )
Transferring an LSP8Token from a UP to another UP (No Delegate) 150249 (0 )
UniversalProfile owned by a 🔒📄 LSP6KeyManager

🔀 execute scenarios

execute scenarios 👑 main controller 🛃 restricted controller
LYX transfer --> to an EOA 64356 (0 ) 75306 (0 )
LYX transfer --> to a UP 78489 (0 ) 93386 (0 )
LSP7 token transfer --> to an EOA 116353 (0 ) 131103 (0 )
LSP7 token transfer --> to a UP 249583 (0 ) 264333 (0 )
LSP8 NFT transfer --> to an EOA 180461 (0 ) 195188 (0 )
LSP8 NFT transfer --> to a UP 296915 (0 ) 311642 (0 )

🗄️ setData scenarios

setData scenarios 👑 main controller 🛃 restricted controller
Update Profile details (LSP3Profile Metadata) 67294 (0 ) 77316 (0 )
Add a new controller with permission to SET_DATA + 3x allowed data keys:
AddressPermissions[]
+ AddressPermissions[index]
+ AddressPermissions:Permissions:<controller>
+ AddressPermissions:AllowedERC725YDataKeys:<controller)
209636 (0 ) 219793 (0 )
Update permissions of previous controller. Allow it now to SUPER_SETDATA 52322 (0 ) 55328 (0 )
Remove a controller:
1. decrease AddressPermissions[] Array length
2. remove the controller address at AddressPermissions[index]
3. set "0x" for the controller permissions under AddressPermissions:Permissions:
78861 (0 ) 90160 (0 )
Write 5x new LSP12 Issued Assets 66989 (0 ) 101616 (0 )
Update 3x data keys (first 3) 125501 (0 ) 159605 (0 )
Update 3x data keys (middle 3) 105589 (0 ) 143759 (0 )
Update 3x data keys (last 3) 125501 (0 ) 169092 (0 )
Set 2 x new data keys + add 3x new controllers 810481 (0 ) 872281 (0 )

@CJ42 CJ42 merged commit a34c504 into develop Nov 24, 2023
25 checks passed
@CJ42 CJ42 deleted the docs/4337-natspec branch November 24, 2023 14:03
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