sourcify icon indicating copy to clipboard operation
sourcify copied to clipboard

Naming Match quality/status/type consistently

Open kuzdogan opened this issue 3 years ago • 3 comments

Right now we have two different names for representing a Match including the bytecode auxdata. It's both "full" and "perfect". This creates confusion and inconsistency.

Let's have a single name for this. I'd suggest just using "perfect"

kuzdogan avatar Jan 17 '23 08:01 kuzdogan

Regarding this topic, I add that more than 1 person during devcon suggested us to give better naming / colors to the two states of verification. From their point of view users should not feel threatened when interacting with a partially verified contract. I honestly feel like they should do, but that said I believe we must focus on a more explenatory naming for the verification statuses.

I already told you that I would go for a name that explicitly explains that the metadata is also verified, and the other one that makes it clear that only the execution bytecode is verified. My proposal is the following:

  • metadata and execution-bytecode verified
  • execution-bytecode verified

Of course the main problem with this naming is that the names are not short and most people will not understand them. But I believe that Sourcify's target are not the final users. From my point of view wallets will be the one thinking about good terminology to explain the users what's going on, our focus should be on giving clear and complete information to the wallets developers.

marcocastignoli avatar Jan 31 '23 14:01 marcocastignoli

Coming back to this, I'd say we want to keep a suggestive naming as pushing for full matches is also a goal of this project. In our perspective, a partial match is indeed inferior to a full match. It does not necessarily imply being "unsafe" but for us it's not the desired way to verify.

If they want to, wallets or applications can choose to convey this to their users differently, e.g. not mentioning full/partial at all and just say verified.

kuzdogan avatar Mar 13 '23 10:03 kuzdogan

Also about the "full" ve "perfect", to go to "perfect" only would require changing the repo structure and potentially other changes. If we were to go this route, we can add a contracts/full_match to contracts/perfect_match redirect.

kuzdogan avatar Mar 13 '23 10:03 kuzdogan