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

00599 Smart contract verification UI/UX implemented with the native explorer experience #758

Merged
merged 88 commits into from
Nov 20, 2023
Merged

00599 Smart contract verification UI/UX implemented with the native explorer experience #758

merged 88 commits into from
Nov 20, 2023

Conversation

ericleponner
Copy link
Collaborator

Description:

With the changes below, contract verification is now handled by Explorer using Verify Contract dialog.

image

This implementation follows closely UI/UX design work but keeps current look&feel of Explorer.
New look&feel will be addressed in a second phase and will be applied to the whole application.

This implementation also updates Contract Bytecode section. As requested, IPFS Hash and SWARM Hash fields are no longer displayed.

image

Related issue(s):

Fixes #599, #755

Notes for reviewer:

You can have look at 0.0.120960 (on previewnet) : it's an HTS contract (source code used for deployment is here).

This implementation has been deployed on staging server for the two last weeks.

Checklist

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

ericleponner and others added 28 commits November 20, 2023 15:07
@ericleponner
Removed ContractAnalyzer.metadataOrigin.
900f27b 
Signed-off-by: Eric Le Ponner <eric.leponner@icloud.com>
@ericleponner
Added SolcIndexCache (to be used later).
200b45e 
Signed-off-by: Eric Le Ponner <eric.leponner@icloud.com>
@ericleponner
Added ContractVerificationDialog (to be used later).
6fe26a5 
Signed-off-by: Eric Le Ponner <eric.leponner@icloud.com>
@ericleponner
Added ContractVerificationDialog (to be used later).
9f9c003 
Signed-off-by: Eric Le Ponner <eric.leponner@icloud.com>
@ericleponner
ContractByteCodeSection now displays ContractVerificationDialog (when…
e29b74d 
… VITE_APP_ENABLE_VERIFICATION_UI_PHASE2 is true).

Signed-off-by: Eric Le Ponner <eric.leponner@icloud.com>
@ericleponner
Added SolcUtils.runAsWorker() (to be used later).
266f625 
Signed-off-by: Eric Le Ponner <eric.leponner@icloud.com>
@ericleponner
ContractVerificationDialog now uses ContractSourceAnalyzer to prepare…
340f3ce 
… verification operation.

Signed-off-by: Eric Le Ponner <eric.leponner@icloud.com>
@ericleponner
Fixed test break in ContractDetails.spec.ts.
d65c439 
Signed-off-by: Eric Le Ponner <eric.leponner@icloud.com>
@ericleponner
Fixed ContractSourceAnalyzer.sources.
c110f04 
Signed-off-by: Eric Le Ponner <eric.leponner@icloud.com>
@ericleponner
ContractVerificationDialog now displays progress dialog during verifi…
7e1c22e 
…cation operation.

Signed-off-by: Eric Le Ponner <eric.leponner@icloud.com>
@ericleponner
ContractSourceAnalyzer now ignores "./" when comparing two paths.
4c0fa90 
Signed-off-by: Eric Le Ponner <eric.leponner@icloud.com>
@svienot @ericleponner
Add icons for contract verification (for future use).
d1ad2b2 
Signed-off-by: Simon Viénot <simon.vienot@icloud.com>
Signed-off-by: Eric Le Ponner <eric.leponner@icloud.com>
@svienot @ericleponner
Base FileList.vue on a table.
f18ae4a 
Signed-off-by: Simon Viénot <simon.vienot@icloud.com>
Signed-off-by: Eric Le Ponner <eric.leponner@icloud.com>
@svienot @ericleponner
Fix index for removal in FileList.vue (still issue with Oruga :curren…
10c027c 
…tPage not updated).

Signed-off-by: Simon Viénot <simon.vienot@icloud.com>
Signed-off-by: Eric Le Ponner <eric.leponner@icloud.com>
@svienot @ericleponner
Drop ability to remove elements from table in FileList.vue
f9e6185 
Signed-off-by: Simon Viénot <simon.vienot@icloud.com>
Signed-off-by: Eric Le Ponner <eric.leponner@icloud.com>
@svienot @ericleponner
Get ContractByteCodeSection layout closer to UI spec.
66a9f42 
Signed-off-by: Simon Viénot <simon.vienot@icloud.com>
Signed-off-by: Eric Le Ponner <eric.leponner@icloud.com>
@svienot @ericleponner
Add simple-stupid mechanism to view the contract sources in ContractB…
f6c6730 
…yteCodeSection.

Signed-off-by: Simon Viénot <simon.vienot@icloud.com>
Signed-off-by: Eric Le Ponner <eric.leponner@icloud.com>
@svienot @ericleponner
Fix formatting and remove warning in SourceCodeValue.vue
ffada63 
Signed-off-by: Simon Viénot <simon.vienot@icloud.com>
Signed-off-by: Eric Le Ponner <eric.leponner@icloud.com>
@svienot @ericleponner
Bring ContractVerificationDialog a bit closer to spec.
10d6096 
Signed-off-by: Simon Viénot <simon.vienot@icloud.com>
Signed-off-by: Eric Le Ponner <eric.leponner@icloud.com>
@svienot @ericleponner
Add support for 'Clear all files' in ContractVerificationDialog.
e3aef4d 
Signed-off-by: Simon Viénot <simon.vienot@icloud.com>
Signed-off-by: Eric Le Ponner <eric.leponner@icloud.com>
@ericleponner
Fixed SolcUtils.findMatchingContract().
cffc8a6 
Signed-off-by: Eric Le Ponner <eric.leponner@icloud.com>
@ericleponner
Added ContractSourceAudit class and unit test (to be used later).
f2eb06c 
Signed-off-by: Eric Le Ponner <eric.leponner@icloud.com>
@ericleponner
ContractVerificationDialog and ContractSourceAnalyzer now uses Contra…
e1048f6 
…ctSourceAudit class.

Signed-off-by: Eric Le Ponner <eric.leponner@icloud.com>
@svienot @ericleponner
Adjust display of contract bytecode to spec.
5c0daec 
Signed-off-by: Simon Viénot <simon.vienot@icloud.com>
Signed-off-by: Eric Le Ponner <eric.leponner@icloud.com>
@svienot @ericleponner
Clean up a bit display of contract source.
afa76d2 
Signed-off-by: Simon Viénot <simon.vienot@icloud.com>
Signed-off-by: Eric Le Ponner <eric.leponner@icloud.com>
@svienot @ericleponner
Use list of ContractAuditItem as prop in FileList.
5ecb4ce 
Signed-off-by: Simon Viénot <simon.vienot@icloud.com>
Signed-off-by: Eric Le Ponner <eric.leponner@icloud.com>
@svienot @ericleponner
Show unused contract files in low contrast.
14cb3d7 
Signed-off-by: Simon Viénot <simon.vienot@icloud.com>
Signed-off-by: Eric Le Ponner <eric.leponner@icloud.com>
@svienot @ericleponner
Sort contract files in FileList to show target first, then used, then…
39e7787 
… unused files.

Signed-off-by: Simon Viénot <simon.vienot@icloud.com>
Signed-off-by: Eric Le Ponner <eric.leponner@icloud.com>
ericleponner and others added 24 commits November 20, 2023 15:07
@ericleponner
ContractVerificationDialog now detects HardHat metadata and use them …
f9913bf 
…in verification operation.

Signed-off-by: Eric Le Ponner <eric.leponner@icloud.com>
@svienot @ericleponner
Rewrite main message in ContractVerificationDialog.
b207b75 
Signed-off-by: Simon Viénot <simon.vienot@icloud.com>
Signed-off-by: Eric Le Ponner <eric.leponner@icloud.com>
@ericleponner
ContractVerificationDialog now enables to verify when a single metada…
3dac7ca 
…ta file is available.

Signed-off-by: Eric Le Ponner <eric.leponner@icloud.com>
@ericleponner
Added SolcUtils.castSolcInput() (to be used later).
0dc24f8 
Signed-off-by: Eric Le Ponner <eric.leponner@icloud.com>
@ericleponner
ContractSourceAudit now uses compilation settings found in solc metad…
bf40365 
…ata or solc input files.

Signed-off-by: Eric Le Ponner <eric.leponner@icloud.com>
@ericleponner
ContractSourceAudit.tryWithSolcMetadata() now avoids superfluous comp…
a4a5966 
…ilations.

Signed-off-by: Eric Le Ponner <eric.leponner@icloud.com>
@ericleponner
Fixed ContractSourceAudit.makeSolcInput().
4e8558e 
Signed-off-by: Eric Le Ponner <eric.leponner@icloud.com>
@ericleponner
SolcWorker.handleMessage() now correctly initializes SolcReport.resol…
9e97ddf 
…ution.

Signed-off-by: Eric Le Ponner <eric.leponner@icloud.com>
@ericleponner
ContractSourceAudit.tryWithSolcMetadata() now correctly retrieves sol…
e69fba8 
…c metadata from contract name.

Signed-off-by: Eric Le Ponner <eric.leponner@icloud.com>
@svienot @ericleponner
Fix condition for showing dialog suggesting to go back add the metada…
c8ab317 
…ta file.

Signed-off-by: Simon Viénot <simon.vienot@icloud.com>
Signed-off-by: Eric Le Ponner <eric.leponner@icloud.com>
@svienot @ericleponner
File FileChooser reset bug.
b6e934f 
Signed-off-by: Simon Viénot <simon.vienot@icloud.com>
Signed-off-by: Eric Le Ponner <eric.leponner@icloud.com>
@svienot @ericleponner
Fix progress dialog when contract name is not known.
590c417 
Signed-off-by: Simon Viénot <simon.vienot@icloud.com>
Signed-off-by: Eric Le Ponner <eric.leponner@icloud.com>
@svienot @ericleponner
Add RE_VERIFY button when contract is verified with partial match.
23da0c8 
Signed-off-by: Simon Viénot <simon.vienot@icloud.com>
Signed-off-by: Eric Le Ponner <eric.leponner@icloud.com>
@ericleponner
Fixed ContractSourceAudit.tryWithSolcMetadata().
5cddda0 
Signed-off-by: Eric Le Ponner <eric.leponner@icloud.com>
@svienot @ericleponner
Don't display IPFS or Swarm hash in ContractDetails.
9dea3d8 
Signed-off-by: Simon Viénot <simon.vienot@icloud.com>
Signed-off-by: Eric Le Ponner <eric.leponner@icloud.com>
@svienot @ericleponner
Do not display "Compilation settings are needed" until we have a dedi…
de6acc0 
…cated dialog.

Signed-off-by: Simon Viénot <simon.vienot@icloud.com>
Signed-off-by: Eric Le Ponner <eric.leponner@icloud.com>
@ericleponner
Re-fixed ContractSourceAudit.tryWithSolcMetadata()
c6c31b0 
Signed-off-by: Eric Le Ponner <eric.leponner@icloud.com>
@ericleponner
Fixed latent bug in SolcWorker.resolvePath().
697ab6d 
Signed-off-by: Eric Le Ponner <eric.leponner@icloud.com>
@ericleponner
ContractSourceAudit.build() now uses same search logic as SolcWorker …
dc8c2df 
…(fix for #755).

Signed-off-by: Eric Le Ponner <eric.leponner@icloud.com>
@ericleponner
Removed dead code and removed redundant initialization.
d023cf3 
Signed-off-by: Eric Le Ponner <eric.leponner@icloud.com>
@svienot @ericleponner
Fix condition for showing the dialog asking for confirmation to proce…
26dee17 
…ed without metadata.

Signed-off-by: Simon Viénot <simon.vienot@icloud.com>
Signed-off-by: Eric Le Ponner <eric.leponner@icloud.com>
@ericleponner
Fixed test break in ContractDetails.spec.ts.
26105d9 
Signed-off-by: Eric Le Ponner <eric.leponner@icloud.com>
@ericleponner
Fixed random test break in ContractSourceAudit.spec.ts.
4cae3b3 
Signed-off-by: Eric Le Ponner <eric.leponner@icloud.com>
@ericleponner
Fixed random test break in ContractSourceAudit.spec.ts (take #2).
b9ab640 
Signed-off-by: Eric Le Ponner <eric.leponner@icloud.com>
@svienot svienot merged commit 7556217 into main Nov 20, 2023
5 of 6 checks passed
@svienot svienot deleted the 00599_contract_verif_v3 branch November 20, 2023 14:09
@sonarcloud SonarCloud
Copy link

sonarcloud bot commented Nov 20, 2023

SonarCloud Quality Gate failed.    Quality Gate failed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot E 6 Security Hotspots
Code Smell A 28 Code Smells

0.0% 0.0% Coverage
0.0% 0.0% Duplication

warning The version of Java (11.0.17) you have used to run this analysis is deprecated and we will stop accepting it soon. Please update to at least Java 17.
Read more here

idea Catch issues before they fail your Quality Gate with our IDE extension sonarlint SonarLint

@svienot svienot mentioned this pull request Nov 20, 2023
Closed
@svienot svienot linked an issue Nov 28, 2023 that may be closed by this pull request
Smart Contract code verification and interaction in explorer #71
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@svienot svienot svienot approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
2 participants
@ericleponner @svienot