@injectivelabs/wallet-base 1.16.38 → 1.16.39-alpha.1

package/dist/esm/index.d.ts

@@ -1,3 +1,475 @@
-export * from './types/index.js';
-export * from './utils/index.js';
-export { default as BaseConcreteStrategy } from './base.js';
+import { AccountAddress, ChainId, CosmosChainId, EvmChainId } from "@injectivelabs/ts-types";
+import { Account, Chain, LocalAccount, PublicClient, WalletClient } from "viem";
+import { CosmosTxV1Beta1TxPb } from "@injectivelabs/sdk-ts";
+import { StdSignDoc } from "@keplr-wallet/types";
+import { OfflineSigner } from "@cosmjs/proto-signing";
+import { TxResponse } from "@injectivelabs/sdk-ts/core/tx";
+import { AminoSignResponse, DirectSignResponse, TxRaw } from "@injectivelabs/sdk-ts/types";
+import { EIP1193Provider } from "eip1193-provider";
+import { Msgs } from "@injectivelabs/sdk-ts/core/modules";
+
+//#region src/types/enums.d.ts
+declare const BroadcastMode: {
+  readonly Block: "block";
+  readonly Sync: "sync";
+  readonly Async: "async";
+};
+type BroadcastMode = (typeof BroadcastMode)[keyof typeof BroadcastMode];
+declare const Wallet: {
+  readonly Leap: "leap";
+  readonly Keplr: "keplr";
+  readonly Ninji: "ninji";
+  readonly Magic: "magic";
+  readonly Rabby: "rabby";
+  readonly Ledger: "ledger";
+  readonly BitGet: "BitGet";
+  readonly OWallet: "owallet";
+  readonly Phantom: "phantom";
+  readonly Rainbow: "rainbow";
+  readonly Turnkey: "turnkey";
+  readonly Metamask: "metamask";
+  readonly KeplrEvm: "keplr-evm";
+  readonly OkxWallet: "okx-wallet";
+  readonly PrivateKey: "private-key";
+  readonly TrustWallet: "trust-wallet";
+  readonly TrezorBip32: "trezor-bip32";
+  readonly TrezorBip44: "trezor-bip44";
+  readonly Cosmostation: "cosmostation";
+  readonly LedgerCosmos: "ledger-cosmos";
+  readonly LedgerLegacy: "ledger-legacy";
+  readonly WalletConnect: "wallet-connect";
+  readonly CosmostationEth: "cosmostation-eth";
+};
+type Wallet = (typeof Wallet)[keyof typeof Wallet];
+declare const MagicProvider: {
+  readonly Email: "email";
+  readonly Apple: "apple";
+  readonly Github: "github";
+  readonly Google: "google";
+  readonly Discord: "discord";
+  readonly Twitter: "twitter";
+  readonly Facebook: "facebook";
+};
+type MagicProvider = (typeof MagicProvider)[keyof typeof MagicProvider];
+declare const WalletDeviceType: {
+  readonly Mobile: "mobile";
+  readonly Other: "other";
+  readonly Browser: "browser";
+  readonly Hardware: "hardware";
+};
+type WalletDeviceType = (typeof WalletDeviceType)[keyof typeof WalletDeviceType];
+declare const WalletEventListener: {
+  readonly AccountChange: "account-change";
+  readonly ChainIdChange: "chain-id-change";
+};
+type WalletEventListener = (typeof WalletEventListener)[keyof typeof WalletEventListener];
+declare const WalletAction: {
+  GetChainId: "get-chain-id";
+  GetAccounts: "get-accounts";
+  GetNetworkId: "get-network-id";
+  SignArbitrary: "sign-arbitrary";
+  SignTransaction: "sign-transaction";
+  SendTransaction: "send-transaction";
+  SendEvmTransaction: "send-evm-transaction";
+  SignEvmTransaction: "sign-evm-transaction";
+  GetEvmTransactionReceipt: "get-evm-transaction-receipt";
+};
+//#endregion
+//#region src/types/strategy.d.ts
+type onAccountChangeCallback = (account: string | string[]) => void;
+type onChainIdChangeCallback = () => void;
+type Eip1193Provider = {
+  request: (args: {
+    method: string;
+    params: any[];
+  }) => Promise<any>;
+  on: (event: string, listener: (...args: any[]) => void) => void;
+  removeListener: (event: string, listener: (...args: any[]) => void) => void;
+};
+type CosmosWalletAbstraction = {
+  enableGasCheck?(chainId: ChainId): Promise<void> | void;
+  disableGasCheck?(chainId: ChainId): Promise<void> | void;
+  signEIP712CosmosTx(args: {
+    signDoc: StdSignDoc;
+    eip712: any;
+  }): Promise<AminoSignResponse>;
+};
+type MagicMetadata = {
+  apiKey?: string;
+  rpcEndpoint?: string;
+};
+type PrivateKeyMetadata = {
+  privateKey: string;
+};
+type WalletConnectMetadata = {
+  projectId?: string;
+};
+interface WalletStrategyEvmOptions {
+  evmChainId: EvmChainId;
+  rpcUrl?: string;
+  rpcUrls?: Partial<Record<EvmChainId, string>>;
+}
+interface SendTransactionOptions {
+  address: string;
+  chainId: ChainId;
+  txTimeout?: number;
+  endpoints: {
+    rest: string;
+    grpc: string;
+    tm?: string;
+  };
+}
+declare const TurnkeyProvider: {
+  readonly Email: "email";
+  readonly Google: "google";
+  readonly Apple: "apple";
+};
+type TurnkeyProvider = (typeof TurnkeyProvider)[keyof typeof TurnkeyProvider];
+type TurnkeySession = {
+  sessionType: any;
+  userId: string;
+  organizationId: string;
+  expiry: number;
+  token: string;
+};
+interface TurnkeyMetadata {
+  apiBaseUrl: string;
+  otpInitPath?: string;
+  otpVerifyPath?: string;
+  googleClientId?: string;
+  oauthLoginPath?: string;
+  session?: TurnkeySession;
+  apiServerEndpoint: string;
+  credentialBundle?: string;
+  googleRedirectUri?: string;
+  expirationSeconds?: string;
+  defaultOrganizationId: string;
+}
+interface WalletMetadata {
+  magic?: MagicMetadata;
+  turnkey?: Partial<TurnkeyMetadata>;
+  walletConnect?: WalletConnectMetadata;
+  privateKey?: PrivateKeyMetadata;
+  derivationPath?: string;
+  baseDerivationPath?: string;
+}
+interface ConcreteWalletStrategyArgs {
+  chainId: ChainId;
+  metadata?: WalletMetadata;
+}
+interface ConcreteEvmWalletStrategyArgs extends ConcreteWalletStrategyArgs {
+  evmOptions: WalletStrategyEvmOptions;
+}
+interface ConcreteCosmosWalletStrategyArgs extends ConcreteWalletStrategyArgs {
+  wallet?: Wallet;
+}
+interface ConcreteCosmosWalletStrategy {
+  metadata?: WalletMetadata;
+  setMetadata?(metadata?: WalletMetadata): void;
+  /**
+   * The accounts from the wallet (addresses)
+   */
+  getAddresses(args?: unknown): Promise<string[]>;
+  /**
+   * The accounts from the wallet with derivation path info (for hardware wallets)
+   */
+  getAddressesInfo(args?: unknown): Promise<{
+    address: string;
+    derivationPath: string;
+    baseDerivationPath: string;
+  }[]>;
+  /**
+   * Return the WalletDeviceType connected on the
+   * wallet provider (extension, mobile, hardware wallet)
+   */
+  getWalletDeviceType(): Promise<WalletDeviceType>;
+  /**
+   * Get the PubKey from the wallet
+   * in base64 for Cosmos native wallets
+   */
+  getPubKey(address?: string): Promise<string>;
+  /**
+   * Perform validations and checks
+   * for the wallet (if the chain is supported, etc)
+   */
+  enable(args?: unknown): Promise<boolean>;
+  /**
+   * Sends Cosmos transaction. Returns a transaction hash
+   * @param transaction should implement TransactionConfig
+   * @param options
+   */
+  sendTransaction(transaction: DirectSignResponse | TxRaw, options: SendTransactionOptions): Promise<TxResponse>;
+  signCosmosTransaction(transaction: {
+    txRaw: TxRaw;
+    chainId: string;
+    accountNumber: number;
+    address: string;
+  }): Promise<DirectSignResponse>;
+  signAminoTransaction(transaction: {
+    stdSignDoc: StdSignDoc;
+    address: string;
+  }): Promise<AminoSignResponse>;
+}
+type ConcreteStrategiesArg = { [key in Wallet]?: ConcreteWalletStrategy };
+interface WalletStrategyArguments {
+  chainId: ChainId;
+  metadata?: WalletMetadata;
+  evmOptions?: WalletStrategyEvmOptions;
+  disabledWallets?: Wallet[];
+  wallet?: Wallet;
+  strategies: ConcreteStrategiesArg;
+}
+interface ConcreteWalletStrategy extends Omit<ConcreteCosmosWalletStrategy, 'sendTransaction' | 'isChainIdSupported' | 'signAminoTransaction'> {
+  /**
+   * The accounts from the wallet with derivation path info (for hardware wallets)
+   */
+  getAddressesInfo(args?: unknown): Promise<{
+    address: string;
+    derivationPath: string;
+    baseDerivationPath: string;
+  }[]>;
+  /**
+   * Sends Cosmos transaction. Returns a transaction hash
+   * @param transaction should implement TransactionConfig
+   * @param options
+   */
+  sendTransaction(transaction: DirectSignResponse | TxRaw, options: {
+    address: string;
+    chainId: ChainId;
+    txTimeout?: number;
+    endpoints?: {
+      rest: string;
+      grpc: string;
+      tm?: string;
+    };
+  }): Promise<TxResponse>;
+  /**
+   * Confirm the address on the wallet
+   * @param address address
+   */
+  getSessionOrConfirm(address?: string): Promise<string>;
+  /**
+   * Sends Ethereum transaction. Returns a transaction hash
+   * @param transaction should implement TransactionConfig
+   * @param options
+   */
+  sendEvmTransaction(transaction: unknown, options: {
+    address: string;
+    evmChainId: EvmChainId;
+  }): Promise<string>;
+  /**
+   * Sign a cosmos transaction using the wallet provider
+   *
+   * @param transaction
+   * @param address - injective address
+   */
+  signCosmosTransaction(transaction: {
+    txRaw: TxRaw;
+    accountNumber: number;
+    chainId: string;
+    address: string;
+  }): Promise<DirectSignResponse>;
+  /**
+   * Sign an amino sign doc using the wallet provider
+   *
+   * @param transaction
+   * @param address - injective address
+   */
+  signAminoCosmosTransaction(transaction: {
+    signDoc: StdSignDoc;
+    address: string;
+  }): Promise<AminoSignResponse>;
+  /**
+   * Sign EIP712 TypedData using the wallet provider
+   * @param eip712TypedData
+   * @param address - ethereum address
+   */
+  signEip712TypedData(eip712TypedData: string, address: string, options?: {
+    txTimeout?: number;
+  }): Promise<string>;
+  signArbitrary(signer: string, data: string | Uint8Array): Promise<string>;
+  getEthereumChainId(): Promise<string>;
+  getEvmTransactionReceipt(txHash: string, evmChainId?: EvmChainId): void;
+  onAccountChange?(callback: onAccountChangeCallback): Promise<void> | void;
+  onChainIdChange?(callback: onChainIdChangeCallback): Promise<void> | void;
+  disconnect?(): Promise<void> | void;
+  getCosmosWallet?(chainId: ChainId): CosmosWalletAbstraction;
+  getWalletClient?<T>(): Promise<T>;
+  getEip1193Provider?(): Promise<Eip1193Provider>;
+  getOfflineSigner?(chainId: string): Promise<OfflineSigner>;
+}
+interface WalletStrategy {
+  strategies: ConcreteStrategiesArg;
+  wallet: Wallet;
+  args: WalletStrategyArguments;
+  metadata?: WalletMetadata;
+  getWallet(): Wallet;
+  getWalletClient?<T>(): Promise<T>;
+  setWallet(wallet: Wallet): Promise<void>;
+  setMetadata(metadata?: WalletMetadata): void;
+  getStrategy(): ConcreteWalletStrategy;
+  getAddresses(args?: unknown): Promise<AccountAddress[]>;
+  getAddressesInfo(args?: unknown): Promise<{
+    address: string;
+    derivationPath: string;
+    baseDerivationPath: string;
+  }[]>;
+  getWalletDeviceType(): Promise<WalletDeviceType>;
+  getPubKey(address?: string): Promise<string>;
+  enable(args?: unknown): Promise<boolean>;
+  enableAndGetAddresses(args?: unknown): Promise<AccountAddress[]>;
+  getEthereumChainId(): Promise<string>;
+  getEvmTransactionReceipt(txHash: string, evmChainId?: EvmChainId): Promise<void>;
+  getSessionOrConfirm(address?: AccountAddress): Promise<string>;
+  sendTransaction(tx: DirectSignResponse | TxRaw, options: SendTransactionOptions): Promise<TxResponse>;
+  sendEvmTransaction(tx: any, options: {
+    address: AccountAddress;
+    evmChainId: EvmChainId;
+  }): Promise<string>;
+  signEip712TypedData(eip712TypedData: string, address: AccountAddress, options?: {
+    txTimeout?: number;
+  }): Promise<string>;
+  signAminoCosmosTransaction(transaction: {
+    signDoc: StdSignDoc;
+    address: string;
+  }): Promise<AminoSignResponse>;
+  signCosmosTransaction(transaction: {
+    txRaw: TxRaw;
+    accountNumber: number;
+    chainId: string;
+    address: string;
+  }): Promise<DirectSignResponse>;
+  signArbitrary(signer: string, data: string | Uint8Array): Promise<string | void>;
+  onAccountChange(callback: onAccountChangeCallback): Promise<void>;
+  onChainIdChange(callback: onChainIdChangeCallback): Promise<void>;
+  disconnect(): Promise<void>;
+  getCosmosWallet?(chainId: ChainId): CosmosWalletAbstraction;
+  getEip1193Provider?(): Promise<Eip1193Provider>;
+  getOfflineSigner?(chainId: string): Promise<OfflineSigner>;
+}
+//#endregion
+//#region src/types/provider.d.ts
+interface BrowserEip1993Provider extends EIP1193Provider {
+  removeAllListeners(): void;
+  isTrust: boolean;
+  isKeplr: boolean;
+  isRabby: boolean;
+  isRainbow: boolean;
+  isPhantom: boolean;
+  isMetaMask: boolean;
+  isOkxWallet: boolean;
+  isTrustWallet: boolean;
+}
+interface WindowWithEip1193Provider extends Window {
+  rainbow: BrowserEip1993Provider;
+  rabby: BrowserEip1993Provider;
+  ethereum: BrowserEip1993Provider;
+  okxwallet: BrowserEip1993Provider;
+  providers: BrowserEip1993Provider[];
+  trustWallet?: BrowserEip1993Provider;
+  bitkeep: {
+    ethereum: BrowserEip1993Provider;
+  };
+  phantom?: {
+    ethereum?: BrowserEip1993Provider;
+  };
+}
+interface EIP6963ProviderInfo {
+  rdns: string;
+  uuid: string;
+  name: string;
+  icon: string;
+}
+interface EIP6963ProviderDetail {
+  info: EIP6963ProviderInfo;
+  provider: BrowserEip1993Provider;
+}
+type EIP6963AnnounceProviderEvent = {
+  detail: EIP6963ProviderDetail;
+};
+//#endregion
+//#region src/utils/tx.d.ts
+declare const createEip712StdSignDoc: ({
+  memo,
+  chainId,
+  accountNumber,
+  timeoutHeight,
+  sequence,
+  gas,
+  msgs
+}: {
+  memo?: string;
+  chainId: ChainId;
+  timeoutHeight?: string;
+  accountNumber: number;
+  sequence: number;
+  gas?: string;
+  msgs: Msgs[];
+}) => {
+  chain_id: ChainId;
+  timeout_height: string;
+  account_number: string;
+  sequence: string;
+  fee: {
+    amount: {
+      denom: string;
+      amount: string;
+    }[];
+    gas: string;
+    payer: string | undefined;
+    granter: string | undefined;
+    feePayer: string | undefined;
+  };
+  msgs: {
+    type: string;
+    value: any;
+  }[];
+  memo: string;
+};
+//#endregion
+//#region src/utils/viem.d.ts
+declare const getEvmChainConfig: (chainId: EvmChainId | number) => Chain;
+declare const getViemPublicClient: (chainId: EvmChainId | number, rpcUrl?: string) => PublicClient;
+declare const getViemWalletClient: ({
+  chainId,
+  account,
+  rpcUrl
+}: {
+  chainId: EvmChainId | number;
+  account: Account | LocalAccount | `0x${string}`;
+  rpcUrl?: string;
+}) => WalletClient;
+declare const getViemPublicClientFromEip1193Provider: (chainId: EvmChainId | number, provider: BrowserEip1993Provider) => PublicClient;
+//#endregion
+//#region src/utils/wallet.d.ts
+declare const isEvmWallet: (wallet: Wallet) => boolean;
+declare const isCosmosWallet: (wallet: Wallet) => boolean;
+declare const isEvmBrowserWallet: (wallet: Wallet) => boolean;
+declare const isCosmosBrowserWallet: (wallet: Wallet) => boolean;
+declare const isEip712V2OnlyWallet: (wallet: Wallet) => boolean;
+declare const isCosmosAminoOnlyWallet: (wallet: Wallet) => boolean;
+//#endregion
+//#region src/utils/cosmos.d.ts
+declare const createCosmosSignDocFromSignDoc: (signDoc: CosmosTxV1Beta1TxPb.SignDoc) => any;
+//#endregion
+//#region src/utils/address.d.ts
+declare const getInjectiveSignerAddress: (address: string | undefined) => string;
+declare const getEthereumSignerAddress: (address: string | undefined) => string;
+//#endregion
+//#region src/utils/constants.d.ts
+declare const GWEI_IN_WEI: BigNumber;
+declare const TIP_IN_GWEI: BigNumber;
+declare const DEFAULT_BASE_DERIVATION_PATH = "m/44'/60'";
+declare const DEFAULT_NUM_ADDRESSES_TO_FETCH = 5;
+declare const DEFAULT_ADDRESS_SEARCH_LIMIT = 100;
+//#endregion
+//#region src/base.d.ts
+declare abstract class BaseConcreteStrategy {
+  protected chainId: ChainId | CosmosChainId;
+  protected evmChainId?: EvmChainId;
+  protected listeners: Partial<Record<WalletEventListener, any>>;
+  metadata?: WalletMetadata;
+  constructor(args: ConcreteWalletStrategyArgs | ConcreteEvmWalletStrategyArgs | ConcreteCosmosWalletStrategyArgs);
+}
+//#endregion
+export { BaseConcreteStrategy, BroadcastMode, BrowserEip1993Provider, ConcreteCosmosWalletStrategy, ConcreteCosmosWalletStrategyArgs, ConcreteEvmWalletStrategyArgs, ConcreteStrategiesArg, ConcreteWalletStrategy, ConcreteWalletStrategyArgs, CosmosWalletAbstraction, DEFAULT_ADDRESS_SEARCH_LIMIT, DEFAULT_BASE_DERIVATION_PATH, DEFAULT_NUM_ADDRESSES_TO_FETCH, EIP6963AnnounceProviderEvent, EIP6963ProviderDetail, EIP6963ProviderInfo, Eip1193Provider, GWEI_IN_WEI, MagicMetadata, MagicProvider, PrivateKeyMetadata, SendTransactionOptions, type StdSignDoc, TIP_IN_GWEI, TurnkeyMetadata, TurnkeyProvider, TurnkeySession, Wallet, WalletAction, WalletConnectMetadata, WalletDeviceType, WalletEventListener, WalletMetadata, WalletStrategy, WalletStrategyArguments, WalletStrategyEvmOptions, WindowWithEip1193Provider, createCosmosSignDocFromSignDoc, createEip712StdSignDoc, getEthereumSignerAddress, getEvmChainConfig, getInjectiveSignerAddress, getViemPublicClient, getViemPublicClientFromEip1193Provider, getViemWalletClient, isCosmosAminoOnlyWallet, isCosmosBrowserWallet, isCosmosWallet, isEip712V2OnlyWallet, isEvmBrowserWallet, isEvmWallet, onAccountChangeCallback, onChainIdChangeCallback };