@tomo-inc/inject-providers 0.0.13 → 0.0.14

package/src/dogecoin/interface.ts

@@ -0,0 +1,330 @@
+import { EventEmitter } from "events";
+
+/**
+ * State interface for DogecoinProvider
+ */
+export interface IDogecoinProviderState {
+  accounts: string[] | null;
+  isConnected: boolean;
+  isUnlocked: boolean;
+  initialized: boolean;
+  isPermanentlyDisconnected: boolean;
+}
+
+/**
+ * Balance response interface
+ */
+export interface IDogecoinBalance {
+  confirmed: number;
+  unconfirmed: number;
+  total: number;
+}
+
+/**
+ * Transaction status response interface
+ */
+export interface ITransactionStatus {
+  status: string;
+  confirmations: number;
+}
+
+/**
+ * Signed message response interface
+ */
+export interface ISignedMessage {
+  signedMessage: string;
+}
+
+/**
+ * Decrypted message response interface
+ */
+export interface IDecryptedMessage {
+  decryptedMessage: string;
+}
+
+/**
+ * PSBT request parameters interface
+ */
+export interface IRequestPsbtParams {
+  rawTx: string;
+  indexes?: [];
+  feeOnly?: boolean;
+  signOnly?: boolean;
+  partial?: boolean;
+  sighashType?: string;
+}
+
+/**
+ * PSBT response interface
+ */
+export interface IPsbtResponse {
+  signedRawTx?: string;
+  txId?: string;
+}
+
+/**
+ * Send options interface
+ */
+export interface ISendOptions {
+  feeRate?: number;
+  memo?: string;
+}
+
+/**
+ * Connection status response interface
+ */
+export interface IConnectionStatus {
+  connected: boolean;
+  address: string;
+  selectedWalletAddress: string;
+}
+
+/**
+ * DRC20 balance response interface
+ */
+export interface IDRC20Balance {
+  availableBalance: number;
+  transferableBalance: number;
+  ticker: string;
+  address: string;
+}
+
+/**
+ * Transferable DRC20 response interface
+ */
+export interface ITransferableDRC20 {
+  inscriptions: any[];
+  ticker: string;
+  address: string;
+}
+
+/**
+ * DRC20 transaction response interface
+ */
+export interface IDRC20Transaction {
+  txId: string;
+  ticker: string;
+  amount: number;
+}
+
+/**
+ * Dunes balance response interface
+ */
+export interface IDunesBalance {
+  balance: number;
+  ticker: string;
+}
+
+/**
+ * Main interface for DogecoinProvider
+ * Extends EventEmitter to support event handling
+ */
+export interface IDogecoinProvider extends EventEmitter {
+  type: "dogecoin";
+
+  rdns: string;
+  name: string;
+
+  // Connection methods
+  /**
+   * Connect to the wallet
+   * @returns Promise resolving to connection result with address, approved, balance, publicKey
+   */
+  connect(): Promise<any>;
+
+  /**
+   * Disconnect from the wallet
+   * @returns Promise resolving to disconnect result with disconnected status
+   */
+  disconnect(): Promise<any>;
+
+  /**
+   * Get connection status
+   * @returns Promise resolving to connection status with connected, address, selectedWalletAddress
+   */
+  getConnectionStatus(): Promise<IConnectionStatus>;
+
+  // Account methods
+  /**
+   * Request accounts from the wallet
+   * @returns Promise resolving to array of account addresses
+   */
+  requestAccounts(): Promise<string[]>;
+
+  /**
+   * Get current accounts
+   * @returns Promise resolving to array of account addresses
+   */
+  getAccounts(): Promise<string[]>;
+
+  /**
+   * Get public key
+   * @returns Promise resolving to public key string
+   */
+  getPublicKey(): Promise<string>;
+
+  // Balance methods
+  /**
+   * Get balance
+   * @returns Promise resolving to balance object with confirmed, unconfirmed, and total
+   */
+  getBalance(): Promise<IDogecoinBalance>;
+
+  // Transaction methods
+  /**
+   * Get transaction status
+   * @param params - Transaction status parameters
+   * @param params.txId - Transaction ID
+   * @returns Promise resolving to transaction status
+   */
+  getTransactionStatus(params: { txId: string }): Promise<ITransactionStatus>;
+
+  /**
+   * Request a transaction
+   * @param params - Transaction parameters
+   * @param params.recipientAddress - Recipient address
+   * @param params.dogeAmount - Amount in DOGE
+   * @returns Promise resolving to transaction result with txId
+   */
+  requestTransaction(params: { recipientAddress: string; dogeAmount: number }): Promise<{ txId: string }>;
+
+  /**
+   * Send DOGE
+   * @param toAddress - Recipient address
+   * @param satoshis - Amount in satoshis (optional)
+   * @param options - Send options (optional)
+   * @returns Promise resolving to transaction ID
+   */
+  send(toAddress: string, satoshis?: number, options?: ISendOptions): Promise<string>;
+
+  /**
+   * Send DOGE (alias for send)
+   * @param toAddress - Recipient address
+   * @param satoshis - Amount in satoshis (optional)
+   * @param options - Send options (optional)
+   * @returns Promise resolving to transaction ID
+   */
+  sendDogecoin(toAddress: string, satoshis?: number, options?: ISendOptions): Promise<string>;
+
+  // Message signing methods
+  /**
+   * Request signed message
+   * @param params - Sign message parameters
+   * @param params.message - Message to sign
+   * @param params.type - Message type (optional)
+   * @returns Promise resolving to signed message result
+   */
+  requestSignedMessage(params: { message: string; type?: string }): Promise<ISignedMessage>;
+
+  /**
+   * Sign message
+   * @param message - Message to sign
+   * @param type - Message type (optional)
+   * @returns Promise resolving to signed message string
+   */
+  signMessage(message: string, type?: string): Promise<string>;
+
+  /**
+   * Request decrypted message
+   * @param params - Decrypt message parameters
+   * @param params.message - Message to decrypt
+   * @returns Promise resolving to decrypted message result
+   */
+  requestDecryptedMessage(params: { message: string }): Promise<IDecryptedMessage>;
+
+  // PSBT methods
+  /**
+   * Request PSBT
+   * @param params - PSBT request parameters
+   * @returns Promise resolving to PSBT result with signedRawTx and/or txId
+   */
+  requestPsbt(params: IRequestPsbtParams): Promise<IPsbtResponse>;
+
+  /**
+   * Sign PSBT
+   * @param psbtHex - PSBT hex string
+   * @param options - Sign options (optional)
+   * @returns Promise resolving to signed PSBT hex string
+   */
+  signPsbt(psbtHex: string, options?: any): Promise<string>;
+
+  /**
+   * Sign multiple PSBTs
+   * @param psbtHexs - Array of PSBT hex strings
+   * @param options - Sign options (optional)
+   * @returns Promise resolving to signed PSBTs
+   */
+  signPsbts(psbtHexs: string[], options?: any): Promise<any>;
+
+  // DRC20 methods
+  /**
+   * Get DRC20 balances
+   * @param address - Address to query
+   * @param ticker - Token ticker (optional)
+   * @returns Promise resolving to DRC20 balances
+   */
+  getDRC20Balances(address: string, ticker?: string): Promise<any>;
+
+  /**
+   * Get DRC20 balance
+   * @param params - Balance query parameters
+   * @param params.ticker - Token ticker (optional)
+   * @returns Promise resolving to DRC20 balance
+   */
+  getDRC20Balance(params: { ticker?: string }): Promise<IDRC20Balance>;
+
+  /**
+   * Get transferable DRC20
+   * @param params - Transferable query parameters
+   * @param params.ticker - Token ticker (optional)
+   * @returns Promise resolving to transferable DRC20
+   */
+  getTransferableDRC20(params: { ticker?: string }): Promise<ITransferableDRC20>;
+
+  /**
+   * Request available DRC20 transaction
+   * @param params - Transaction parameters
+   * @param params.ticker - Token ticker
+   * @param params.amount - Amount to transfer
+   * @returns Promise resolving to DRC20 transaction result
+   */
+  requestAvailableDRC20Transaction(params: { ticker: string; amount: number }): Promise<IDRC20Transaction>;
+
+  /**
+   * Request inscription transaction
+   * @param params - Inscription transaction parameters
+   * @param params.location - Inscription location
+   * @param params.recipientAddress - Recipient address
+   * @returns Promise resolving to transaction result with txId
+   */
+  requestInscriptionTransaction(params: { location: string; recipientAddress: string }): Promise<{ txId: string }>;
+
+  // Dunes methods
+  /**
+   * Get Dunes balance
+   * @param params - Balance query parameters
+   * @param params.ticker - Token ticker
+   * @returns Promise resolving to Dunes balance
+   */
+  getDunesBalance(params: { ticker: string }): Promise<IDunesBalance>;
+
+  /**
+   * Request Dunes transaction
+   * @param params - Transaction parameters
+   * @param params.ticker - Token ticker
+   * @param params.amount - Amount to transfer
+   * @param params.recipientAddress - Recipient address
+   * @returns Promise resolving to transaction result
+   */
+  requestDunesTransaction(params: { ticker: string; amount: number; recipientAddress: string }): Promise<any>;
+
+  // Generic request method
+  /**
+   * Generic request method
+   * @param params - Request parameters
+   * @param params.method - RPC method name
+   * @param params.params - Method parameters
+   * @returns Promise resolving to request result
+   */
+  request(params: { method: string; params: any }): Promise<any>;
+}

package/src/evm/interface.ts

@@ -0,0 +1,189 @@
+import { EventEmitter } from "events";
+import { JsonRpcRequest, JsonRpcResponse } from "json-rpc-engine";
+import { Maybe } from "./utils";
+import { RequestArguments, SendSyncJsonRpcRequest } from "./type";
+
+/**
+ * Connect event data interface
+ */
+export interface IConnectEvent {
+  chainId?: string;
+}
+
+/**
+ * Disconnect event data interface
+ */
+export interface IDisconnectEvent {
+  code: number;
+  message: string;
+  data?: unknown;
+}
+
+/**
+ * Provider message interface
+ */
+export interface IProviderMessage {
+  type: string;
+  data: unknown;
+}
+
+/**
+ * Main interface for EvmProvider
+ * Extends EventEmitter to support event handling
+ * Implements EIP-1193 standard
+ */
+export interface IEvmProvider extends EventEmitter {
+  type: "evm";
+
+  // Public properties
+  /**
+   * The chain ID of the currently connected Ethereum chain.
+   * See https://chainid.network for more information.
+   */
+  chainId: string | null;
+
+  /**
+   * The user's currently selected Ethereum address.
+   * If null, wallet is either locked or the user has not permitted any
+   * addresses to be viewed.
+   */
+  selectedAddress: string | null;
+
+  /**
+   * Provider name
+   */
+  name: string;
+
+  /**
+   * Provider icon
+   */
+  icon: string;
+
+  // Connection methods
+  /**
+   * Returns whether the provider can process RPC requests.
+   * @returns true if connected, false otherwise
+   */
+  isConnected(): boolean;
+
+  /**
+   * Submits an RPC request for the given method, with the given params.
+   * Resolves with the result of the method call, or rejects on error.
+   *
+   * @param args - The RPC request arguments.
+   * @param args.method - The RPC method name.
+   * @param args.params - The parameters for the RPC method.
+   * @returns A Promise that resolves with the result of the RPC method,
+   * or rejects if an error is encountered.
+   */
+  request<T = unknown>(args: RequestArguments): Promise<Maybe<T>>;
+
+  /**
+   * Connect to the wallet
+   * Equivalent to: ethereum.request('eth_requestAccounts')
+   * @returns Promise resolving to array of account addresses
+   */
+  connect(): Promise<string[]>;
+
+  /**
+   * Disconnect from the wallet
+   * @returns Promise resolving to boolean indicating disconnect status
+   */
+  disconnect(): Promise<boolean>;
+
+  /**
+   * Equivalent to: ethereum.request('eth_requestAccounts')
+   * @deprecated Use request({ method: 'eth_requestAccounts' }) instead.
+   * @returns Promise resolving to array of addresses
+   */
+  enable(): Promise<string[]>;
+
+  // Legacy send methods (deprecated)
+  /**
+   * Submits an RPC request for the given method, with the given params.
+   * @deprecated Use request() instead.
+   * @param method - The method to request.
+   * @param params - Any params for the method.
+   * @returns A Promise that resolves with the JSON-RPC response object for the request.
+   */
+  send<T>(method: string, params?: T[]): Promise<JsonRpcResponse<T>>;
+
+  /**
+   * Submits an RPC request per the given JSON-RPC request object.
+   * @deprecated Use request() instead.
+   * @param payload - A JSON-RPC request object.
+   * @param callback - An error-first callback that will receive the JSON-RPC response object.
+   */
+  send<T>(payload: JsonRpcRequest<unknown>, callback: (error: Error | null, result?: JsonRpcResponse<T>) => void): void;
+
+  /**
+   * Accepts a JSON-RPC request object, and synchronously returns the cached result
+   * for the given method. Only supports 4 specific RPC methods.
+   * @deprecated Use request() instead.
+   * @param payload - A JSON-RPC request object.
+   * @returns A JSON-RPC response object.
+   */
+  send<T>(payload: SendSyncJsonRpcRequest): JsonRpcResponse<T>;
+
+  /**
+   * Adds a listener for the specified event.
+   * @param eventName - Event name
+   * @param listener - Event listener function
+   * @returns This instance for chaining
+   */
+  on(eventName: string, listener: (...args: unknown[]) => void): this;
+
+  /**
+   * Adds a one-time listener for the specified event.
+   * @param eventName - Event name
+   * @param listener - Event listener function
+   * @returns This instance for chaining
+   */
+  once(eventName: string, listener: (...args: unknown[]) => void): this;
+
+  // Event types
+  /**
+   * Emitted when the provider connects to a chain.
+   * @event
+   */
+  on(event: "connect", listener: (connectInfo: IConnectEvent) => void): this;
+
+  /**
+   * Emitted when the provider disconnects from a chain.
+   * @event
+   */
+  on(event: "disconnect", listener: (error: IDisconnectEvent) => void): this;
+
+  /**
+   * Emitted when the chain ID changes.
+   * @event
+   */
+  on(event: "chainChanged", listener: (chainId: string) => void): this;
+
+  /**
+   * Emitted when accounts change.
+   * @event
+   */
+  on(event: "accountsChanged", listener: (accounts: string[]) => void): this;
+
+  /**
+   * Emitted when the connection closes (deprecated).
+   * @event
+   * @deprecated
+   */
+  on(event: "close", listener: (error: IDisconnectEvent) => void): this;
+
+  /**
+   * Emitted when data is received (deprecated).
+   * @event
+   * @deprecated
+   */
+  on(event: "data", listener: (payload: unknown) => void): this;
+
+  /**
+   * Emitted when the network changes (deprecated).
+   * @event
+   * @deprecated
+   */
+  on(event: "networkChanged", listener: (networkId: string) => void): this;
+}

package/src/index.ts

@@ -5,3 +5,7 @@ import { SolanaProvider } from "./solana";
 import { TronProvider } from "./tron";
 
 export { BtcProvider, DogecoinProvider, EvmProvider, SolanaProvider, TronProvider };
+
+import { IDogecoinProvider } from "./dogecoin/interface";
+import { IEvmProvider } from "./evm/interface";
+export type WalletProvider = IDogecoinProvider | IEvmProvider;