feat: support account name management from snap #508

khanti42 · 2025-02-12T10:51:19Z

PR Summary: Account Naming in Snap

New Features

1. Account Naming

Introduces an accountName field for accounts.
Default names follow the pattern: "Account {index}" (e.g., Account 1, Account 2).
Names are assigned during:
- Account creation
- Account recovery
Users can rename accounts via the new SetAccountName RPC method.

2. New RPC Methods

SetAccountName: Allows renaming an account.

Code Changes

Account Management Enhancements

Modified AccountStateManager to store and update accountName.
Introduced getNextIndex() in AccountService to fetch the next account index, used in the frontend to display the default Name.
Updated createAccount, recoverAccounts, and addAccount to handle account names.

RPC Handling

Added new RPC handlers:
- SetAccountNameRpc (for renaming accounts)
Updated onRpcRequest to support these methods.

Testing

Added test cases for:
- setAccountName
- getNextAccountIndex
Updated existing tests to validate account name assignments.
Removed unnecessary whitespace in config.ts.
Updated superstruct.ts to validate accountName.

BEGIN_COMMIT_OVERRIDE

feat: Support account name management in Snap

END_COMMIT_OVERRIDE

* feat: add account service

* feat: add account service factory * fix: rename deployPayload

* feat: add account serviceΩ --------- Co-authored-by: khanti42 <[email protected]>

* feat: add `AddAccount` RPC * feat: add max account create limit --------- Co-authored-by: khanti42 <[email protected]>

* feat: add account ui --------- Co-authored-by: khanti42 <[email protected]>

* feat: add get current account RPC * fix: add some detail comment on contract discovery * fix: comments on test title --------- Co-authored-by: khanti42 <[email protected]>

* feat: add list accounts rpc * fix: lint * fix: add some detail comment on contract discovery * fix: comments on test title --------- Co-authored-by: khanti42 <[email protected]>

* feat: add swtich account rpc --------- Co-authored-by: khanti42 <[email protected]>

#479) * chore: set new account to current in snap * fix: lint * chore: update logger mocking

* feat: add manage multi account hooks * fix: remove non exist component * fix: var naming in UI * chore: update logger mocking * chore: update setAccounts logic in UI * chore: remove duplicate when set account from UI * chore: remove non necessary account array in UI

…483)

* feat: add account service * chore: fix lint * chore: update account contract discovery logic * fix: code comment * chore: add discovery logic description * fix: lint * feat: add account service factory * fix: rename deployPayload * chore: adopt account discovery in RPCs * chore: update execute txn test * fix: execute test * fix: account discovery bug * fix: discovery logic * feat: add `AddAccount` RPC * feat: add max account create limit * fix: add `isMaxAccountLimitExceeded` unit test * feat: add account ui * fix: account deploy require result * fix: lint * fix: lint * feat: add get current account RPC * feat: add list accounts rpc * fix: lint * feat: add swtich account rpc * fix: comments on add account icon * chore: set new account to current in snap * fix: lint * feat: add manage multi account hooks * fix: remove non exist component * fix: var naming in UI * chore: update logger mocking * chore: update setAccounts logic in UI * chore: remove duplicate when set account from UI * chore: remove non necessary account array in UI * feat: account selection dropdown * chore: connect ui to snap for switch account * chore: fix comments * chore: lint + prettier * chore: fix bugs qa * chore: fix comments * chore: revert snap changes * chore: revert snap changes --------- Co-authored-by: stanleyyuen <[email protected]>

…ap home page UI (#487) * fix: use correct account on snap homepage * fix: eof

* feat: get-starknet support for account change event * chore: lint + prettier * chore: fix comments * chore: lint + prettier * fix: use fromState=true * chore: fix comments * chore: fix tests * chore: fix comments * chore: fix comments * chore: fix comments * fix: rollback change --------- Co-authored-by: stanleyyuen <[email protected]>

* chore: add unit test * chore: update wallet test in get-starknet * chore: block init event not send out --------- Co-authored-by: stanleyyuen <[email protected]>

Co-authored-by: khanti42 <[email protected]>

…t visibility (#494) * chore: unblock account create limit * feat: add toggle account visibility RPC * fix: typo * fix: add permission

* feat: wallet-ui multiple accounts scrollbar

* feat: wallet-ui multiple accounts scrollbar * feat: hide account feature * feat: show account feature * chore: fix sonar qube * chore: fix comments * chore: lint * chore: fix comments * chore: lint * chore: fix comments * chore: fix comments * chore: fix comments * chore: fix comments * chore: fix comments * chore: fix comments * chore: fix comments * chore: fix comments * chore: fix comments * chore: currentAccount is always defined in walletSlice redux state (#502) * chore: fix comments * chore: fix comments

stanleyyconsensys

Thanks for the work
some comments and some of them are coming from copy and paste
Lets be more careful next time

packages/starknet-snap/src/rpcs/add-account.ts

packages/starknet-snap/src/wallet/account/service.ts

packages/starknet-snap/src/config.ts

packages/starknet-snap/src/types/snapState.ts

packages/starknet-snap/src/state/account-state-manager.ts

packages/starknet-snap/src/wallet/account/account.ts

packages/starknet-snap/src/state/account-state-manager.test.ts

packages/starknet-snap/src/wallet/account/account.ts

packages/starknet-snap/src/wallet/account/service.ts

packages/starknet-snap/test/constants.test.ts

stanleyyconsensys

Almost prefect, just 3 comments for enhancement

packages/starknet-snap/src/utils/account.test.ts

packages/starknet-snap/src/utils/superstruct.ts

packages/starknet-snap/src/rpcs/set-account-name.ts

stanleyyconsensys

few more comments

packages/starknet-snap/src/rpcs/set-account-name.ts

packages/starknet-snap/src/utils/superstruct.ts

packages/starknet-snap/src/rpcs/set-account-name.test.ts

sonarqubecloud · 2025-02-13T13:00:45Z

Quality Gate passed for 'consensys_starknet-snap-wallet-ui'

Issues
0 New issues
0 Accepted issues

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

See analysis details on SonarQube Cloud

sonarqubecloud · 2025-02-13T13:00:54Z

Quality Gate passed for 'consensys_starknet-snap-starknet-snap'

Issues
0 New issues
0 Accepted issues

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

See analysis details on SonarQube Cloud

stanleyyconsensys and others added 30 commits January 9, 2025 10:16

feat: add account service (#470)

4a15102

* feat: add account service

feat: add account service factory (#472)

5ffab0e

* feat: add account service factory * fix: rename deployPayload

refactor: adopt account discovery (#473)

3fa9386

* feat: add account serviceΩ --------- Co-authored-by: khanti42 <[email protected]>

feat: add new RPC starkNet_addAccount (#474)

61ea119

* feat: add `AddAccount` RPC * feat: add max account create limit --------- Co-authored-by: khanti42 <[email protected]>

feat: add account UI (#475)

8688436

* feat: add account ui --------- Co-authored-by: khanti42 <[email protected]>

feat: add new RPC starkNet_getCurrentAccount (#476)

88faf8f

* feat: add get current account RPC * fix: add some detail comment on contract discovery * fix: comments on test title --------- Co-authored-by: khanti42 <[email protected]>

feat: add new RPC starkNet_listAccounts (#477)

0db8fb1

* feat: add list accounts rpc * fix: lint * fix: add some detail comment on contract discovery * fix: comments on test title --------- Co-authored-by: khanti42 <[email protected]>

feat: add new RPC starkNet_switchAccount (#478)

1ec0dcd

* feat: add swtich account rpc --------- Co-authored-by: khanti42 <[email protected]>

chore: set new account to current current in RPC starkNet_addAccount (

bd65fa6

#479) * chore: set new account to current in snap * fix: lint * chore: update logger mocking

chore: update get current account rpc to return data from state only (#…

591050a

…483)

fix: after a account switched, the address is not reflected on the Sn…

d26d8de

…ap home page UI (#487) * fix: use correct account on snap homepage * fix: eof

fix: account contract isRequiredDeploy Upgrade order mismatch (#491)

a31c492

fix: typo of SwitchAccount RPC api name

0056468

chore: add unit test for get-starknet event (#490)

c233cc8

* chore: add unit test * chore: update wallet test in get-starknet * chore: block init event not send out --------- Co-authored-by: stanleyyuen <[email protected]>

fix: incorrect switch account rpc endpoint (#496)

ac5e50a

chore: unblock account create limit (#493)

0eb4f4e

Co-authored-by: khanti42 <[email protected]>

feat: Add RPC starkNet_toggleAccountVisibility to toggle the accoun…

492e311

…t visibility (#494) * chore: unblock account create limit * feat: add toggle account visibility RPC * fix: typo * fix: add permission

feat: wallet-ui multiple accounts scrollbar (#499)

ef9e9cf

* feat: wallet-ui multiple accounts scrollbar

Merge branch 'main' into feat/enable-multiple-accounts

961d518

chore: add missing translation

d8e60d2

chore: lint + test

840f36c

chore: qa fix

05cd63c

chore: account name in state optional

60a8c58

Merge branch 'main' into feat/sf-785

287149f

chore: default account name

36b9f5f

chore: lint+test

f306365

khanti42 requested a review from a team as a code owner February 12, 2025 21:32

khanti42 requested review from Julink-eth and jonesho and removed request for a team February 12, 2025 21:32

khanti42 changed the title ~~feat: account Naming in Starknet Snap~~ feat: account Naming in Snap Feb 12, 2025

stanleyyconsensys changed the title ~~feat: account Naming in Snap~~ feat: support account name management from snap Feb 13, 2025

stanleyyconsensys requested changes Feb 13, 2025

View reviewed changes

khanti42 and others added 11 commits February 13, 2025 09:45

chore: fix comments

177738f

chore: fix comments

16a50cf

chore: fix comments

cc737ab

chore: add AccountMissMatchError

9afee97

chore: update account state test helper

21eb443

chore: add defaultAccountIndex config

7c566e8

chore: update account service

df0f11a

chore: lint

bf3498d

Merge branch 'feat/sf-801' into chore/refine-account-service

ad6e37c

chore: use new account state

a31a825

chore: fix tests

db8bc8a

khanti42 changed the base branch from main to chore/refine-account-service February 13, 2025 11:37

chore: set account name

385d106

khanti42 requested a review from stanleyyconsensys February 13, 2025 12:07

stanleyyconsensys requested changes Feb 13, 2025

View reviewed changes

packages/starknet-snap/src/utils/account.test.ts Outdated Show resolved Hide resolved

packages/starknet-snap/src/utils/superstruct.ts Outdated Show resolved Hide resolved

packages/starknet-snap/src/rpcs/set-account-name.ts Outdated Show resolved Hide resolved

chore: fix comments

e17a963

stanleyyconsensys requested changes Feb 13, 2025

View reviewed changes

Base automatically changed from chore/refine-account-service to main February 13, 2025 12:35

khanti42 added 2 commits February 13, 2025 13:46

chore: fix comments

c97e1a8

Merge branch 'main' into feat/sf-801

7465c5c

stanleyyconsensys approved these changes Feb 13, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: support account name management from snap #508

feat: support account name management from snap #508

khanti42 commented Feb 12, 2025 •

edited

Loading

stanleyyconsensys left a comment

stanleyyconsensys left a comment

stanleyyconsensys left a comment

sonarqubecloud bot commented Feb 13, 2025

sonarqubecloud bot commented Feb 13, 2025

feat: support account name management from snap #508

Are you sure you want to change the base?

feat: support account name management from snap #508

Conversation

khanti42 commented Feb 12, 2025 • edited Loading

PR Summary: Account Naming in Snap

New Features

1. Account Naming

2. New RPC Methods

Code Changes

Account Management Enhancements

RPC Handling

Testing

stanleyyconsensys left a comment

Choose a reason for hiding this comment

stanleyyconsensys left a comment

Choose a reason for hiding this comment

stanleyyconsensys left a comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Feb 13, 2025

Quality Gate passed for 'consensys_starknet-snap-wallet-ui'

sonarqubecloud bot commented Feb 13, 2025

Quality Gate passed for 'consensys_starknet-snap-starknet-snap'

khanti42 commented Feb 12, 2025 •

edited

Loading