feat(keyring-api): add TRON account support (#308)

Author: ulissesferreira

packages/keyring-api/src/api/account.ts

@@ -1,6 +1,6 @@
 import { AccountIdStruct, object } from '@metamask/keyring-utils';
 import type { Infer } from '@metamask/superstruct';
-import { nonempty, array, enums, record, string } from '@metamask/superstruct';
+import { array, enums, nonempty, record, string } from '@metamask/superstruct';
 import { JsonStruct } from '@metamask/utils';
 
 import { CaipChainIdStruct } from './caip';
@@ -30,6 +30,13 @@ export enum SolAccountType {
   DataAccount = 'solana:data-account',
 }
 
+/**
+ * Supported TRON account types.
+ */
+export enum TrxAccountType {
+  Eoa = 'tron:eoa',
+}
+
 /**
  * Supported account types.
  */
@@ -40,7 +47,8 @@ export type KeyringAccountType =
   | `${BtcAccountType.P2sh}`
   | `${BtcAccountType.P2wpkh}`
   | `${BtcAccountType.P2tr}`
-  | `${SolAccountType.DataAccount}`;
+  | `${SolAccountType.DataAccount}`
+  | `${TrxAccountType.Eoa}`;
 
 /**
  * A struct which represents a Keyring account object. It is abstract enough to
@@ -66,6 +74,7 @@ export const KeyringAccountStruct = object({
     `${BtcAccountType.P2wpkh}`,
     `${BtcAccountType.P2tr}`,
     `${SolAccountType.DataAccount}`,
+    `${TrxAccountType.Eoa}`,
   ]),
 
   /**

packages/keyring-api/src/api/address.test.ts

@@ -6,16 +6,19 @@ import type { CaipAccountId } from './caip';
 import { BtcScope } from '../btc';
 import { EthScope } from '../eth';
 import { SolScope } from '../sol';
+import { TrxScope } from '../trx';
 
 const MOCK_ETH_ADDRESS = '0x6431726EEE67570BF6f0Cf892aE0a3988F03903F';
 const MOCK_BTC_ADDRESS = 'bc1qwl8399fz829uqvqly9tcatgrgtwp3udnhxfq4k';
 const MOCK_SOL_ADDRESS = '7EcDhSYGxXyscszYEp35KHN8vvw3svAuLKTzXwCFLtV';
+const MOCK_TRX_ADDRESS = 'TT2T17KZhoDu47i2E4FWxfG79zdkEWkU9N';
 
 describe('ResolveAccountAddress', () => {
   it.each([
     `${EthScope.Eoa}:${MOCK_ETH_ADDRESS}`,
     `${BtcScope.Mainnet}:${MOCK_BTC_ADDRESS}`,
     `${SolScope.Mainnet}:${MOCK_SOL_ADDRESS}`,
+    `${TrxScope.Mainnet}:${MOCK_TRX_ADDRESS}`,
   ] as CaipAccountId[])(
     'allows CAIP-10 account ID: %s',
     (address: CaipAccountId) => {
@@ -28,7 +31,12 @@ describe('ResolveAccountAddress', () => {
     },
   );
 
-  it.each([MOCK_ETH_ADDRESS, MOCK_BTC_ADDRESS, MOCK_SOL_ADDRESS])(
+  it.each([
+    MOCK_ETH_ADDRESS,
+    MOCK_BTC_ADDRESS,
+    MOCK_SOL_ADDRESS,
+    MOCK_TRX_ADDRESS,
+  ])(
     'throws an error if address is not a CAIP-10 account ID: %s',
     (address: string) => {
       const resolvedAddress: ResolvedAccountAddress = {

packages/keyring-api/src/index.ts

@@ -2,6 +2,7 @@ export * from './api';
 export * from './btc';
 export * from './sol';
 export * from './eth';
+export * from './trx';
 export type * from './contexts';
 export * from './rpc';
 export * from './events';

packages/keyring-api/src/trx/constants.ts

@@ -0,0 +1,10 @@
+// istanbul ignore file
+
+/**
+ * Scopes for TRON account type. See {@link KeyringAccount.scopes}.
+ */
+export enum TrxScope {
+  Mainnet = 'tron:728126428',
+  Nile = 'tron:3448148188',
+  Shasta = 'tron:2494104990',
+}

packages/keyring-api/src/trx/index.ts

@@ -0,0 +1,2 @@
+export * from './constants';
+export * from './types';

packages/keyring-api/src/trx/types.test-d.ts

@@ -0,0 +1,8 @@
+import type { Extends } from '@metamask/keyring-utils';
+import { expectTrue } from '@metamask/keyring-utils';
+
+import type { TrxEoaAccount } from './types';
+import type { KeyringAccount } from '../api';
+
+// `TrxEoaAccount` extends `KeyringAccount`
+expectTrue<Extends<TrxEoaAccount, KeyringAccount>>();

packages/keyring-api/src/trx/types.test.ts

@@ -0,0 +1,28 @@
+import { TrxAddressStruct } from './types';
+
+describe('types', () => {
+  describe('TrxAddressStruct', () => {
+    it.each([
+      'TT2T17KZhoDu47i2E4FWxfG79zdkEWkU9N',
+      'TE2RzoSV3wFK99w6J9UnnZ4vLfXYoxvRwP',
+    ])('is valid address: %s', (address) => {
+      expect(() => TrxAddressStruct.assert(address)).not.toThrow();
+    });
+
+    it.each([
+      // Invalid lengths, too long (45 chars)
+      'TT2T17KZhoDu47i2E4FWxfG79zdkEWkU9NTT2T17KZhoD',
+      // Too short (24 chars)
+      'TT2T17KZhoDu47i2E4FWxfG7',
+      // Empty or invalid input
+      '',
+      // Eth style address
+      '0x1234',
+      'not-an-address',
+    ])('rejects invalid address: %s', (address) => {
+      expect(() => TrxAddressStruct.assert(address)).toThrow(
+        `Expected a value of type \`TrxAddress\`, but received: \`"${address}"\``,
+      );
+    });
+  });
+});

packages/keyring-api/src/trx/types.ts

@@ -0,0 +1,53 @@
+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,
+  TrxAccountType,
+} from '../api';
+
+/**
+ * TRON addresses are Base58-encoded strings that are exactly 34 characters long
+ * and start with the letter 'T'.
+ */
+export const TrxAddressStruct = definePattern(
+  'TrxAddress',
+  /^T[1-9A-HJ-NP-Za-km-z]{33}$/u,
+);
+
+/**
+ * Supported TRON methods.
+ */
+export enum TrxMethod {
+  SignMessageV2 = 'signMessageV2',
+  VerifyMessageV2 = 'verifyMessageV2',
+}
+
+export const TrxEoaAccountStruct = object({
+  ...KeyringAccountStruct.schema,
+
+  /**
+   * Account address.
+   */
+  address: TrxAddressStruct,
+
+  /**
+   * Account type.
+   */
+  type: literal(`${TrxAccountType.Eoa}`),
+
+  /**
+   * Account supported scopes (CAIP-2 chain IDs).
+   */
+  scopes: nonempty(array(CaipChainIdStruct)),
+
+  /**
+   * Account supported methods.
+   */
+  methods: array(enums(Object.values(TrxMethod))),
+});
+
+export type TrxEoaAccount = Infer<typeof TrxEoaAccountStruct>;