Compare commits
2 Commits
86669d0f53
...
75bff7c29c
| Author | SHA1 | Date | |
|---|---|---|---|
| 75bff7c29c | |||
| b882cede9f |
406
README.md
406
README.md
@@ -271,10 +271,10 @@ on a different table knows exactly tf I am talking about.
|
||||
|
||||
Every interactive element must visually indicate that it is clickable. Buttons
|
||||
use a visible border, padding, and a hover state (invert to white-on-black).
|
||||
Text that triggers an action (e.g. "Import private key") uses an underline. No
|
||||
invisible hit targets, no bare text that happens to have a click handler. If it
|
||||
does something when you click it, it must look like it does something when you
|
||||
click it.
|
||||
Text that triggers an action (e.g. "Add additional wallet...") uses an
|
||||
underline. No invisible hit targets, no bare text that happens to have a click
|
||||
handler. If it does something when you click it, it must look like it does
|
||||
something when you click it.
|
||||
|
||||
#### Display Consistency
|
||||
|
||||
@@ -334,12 +334,18 @@ attack.
|
||||
|
||||
The core hierarchy is **Wallets → Addresses**:
|
||||
|
||||
- A **wallet** is either:
|
||||
- An **HD wallet** (recovery phrase): generates multiple addresses from a
|
||||
single 12/24 word recovery phrase using BIP-39/BIP-44 derivation. The user
|
||||
can add more addresses with a "+" button.
|
||||
- A **key wallet** (private key): a single address imported directly from a
|
||||
private key. No "+" button since there is only one address.
|
||||
- A **wallet** is one of three types:
|
||||
- An **HD wallet** (`type: "hd"`, recovery phrase): generates multiple
|
||||
addresses from a single 12/24 word recovery phrase using BIP-39/BIP-44
|
||||
derivation. The user can add more addresses with a "+" button.
|
||||
- A **key wallet** (`type: "key"`, private key): a single address imported
|
||||
directly from a private key. No "+" button since there is only one
|
||||
address.
|
||||
- An **xprv wallet** (`type: "xprv"`, extended private key): the same
|
||||
multi-address behavior as an HD wallet, including the "+" button and the
|
||||
address scan on import, but imported from an extended private key rather
|
||||
than a recovery phrase. It therefore has no recovery phrase to display or
|
||||
back up.
|
||||
- An **address** holds ETH and any user-added ERC-20 tokens.
|
||||
- The user can have multiple wallets, each with multiple addresses (HD) or a
|
||||
single address (key).
|
||||
@@ -354,95 +360,140 @@ menus.
|
||||
|
||||
### Screen Map
|
||||
|
||||
Navigation uses a stack model (like iOS): each action pushes a screen onto the
|
||||
stack, and "Back" pops it. The root screen is either Welcome (no wallets) or
|
||||
Home (has wallets). Screens are listed below with their elements and
|
||||
transitions.
|
||||
Navigation uses a stack model (like iOS): each forward action pushes the current
|
||||
screen onto `state.viewStack`, and "Back" pops it (`pushCurrentView()` and
|
||||
`goBack()` in `src/popup/views/helpers.js`). The root screen is either Welcome
|
||||
(no wallets) or Home (has wallets). Each screen below gives its view id in
|
||||
parentheses; the registry of view ids is the `VIEWS` array in
|
||||
`src/popup/views/helpers.js`, and the markup for a screen is the element with id
|
||||
`view-` plus that view id in `src/popup/index.html`.
|
||||
|
||||
#### Welcome
|
||||
Three elements sit outside the screens and are present on all of them: the title
|
||||
bar ("AutistMask by @sneak" plus the Settings gear), the flash message line
|
||||
under it, and the red banner at the very top that appears on a debug build, when
|
||||
runtime debug mode is on, or when the active network is a testnet. They are not
|
||||
repeated in the element lists below.
|
||||
|
||||
- **When**: No wallets exist yet.
|
||||
- **Elements**: "AutistMask" heading, brief intro text, "Add wallet" button.
|
||||
Closing and reopening the popup returns to the screen the user was last on only
|
||||
for the views listed in `RESTORABLE_VIEWS` (`src/popup/index.js`). Every other
|
||||
screen, including ExportPrivKey, falls back to Home.
|
||||
|
||||
#### Welcome (`welcome`)
|
||||
|
||||
- **When**: No wallets exist yet (`state.hasWallet` is false). This is the root
|
||||
screen in that case.
|
||||
- **Elements**:
|
||||
- "Welcome! To get started, add a wallet." text
|
||||
- "Add wallet" button
|
||||
- **Transitions**:
|
||||
- "Add wallet" → **AddWallet**
|
||||
|
||||
#### Home
|
||||
#### Home (`main`)
|
||||
|
||||
- **When**: At least one wallet exists. This is the root screen.
|
||||
- **Elements**:
|
||||
- Header: "AutistMask", Settings gear button
|
||||
- Active address ETH balance (large) + USD value (inline parentheses)
|
||||
- Total USD value across all tokens (small text)
|
||||
- Active address ETH balance (large) + USD value in parentheses
|
||||
- "Total:" USD value across ETH and all tracked tokens of the active address
|
||||
- Active address (color dot, full address, etherscan link, tap to copy)
|
||||
- Send / Receive quick-action buttons
|
||||
- Send / Receive quick-action buttons, both acting on the active address
|
||||
- ETH/USD price display
|
||||
- Wallet list: each wallet shows name (tap to rename), "+" button (HD only),
|
||||
and its addresses with color dots, balances, and `[info]` buttons
|
||||
- Recent transactions across all addresses (merged, deduplicated, filtered)
|
||||
- Wallet list: each wallet shows its name (tap to rename inline) and a "+"
|
||||
button for HD and xprv wallets, then one block per address with "Address
|
||||
N" (bold when active), the ENS name if resolved, the full address, an
|
||||
`[info]` button, the address USD total, and a balance line for ETH and for
|
||||
each tracked token
|
||||
- "Recent Transactions": up to 25 transactions merged across every address
|
||||
of every wallet, deduplicated by hash and filtered
|
||||
- "Add additional wallet..." link at bottom
|
||||
- **Transitions**:
|
||||
- Tap address row → sets active address (no screen change)
|
||||
- Tap address row → sets the active address and broadcasts
|
||||
`AUTISTMASK_ACTIVE_CHANGED` (no screen change)
|
||||
- Tap wallet name → inline rename field (no screen change)
|
||||
- "+" on wallet → derives the next address inline (no screen change)
|
||||
- `[info]` on address → **AddressDetail**
|
||||
- "Send" → **Send** (selects active address)
|
||||
- "Send" → **Send** (refuses with a flash message on a zero balance)
|
||||
- "Receive" → **Receive** (shows active address QR)
|
||||
- "+" on wallet → derives next address inline
|
||||
- Tap home tx row → **TransactionDetail**
|
||||
- "Add additional wallet..." → **AddWallet**
|
||||
- Settings gear → **Settings** (toggles; tap again to return)
|
||||
- Tap home tx row → **AddressDetail** (for the address involved)
|
||||
|
||||
#### AddWallet
|
||||
#### AddWallet (`add-wallet`)
|
||||
|
||||
- **When**: User wants to add a new wallet (from Home, Welcome, or Settings).
|
||||
- **When**: User wants to add a new wallet (from Welcome, Home, or Settings).
|
||||
This one screen covers all three import modes; there is no separate import
|
||||
screen.
|
||||
- **Elements**:
|
||||
- "Add Wallet" heading, "Back" button
|
||||
- Instruction text
|
||||
- Die button `[die]` (generates random recovery phrase)
|
||||
- Recovery phrase textarea
|
||||
- Backup warning box (shown after die is clicked)
|
||||
- Password + confirm password inputs
|
||||
- "Add" button
|
||||
- "Have a private key instead?" link
|
||||
- **Transitions**:
|
||||
- "Add" (valid phrase + password) → **Home**
|
||||
- "Back" → previous screen (Home or Welcome)
|
||||
- "Have a private key instead?" → **ImportKey**
|
||||
|
||||
#### ImportKey
|
||||
|
||||
- **When**: User wants to import a single private key.
|
||||
- **Elements**:
|
||||
- "Import Private Key" heading, "Back" button
|
||||
- Instruction text
|
||||
- Private key input (password-masked)
|
||||
- Password + confirm password inputs
|
||||
- "Back" button, "Add Wallet" heading
|
||||
- Three tabs — "From Phrase" (`tab-mnemonic`), "From Key" (`tab-privkey`),
|
||||
"From xprv" (`tab-xprv`) — each showing its own form section:
|
||||
- **From Phrase**: instruction text, a die button that generates a
|
||||
random recovery phrase, a recovery phrase textarea, and a backup
|
||||
warning box that becomes visible once the die button has been used
|
||||
- **From Key**: instruction text and a masked private key input
|
||||
- **From xprv**: instruction text and a masked extended private key
|
||||
input
|
||||
- Password + confirm password inputs, with a hint line whose wording depends
|
||||
on the selected tab
|
||||
- "Import" button
|
||||
- **Transitions**:
|
||||
- "Import" (valid key + password) → **Home**
|
||||
- "Back" → **AddWallet**
|
||||
- "Import" with a valid entry and a matching password of at least 12
|
||||
characters → creates the wallet, clears the navigation stack, and →
|
||||
**Home**. The phrase and xprv modes then scan for further used addresses
|
||||
and report the count as a flash message.
|
||||
- "Import" with an invalid entry, a duplicate wallet or address, or a short
|
||||
or mismatched password → flash message, no screen change
|
||||
- "Back" → previous screen (Welcome, Home, or Settings)
|
||||
|
||||
#### AddressDetail
|
||||
#### AddressDetail (`address`)
|
||||
|
||||
- **When**: User tapped `[info]` on an address from Home.
|
||||
- **Elements**:
|
||||
- "Back" button
|
||||
- Blockie identicon (48px, centered)
|
||||
- Title: "Wallet Name — Address N"
|
||||
- ENS name (if resolved, bold with color dot)
|
||||
- ENS name (if resolved, bold above the address)
|
||||
- Full address (color dot, etherscan link, tap to copy)
|
||||
- USD total for address
|
||||
- Balance list: ETH + tracked ERC-20 tokens (4 decimal places, USD inline).
|
||||
Each balance row is clickable → **AddressToken**
|
||||
- Send / Receive / + Token buttons
|
||||
- Send / Receive / + Token buttons and a "···" menu button
|
||||
- "···" dropdown containing a single "Export Private Key" entry
|
||||
- Transaction list (with ENS resolution for counterparties)
|
||||
- **Transitions**:
|
||||
- Tap balance row → **AddressToken** (for that token)
|
||||
- "Send" → **Send**
|
||||
- "Send" → **Send** (refuses with a flash message on a zero balance)
|
||||
- "Receive" → **Receive**
|
||||
- "+ Token" → **AddToken**
|
||||
- "···" → "Export Private Key" → **ExportPrivKey**
|
||||
- Tap transaction row → **TransactionDetail**
|
||||
- "Back" → **Home**
|
||||
- "Back" → previous screen (Home)
|
||||
|
||||
#### AddressToken
|
||||
#### ExportPrivKey (`export-privkey`)
|
||||
|
||||
- **When**: User chose "Export Private Key" from the "···" menu on
|
||||
AddressDetail. This screen discloses secret material.
|
||||
- **Elements**:
|
||||
- "Back" button
|
||||
- Blockie identicon (48px, centered)
|
||||
- "Export Private Key" heading
|
||||
- "Wallet Name — Address N" and the full address (etherscan link, tap to
|
||||
copy)
|
||||
- Warning that anyone holding the private key can transfer all funds from
|
||||
the address
|
||||
- Error line
|
||||
- Password input and "Reveal" button, shown until the key is revealed
|
||||
- The private key on a highlighted background, tap to copy, shown only after
|
||||
the password has been accepted
|
||||
- **Transitions**:
|
||||
- "Reveal" (correct password) → decrypts the wallet secret, derives this
|
||||
address's key, hides the password input and shows the key (no screen
|
||||
change)
|
||||
- "Reveal" (wrong password) → "Wrong password." on the error line, nothing
|
||||
revealed
|
||||
- "Back" → clears the key and password from the DOM, then → previous screen
|
||||
(AddressDetail)
|
||||
|
||||
#### AddressToken (`address-token`)
|
||||
|
||||
- **When**: User clicked a specific token balance on AddressDetail.
|
||||
- **Elements**:
|
||||
@@ -453,49 +504,64 @@ transitions.
|
||||
- USD total for this token
|
||||
- Single token balance line (4 decimal places)
|
||||
- Send / Receive buttons
|
||||
- Token contract well (ERC-20 only): full contract address (tap to copy,
|
||||
etherscan link) plus name, symbol, decimals, holder count and project
|
||||
website where known
|
||||
- Token-filtered transaction list (only this token's transfers)
|
||||
- **Transitions**:
|
||||
- "Send" → **Send** (token pre-selected and locked in dropdown)
|
||||
- "Send" → **Send** (token locked: the dropdown is replaced by a static
|
||||
symbol and contract address)
|
||||
- "Receive" → **Receive** (ERC-20 warning shown for non-ETH tokens)
|
||||
- Tap transaction row → **TransactionDetail**
|
||||
- "Back" → **AddressDetail**
|
||||
- "Back" → previous screen (AddressDetail)
|
||||
|
||||
#### Send
|
||||
#### Send (`send`)
|
||||
|
||||
- **When**: User wants to send ETH or a token from this address.
|
||||
- **When**: User wants to send ETH or a token, from Home, AddressDetail, or
|
||||
AddressToken.
|
||||
- **Elements**:
|
||||
- "Send" heading, "Back" button
|
||||
- "Back" button, "Send" heading
|
||||
- From: address with color dot + etherscan link
|
||||
- What to send: token dropdown (or static display with contract address when
|
||||
locked from AddressToken)
|
||||
- To: address or ENS name input
|
||||
- To: address or ENS name input, with an inline validation message
|
||||
- Amount input with current balance display
|
||||
- "Review" button
|
||||
- "Review" button, disabled until the recipient validates
|
||||
- **Transitions**:
|
||||
- "Review" (valid inputs, ENS resolved) → **ConfirmTx**
|
||||
- "Back" → **AddressToken** (if came from token view) or **AddressDetail**
|
||||
- "Review" with an unresolvable ENS name or an invalid amount → flash
|
||||
message, no screen change
|
||||
- "Back" → previous screen (Home, AddressDetail, or AddressToken)
|
||||
|
||||
#### ConfirmTx
|
||||
#### ConfirmTx (`confirm-tx`)
|
||||
|
||||
- **When**: User reviewed send details and is ready to authorize.
|
||||
- **Elements**:
|
||||
- "Confirm Transaction" heading, "Back" button
|
||||
- "Back" button, "Confirm Transaction" heading
|
||||
- Type: "Native ETH transfer" or "ERC-20 token transfer (SYMBOL)"
|
||||
- Token contract: full address + etherscan link (ERC-20 only)
|
||||
- From: blockie + color dot + full address + etherscan link + wallet title
|
||||
- To: blockie + color dot + full address + etherscan link + ENS name
|
||||
- Amount: value + symbol (USD in parentheses)
|
||||
- Your balance: value + symbol (USD in parentheses)
|
||||
- Estimated network fee: ETH amount (USD in parentheses), fetched async
|
||||
- Warnings (scam address, self-send)
|
||||
- Estimated network fee: "Estimating..." then the ETH amount (USD in
|
||||
parentheses) or "Unable to estimate", fetched async
|
||||
- Warnings: inline warnings from the local checks (scam address, self-send)
|
||||
plus four reserved warning boxes made visible by the async checks —
|
||||
recipient with no transaction history, recipient is a contract, burn
|
||||
address, and an Etherscan phishing/scam label
|
||||
- Errors (insufficient balance)
|
||||
- "Send" button (disabled if errors)
|
||||
- Password: an inline field on this screen, not a modal, with its own error
|
||||
line
|
||||
- "Sign & Send" button (disabled if errors)
|
||||
- **Transitions**:
|
||||
- "Send" → password modal → broadcast tx → **WaitTx**
|
||||
- "Send" → password modal → broadcast fails → **ErrorTx**
|
||||
- "Sign & Send" (correct password) → broadcast tx → **WaitTx**
|
||||
- "Sign & Send" (correct password) → broadcast fails → **ErrorTx**
|
||||
- "Sign & Send" (wrong password) → "Wrong password." on the password error
|
||||
line, no screen change
|
||||
- "Back" → **Send**
|
||||
|
||||
#### WaitTx
|
||||
#### WaitTx (`wait-tx`)
|
||||
|
||||
- **When**: Transaction has been broadcast, waiting for on-chain confirmation.
|
||||
- **Elements**:
|
||||
@@ -509,20 +575,24 @@ transitions.
|
||||
- Receipt found → **SuccessTx**
|
||||
- 60 seconds without confirmation → **ErrorTx** (timeout message)
|
||||
|
||||
#### SuccessTx
|
||||
#### SuccessTx (`success-tx`)
|
||||
|
||||
- **When**: Transaction confirmed on-chain.
|
||||
- **Elements**:
|
||||
- "Transaction Confirmed" heading
|
||||
- Decoded action well (shown when the transaction carried recognized
|
||||
calldata; the top-level Amount and To are hidden in that case)
|
||||
- Amount + symbol
|
||||
- To: color dot + full address + etherscan link
|
||||
- Block number
|
||||
- Transaction hash: full hash (tap to copy) + etherscan link
|
||||
- "Done" button
|
||||
- **Transitions**:
|
||||
- "Done" → **AddressToken** (if `selectedToken` set) or **AddressDetail**
|
||||
- "Done" in the approval popup → closes the popup window
|
||||
- "Done" otherwise → resets the navigation stack, then → **AddressToken**
|
||||
(if `selectedToken` set) or **AddressDetail**
|
||||
|
||||
#### ErrorTx
|
||||
#### ErrorTx (`error-tx`)
|
||||
|
||||
- **When**: Transaction broadcast failed, or timed out waiting for confirmation.
|
||||
- **Elements**:
|
||||
@@ -534,24 +604,28 @@ transitions.
|
||||
full hash (tap to copy) + etherscan link
|
||||
- "Done" button
|
||||
- **Transitions**:
|
||||
- "Done" → **AddressToken** (if `selectedToken` set) or **AddressDetail**
|
||||
- "Done" in the approval popup → closes the popup window
|
||||
- "Done" otherwise → resets the navigation stack, then → **AddressToken**
|
||||
(if `selectedToken` set) or **AddressDetail**
|
||||
|
||||
#### Receive
|
||||
#### Receive (`receive`)
|
||||
|
||||
- **When**: User wants to receive funds at this address.
|
||||
- **When**: User wants to receive funds at this address, from Home,
|
||||
AddressDetail, or AddressToken.
|
||||
- **Elements**:
|
||||
- "Receive" heading, "Back" button
|
||||
- "Back" button, "Receive" heading
|
||||
- Instruction text
|
||||
- QR code encoding the address
|
||||
- Full address (color dot, selectable, etherscan link)
|
||||
- "Copy address" button
|
||||
- ERC-20 warning (shown when navigating from AddressToken for non-ETH token)
|
||||
- **Transitions**:
|
||||
- "Back" → **AddressToken** (if `selectedToken` set) or **AddressDetail**
|
||||
- "Back" → previous screen (Home, AddressDetail, or AddressToken)
|
||||
|
||||
#### TransactionDetail
|
||||
#### TransactionDetail (`transaction`)
|
||||
|
||||
- **When**: User tapped a transaction row from AddressDetail or AddressToken.
|
||||
- **When**: User tapped a transaction row on Home, AddressDetail, or
|
||||
AddressToken.
|
||||
- **Elements** (grouped into logical blocks using light well containers; field
|
||||
labels are self-explanatory so groups have no headings):
|
||||
- "Transaction" heading, "Back" button
|
||||
@@ -576,91 +650,182 @@ transitions.
|
||||
- Raw data (shown when calldata is present): full calldata in monospace
|
||||
dashed border
|
||||
- **Transitions**:
|
||||
- "Back" → **AddressToken** (if `selectedToken` set) or **AddressDetail**
|
||||
- "Back" → previous screen (Home, AddressDetail, or AddressToken)
|
||||
|
||||
#### AddToken
|
||||
#### AddToken (`add-token`)
|
||||
|
||||
- **When**: User wants to track an ERC-20 token on this address.
|
||||
- **When**: User wants to track an ERC-20 token, reached from "+ Token" on
|
||||
AddressDetail.
|
||||
- **Elements**:
|
||||
- "Add Token" heading, "Back" button
|
||||
- "Back" button, "Add Token" heading
|
||||
- Instruction text (find contract address on Etherscan)
|
||||
- Contract address input
|
||||
- Token info preview (name, symbol — fetched from contract)
|
||||
- Common token quick-pick buttons
|
||||
- Status line ("Looking up token...", cleared or replaced on failure)
|
||||
- Common token quick-pick buttons (top 25 by market cap), which fill the
|
||||
contract address input
|
||||
- "Add" button
|
||||
- **Transitions**:
|
||||
- "Add" (valid contract) → **AddressDetail**
|
||||
- "Back" → **AddressDetail**
|
||||
- "Add" (valid contract) → tracks the token, pops the stack, and re-renders
|
||||
**AddressDetail**
|
||||
- "Add" with a token already tracked, a scam-listed address, or a failed
|
||||
contract lookup → flash message, no screen change
|
||||
- "Back" → previous screen (AddressDetail)
|
||||
|
||||
#### Settings
|
||||
#### Settings (`settings`)
|
||||
|
||||
- **When**: User tapped Settings gear from Home.
|
||||
- **When**: User tapped the Settings gear.
|
||||
- **Elements**:
|
||||
- "Settings" heading, "Back" button
|
||||
- Wallets: "+ Add wallet" button
|
||||
- Display: "Show tracked tokens with zero balance" checkbox
|
||||
- Ethereum RPC: endpoint URL input + "Save" button
|
||||
- Blockscout API: endpoint URL input + "Save" button
|
||||
- "Back" button, "Settings" heading
|
||||
- Wallets: one row per wallet with its name (tap to rename inline) and an
|
||||
`[x]` delete button, plus a "+ Add wallet" button
|
||||
- Tracked Tokens: one row per tracked token with an `[x]` remove button,
|
||||
plus a "+ Add token" button
|
||||
- Display: "Show tracked tokens with zero balance" checkbox and a Theme
|
||||
selector (System / Light / Dark)
|
||||
- Network: network selector (Ethereum Mainnet / Sepolia Testnet); switching
|
||||
resets the RPC and Blockscout endpoints to that network's defaults
|
||||
- Ethereum RPC: endpoint URL input + "Save" button (validated against
|
||||
`eth_chainId` before being saved)
|
||||
- Blockscout API: endpoint URL input + "Save" button (validated against
|
||||
`/stats` before being saved)
|
||||
- Token Spam Protection:
|
||||
- "Hide tokens with fewer than 1,000 holders" checkbox
|
||||
- "Hide transactions from detected fraud contracts" checkbox
|
||||
- "Hide dust transactions below N gwei" checkbox + threshold input
|
||||
- "UTC Timestamps" checkbox
|
||||
- Allowed Sites: list with remove buttons
|
||||
- Denied Sites: list with remove buttons
|
||||
- About: project link, license, author, version, release date, and the
|
||||
commit, which links to the commit in the repository
|
||||
- Debug: hidden until revealed, then an "Enable debug mode" checkbox that
|
||||
turns on the red banner and verbose logging
|
||||
- **Transitions**:
|
||||
- "+ Add wallet" → **AddWallet**
|
||||
- "Back" (or Settings gear again) → **Home**
|
||||
- "+ Add token" → **SettingsAddToken**
|
||||
- `[x]` on a wallet → **DeleteWallet**
|
||||
- Tap wallet name → inline rename field (no screen change)
|
||||
- `[x]` on a tracked token or a site → removes it in place (no screen
|
||||
change)
|
||||
- Ten clicks on the version → reveals the Debug well (no screen change)
|
||||
- "Back" (or Settings gear again) → previous screen (Home)
|
||||
|
||||
#### SiteApproval
|
||||
#### DeleteWallet (`delete-wallet-confirm`)
|
||||
|
||||
- **When**: A website requests wallet access via `eth_requestAccounts`. Opened
|
||||
in a separate popup by the background script.
|
||||
- **When**: User tapped the `[x]` next to a wallet in Settings.
|
||||
- **Elements**:
|
||||
- "Back" button, "Delete Wallet" heading
|
||||
- Warning naming the wallet and stating that deletion is permanent and any
|
||||
funds are unrecoverable without the recovery phrase
|
||||
- Error line
|
||||
- Password input
|
||||
- "Confirm Delete" button
|
||||
- **Transitions**:
|
||||
- "Confirm Delete" (correct password, other wallets remain) → deletes the
|
||||
wallet and its site permissions, then → **Settings** with a "Wallet
|
||||
deleted." flash message
|
||||
- "Confirm Delete" (correct password, last wallet) → deletes the wallet,
|
||||
clears the selection and the navigation stack, then → **Welcome**
|
||||
- Either way, the active address moves only if it belonged to the deleted
|
||||
wallet, and `AUTISTMASK_ACTIVE_CHANGED` is broadcast when it does
|
||||
(`src/shared/walletDelete.js`)
|
||||
- "Confirm Delete" (wrong password) → "Wrong password." on the error line,
|
||||
nothing deleted
|
||||
- "Back" → previous screen (Settings)
|
||||
|
||||
#### SettingsAddToken (`settings-addtoken`)
|
||||
|
||||
- **When**: User tapped "+ Add token" in Settings. Tokens added here are tracked
|
||||
across every address, unlike AddToken which is reached from one address.
|
||||
- **Elements**:
|
||||
- "Back" button, "Add Token" heading
|
||||
- Instruction text
|
||||
- "Top tokens:" quick-pick buttons (top 10 by market cap; already-tracked
|
||||
tokens are disabled)
|
||||
- "Or pick from top 100:" dropdown (already-tracked tokens are disabled) +
|
||||
"Add selected" button
|
||||
- "Or enter contract address:" input, a status line, and an "Add" button
|
||||
- **Transitions**:
|
||||
- Any of the three add paths, on success → adds the token and shows an
|
||||
"Added SYMBOL" flash message (no screen change)
|
||||
- A duplicate, a scam-listed address, or a failed contract lookup → flash
|
||||
message, no screen change
|
||||
- "Back" → previous screen (Settings)
|
||||
|
||||
#### SiteApproval (`approve-site`)
|
||||
|
||||
- **When**: A website requests wallet access via `eth_requestAccounts` or
|
||||
`wallet_requestPermissions` and is on neither the allowed nor the denied list.
|
||||
The background script prefers the toolbar popup (`action.openPopup()`) and
|
||||
falls back to a separate popup window (`src/background/index.js`,
|
||||
`requestApproval()`).
|
||||
- **Elements**:
|
||||
- "Connection Request" heading
|
||||
- Site hostname (bold)
|
||||
- Phishing warning banner (shown when the hostname is on the phishing
|
||||
blocklist)
|
||||
- Site hostname (bold) + "wants to connect to your wallet"
|
||||
- Address that will be shared (color dot + full address + etherscan link)
|
||||
- "Remember my choice for this site" checkbox
|
||||
- "Allow" / "Deny" buttons
|
||||
- **Transitions**:
|
||||
- "Allow" / "Deny" → closes popup (returns result to background script)
|
||||
- "Allow" / "Deny" → closes popup (returns result to background script; the
|
||||
choice is persisted to the allowed or denied list when "Remember" is
|
||||
checked)
|
||||
- Popup closed without answering → treated as a denial
|
||||
|
||||
#### TxApproval
|
||||
#### TxApproval (`approve-tx`)
|
||||
|
||||
- **When**: A connected website requests a transaction via
|
||||
`eth_sendTransaction`. Opened via the toolbar popup by the background script.
|
||||
`eth_sendTransaction`. Always opened in a separate popup window by the
|
||||
background script (`windows.create()`), because the request is triggered
|
||||
programmatically rather than by a user gesture.
|
||||
- **Elements**:
|
||||
- "Transaction Request" heading
|
||||
- Phishing warning banner (shown when the hostname is on the phishing
|
||||
blocklist)
|
||||
- Site hostname (bold) + "wants to send a transaction"
|
||||
- Decoded action (if calldata is recognized): action name, token details,
|
||||
amounts, steps, deadline (see Transaction Decoding)
|
||||
- From: color dot + full address + etherscan link
|
||||
- To/Contract: color dot + full address + etherscan link (or "contract
|
||||
- Contract: color dot + full address + etherscan link (or "contract
|
||||
creation"), token symbol label if known
|
||||
- Value: amount in ETH (4 decimal places)
|
||||
- Value: amount in ETH (4 decimal places, USD in parentheses)
|
||||
- Raw data: full calldata displayed inline (shown if present)
|
||||
- Password input
|
||||
- Password input and an error line
|
||||
- "Confirm" / "Reject" buttons
|
||||
- **Transitions**:
|
||||
- "Confirm" (with password) → closes popup (returns result to background)
|
||||
- "Confirm" (correct password) → decrypts and signs in the popup, hands the
|
||||
signed transaction to the background to broadcast, then → **WaitTx** in
|
||||
the same popup window
|
||||
- "Confirm" (wrong password) → error line, no screen change
|
||||
- "Reject" → closes popup (returns rejection to background)
|
||||
- Popup window closed without answering → the request is rejected with
|
||||
EIP-1193 code 4001
|
||||
|
||||
#### SignApproval
|
||||
#### SignApproval (`approve-sign`)
|
||||
|
||||
- **When**: A connected website requests a message signature via
|
||||
`personal_sign`, `eth_sign`, or `eth_signTypedData_v4`. Opened via the toolbar
|
||||
popup by the background script.
|
||||
`personal_sign`, `eth_sign`, or `eth_signTypedData_v4`. Opened the same way as
|
||||
TxApproval, in a separate popup window.
|
||||
- **Elements**:
|
||||
- "Signature Request" heading
|
||||
- Phishing warning banner (shown when the hostname is on the phishing
|
||||
blocklist)
|
||||
- Site hostname (bold) + "wants you to sign a message"
|
||||
- Danger warning box (shown for `eth_sign`, which signs a raw hash)
|
||||
- Type: "Personal message" or "Typed data (EIP-712)"
|
||||
- From: color dot + full address + etherscan link
|
||||
- Message: decoded UTF-8 text (personal_sign) or formatted domain/type/
|
||||
message fields (EIP-712 typed data)
|
||||
- Password input
|
||||
- Password input and an error line
|
||||
- "Sign" / "Reject" buttons
|
||||
- **Transitions**:
|
||||
- "Sign" (with password) → signs locally → closes popup (returns signature)
|
||||
- "Sign" (correct password) → signs locally → closes popup (returns
|
||||
signature)
|
||||
- "Sign" (wrong password, or a signing failure) → error line, no screen
|
||||
change
|
||||
- "Reject" → closes popup (returns rejection to background)
|
||||
- Popup window closed without answering → the request is rejected with
|
||||
EIP-1193 code 4001
|
||||
|
||||
### External Services
|
||||
|
||||
@@ -815,6 +980,7 @@ hardcoded test phrase.
|
||||
- Create new HD wallet (generates 12-word recovery phrase)
|
||||
- Import HD wallet from existing 12 or 24 word recovery phrase
|
||||
- Import single-address wallet from private key
|
||||
- Import multi-address wallet from an extended private key (`xprv`)
|
||||
- Add multiple addresses within an HD wallet
|
||||
- Manage multiple wallets simultaneously
|
||||
- View ETH balance per address
|
||||
@@ -980,13 +1146,13 @@ Currently supported:
|
||||
|
||||
### Wallet Management
|
||||
|
||||
- [ ] Delete wallet (with confirmation)
|
||||
- [x] Delete wallet (with confirmation)
|
||||
- [ ] Delete address from HD wallet (with confirmation)
|
||||
- [ ] Show wallet's recovery phrase (requires password)
|
||||
|
||||
### Transactions
|
||||
|
||||
- [ ] Gas estimation and fee display before confirming
|
||||
- [x] Gas estimation and fee display before confirming
|
||||
|
||||
### Testing
|
||||
|
||||
|
||||
7
TODO.md
7
TODO.md
@@ -44,6 +44,13 @@ undefined identifiers, which is how
|
||||
|
||||
# Completed Steps
|
||||
|
||||
- 2026-08-11: README Screen Map rebuilt from the code — every screen, element
|
||||
and transition re-verified against `src/popup/`
|
||||
([#164](https://git.eeqj.de/sneak/AutistMask/issues/164)).
|
||||
- 2026-08-11: Wallet deletion repairs its own state — `hasWallet` follows the
|
||||
remaining wallets, the selection only moves when it was deleted, and the
|
||||
active-address change is broadcast to connected sites
|
||||
([#156](https://git.eeqj.de/sneak/AutistMask/issues/156)).
|
||||
- 2026-08-11: `TODO.md` Workflow rewritten to the branch-and-PR-per-issue model
|
||||
on `next`, with Status and Next Step refreshed
|
||||
([#191](https://git.eeqj.de/sneak/AutistMask/issues/191)).
|
||||
|
||||
@@ -1,6 +1,10 @@
|
||||
const { $, showView, showFlash, goBack, clearViewStack } = require("./helpers");
|
||||
const { state, saveState } = require("../../shared/state");
|
||||
const { decryptWithPassword } = require("../../shared/vault");
|
||||
const {
|
||||
removeWalletFromState,
|
||||
broadcastActiveChanged,
|
||||
} = require("../../shared/walletDelete");
|
||||
|
||||
let deleteWalletIndex = null;
|
||||
let ctx = null;
|
||||
@@ -58,35 +62,24 @@ function init(_ctx) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Collect addresses to clean up from allowedSites/deniedSites
|
||||
const addresses = (wallet.addresses || []).map((a) => a.address);
|
||||
|
||||
// Remove wallet
|
||||
state.wallets.splice(walletIdx, 1);
|
||||
|
||||
// Clean up site permissions for deleted addresses
|
||||
for (const addr of addresses) {
|
||||
delete state.allowedSites[addr];
|
||||
delete state.deniedSites[addr];
|
||||
}
|
||||
// Remove the wallet and repair selection, permissions and hasWallet
|
||||
const { activeAddressChanged } = removeWalletFromState(
|
||||
state,
|
||||
walletIdx,
|
||||
);
|
||||
|
||||
deleteWalletIndex = null;
|
||||
|
||||
if (state.wallets.length === 0) {
|
||||
// No wallets left — reset selection and show welcome
|
||||
state.selectedWallet = null;
|
||||
state.selectedAddress = null;
|
||||
state.activeAddress = null;
|
||||
if (!state.hasWallet) {
|
||||
clearViewStack();
|
||||
await saveState();
|
||||
// Save before broadcasting: the background reads the active
|
||||
// address back out of storage to build accountsChanged.
|
||||
if (activeAddressChanged) broadcastActiveChanged();
|
||||
showView("welcome");
|
||||
} else {
|
||||
// Switch to first wallet if deleted wallet was active
|
||||
state.selectedWallet = 0;
|
||||
state.selectedAddress = 0;
|
||||
state.activeAddress =
|
||||
state.wallets[0].addresses[0]?.address || null;
|
||||
await saveState();
|
||||
if (activeAddressChanged) broadcastActiveChanged();
|
||||
// Reset stack to [main] so Settings back goes home.
|
||||
// Use require() lazily to avoid circular dependency
|
||||
// (settings.js requires deleteWallet.js).
|
||||
|
||||
70
src/shared/walletDelete.js
Normal file
70
src/shared/walletDelete.js
Normal file
@@ -0,0 +1,70 @@
|
||||
// Wallet deletion state transition, kept out of the view so the selection
|
||||
// and broadcast rules are testable without a DOM.
|
||||
|
||||
// Remove wallet `walletIdx` from `state` and repair the derived state.
|
||||
//
|
||||
// Rules:
|
||||
// - `hasWallet` tracks whether any wallet remains.
|
||||
// - Site permissions are dropped for every address of the deleted wallet.
|
||||
// - `selectedWallet` follows the splice: it is decremented when a wallet
|
||||
// before it was removed, and falls back to the first remaining wallet's
|
||||
// first address only when the selection itself was deleted.
|
||||
// - `activeAddress` is only moved when it belonged to the deleted wallet;
|
||||
// the fallback is the first remaining wallet's first address, or null
|
||||
// when no wallet remains.
|
||||
//
|
||||
// Returns whether `activeAddress` changed, so the caller can broadcast it.
|
||||
function removeWalletFromState(state, walletIdx) {
|
||||
const wallet = state.wallets[walletIdx];
|
||||
const addresses = (wallet.addresses || []).map((a) => a.address);
|
||||
const previousActive = state.activeAddress;
|
||||
const activeWasDeleted =
|
||||
previousActive !== null &&
|
||||
previousActive !== undefined &&
|
||||
addresses.some(
|
||||
(a) => a.toLowerCase() === String(previousActive).toLowerCase(),
|
||||
);
|
||||
|
||||
state.wallets.splice(walletIdx, 1);
|
||||
|
||||
for (const addr of addresses) {
|
||||
delete state.allowedSites[addr];
|
||||
delete state.deniedSites[addr];
|
||||
}
|
||||
|
||||
state.hasWallet = state.wallets.length > 0;
|
||||
|
||||
const fallbackAddress = state.hasWallet
|
||||
? state.wallets[0].addresses[0]?.address || null
|
||||
: null;
|
||||
|
||||
if (!state.hasWallet) {
|
||||
state.selectedWallet = null;
|
||||
state.selectedAddress = null;
|
||||
} else if (state.selectedWallet === walletIdx) {
|
||||
state.selectedWallet = 0;
|
||||
state.selectedAddress = 0;
|
||||
} else if (
|
||||
typeof state.selectedWallet === "number" &&
|
||||
state.selectedWallet > walletIdx
|
||||
) {
|
||||
state.selectedWallet -= 1;
|
||||
}
|
||||
|
||||
if (activeWasDeleted || !state.hasWallet) {
|
||||
state.activeAddress = fallbackAddress;
|
||||
}
|
||||
|
||||
return { activeAddressChanged: state.activeAddress !== previousActive };
|
||||
}
|
||||
|
||||
// Tell the background the active address changed, so it re-emits
|
||||
// accountsChanged to connected sites. Same call shape as the address
|
||||
// switch in the home view.
|
||||
function broadcastActiveChanged() {
|
||||
const runtime =
|
||||
typeof browser !== "undefined" ? browser.runtime : chrome.runtime;
|
||||
runtime.sendMessage({ type: "AUTISTMASK_ACTIVE_CHANGED" });
|
||||
}
|
||||
|
||||
module.exports = { removeWalletFromState, broadcastActiveChanged };
|
||||
129
tests/walletDelete.test.js
Normal file
129
tests/walletDelete.test.js
Normal file
@@ -0,0 +1,129 @@
|
||||
const {
|
||||
removeWalletFromState,
|
||||
broadcastActiveChanged,
|
||||
} = require("../src/shared/walletDelete");
|
||||
|
||||
// Fixed addresses — never used for anything but these tests.
|
||||
const A0 = "0x66133E8ea0f5D1d612D2502a968757D1048c214a";
|
||||
const A1 = "0xdAC17F958D2ee523a2206206994597C13D831ec7";
|
||||
const B0 = "0x2260FAC5E5542a773Aa44fBCfeDf7C193bc2C599";
|
||||
const C0 = "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48";
|
||||
|
||||
function wallet(name, addresses) {
|
||||
return {
|
||||
name,
|
||||
addresses: addresses.map((address) => ({ address })),
|
||||
};
|
||||
}
|
||||
|
||||
// A three-wallet state; wallet A is an HD wallet with two addresses.
|
||||
function makeState(overrides = {}) {
|
||||
return {
|
||||
hasWallet: true,
|
||||
wallets: [wallet("A", [A0, A1]), wallet("B", [B0]), wallet("C", [C0])],
|
||||
selectedWallet: 0,
|
||||
selectedAddress: 0,
|
||||
activeAddress: A0,
|
||||
allowedSites: {
|
||||
[A0]: ["a.example"],
|
||||
[A1]: ["b.example"],
|
||||
[B0]: ["c.example"],
|
||||
},
|
||||
deniedSites: { [A1]: ["d.example"], [C0]: ["e.example"] },
|
||||
...overrides,
|
||||
};
|
||||
}
|
||||
|
||||
describe("removeWalletFromState", () => {
|
||||
test("deleting the last wallet clears hasWallet", () => {
|
||||
const state = makeState({
|
||||
wallets: [wallet("A", [A0])],
|
||||
allowedSites: { [A0]: ["a.example"] },
|
||||
deniedSites: {},
|
||||
});
|
||||
|
||||
const { activeAddressChanged } = removeWalletFromState(state, 0);
|
||||
|
||||
expect(state.hasWallet).toBe(false);
|
||||
expect(state.wallets).toEqual([]);
|
||||
expect(state.selectedWallet).toBeNull();
|
||||
expect(state.selectedAddress).toBeNull();
|
||||
expect(state.activeAddress).toBeNull();
|
||||
expect(activeAddressChanged).toBe(true);
|
||||
});
|
||||
|
||||
test("deleting a non-selected wallet leaves the selection intact", () => {
|
||||
const state = makeState({
|
||||
selectedWallet: 2,
|
||||
selectedAddress: 0,
|
||||
activeAddress: C0,
|
||||
});
|
||||
|
||||
const { activeAddressChanged } = removeWalletFromState(state, 1);
|
||||
|
||||
// Wallet C moved from index 2 to index 1 by the splice.
|
||||
expect(state.wallets.map((w) => w.name)).toEqual(["A", "C"]);
|
||||
expect(state.selectedWallet).toBe(1);
|
||||
expect(state.selectedAddress).toBe(0);
|
||||
expect(state.activeAddress).toBe(C0);
|
||||
expect(activeAddressChanged).toBe(false);
|
||||
expect(state.hasWallet).toBe(true);
|
||||
});
|
||||
|
||||
test("deleting a wallet after the selection does not shift it", () => {
|
||||
const state = makeState({
|
||||
selectedWallet: 1,
|
||||
selectedAddress: 0,
|
||||
activeAddress: B0,
|
||||
});
|
||||
|
||||
const { activeAddressChanged } = removeWalletFromState(state, 2);
|
||||
|
||||
expect(state.selectedWallet).toBe(1);
|
||||
expect(state.activeAddress).toBe(B0);
|
||||
expect(activeAddressChanged).toBe(false);
|
||||
});
|
||||
|
||||
test("deleting the active wallet falls back to the first remaining address", () => {
|
||||
const state = makeState({
|
||||
selectedWallet: 0,
|
||||
selectedAddress: 1,
|
||||
activeAddress: A1,
|
||||
});
|
||||
|
||||
const { activeAddressChanged } = removeWalletFromState(state, 0);
|
||||
|
||||
expect(state.wallets.map((w) => w.name)).toEqual(["B", "C"]);
|
||||
expect(state.selectedWallet).toBe(0);
|
||||
expect(state.selectedAddress).toBe(0);
|
||||
expect(state.activeAddress).toBe(B0);
|
||||
expect(activeAddressChanged).toBe(true);
|
||||
expect(state.hasWallet).toBe(true);
|
||||
});
|
||||
|
||||
test("site permissions are dropped for every address of the wallet", () => {
|
||||
const state = makeState();
|
||||
|
||||
removeWalletFromState(state, 0);
|
||||
|
||||
expect(state.allowedSites).toEqual({ [B0]: ["c.example"] });
|
||||
expect(state.deniedSites).toEqual({ [C0]: ["e.example"] });
|
||||
});
|
||||
});
|
||||
|
||||
describe("broadcastActiveChanged", () => {
|
||||
afterEach(() => {
|
||||
delete global.chrome;
|
||||
});
|
||||
|
||||
test("sends AUTISTMASK_ACTIVE_CHANGED to the background", () => {
|
||||
const sendMessage = jest.fn();
|
||||
global.chrome = { runtime: { sendMessage } };
|
||||
|
||||
broadcastActiveChanged();
|
||||
|
||||
expect(sendMessage).toHaveBeenCalledWith({
|
||||
type: "AUTISTMASK_ACTIVE_CHANGED",
|
||||
});
|
||||
});
|
||||
});
|
||||
Reference in New Issue
Block a user