Feat: Bitcoin wallet overview (Flask Only)

owencraston commented 1 week ago

Description

This PR does enables the creation of Bitcoin (Mainnet and Testnet) accounts on MetaMask mobile. This is done via the snap-bitcoin-wallet which is included as a preinstalled snap. The added UI buttons to the account actions communicate with the snap, then the snap is routed through our SnapKeyring handlers to enable custom account names.

This is just the first step and does not include all of the necessary logic/UI to launch this feature. This PR simply enables Bitcoin account creation and renders the proper BTC address and network in the wallet view.

How

adds the Snap Bitcoin Wallet as a pre installed snap
added the BitcoinWalletSnapSender which allows us to communicate with the bitcoin snap
added the Bitcoin Logo to the assets and conditionally render them on the wallet view if the selected account is BTC. This is just visual and is a disabled button. This also does not change any other network related logic elsewhere in the app.
renamed selectSelectedInternalAccountChecksummedAddress to selectSelectedInternalAccountFormattedAddress since bitcoin addresses are not checksummed.
instead of eagerly checksumming addresses, I conditionally checksum them based on wether the address is EVM or not. this is done with the toFormattedAddress in app/util/address/index.ts and getFormattedAddressFromInternalAccount in app/core/MultiChain/utils.ts
added selector hasCreatedBtcMainnetAccount and hasCreatedBtcTestnetAccount
added new call to actions in the account actions menu for adding Bitcoin accounts.

Manual testing steps

Adding a Bitcoin Testnet account

open .js.env and ensure that METAMASK_BUILD_TYPE is set to flask
run the app on this branch
complete onboarding
click on your account
the account list menu should open with a CTA to add a new account
click Add account or hardware wallet
then click Add a new Bitcoin Account (Testnet)
a bottom sheet should open with a text field pre filled with Bitcoin Testnet Account
click Add account
the account should be added and selected on the wallet view.
if you go through the same steps (steps 4-6) the option to add a Bitcoin testnet account should be disabled since you can only have one BTC Test account.
Now that you are on the wallet view, verify that the address is rendered in short form i.e tb1qcv...4av3
you will not see a balance rendered for this account since BTC balances are not yet supported.
verify that the network that is displayed on the wallet view shows the Bitcoin logo and that when you click it nothing happens.
verify that when clicking on the actions button in the bottom tab bar opens a list of actions that are disabled (send, swap, bridge etc). All of these features should be disabled for BTC
click on your account, when the account list opens up select one of your ethereum accounts.
the Balance should render and the network should display the ethereum network.
clicking on the network picker DOES open the network selector list

Adding a Bitcoin Mainnet account

open .js.env and ensure that METAMASK_BUILD_TYPE is set to flask
run the app on this branch
complete onboarding
click on your account
the account list menu should open with a CTA to add a new account
click Add account or hardware wallet
then click Add a new Bitcoin Account (Beta)
a bottom sheet should open with a text field pre filled with Bitcoin Account
click Add account
the account should be added and selected on the wallet view.
if you go through the same steps (steps 4-6) the option to add a Bitcoin Account should be disabled since you can only have one BTC mainnet account.
Now that you are on the wallet view, verify that the address is rendered in short form i.e bc1qrw...atay
you will not see a balance rendered for this account since BTC balances are not yet supported.
verify that the network that is displayed on the wallet view shows the Bitcoin logo and that when you click it nothing happens.
1. verify that when clicking on the actions button in the bottom tab bar opens a list of actions that are disabled (send, swap, bridge etc). All of these features should be disabled for BTC
click on your account, when the account list opens up select one of your ethereum accounts.
the Balance should render and the network should display the ethereum network.
clicking on the network picker DOES open the network selector list

Verify ETH account address formats

assuming you completed the above testing steps...
select your ethereum account from the account list
verify that when selected, the address is rendered in checksummed format WITH a 0z prefix.

Screenshots/Recordings

Before

N/A

After

https://github.com/user-attachments/assets/96836574-7b12-4566-b70f-ea85efa3b663

Pre-merge author checklist

[ ] I’ve followed MetaMask Contributor Docs and MetaMask Mobile Coding Standards.
[ ] I've completed the PR template to the best of my ability
[ ] I’ve included tests if applicable
[ ] I’ve documented my code using JSDoc format if applicable
[ ] I’ve applied the right labels on the PR (see labeling guidelines). Not required for external contributors.

Pre-merge reviewer checklist

[ ] I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed).
[ ] I confirm that this PR addresses all acceptance criteria described in the ticket it closes and includes the necessary testing evidence such as recordings and or screenshots.

github-actions[bot] commented 1 week ago

CLA Signature Action: All authors have signed the CLA. You may need to manually re-run the blocking PR check if it doesn't pass in a few minutes.

socket-security[bot] commented 1 week ago

New dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher
npm/@metamask/bitcoin-wallet-snap@0.8.2	network	`0`	1.61 MB	gudahtt
npm/base58-js@1.0.5	None	`0`	9.65 kB	pur3miish
npm/bitcoin-address-validation@2.2.3	None	`0`	35.5 kB	ruigomes
npm/sha256-uint8array@0.10.7	None	`0`	33.2 kB	kawanet

View full report↗︎

socket-security[bot] commented 1 week ago

🚨 Potential security issues detected. Learn more about Socket for GitHub ↗︎

To accept the risk, merge this PR and you will not be notified again.

Alert	Package	Note	Source	CI
New author	npm/@metamask/bitcoin-wallet-snap@0.8.2	New Author: gudahtt Previous Author: metamaskbot	`package.json` `yarn.lock`	🚫
Unstable ownership	npm/@metamask/bitcoin-wallet-snap@0.8.2	Author: gudahtt	`package.json` `yarn.lock`	🚫
Network access	npm/@metamask/bitcoin-wallet-snap@0.8.2	Module: globalThis["fetch"] Location: Package overview	`package.json` `yarn.lock`	🚫

View full report↗︎

Next steps

What is new author?

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Scrutinize new collaborator additions to packages because they now have the ability to publish code into your dependency tree. Packages should avoid frequent or unnecessary additions or changes to publishing rights.

What is unstable ownership?

A new collaborator has begun publishing package versions. Package stability and security risk may be elevated.

Try to reduce the amount of authors you depend on to reduce the risk to malicious actors gaining access to your supply chain. Packages should remove inactive collaborators with publishing rights from packages on npm.

What is network access?

This module accesses the network.

Packages should remove all network access that is functionally unnecessary. Consumers should audit network access to ensure legitimate use.

Take a deeper look at the dependency

Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at support [AT] socket [DOT] dev.

Remove the package

If you happen to install a dependency that Socket reports as Known Malware you should immediately remove it and select a different dependency. For other alert types, you may may wish to investigate alternative packages or consider if there are other ways to mitigate the specific risk posed by the dependency.

Mark a package as acceptable risk

To ignore an alert, reply with a comment starting with @SocketSecurity ignore followed by a space separated list of ecosystem/package-name@version specifiers. e.g. @SocketSecurity ignore npm/foo@1.0.0 or ignore all packages with @SocketSecurity ignore-all

@SocketSecurity ignore npm/@metamask/bitcoin-wallet-snap@0.8.2

sonarcloud[bot] commented 18 hours ago

Quality Gate passed

Issues
3 New issues
0 Accepted issues

Measures
0 Security Hotspots
69.1% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

github-actions[bot] commented 17 hours ago

Bitrise

❌❌❌ pr_smoke_e2e_pipeline failed on Bitrise! ❌❌❌

Commit hash: 389d496c85c48f129cbed51c88886c0f76c829ce Build link: https://app.bitrise.io/app/be69d4368ee7e86d/pipelines/c0392760-05eb-42f2-915b-376cab548fdb

[!NOTE]

You can kick off another pr_smoke_e2e_pipeline on Bitrise by removing and re-applying the Run Smoke E2E label on the pull request

[!TIP]

Check the documentation if you have any doubts on how to understand the failure on bitrise

MetaMask / metamask-mobile