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.

Sign up for GitHub

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

Jump to bottom

feat: add display of contract disassembly in ContractDetails page (#817) #818

Merged
merged 51 commits into from
Dec 27, 2023
Merged

feat: add display of contract disassembly in ContractDetails page (#817) #818

merged 51 commits into from
Dec 27, 2023

Conversation

svienot
Copy link
Collaborator

@svienot svienot commented Dec 26, 2023 •
edited
Loading

Description:

  • Display of Runtime Bytecode and Assembly Bytecode side-by-side in the Contract Bytecode section
  • Showing the hexadecimal opcode is optional, and persisted as a user preference
  • Contract Bytecode section is now displayed after the Recent Contract Calls section
  • Compiler version renamed Solidity Compiler Version

Related issue(s):

Fixes #817

Notes for reviewer:

  • Screen capture:
Screenshot 2023-12-26 at 19 13 43
  • Also deployed on staging.

Checklist

  • Documented (Code comments, README, etc.)
  • Tested (unit, integration, etc.)

quiet-node and others added 30 commits December 22, 2023 23:39
@quiet-node @svienot
feat: added EVM bytecode Disassembler util class
e7e2402 
Signed-off-by: Logan Nguyen <[email protected]>
@quiet-node @svienot
feat: added BycodeTool component
1923e84 
Signed-off-by: Logan Nguyen <[email protected]>
@quiet-node @svienot
update: integrated BycodeTools for Disassmbler tool to main contract …
cd1d891 
…layout

Signed-off-by: Logan Nguyen <[email protected]>
@quiet-node @svienot
feat: added a new bytecode-tools route to host new BytecodeAnalyzerTo…
87e366e 
…ols component

Signed-off-by: Logan Nguyen <[email protected]>
@quiet-node @svienot
fix(test): fixed unit tests
b7e546a 
Signed-off-by: Logan Nguyen <[email protected]>
@quiet-node @svienot
test: added new test for BytecodeAnalyzerTools
e5603f4 
Signed-off-by: Logan Nguyen <[email protected]>
@quiet-node @svienot
feat: added removeCBORMetadata() in bytecode disassembler
b7ebb72 
Signed-off-by: Logan Nguyen <[email protected]>
@quiet-node @svienot
update: reorganized bytecode tool util folder
1421635 
Signed-off-by: Logan Nguyen <[email protected]>
@quiet-node @svienot
update: added DisassembledOpcodeOutput interface
0e52d59 
Signed-off-by: Logan Nguyen <[email protected]>
@quiet-node @svienot
feat: added Decompiler util class
3fd291a 
Signed-off-by: Logan Nguyen <[email protected]>
@quiet-node @svienot
feat: integrated Decompiler class and showcase decompiled solidity co…
8dfef36 
…ntract

Signed-off-by: Logan Nguyen <[email protected]>
@quiet-node @svienot
update: added prism to highlight decompiled solidity code
e46bd01 
Signed-off-by: Logan Nguyen <[email protected]>
@quiet-node @svienot
update: reworked bycode tools controller logic
9584090 
Signed-off-by: Logan Nguyen <[email protected]>
@quiet-node @svienot
update: updated bytecode tools
c391456 
Signed-off-by: Logan Nguyen <[email protected]>
@quiet-node @svienot
fix(style): fixed testBytecodeToolsRoute to compare to the correct value
dcfb374 
Signed-off-by: Logan Nguyen <[email protected]>
@quiet-node @svienot
update: removed param in makeRouteToBytecodeTools()
7b0493c 
Signed-off-by: Logan Nguyen <[email protected]>
@quiet-node @svienot
feat: added keyhash to rest calls to decompiler service
c76401c 
Signed-off-by: Logan Nguyen <[email protected]>
@quiet-node @svienot
update: added loading effect to disassmbler and decompiler
f205eef 
Signed-off-by: Logan Nguyen <[email protected]>
@quiet-node @svienot
update: removed unused component
a158220 
Signed-off-by: Logan Nguyen <[email protected]>
@quiet-node @svienot
udpate: reorganized disassembler folder
1d59b8a 
Signed-off-by: Logan Nguyen <[email protected]>
@quiet-node @svienot
chore(docs): added a evm version flag to EVM_OPCODES object
788c871 
Signed-off-by: Logan Nguyen <[email protected]>
@quiet-node @svienot
update: removed decompiler tool
3c9af81 
Signed-off-by: Logan Nguyen <[email protected]>
@svienot
Display 'Disassembled Bytecode' property at all times in ContractByte…
d559c92 
…CodeSection and remove the rest of bytecode tooling for the time being.

Signed-off-by: Simon Viénot <[email protected]>
@svienot
Adjust unit tests.
a78e246 
Signed-off-by: Simon Viénot <[email protected]>
@svienot
Introduce OpcodeValue to resolve (and link to) contract/account addre…
48a8c8a 
…sses in disassembled code.

Signed-off-by: Simon Viénot <[email protected]>
@svienot
Used computed in DisassembledCodeValue.
0f98ecd 
Signed-off-by: Simon Viénot <[email protected]>
@svienot
Take care of initialLoading in DisassembledCodeValue.
c0670f9 
Signed-off-by: Simon Viénot <[email protected]>
@svienot
Type computed in DisassembledCodeValue.
cfd77b3 
Signed-off-by: Simon Viénot <[email protected]>
@svienot
Show invalid opcodes with contrast.
4ebc2a3 
Signed-off-by: Simon Viénot <[email protected]>
@quiet-node @svienot
fix: fixed operation index
9b9ccfc 
Signed-off-by: Logan Nguyen <[email protected]>
svienot added 13 commits December 22, 2023 23:39
@svienot
Display Recent Contract Calls above Contract Bytecode
e8e6794 
Signed-off-by: Simon Viénot <[email protected]>
@svienot
Adjust unit tests.
eac6e5b 
Signed-off-by: Simon Viénot <[email protected]>
@svienot
Make left and right content wrap in DashboardCard.
636e7b1 
Signed-off-by: Simon Viénot <[email protected]>
@svienot
Preserve left/right content proportions in DashboardCard.
25f311b 
Signed-off-by: Simon Viénot <[email protected]>
@svienot
Display bytecode and assembly code side-by-side.
3848dae 
Signed-off-by: Simon Viénot <[email protected]>
@svienot
Adjust unit tests.
e524a4d 
Signed-off-by: Simon Viénot <[email protected]>
@svienot
Show FE opcode as 'INVALID' (white) and unknown opcodes as 'invalid' …
9519583 
…(grey)

Signed-off-by: Simon Viénot <[email protected]>
@svienot
Check bytecode and assembly code in unit tests.
131af9f 
Signed-off-by: Simon Viénot <[email protected]>
@svienot
ByteCodeValue is not copyable. Don't change background on hover when …
75dbbc2 
…a copyable does not have copy enabled.

Signed-off-by: Simon Viénot <[email protected]>
@svienot
Fix typo
8ca7bb4 
Signed-off-by: Simon Viénot <[email protected]>
@svienot
Make proper use of contract and account caches in OpcodeValue.
e1dec69 
Signed-off-by: Simon Viénot <[email protected]>
@svienot
Remove debug traces.
aa1de01 
Signed-off-by: Simon Viénot <[email protected]>
@svienot
Save 'Show hexa opcode' user pref in local storage.
48da731 
Signed-off-by: Simon Viénot <[email protected]>
@svienot svienot self-assigned this Dec 26, 2023
@github-actions GitHub Actions
Copy link

github-actions bot commented Dec 26, 2023 •
edited
Loading

Coverage Report

Status Category Percentage Covered / Total
🔵 Lines 88.4% 33365 / 37743
🔵 Statements 88.4% 33365 / 37743
🔵 Functions 66.69% 799 / 1198
🔵 Branches 84.42% 3697 / 4379
File Coverage
File Stmts % Branch % Funcs % Lines Uncovered Lines
Changed Files
src/AppStorage.ts 75.13% 70% 52.94% 75.13% 51-52, 55-56, 70-71, 98-100, 103-105, 118-119, 130-131, 141-142, 144-145, 154-163, 166-180
src/components/Copyable.vue 94.04% 80% 50% 94.04% 60-64
src/components/DashboardCard.vue 100% 100% 100% 100%
src/components/contract/ContractByteCodeSection.vue 98.13% 91.66% 20% 98.13% 32-33, 178-179
src/components/values/ByteCodeValue.vue 100% 83.33% 100% 100%
src/components/values/DisassembledCodeValue.vue 97.19% 57.14% 100% 97.19% 70-71, 78
src/components/values/HexaValue.vue 97.33% 88.46% 75% 97.33% 102-105
src/components/values/OpcodeValue.vue 99.1% 95.45% 100% 99.1% 40
src/pages/ContractDetails.vue 98.63% 92.4% 100% 98.63% 74-78
src/utils/bytecode_tools/disassembler/BytecodeDisassembler.ts 100% 100% 100% 100%
src/utils/bytecode_tools/disassembler/utils/evm_opcodes.ts 100% 100% 100% 100%
src/utils/bytecode_tools/disassembler/utils/helpers.ts 93.47% 89.47% 100% 93.47% 101-110, 174-175
Generated in workflow #612

@svienot
Extend OpcodeValue unit tests.
b62b83d 
Signed-off-by: Simon Viénot <[email protected]>
@svienot
Remove test code.
2abff17 
Signed-off-by: Simon Viénot <[email protected]>
@svienot svienot marked this pull request as ready for review December 26, 2023 22:34
quiet-node
quiet-node previously approved these changes Dec 27, 2023
View reviewed changes
Copy link
Member

@quiet-node quiet-node left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@quiet-node quiet-node changed the title 00817 disassemble contract bytecode feat: added new feature to display contract's disassembly in ContractDetail page (#817) Dec 27, 2023
@svienot svienot changed the title feat: added new feature to display contract's disassembly in ContractDetail page (#817) feat: add display of contract disassembly in ContractDetails page (#817) Dec 27, 2023
@sonarqubecloud SonarQubeCloud
Copy link

Quality Gate Failed Quality Gate failed

Failed conditions

1 Security Hotspot
0.0% Coverage on New Code (required ≥ 80%)
8.8% Duplication on New Code (required ≤ 3%)

See analysis details on SonarCloud

ericleponner
ericleponner approved these changes Dec 27, 2023
View reviewed changes
Copy link
Collaborator

@ericleponner ericleponner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good

@svienot svienot merged commit bafcf97 into main Dec 27, 2023
4 of 5 checks passed
@svienot svienot deleted the 00817-disassemble-contract-bytecode branch December 27, 2023 16:05
svienot added a commit that referenced this pull request Jan 8, 2024
@svienot
Revert "feat: add display of contract disassembly in ContractDetails …
b80c3e5 
…page (#817) (#818)"

This reverts commit bafcf97.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ericleponner ericleponner ericleponner approved these changes

@quiet-node quiet-node quiet-node left review comments

Assignees

@svienot svienot

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Allow to visualize Assembly Bytecode in ContractDetails view.
3 participants
@svienot @quiet-node @ericleponner