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

Update wallet listing policy #6438

Merged
merged 56 commits into from
Jun 1, 2022
Merged

Update wallet listing policy #6438

Changes from 2 commits
Commits
Show all changes
56 commits
Select commit Hold shift + click to select a range
2882732
Copy over content from GH issue (#6434)
samajammin May 23, 2022
8499ca5
Format template
samajammin May 23, 2022
e94d027
Update .github/ISSUE_TEMPLATE/suggest_wallet.md
corwintines May 24, 2022
a03d908
Update .github/ISSUE_TEMPLATE/suggest_wallet.md
corwintines May 24, 2022
82826e1
Update .github/ISSUE_TEMPLATE/suggest_wallet.md
corwintines May 24, 2022
ab182e2
Update .github/ISSUE_TEMPLATE/suggest_wallet.md
corwintines May 24, 2022
a3b2fc1
Update .github/ISSUE_TEMPLATE/suggest_wallet.md
corwintines May 25, 2022
ac47cc7
Update .github/ISSUE_TEMPLATE/suggest_wallet.md
corwintines May 25, 2022
39ddd6e
Update .github/ISSUE_TEMPLATE/suggest_wallet.md
corwintines May 25, 2022
7e053e9
Update .github/ISSUE_TEMPLATE/suggest_wallet.md
corwintines May 25, 2022
6c37a98
Update .github/ISSUE_TEMPLATE/suggest_wallet.md
corwintines May 25, 2022
a5f11e0
Update .github/ISSUE_TEMPLATE/suggest_wallet.md
corwintines May 25, 2022
c9f471a
Update suggest_wallet.md
corwintines May 25, 2022
3b6145a
Update suggest_wallet.md
corwintines May 25, 2022
722f04f
Update .github/ISSUE_TEMPLATE/suggest_wallet.md
corwintines May 25, 2022
4994d77
Update .github/ISSUE_TEMPLATE/suggest_wallet.md
corwintines May 25, 2022
569fc85
Update .github/ISSUE_TEMPLATE/suggest_wallet.md
corwintines May 25, 2022
09e63fd
Update .github/ISSUE_TEMPLATE/suggest_wallet.md
corwintines May 25, 2022
293634c
Update .github/ISSUE_TEMPLATE/suggest_wallet.md
corwintines May 25, 2022
11f7342
Update .github/ISSUE_TEMPLATE/suggest_wallet.md
corwintines May 25, 2022
0b340cd
Update .github/ISSUE_TEMPLATE/suggest_wallet.md
corwintines May 25, 2022
fa2779c
Update .github/ISSUE_TEMPLATE/suggest_wallet.md
corwintines May 25, 2022
abf92f8
Update .github/ISSUE_TEMPLATE/suggest_wallet.md
corwintines May 25, 2022
c2a8183
Update .github/ISSUE_TEMPLATE/suggest_wallet.md
corwintines May 25, 2022
7494f9f
Update .github/ISSUE_TEMPLATE/suggest_wallet.md
corwintines May 25, 2022
49c6e0a
Update .github/ISSUE_TEMPLATE/suggest_wallet.md
corwintines May 25, 2022
2814fd4
Update .github/ISSUE_TEMPLATE/suggest_wallet.md
corwintines May 25, 2022
887c27d
Update suggest_wallet.md
corwintines May 25, 2022
79f0b21
Update .github/ISSUE_TEMPLATE/suggest_wallet.md
corwintines May 25, 2022
4acb059
Update .github/ISSUE_TEMPLATE/suggest_wallet.md
corwintines May 25, 2022
9a0ac4c
Update .github/ISSUE_TEMPLATE/suggest_wallet.md
corwintines May 26, 2022
d26024e
Update .github/ISSUE_TEMPLATE/suggest_wallet.md
corwintines May 26, 2022
b206960
Update .github/ISSUE_TEMPLATE/suggest_wallet.md
corwintines May 26, 2022
23bfea0
Update .github/ISSUE_TEMPLATE/suggest_wallet.md
corwintines May 26, 2022
cba7469
Update .github/ISSUE_TEMPLATE/suggest_wallet.md
corwintines May 26, 2022
fdf119d
Update .github/ISSUE_TEMPLATE/suggest_wallet.md
corwintines May 26, 2022
c1f8876
Update .github/ISSUE_TEMPLATE/suggest_wallet.md
corwintines May 26, 2022
0c0b6a3
Update .github/ISSUE_TEMPLATE/suggest_wallet.md
corwintines May 26, 2022
a557f42
Update .github/ISSUE_TEMPLATE/suggest_wallet.md
corwintines May 26, 2022
b4b5654
Update .github/ISSUE_TEMPLATE/suggest_wallet.md
corwintines May 26, 2022
c1de7a7
Update .github/ISSUE_TEMPLATE/suggest_wallet.md
corwintines May 26, 2022
1036f39
Merge branch 'dev' into wallet-listing-policy
corwintines May 26, 2022
2002de2
change requests
corwintines May 26, 2022
bec25f3
setup yaml
corwintines May 26, 2022
f52c997
test commit
corwintines May 26, 2022
778982d
test
corwintines May 26, 2022
b615e9b
project info form
corwintines May 26, 2022
39d4a75
device form
corwintines May 26, 2022
0e3f089
security form
corwintines May 26, 2022
60a5bff
features form
corwintines May 26, 2022
ee94755
fix features bugs
corwintines May 26, 2022
f358eaa
finance form
corwintines May 26, 2022
1246f99
smart contract form
corwintines May 26, 2022
1a52f39
support form
corwintines May 26, 2022
08de2bc
extra form
corwintines May 26, 2022
193a3eb
remove md issue template
corwintines May 30, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
180 changes: 137 additions & 43 deletions .github/ISSUE_TEMPLATE/suggest_wallet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,98 +6,192 @@ labels: "wallet :purse:,"
assignees: ""
---

_Please note as part of [our Q2 product roadmap](https://github.com/ethereum/ethereum-org-website/issues/6161) we paused adding new wallets until we establish new, expanded criteria._
Before suggesting a wallet, make sure you've read [our listing policy](https://www.ethereum.org/en/contributing/adding-products/). Only continue with the issue if your wallet meets the criteria listed there.
corwintines marked this conversation as resolved.
Show resolved Hide resolved

Before suggesting a wallet, make sure you've read [our listing policy](https://www.ethereum.org/en/contributing/adding-products/).
If the wallet does meet our list policy, please complete the following information which we need to accurately list the wallet.
corwintines marked this conversation as resolved.
Show resolved Hide resolved

Only continue with the issue if your wallet meets the criteria listed there.
### Project info

If it does complete the following information which we need to accurately list the wallet.
**Wallet name**

**Is your wallet security tested? Please explain security measures i.e. security audit, internal security team or some other method.**
<!-- Please provide the official name of the wallet -->

**Wallet description**

<!-- Please provide a short 1-2 sentence description of the wallet without marketing claims. Avoid claims like “the best Ethereum wallet”. We will ask for revisions if this comes across as marketing-focused. -->
corwintines marked this conversation as resolved.
Show resolved Hide resolved

**Wallet logo**

<!-- Please provide a hi-res SVG or transparent PNG -->
corwintines marked this conversation as resolved.
Show resolved Hide resolved

**Background color for brand logo**

<!-- Please provide a hex code for the brand color. This will be added to the background of the wallet card. -->

**URL to the project**

<!-- Please provide a URL (e.g. to the website of the wallet) -->

**URL to the documentation**
corwintines marked this conversation as resolved.
Show resolved Hide resolved

<!-- Please provide a URL to the documentation -->

**Is your wallet security tested? Please explain security measures i.e. security audit, internal security team, or some other method.**
Copy link
Member Author

Choose a reason for hiding this comment

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

I think we can remove this - this is covered in the security section:

Please describe the measures taken to ensure the wallet's security and provide documentation wherever possible

Copy link
Contributor

Choose a reason for hiding this comment

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

I think we should be more explicit here. People often fluff this section with irrelevant information.

**Has the wallet's smart contract code been audited?**

<!-- If yes, provide a link to any audits. -->

**Does the wallet have an internal security team?**

<!-- If yes, please provide details. -->

**Any other security testing that should be noted?**

<!-- Please note any other security precautions taken. -->

The final point is potentially unnecessary but I think that it might help inform future iterations of the listing criteria.

Copy link
Contributor

Choose a reason for hiding this comment

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

@corwintines thoughts on this?

Copy link
Member

Choose a reason for hiding this comment

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

Will put this in the security section.

corwintines marked this conversation as resolved.
Show resolved Hide resolved

<!-- Please explain any security measures you have taken to ensure your wallet is secure -->
corwintines marked this conversation as resolved.
Show resolved Hide resolved

**When did your wallet go live to users?**
corwintines marked this conversation as resolved.
Show resolved Hide resolved

<!-- Please provide an exact or approximate date when your wallet was usable by the public -->
<!-- Please provide a date when your wallet was usable by the public. Please provide some user metrics for how many users are using this wallet. -->
corwintines marked this conversation as resolved.
Show resolved Hide resolved

**Does your wallet have an active development team?**
Copy link
Member

Choose a reason for hiding this comment

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

Open question for discussion: Should an active development team be noted as an absolute requirement?
Also, what defines active?

My take is this should be a requirement to keep users safe. Ethereum is still relatively young and has many upgrades being rolled out, and listed wallets should have developers maintaining the codebase and tending to bug reports.

Not sure what the cutoff should be though for an "inactive" project... Perhaps either an official announcement, or no code commits for > 6 mos?

Copy link
Member

Choose a reason for hiding this comment

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

I do think an active development team is a requirement. Just last year there was the EIP-1559 upgrade that required wallets to upgrade as a single example where there are changes that wallets would need to support. If anything this is almost the main requirement out of all of this.

corwintines marked this conversation as resolved.
Show resolved Hide resolved

<!-- Are developers actively working on the wallet? -->

**Is your wallet open-source?**

<!-- If yes, please provide a direct link to the repository, if you can -->
<!-- Are developers actively working on the wallet? Provide proof that the wallet is actively being worked on (ex. GitHub repo link). -->

**Is your wallet globally accessible?**
corwintines marked this conversation as resolved.
Show resolved Hide resolved

<!-- Please list any KYC requirements or geographic limitations of your wallet, if any exist. -->
corwintines marked this conversation as resolved.
Show resolved Hide resolved

**Is your wallet custodial, non-custodial, or a hardware wallet?**
**Is there internationalization support for your wallet?**
corwintines marked this conversation as resolved.
Show resolved Hide resolved

<!-- Please list languages that the wallet actively supports -->

**What is the repository for your codebase?**

<!-- If you’re project is open source, please provide a link to the codebase. -->
Copy link
Contributor

Choose a reason for hiding this comment

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

We should move this below the 'is the wallet open-source' question

Copy link
Member

Choose a reason for hiding this comment

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

Since we ask for the repo in that question I agree this can be removed.


**What social links are there for the project?**

<!-- Please provide social links for the wallet (Discord, Twitter, etc.) -->
Copy link
Contributor

Choose a reason for hiding this comment

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

Are we going to use this information? We should probably ask for exactly what we want if we are.

Copy link
Member

Choose a reason for hiding this comment

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

I don't see this explicitly in the design right now. @nloureiro Was there a plan to include these?

For comparison to other areas of the site, we have the socials in the staking-products.json for each product, but we ended up not adding these to the product cards that get rendered. Agree if we decide to not include this in the design then we should probably remove the question.

Copy link
Member

Choose a reason for hiding this comment

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

Im ok if these arent in v1 of this release, but I do think at some point showing this information would be ideal.

Copy link
Contributor

Choose a reason for hiding this comment

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

Im ok if these arent in v1 of this release, but I do think at some point showing this information would be ideal.

Then perhaps we ask explicitly? It'll save a bunch of time in the future.

Discord server:
Twitter:
what else?


**What is your wallet's onboarding experience?**
corwintines marked this conversation as resolved.
Show resolved Hide resolved

<!-- Please provide an explanation of where to find the user onboarding experience (links, is it built into the app, etc.), and what the onboarding experience is. -->

### Device

**Does the wallet have a mobile app? If yes, which operating systems are supported (iOS, Android)?**

<!-- If the wallet has a mobile interface, please provide information and links to the app store for the operating systems supported. -->
corwintines marked this conversation as resolved.
Show resolved Hide resolved

**Does the wallet have a desktop app? If yes, which operating systems are supported (Windows, Mac, Linux)?**

<!-- If the wallet has a desktop interface, please provide links and information for the operating systems supported. -->
corwintines marked this conversation as resolved.
Show resolved Hide resolved

**Does the wallet have a browser extension? If yes, which browsers are supported (Chromium, Firefox, Safari)?**

<!-- If the wallet has a browser extension, please provide links and information for the browsers that are supported. -->
corwintines marked this conversation as resolved.
Show resolved Hide resolved

**Is it a hardware wallet?**

<!-- How is it used / how does it connect (e.g. USB)? What software wallets does it integrate with (e.g. MetaMask)? -->
corwintines marked this conversation as resolved.
Show resolved Hide resolved

### Security

**Is the wallet code open-sourced?**
corwintines marked this conversation as resolved.
Show resolved Hide resolved

<!-- If yes, please provide a direct link to the repository. -->

**What license was the wallet software released under?**
corwintines marked this conversation as resolved.
Show resolved Hide resolved

<!-- Please provide information on the software license used for the wallet. -->

**Is your wallet custodial, or non-custodial?**
corwintines marked this conversation as resolved.
Show resolved Hide resolved

<!-- Do users have access to their public and/or private keys? If your company/project were to disappear, would users still be able to access their funds? -->
corwintines marked this conversation as resolved.
Show resolved Hide resolved

**Please describe the measures taken to ensure the wallet's security and provide documentation wherever possible**

<!-- Please provide a link to a report or repo. If you haven't been audited but think your wallet should be listed anyway, explain here. -->
<!-- Please provide a link to any security audits or code reports. If you haven't been audited but think your wallet should be listed anyway, explain here. -->
corwintines marked this conversation as resolved.
Show resolved Hide resolved

**Does the wallet support layer 2 networks?**
**Spam protection?**

<!-- Please list which L2 solutions the wallet supports. -->
<!-- Does the wallet employ any practices to warn users against potential spam (e.g. when interacting with suspicious accounts/contracts)? -->
Copy link
Contributor

Choose a reason for hiding this comment

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

Is spam the right word here? I'm curious do we know which wallets have features like this?


**Can the wallet be used with arbitrary Ethereum RPC endpoint?**
### Features

<!-- Does wallet allow user to use the wallet with own Eth client? -->
**Does the wallet have hardware wallet support?**
corwintines marked this conversation as resolved.
Show resolved Hide resolved

**Does the wallet have fiat on-ramps?**
<!-- Please provide information on how a user can connect a hardware wallet to this wallet. -->
Copy link
Member

Choose a reason for hiding this comment

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

Curious how we would use this info? Wouldn't this one be more of a binary yes/no?

Copy link
Member

Choose a reason for hiding this comment

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

Yeah, this is more binary. My idea here is a link to documentation like this: https://docs.metamask.io/guide/signing-data.html#signing-data-with-metamask


<!-- Does the wallet subsidise transaction fees for all or some wallet activity? -->
**Does the wallet support WalletConnect?**

**Does the wallet allow users to explore dapps?**
<!-- Please provide information on if the wallet supports WalletConnect. -->
Copy link
Member

Choose a reason for hiding this comment

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

WalletConnect can just be a simple yes/no, wouldn't ask to "provide information" here... super easy to confirm which wallets support WalletConnect.

Copy link
Member

Choose a reason for hiding this comment

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

Yeah this can just be yes or no.

corwintines marked this conversation as resolved.
Show resolved Hide resolved

<!-- Is the wallet integrated with WalletConnect? Does it have a dapp browser? Or can users connect to a dapp using the wallet? -->
**Does the wallet support importing Ethereum RPC endpoints?**

**Does the wallet have integrated defi/financial tools?**
<!-- Please provide documentation on how a user can import an Ethereum RPC into the wallet. -->

<!-- Can users borrow/earn/lend assets directly from a screen in the wallet? -->
**Does the wallet support viewing and interacting with NFTs?**

**Can a user withdraw to their card?**
<!-- Please provide information on the experience of NFTs in the wallet. -->

<!-- Can a user cash out their crypto assets directly to a card or bank account? -->
**Does the wallet support connecting to Ethereum applications?**

**Does the wallet offer limits protection?**
<!-- Please provide documentation for how users connect to applications. List examples (ie. connect wallet to dapp, in wallet browser, etc.) -->

<!-- Can a user set a limit for transfers to protect their assets? -->
**Does the wallet support staking directly?**
Copy link
Member Author

Choose a reason for hiding this comment

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

I wonder how important this feature is given that users could just swap for liquid staking tokens?

Copy link
Member

Choose a reason for hiding this comment

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

Probably less important. There is still a difference between adding more ETH to the pool, compared to just buying someone elses stake, but I hear ya. I think it's still worth leaving this in.


**Does the wallet allow high-volume purchases?**
<!-- Please provide documentation on direct staking this wallet supports. -->

<!-- Can a user buy more than $2000 worth of crypto in one go? -->
**Does the wallet support swaps directly?**

**Does the wallet have an integrated token swap?**
<!-- Please provide documentation on swaps. -->

<!-- Can a user swap ETH for other tokens from within a screen in the wallet? -->
**Does the wallet support multi-chain networks?**
Copy link
Member Author

Choose a reason for hiding this comment

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

Suggested change
**Does the wallet support multi-chain networks?**
**Does the wallet support layer 2 networks?**

Curious what folks think of "layer 2" vs. "multi-chain"? Or should we include both?

Ultimately I suspect L2 is what we care about. Users may want other EVM chains. There could also be user benefit in e.g. Bitcoin support in a wallet (like Ledger does).

Copy link
Contributor

Choose a reason for hiding this comment

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

Agree that we don't care about alt L1s like AVAX here but what about sidechains like Polygon?

Copy link
Contributor

Choose a reason for hiding this comment

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

Perhaps a better question: which L2s do you support? e.g. Argent supports zkSync but not Optimism. But Metamask supports custom RPCs.

Copy link
Member

Choose a reason for hiding this comment

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

Yeah, I see L2 and multi-chain as two different feature sets... one is contained within the Ethereum security bubble, the other is many different security bubbles.

Yes, in general, it's about which networks the wallet can connect to... but someone who uses Ethereum may reasonably want to find a wallet that supports L2s so they can inherit Ethereum's L1 security and still afford gas.

Meanwhile, someone who uses many cryptocurrencies on many chains care that their wallet also supports these other chains.

So my vote would be to include both. We should ask what non-EVM chains are compatible, and also what Ethereum L2s are compatible, imo.

Copy link
Member

Choose a reason for hiding this comment

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

I agree with the notion here, but my pushback would be from our discussions of what layer 2's are. I think a user would want to look at validiums or optimistic chains as well, which I would say still fall under the bundle of scaling Ethereum, but we don't classify it as a layer 2. That being said, I think that is more captured in the RPC importing question. Down for a discussion, but I think I agree with this suggestion.


**Is the wallet a multi-signature wallet?**
<!-- Please provide documentation on multi-chain networks this wallet supports. -->

<!-- Can a user opt to require multiple signatures to authorise transactions? -->
**Does the wallet allow the user to customize gas fees?**

**Wallet title**
<!-- Please provide documentation on how users can customize gas fees for transactions. -->

<!-- Please provide the official name of the wallet -->
**Does the wallet support ENS?**
corwintines marked this conversation as resolved.
Show resolved Hide resolved
corwintines marked this conversation as resolved.
Show resolved Hide resolved

**Wallet description**
<!-- Please provide information on ENS support. -->

<!-- Please provide a short 1-2 sentence description of the wallet -->
**Does the wallet support importing or automatically querying and displaying ERC-20 tokens?**

**Wallet logo**
<!-- Please provide documentation on how to import tokens into the wallet. -->

<!-- Please provide a hi-res SVG or transparent PNG -->
**Does the wallet support EIP-1559 style transactions?**
corwintines marked this conversation as resolved.
Show resolved Hide resolved

**Background colour for brand logo**
<!-- Please provide information on how the type of transactions this wallet supports. -->

<!-- Please provide a hex code for the brand color. This will be added to the background of the wallet card. -->
### Finance

**Does the wallet have fiat on-ramps through credit/debit cards or wire transfers, or Bank transfers (ACH)?**
corwintines marked this conversation as resolved.
Show resolved Hide resolved

<!-- Please provide documentation on how a user is able to onboard and purchase crypto in the wallet. -->
<!-- Credit/debit cards -->
corwintines marked this conversation as resolved.
Show resolved Hide resolved
<!-- Wire transfer -->
<!-- Bank Transfer (ACH) -->

**Does the wallet support withdrawals to fiat?**

<!-- Can a user cash out their crypto assets directly to a card or bank account? Please provide documentation. -->

### Smart Contract
corwintines marked this conversation as resolved.
Show resolved Hide resolved

**Is the wallet a multi-signature wallet?**

<!-- Please provide documentation on how users set up and use the multisig functionality for the wallet. -->

**Does the wallet support social recovery?**

<!-- Please provide documentation on how users set up guardians and use social recovery for the wallet. -->

### Support

corwintines marked this conversation as resolved.
Show resolved Hide resolved
**Does your wallet have a dedicated support team?**
corwintines marked this conversation as resolved.
Show resolved Hide resolved

<!-- Where should we send users that are having issues? -->
<!-- How fast is your support? -->
corwintines marked this conversation as resolved.
Show resolved Hide resolved

**What educational resources/documentation do you provide to users?**

corwintines marked this conversation as resolved.
Show resolved Hide resolved
### Extra

**URL**
**Does the wallet have any integrated tools not mentioned above?**

<!-- Please provide a URL (e.g. to the website of the wallet). -->
<!-- Please provide any information about extra features this wallet has that we may have missed in the above criteria. (e.g. privacy features, transaction batching, etc). -->