feat(stellar-wallet-snap): Add exportAccount keyring API - #187
Draft
stanleyyconsensys wants to merge 3 commits into
Draft
feat(stellar-wallet-snap): Add exportAccount keyring API#187stanleyyconsensys wants to merge 3 commits into
exportAccount keyring API#187stanleyyconsensys wants to merge 3 commits into
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds support for the Keyring API v2 exportAccount method in @metamask/stellar-wallet-snap, enabling Stellar secret-seed (S…) export in base32 format, with validation and safeguards to reduce the risk of leaking secrets.
Changes:
- Implement
exportAccountin the keyring handler, deriving the wallet from entropy and returning anExportedAccountpayload (base32 only). - Add secret-seed validation (
StellarSecretKeyStruct) and wire in a single supported export encoding constant. - Update permissions, manifest capabilities, docs, tests, and changelog to reflect the new export functionality.
Reviewed changes
Copilot reviewed 16 out of 16 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/stellar-wallet-snap/src/utils/requestResponse.test.ts | Extends origin validation test coverage to include ExportAccount. |
| packages/stellar-wallet-snap/src/services/wallet/Wallet.ts | Exposes secret getter for derived keypairs to support exportAccount. |
| packages/stellar-wallet-snap/src/services/wallet/Wallet.test.ts | Adds unit test asserting the derived wallet returns the expected Stellar secret seed. |
| packages/stellar-wallet-snap/src/permissions.ts | Allows keyring_exportAccount for the MetaMask origin. |
| packages/stellar-wallet-snap/src/handlers/keyring/keyring.ts | Implements exportAccount, validates inputs/defaults, derives wallet, validates secret, and wraps errors to avoid leaking secrets. |
| packages/stellar-wallet-snap/src/handlers/keyring/keyring.test.ts | Adds exportAccount behavior tests and verifies secrets are not logged. |
| packages/stellar-wallet-snap/src/handlers/keyring/exceptions.ts | Introduces ExportAccountException to represent export failures without embedding secrets in messages. |
| packages/stellar-wallet-snap/src/handlers/keyring/api.ts | Adds ExportAccountRequestStruct with defaulting + strict encoding validation (base32 only). |
| packages/stellar-wallet-snap/src/handlers/keyring/api.test.ts | Adds tests for ExportAccountRequestStruct acceptance/rejection and defaulting behavior. |
| packages/stellar-wallet-snap/src/context.ts | Injects walletService into KeyringHandler to support wallet derivation for export. |
| packages/stellar-wallet-snap/src/constants.ts | Defines PRIVATE_KEY_EXPORT_ENCODING = 'base32' as the sole supported export encoding. |
| packages/stellar-wallet-snap/src/api/address.ts | Adds StellarSecretKeyStruct for Stellar secret-seed format validation. |
| packages/stellar-wallet-snap/src/api/address.test.ts | Adds unit tests for StellarSecretKeyStruct. |
| packages/stellar-wallet-snap/snap.manifest.json | Declares keyring privateKey.exportFormats support for base32. |
| packages/stellar-wallet-snap/docs/use-cases/keyring/keyring.md | Documents exportAccount behavior and data source (derived, not persisted). |
| packages/stellar-wallet-snap/CHANGELOG.md | Adds an Unreleased changelog entry for exportAccount. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| this.#logger.debug('Keyring request handled', { | ||
| origin, | ||
| method: request.method, | ||
| result: keyringRequestResult, |
Contributor
Author
There was a problem hiding this comment.
remove it for security purpose
| privateKey, | ||
| }; | ||
| } catch (error: unknown) { | ||
| return rethrowIfInstanceElseThrow( |
Contributor
Author
There was a problem hiding this comment.
return rethrowIfInstanceElseThrow is a exception throw process, the return is just to align the type check on tsc
| const { account } = await this.#accountService.resolveAccount({ | ||
| accountId, | ||
| }); | ||
| const wallet = await this.#walletService.resolveWallet(account); |
Contributor
Author
There was a problem hiding this comment.
both method will auto assert if the address is same, and throw error if
- account not found
- address not match
- fail to derived account
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Explanation
Adds support for the Keyring API v2
exportAccountmethod in@metamask/stellar-wallet-snap, enabling Stellar secret-seed (S…) export inbase32format, with validation and safeguards to reduce the risk of leaking secrets.Changes:
exportAccountin the keyring handler, deriving the wallet from entropy and returning anExportedAccountpayload (base32 only).StellarSecretKeyStruct) and wire in a single supported export encoding constant.References
Checklist