@sodax/wallet-sdk-react 1.3.1-beta-rc1 → 1.3.1-beta-rc2

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import { ChainId, ChainType, XToken, IEvmWalletProvider, ISuiWalletProvider, IIconWalletProvider, IInjectiveWalletProvider, IStellarWalletProvider, ISolanaWalletProvider, INearWalletProvider, RpcConfig } from '@sodax/types';
+import { ChainId, ChainType, XToken, IBitcoinWalletProvider, IEvmWalletProvider, ISuiWalletProvider, IIconWalletProvider, IInjectiveWalletProvider, IStellarWalletProvider, ISolanaWalletProvider, INearWalletProvider, RpcConfig } from '@sodax/types';
 import { Config, Connector } from 'wagmi';
 import { IconService } from 'icon-sdk-js';
 import { IndexerGrpcAccountPortfolioApi, ChainGrpcWasmApi } from '@injectivelabs/sdk-ts';
@@ -20,6 +20,7 @@ declare function getXChainType(xChainId: ChainId | undefined): ChainType | undef
 type XAccount = {
     address: string | undefined;
     xChainType: ChainType | undefined;
+    publicKey?: string;
 };
 type XConnection = {
     xAccount: XAccount;
@@ -127,6 +128,109 @@ declare function getXService(xChainType: ChainType): XService;
 declare const isNativeToken: (xToken: XToken) => boolean;
 declare const getWagmiChainId: (xChainId: ChainId) => number;
 
+declare class BitcoinXService extends XService {
+    private static instance;
+    private rpcUrl;
+    private constructor();
+    static getInstance(rpcUrl?: string): BitcoinXService;
+    getBalance(address: string | undefined, xToken: XToken): Promise<bigint>;
+}
+
+/**
+ * Abstract base class for Bitcoin wallet connectors.
+ * Subclasses implement wallet-specific connection logic (Unisat, Xverse, OKX).
+ */
+declare abstract class BitcoinXConnector extends XConnector {
+    constructor(name: string, id: string);
+    getXService(): BitcoinXService;
+    abstract connect(): Promise<XAccount | undefined>;
+    abstract disconnect(): Promise<void>;
+    /**
+     * Returns an IBitcoinWalletProvider instance after connecting.
+     * Used by useSpokeProvider to build BitcoinSpokeProvider.
+     */
+    abstract getWalletProvider(): IBitcoinWalletProvider | undefined;
+    /**
+     * Recreates a walletProvider from the browser extension window object
+     * and stored xAccount data (no connect() call, no popup).
+     * Used to restore provider after page reload without requiring reconnect.
+     */
+    abstract recreateWalletProvider(xAccount: XAccount): IBitcoinWalletProvider | undefined;
+}
+
+interface UnisatWallet {
+    getAccounts(): Promise<string[]>;
+    getPublicKey(): Promise<string>;
+    signPsbt(psbtHex: string, options?: {
+        autoFinalized?: boolean;
+    }): Promise<string>;
+    signMessage(message: string, type?: 'bip322-simple' | 'ecdsa'): Promise<string>;
+    requestAccounts(): Promise<string[]>;
+    sendBitcoin(address: string, satoshis: number): Promise<string>;
+}
+declare global {
+    interface Window {
+        unisat?: UnisatWallet;
+    }
+}
+declare class UnisatXConnector extends BitcoinXConnector {
+    private walletProvider;
+    constructor();
+    static isAvailable(): boolean;
+    get icon(): string;
+    connect(): Promise<XAccount | undefined>;
+    disconnect(): Promise<void>;
+    getWalletProvider(): IBitcoinWalletProvider | undefined;
+    recreateWalletProvider(xAccount: XAccount): IBitcoinWalletProvider | undefined;
+}
+
+declare class XverseXConnector extends BitcoinXConnector {
+    private walletProvider;
+    constructor();
+    static isAvailable(): boolean;
+    get icon(): string;
+    connect(): Promise<XAccount | undefined>;
+    disconnect(): Promise<void>;
+    getWalletProvider(): IBitcoinWalletProvider | undefined;
+    recreateWalletProvider(xAccount: XAccount): IBitcoinWalletProvider | undefined;
+}
+
+interface OKXBitcoinWallet {
+    getAccounts(): Promise<string[]>;
+    getPublicKey(): Promise<string>;
+    signPsbt(psbtHex: string, options?: {
+        autoFinalized?: boolean;
+    }): Promise<string>;
+    signMessage(message: string, type?: 'bip322-simple' | 'ecdsa'): Promise<string>;
+    connect(): Promise<{
+        address: string;
+        publicKey: string;
+    }>;
+    sendBitcoin(toAddress: string, satoshis: number): Promise<string>;
+}
+declare global {
+    interface Window {
+        okxwallet?: {
+            bitcoin?: OKXBitcoinWallet;
+        };
+    }
+}
+declare class OKXXConnector extends BitcoinXConnector {
+    private walletProvider;
+    constructor();
+    static isAvailable(): boolean;
+    get icon(): string;
+    connect(): Promise<XAccount | undefined>;
+    disconnect(): Promise<void>;
+    getWalletProvider(): IBitcoinWalletProvider | undefined;
+    recreateWalletProvider(xAccount: XAccount): IBitcoinWalletProvider | undefined;
+}
+
+/**
+ * Hook to return available Bitcoin wallet connectors from the globally registered xService.
+ */
+declare function useBitcoinXConnectors(): BitcoinXConnector[];
+
 /**
  * Service class for handling EVM chain interactions.
  * Implements singleton pattern and provides methods for wallet/chain operations.
@@ -271,7 +375,7 @@ declare class SuiXConnector extends XConnector {
 
 declare function useXAccount(chainIdentifier?: ChainType | ChainId): XAccount;
 
-declare function useXAccounts(): Partial<Record<"ICON" | "EVM" | "INJECTIVE" | "SUI" | "STELLAR" | "SOLANA" | "NEAR", XAccount>>;
+declare function useXAccounts(): Partial<Record<"ICON" | "EVM" | "INJECTIVE" | "SUI" | "STELLAR" | "SOLANA" | "NEAR" | "BITCOIN", XAccount>>;
 
 /**
  * Hook for connecting to various blockchain wallets across different chains
@@ -425,7 +529,7 @@ declare const useEvmSwitchChain: (expectedXChainId: ChainId) => UseEvmSwitchChai
  * const walletProvider = useWalletProvider('sui');
  * ```
  */
-declare function useWalletProvider(spokeChainId: ChainId | undefined): IEvmWalletProvider | ISuiWalletProvider | IIconWalletProvider | IInjectiveWalletProvider | IStellarWalletProvider | ISolanaWalletProvider | INearWalletProvider | undefined;
+declare function useWalletProvider(spokeChainId: ChainId | undefined): IEvmWalletProvider | ISuiWalletProvider | IIconWalletProvider | IInjectiveWalletProvider | IStellarWalletProvider | ISolanaWalletProvider | IBitcoinWalletProvider | INearWalletProvider | undefined;
 
 type SignMessageReturnType = `0x${string}` | Uint8Array | string | undefined;
 declare function useXSignMessage(): UseMutationResult<SignMessageReturnType, Error, {
@@ -464,4 +568,4 @@ declare const SodaxWalletProvider: ({ children, rpcConfig }: {
     rpcConfig: RpcConfig;
 }) => React.JSX.Element;
 
-export { type CurrencyKey, EvmXConnector, EvmXService, IconHanaXConnector, IconXService, InjectiveKelprXConnector, InjectiveMetamaskXConnector, InjectiveXService, SodaxWalletProvider, SolanaXConnector, SolanaXService, StellarWalletsKitXConnector, StellarXService, SuiXConnector, SuiXService, WalletId, type XAccount, type XConnection, XConnector, XService, getWagmiChainId, getXChainType, getXService, isNativeToken, switchEthereumChain, useEvmSwitchChain, useWalletProvider, useXAccount, useXAccounts, useXBalances, useXConnect, useXConnection, useXConnectors, useXDisconnect, useXService, useXSignMessage, useXWagmiStore };
+export { BitcoinXConnector, BitcoinXService, type CurrencyKey, EvmXConnector, EvmXService, IconHanaXConnector, IconXService, InjectiveKelprXConnector, InjectiveMetamaskXConnector, InjectiveXService, OKXXConnector, SodaxWalletProvider, SolanaXConnector, SolanaXService, StellarWalletsKitXConnector, StellarXService, SuiXConnector, SuiXService, UnisatXConnector, WalletId, type XAccount, type XConnection, XConnector, XService, XverseXConnector, getWagmiChainId, getXChainType, getXService, isNativeToken, switchEthereumChain, useBitcoinXConnectors, useEvmSwitchChain, useWalletProvider, useXAccount, useXAccounts, useXBalances, useXConnect, useXConnection, useXConnectors, useXDisconnect, useXService, useXSignMessage, useXWagmiStore };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { ChainId, ChainType, XToken, IEvmWalletProvider, ISuiWalletProvider, IIconWalletProvider, IInjectiveWalletProvider, IStellarWalletProvider, ISolanaWalletProvider, INearWalletProvider, RpcConfig } from '@sodax/types';
+import { ChainId, ChainType, XToken, IBitcoinWalletProvider, IEvmWalletProvider, ISuiWalletProvider, IIconWalletProvider, IInjectiveWalletProvider, IStellarWalletProvider, ISolanaWalletProvider, INearWalletProvider, RpcConfig } from '@sodax/types';
 import { Config, Connector } from 'wagmi';
 import { IconService } from 'icon-sdk-js';
 import { IndexerGrpcAccountPortfolioApi, ChainGrpcWasmApi } from '@injectivelabs/sdk-ts';
@@ -20,6 +20,7 @@ declare function getXChainType(xChainId: ChainId | undefined): ChainType | undef
 type XAccount = {
     address: string | undefined;
     xChainType: ChainType | undefined;
+    publicKey?: string;
 };
 type XConnection = {
     xAccount: XAccount;
@@ -127,6 +128,109 @@ declare function getXService(xChainType: ChainType): XService;
 declare const isNativeToken: (xToken: XToken) => boolean;
 declare const getWagmiChainId: (xChainId: ChainId) => number;
 
+declare class BitcoinXService extends XService {
+    private static instance;
+    private rpcUrl;
+    private constructor();
+    static getInstance(rpcUrl?: string): BitcoinXService;
+    getBalance(address: string | undefined, xToken: XToken): Promise<bigint>;
+}
+
+/**
+ * Abstract base class for Bitcoin wallet connectors.
+ * Subclasses implement wallet-specific connection logic (Unisat, Xverse, OKX).
+ */
+declare abstract class BitcoinXConnector extends XConnector {
+    constructor(name: string, id: string);
+    getXService(): BitcoinXService;
+    abstract connect(): Promise<XAccount | undefined>;
+    abstract disconnect(): Promise<void>;
+    /**
+     * Returns an IBitcoinWalletProvider instance after connecting.
+     * Used by useSpokeProvider to build BitcoinSpokeProvider.
+     */
+    abstract getWalletProvider(): IBitcoinWalletProvider | undefined;
+    /**
+     * Recreates a walletProvider from the browser extension window object
+     * and stored xAccount data (no connect() call, no popup).
+     * Used to restore provider after page reload without requiring reconnect.
+     */
+    abstract recreateWalletProvider(xAccount: XAccount): IBitcoinWalletProvider | undefined;
+}
+
+interface UnisatWallet {
+    getAccounts(): Promise<string[]>;
+    getPublicKey(): Promise<string>;
+    signPsbt(psbtHex: string, options?: {
+        autoFinalized?: boolean;
+    }): Promise<string>;
+    signMessage(message: string, type?: 'bip322-simple' | 'ecdsa'): Promise<string>;
+    requestAccounts(): Promise<string[]>;
+    sendBitcoin(address: string, satoshis: number): Promise<string>;
+}
+declare global {
+    interface Window {
+        unisat?: UnisatWallet;
+    }
+}
+declare class UnisatXConnector extends BitcoinXConnector {
+    private walletProvider;
+    constructor();
+    static isAvailable(): boolean;
+    get icon(): string;
+    connect(): Promise<XAccount | undefined>;
+    disconnect(): Promise<void>;
+    getWalletProvider(): IBitcoinWalletProvider | undefined;
+    recreateWalletProvider(xAccount: XAccount): IBitcoinWalletProvider | undefined;
+}
+
+declare class XverseXConnector extends BitcoinXConnector {
+    private walletProvider;
+    constructor();
+    static isAvailable(): boolean;
+    get icon(): string;
+    connect(): Promise<XAccount | undefined>;
+    disconnect(): Promise<void>;
+    getWalletProvider(): IBitcoinWalletProvider | undefined;
+    recreateWalletProvider(xAccount: XAccount): IBitcoinWalletProvider | undefined;
+}
+
+interface OKXBitcoinWallet {
+    getAccounts(): Promise<string[]>;
+    getPublicKey(): Promise<string>;
+    signPsbt(psbtHex: string, options?: {
+        autoFinalized?: boolean;
+    }): Promise<string>;
+    signMessage(message: string, type?: 'bip322-simple' | 'ecdsa'): Promise<string>;
+    connect(): Promise<{
+        address: string;
+        publicKey: string;
+    }>;
+    sendBitcoin(toAddress: string, satoshis: number): Promise<string>;
+}
+declare global {
+    interface Window {
+        okxwallet?: {
+            bitcoin?: OKXBitcoinWallet;
+        };
+    }
+}
+declare class OKXXConnector extends BitcoinXConnector {
+    private walletProvider;
+    constructor();
+    static isAvailable(): boolean;
+    get icon(): string;
+    connect(): Promise<XAccount | undefined>;
+    disconnect(): Promise<void>;
+    getWalletProvider(): IBitcoinWalletProvider | undefined;
+    recreateWalletProvider(xAccount: XAccount): IBitcoinWalletProvider | undefined;
+}
+
+/**
+ * Hook to return available Bitcoin wallet connectors from the globally registered xService.
+ */
+declare function useBitcoinXConnectors(): BitcoinXConnector[];
+
 /**
  * Service class for handling EVM chain interactions.
  * Implements singleton pattern and provides methods for wallet/chain operations.
@@ -271,7 +375,7 @@ declare class SuiXConnector extends XConnector {
 
 declare function useXAccount(chainIdentifier?: ChainType | ChainId): XAccount;
 
-declare function useXAccounts(): Partial<Record<"ICON" | "EVM" | "INJECTIVE" | "SUI" | "STELLAR" | "SOLANA" | "NEAR", XAccount>>;
+declare function useXAccounts(): Partial<Record<"ICON" | "EVM" | "INJECTIVE" | "SUI" | "STELLAR" | "SOLANA" | "NEAR" | "BITCOIN", XAccount>>;
 
 /**
  * Hook for connecting to various blockchain wallets across different chains
@@ -425,7 +529,7 @@ declare const useEvmSwitchChain: (expectedXChainId: ChainId) => UseEvmSwitchChai
  * const walletProvider = useWalletProvider('sui');
  * ```
  */
-declare function useWalletProvider(spokeChainId: ChainId | undefined): IEvmWalletProvider | ISuiWalletProvider | IIconWalletProvider | IInjectiveWalletProvider | IStellarWalletProvider | ISolanaWalletProvider | INearWalletProvider | undefined;
+declare function useWalletProvider(spokeChainId: ChainId | undefined): IEvmWalletProvider | ISuiWalletProvider | IIconWalletProvider | IInjectiveWalletProvider | IStellarWalletProvider | ISolanaWalletProvider | IBitcoinWalletProvider | INearWalletProvider | undefined;
 
 type SignMessageReturnType = `0x${string}` | Uint8Array | string | undefined;
 declare function useXSignMessage(): UseMutationResult<SignMessageReturnType, Error, {
@@ -464,4 +568,4 @@ declare const SodaxWalletProvider: ({ children, rpcConfig }: {
     rpcConfig: RpcConfig;
 }) => React.JSX.Element;
 
-export { type CurrencyKey, EvmXConnector, EvmXService, IconHanaXConnector, IconXService, InjectiveKelprXConnector, InjectiveMetamaskXConnector, InjectiveXService, SodaxWalletProvider, SolanaXConnector, SolanaXService, StellarWalletsKitXConnector, StellarXService, SuiXConnector, SuiXService, WalletId, type XAccount, type XConnection, XConnector, XService, getWagmiChainId, getXChainType, getXService, isNativeToken, switchEthereumChain, useEvmSwitchChain, useWalletProvider, useXAccount, useXAccounts, useXBalances, useXConnect, useXConnection, useXConnectors, useXDisconnect, useXService, useXSignMessage, useXWagmiStore };
+export { BitcoinXConnector, BitcoinXService, type CurrencyKey, EvmXConnector, EvmXService, IconHanaXConnector, IconXService, InjectiveKelprXConnector, InjectiveMetamaskXConnector, InjectiveXService, OKXXConnector, SodaxWalletProvider, SolanaXConnector, SolanaXService, StellarWalletsKitXConnector, StellarXService, SuiXConnector, SuiXService, UnisatXConnector, WalletId, type XAccount, type XConnection, XConnector, XService, XverseXConnector, getWagmiChainId, getXChainType, getXService, isNativeToken, switchEthereumChain, useBitcoinXConnectors, useEvmSwitchChain, useWalletProvider, useXAccount, useXAccounts, useXBalances, useXConnect, useXConnection, useXConnectors, useXDisconnect, useXService, useXSignMessage, useXWagmiStore };