Skip to content
This repository has been archived by the owner on Oct 7, 2024. It is now read-only.

feat: allow multiple address per account #343

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 29 additions & 3 deletions src/api/account.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { JsonStruct } from '@metamask/utils';
import type { Infer } from 'superstruct';
import { array, enums, record, string } from 'superstruct';
import { array, enums, record, string, union } from 'superstruct';

import { object } from '../superstruct';
import { UuidStruct } from '../utils';
Expand Down Expand Up @@ -51,9 +51,35 @@ export const KeyringAccountStruct = object({
]),

/**
* Account main address.
* Account addresses. It can be a single address or a map of addresses per
* chain.
*
* If the address is a string, it's assumed to be under the 'eip155'
* namespace. Otherwise, it must be a map of addresses per chain, where the
* key is the chain ID (CAIP-2) and the value is an array of addresses.
*
* @example
* ```ts
* address: {
* // Different addresses per chain.
* 'eip155:1': ['0x1234...'],
* 'eip155:137': ['0x5678...'],
* }
* ```
* @example
* ```ts
* address: {
* // The address is the same across all 'eip155' chains.
* 'eip155': ['0x1234...'],
* }
* ```
* @example
* ```ts
* // Assumed to be under the 'eip155' namespace.
* address: '0x1234...',
* ```
*/
address: string(),
address: union([string(), record(string(), array(string()))]),

/**
* Account options.
Expand Down
7 changes: 6 additions & 1 deletion src/api/keyring.ts
Original file line number Diff line number Diff line change
Expand Up @@ -81,12 +81,17 @@ export type Keyring = {
/**
* Filter supported chains for a given account.
*
* See {@link KeyringAccount}.
*
* @deprecated Use the keys of the `address` map of the account object to
* indicate the supported chains. This method will be removed in a future
* version of the Keyring API.
* @param id - ID of the account to be checked.
* @param chains - List of chains (CAIP-2) to be checked.
* @returns A Promise that resolves to a filtered list of CAIP-2 IDs
* representing the supported chains.
*/
filterAccountChains(id: string, chains: string[]): Promise<string[]>;
filterAccountChains?(id: string, chains: string[]): Promise<string[]>;

/**
* Update an account.
Expand Down
20 changes: 19 additions & 1 deletion src/rpc-handler.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,25 @@ describe('handleKeyringRequest', () => {
expect(result).toBe('FilterSupportedChains result');
});

it('calls `keyring_updateAccount`', async () => {
it('fails because `keyring_filterAccountChains` is not implemented', async () => {
const request: JsonRpcRequest = {
jsonrpc: '2.0',
id: '7c507ff0-365f-4de0-8cd5-eb83c30ebda4',
method: 'keyring_filterAccountChains',
params: {
id: '4f983fa2-4f53-4c63-a7c2-f9a5ed750041',
chains: ['chain1', 'chain2'],
},
};

const { filterAccountChains, ...partialKeyring } = keyring;

await expect(handleKeyringRequest(partialKeyring, request)).rejects.toThrow(
'Method not supported: keyring_filterAccountChains',
);
});

it('calls keyring_updateAccount', async () => {
const request: JsonRpcRequest = {
jsonrpc: '2.0',
id: '7c507ff0-365f-4de0-8cd5-eb83c30ebda4',
Expand Down
3 changes: 3 additions & 0 deletions src/rpc-handler.ts
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,9 @@ async function dispatchRequest(
}

case KeyringRpcMethod.FilterAccountChains: {
if (keyring.filterAccountChains === undefined) {
throw new MethodNotSupportedError(request.method);
}
assert(request, FilterAccountChainsStruct);
return keyring.filterAccountChains(
request.params.id,
Expand Down
Loading