types.ts

// FIXME: eslint is complaning about our account union even if those accounts
// types should all be different, so we disable this for now:
/* eslint-disable @typescript-eslint/no-duplicate-type-constituents */

import {
  BtcAccountType,
  EthAccountType,
  KeyringAccountStruct,
  SolAccountType,
  BtcP2pkhAccountStruct,
  BtcP2shAccountStruct,
  BtcP2wpkhAccountStruct,
  BtcP2trAccountStruct,
  EthEoaAccountStruct,
  EthErc4337AccountStruct,
  SolDataAccountStruct,
  TrxAccountType,
  TrxEoaAccountStruct,
} from '@metamask/keyring-api';
import { exactOptional, object } from '@metamask/keyring-utils';
import type { Infer, Struct } from '@metamask/superstruct';
import { boolean, string, number } from '@metamask/superstruct';

export type InternalAccountType =
  | EthAccountType
  | BtcAccountType
  | SolAccountType
  | TrxAccountType;

export const InternalAccountMetadataStruct = object({
  metadata: object({
    name: string(),
    nameLastUpdatedAt: exactOptional(number()),
    snap: exactOptional(
      object({
        id: string(),
        enabled: boolean(),
        name: string(),
      }),
    ),
    lastSelected: exactOptional(number()),
    importTime: number(),
    keyring: object({
      type: string(),
    }),
  }),
});

export const InternalEthEoaAccountStruct = object({
  ...EthEoaAccountStruct.schema,
  ...InternalAccountMetadataStruct.schema,
});

export const InternalEthErc4337AccountStruct = object({
  ...EthErc4337AccountStruct.schema,
  ...InternalAccountMetadataStruct.schema,
});

export const InternalBtcP2pkhAccountStruct = object({
  ...BtcP2pkhAccountStruct.schema,
  ...InternalAccountMetadataStruct.schema,
});

export const InternalBtcP2shAccountStruct = object({
  ...BtcP2shAccountStruct.schema,
  ...InternalAccountMetadataStruct.schema,
});

export const InternalBtcP2wpkhAccountStruct = object({
  ...BtcP2wpkhAccountStruct.schema,
  ...InternalAccountMetadataStruct.schema,
});

export const InternalBtcP2trAccountStruct = object({
  ...BtcP2trAccountStruct.schema,
  ...InternalAccountMetadataStruct.schema,
});

export const InternalSolDataAccountStruct = object({
  ...SolDataAccountStruct.schema,
  ...InternalAccountMetadataStruct.schema,
});

export const InternalTrxEoaAccountStruct = object({
  ...TrxEoaAccountStruct.schema,
  ...InternalAccountMetadataStruct.schema,
});

export type InternalEthEoaAccount = Infer<typeof InternalEthEoaAccountStruct>;

export type InternalEthErc4337Account = Infer<
  typeof InternalEthErc4337AccountStruct
>;

export type InternalBtcP2pkhAccount = Infer<
  typeof InternalBtcP2pkhAccountStruct
>;

export type InternalBtcP2shAccount = Infer<typeof InternalBtcP2shAccountStruct>;

export type InternalBtcP2wpkhAccount = Infer<
  typeof InternalBtcP2wpkhAccountStruct
>;

export type InternalBtcP2trAccount = Infer<typeof InternalBtcP2trAccountStruct>;

export type InternalSolDataAccount = Infer<typeof InternalSolDataAccountStruct>;

export type InternalTrxEoaAccount = Infer<typeof InternalTrxEoaAccountStruct>;

export const InternalAccountStructs: Record<
  string,
  | Struct<InternalEthEoaAccount>
  | Struct<InternalEthErc4337Account>
  | Struct<InternalBtcP2pkhAccount>
  | Struct<InternalBtcP2shAccount>
  | Struct<InternalBtcP2wpkhAccount>
  | Struct<InternalBtcP2trAccount>
  | Struct<InternalSolDataAccount>
  | Struct<InternalTrxEoaAccount>
> = {
  [`${EthAccountType.Eoa}`]: InternalEthEoaAccountStruct,
  [`${EthAccountType.Erc4337}`]: InternalEthErc4337AccountStruct,
  [`${BtcAccountType.P2pkh}`]: InternalBtcP2pkhAccountStruct,
  [`${BtcAccountType.P2sh}`]: InternalBtcP2shAccountStruct,
  [`${BtcAccountType.P2wpkh}`]: InternalBtcP2wpkhAccountStruct,
  [`${BtcAccountType.P2tr}`]: InternalBtcP2trAccountStruct,
  [`${SolAccountType.DataAccount}`]: InternalSolDataAccountStruct,
  [`${TrxAccountType.Eoa}`]: InternalTrxEoaAccountStruct,
};

export type InternalAccountTypes =
  | InternalEthEoaAccount
  | InternalEthErc4337Account
  | InternalBtcP2pkhAccount
  | InternalBtcP2shAccount
  | InternalBtcP2wpkhAccount
  | InternalBtcP2trAccount
  | InternalSolDataAccount
  | InternalTrxEoaAccount;

export const InternalAccountStruct = object({
  ...KeyringAccountStruct.schema,
  ...InternalAccountMetadataStruct.schema,
});

/**
 * Internal account representation.
 *
 * This type is used internally by MetaMask to add additional metadata to the
 * account object. It's should not be used by external applications.
 */
export type InternalAccount = Infer<typeof InternalAccountStruct>;