feat: add Stellar (XLM) support to keyring-api, keyring-internal-api, and eth-snap-keyring #483
There are no files selected for viewing
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| // istanbul ignore file | ||
|
|
||
| /** | ||
| * Scopes for Stellar account type. See {@link KeyringAccount.scopes}. | ||
| * | ||
| * @see https://namespaces.chainagnostic.org/stellar/caip2 | ||
| */ | ||
| export enum XlmScope { | ||
| Pubnet = 'stellar:pubnet', | ||
| Testnet = 'stellar:testnet', | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| export * from './constants'; | ||
| export * from './types'; |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| import type { Extends } from '@metamask/keyring-utils'; | ||
| import { expectTrue } from '@metamask/keyring-utils'; | ||
|
|
||
| import type { XlmAccount } from './types'; | ||
| import type { KeyringAccount } from '../api'; | ||
|
|
||
| // `XlmAccount` extends `KeyringAccount` | ||
| expectTrue<Extends<XlmAccount, KeyringAccount>>(); |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| import { XlmAddressStruct } from './types'; | ||
|
|
||
| describe('types', () => { | ||
| describe('XlmAddressStruct', () => { | ||
| it.each([ | ||
| 'GAKGOF5HPQSMKOJ6L4I2LNTLY6EERIRC7ZB6F7MOAXDLPZ7D5I4NZGNZ', | ||
| 'GDAMXWN25KO5HFBYY6GYVF56QQLJKKZJ5FTSBKFXVBVKQCV4AI5HAQOA', | ||
| ])('is valid address: %s', (address) => { | ||
| expect(() => XlmAddressStruct.assert(address)).not.toThrow(); | ||
| }); | ||
|
|
||
| it.each([ | ||
| // Invalid lengths, too long (57 chars) | ||
| 'GAKGOF5HPQSMKOJ6L4I2LNTLY6EERIRC7ZB6F7MOAXDLPZ7D5I4NZGNZ1', | ||
| // Too short (54 chars after G) | ||
| 'GAKGOF5HPQSMKOJ6L4I2LNTLY6EERIRC7ZB6F7MOAXDLPZ7D5I4NZGN', | ||
| // Empty or invalid input | ||
| '', | ||
| // Eth style address | ||
| '0x1234', | ||
| 'not-an-address', | ||
| // Muxed address (not supported) | ||
| 'MAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABWTA', | ||
| ])('rejects invalid address: %s', (address) => { | ||
| expect(() => XlmAddressStruct.assert(address)).toThrow( | ||
| `Expected a value of type \`XlmAddress\`, but received: \`"${address}"\``, | ||
| ); | ||
| }); | ||
| }); | ||
| }); |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| import { object } from '@metamask/keyring-utils'; | ||
| import type { Infer } from '@metamask/superstruct'; | ||
| import { array, enums, literal, nonempty } from '@metamask/superstruct'; | ||
| import { definePattern } from '@metamask/utils'; | ||
|
|
||
| import { | ||
| CaipChainIdStruct, | ||
| KeyringAccountStruct, | ||
| XlmAccountType, | ||
| } from '../api'; | ||
|
|
||
| /** | ||
| * Stellar account addresses use strkey encoding: non-muxed accounts start with `G` | ||
| * and are 56 characters long. | ||
| * | ||
| * TODO: Add checksum validation. | ||
| */ | ||
| export const XlmAddressStruct = definePattern('XlmAddress', /^G[A-Z2-7]{55}$/u); | ||
khanti42 marked this conversation as resolved.
Show resolved
Hide resolved
khanti42 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| /** | ||
| * Supported Stellar methods. | ||
| */ | ||
| export enum XlmMethod { | ||
| SignMessage = 'signMessage', | ||
| SignTransaction = 'signTransaction', | ||
| } | ||
|
|
||
| export const XlmAccountStruct = object({ | ||
| ...KeyringAccountStruct.schema, | ||
| /** | ||
| * Account address. | ||
| */ | ||
| address: XlmAddressStruct, | ||
| /** | ||
| * Account type. | ||
| */ | ||
| type: literal(`${XlmAccountType.Account}`), | ||
| /** | ||
| * Account supported scopes (CAIP-2 chain IDs). | ||
| */ | ||
| scopes: nonempty(array(CaipChainIdStruct)), | ||
| /** | ||
| * Account supported methods. | ||
| */ | ||
| methods: array(enums(Object.values(XlmMethod))), | ||
| }); | ||
|
|
||
| export type XlmAccount = Infer<typeof XlmAccountStruct>; | ||
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.