@babylonlabs-io/wallet-connector 0.4.1 → 0.5.0

package/README.md

@@ -89,14 +89,13 @@ Full interface definitions can be found in
 Below we outline the interfaces for Bitcoin and Babylon wallets that need to be
 implemented for integration with the Babylon staking app.
 
-#### IBTCProvider
+### IProvider
 
 ```ts
-interface IBTCProvider extends IProvider {
+export interface IProvider {
   /**
    * Connects to the wallet and returns the instance of the wallet provider.
-   * Currently only supports "native segwit" and "taproot" address types.
-   * @returns A promise that resolves to an instance of the wrapper wallet provider in babylon friendly format.
+   * @returns A promise that resolves to an instance of the wrapper wallet provider.
    * @throws An error if the wallet is not installed or if connection fails.
    */
   connectWallet(): Promise<void>;
@@ -112,7 +111,13 @@ interface IBTCProvider extends IProvider {
    * @returns A promise that resolves to the public key of the connected wallet.
    */
   getPublicKeyHex(): Promise<string>;
+}
+```
+
+#### IBTCProvider
 
+```ts
+interface IBTCProvider extends IProvider {
   /**
    * Signs the given PSBT in hex format.
    * @param psbtHex - The hex string of the unsigned PSBT to sign.
@@ -180,25 +185,6 @@ interface IBTCProvider extends IProvider {
 
 ```ts
 export interface IBBNProvider extends IProvider {
-  /**
-   * Connects to the wallet and returns the instance of the wallet provider.
-   * @returns A promise that resolves to an instance of the wrapper wallet provider.
-   * @throws An error if the wallet is not installed or if connection fails.
-   */
-  connectWallet(): Promise<void>;
-
-  /**
-   * Gets the address of the connected wallet.
-   * @returns A promise that resolves to the address of the connected wallet.
-   */
-  getAddress(): Promise<string>;
-
-  /**
-   * Gets the public key of the connected wallet.
-   * @returns A promise that resolves to the public key of the connected wallet.
-   */
-  getPublicKeyHex(): Promise<string>;
-
   /**
    * Gets the name of the wallet provider.
    * @returns A promise that resolves to the name of the wallet provider.
@@ -219,6 +205,31 @@ export interface IBBNProvider extends IProvider {
    * @throws {Error} If wallet connection is not established or signer cannot be retrieved
    */
   getOfflineSigner(): Promise<OfflineAminoSigner & OfflineDirectSigner>;
+
+  /**
+   * Retrieves an offline signer that supports either Amino or Direct signing methods.
+   * This is required for compatibility with older wallets and hardware wallets (like Ledger) that do not support both signing methods.
+   * This signer is used for signing transactions offline before broadcasting them to the network.
+   *
+   * @returns {Promise<OfflineAminoSigner & OfflineDirectSigner>} A promise that resolves to a signer supporting either Amino or Direct signing
+   * @throws {Error} If wallet connection is not established or signer cannot be retrieved
+   */
+  getOfflineSignerAuto?(): Promise<OfflineAminoSigner | OfflineDirectSigner>;
+
+  /**
+   * Registers an event listener for the specified event.
+   * At the moment, only the "accountChanged" event is supported.
+   * @param eventName - The name of the event to listen for.
+   * @param callBack - The callback function to be executed when the event occurs.
+   */
+  on(eventName: string, callBack: () => void): void;
+
+  /**
+   * Unregisters an event listener for the specified event.
+   * @param eventName - The name of the event to listen for.
+   * @param callBack - The callback function to be executed when the event occurs.
+   */
+  off(eventName: string, callBack: () => void): void;
 }
 ```
 

package/dist/components/WalletProvider/components/WalletDialog.d.ts

@@ -1,6 +1,8 @@
+import { HashMap } from '../../../core/types';
 interface WalletDialogProps {
     onError?: (e: Error) => void;
+    storage: HashMap;
     config: any;
 }
-export declare function WalletDialog({ config, onError }: WalletDialogProps): import("react/jsx-runtime").JSX.Element;
+export declare function WalletDialog({ storage, config, onError }: WalletDialogProps): import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/components/WalletProvider/constants.d.ts

@@ -1,2 +1,3 @@
 import { ChainConfigArr } from '../../context/Chain.context';
+export declare const ONE_HOUR: number;
 export declare const config: ChainConfigArr;

package/dist/components/WalletProvider/index.d.ts

@@ -1,9 +1,11 @@
 import { PropsWithChildren } from 'react';
 import { ChainConfigArr } from '../../context/Chain.context';
+import { LifeCycleHooksProps } from '../../context/LifecycleHooks.context';
 interface WalletProviderProps {
+    lifecycleHooks?: LifeCycleHooksProps;
     context?: any;
     config: Readonly<ChainConfigArr>;
     onError?: (e: Error) => void;
 }
-export declare function WalletProvider({ children, config, context, onError, }: PropsWithChildren<WalletProviderProps>): import("react/jsx-runtime").JSX.Element;
+export declare function WalletProvider({ lifecycleHooks, children, config, context, onError, }: PropsWithChildren<WalletProviderProps>): import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/context/Chain.context.d.ts

@@ -1,6 +1,6 @@
 import { PropsWithChildren } from 'react';
 import { WalletConnector } from '../core/WalletConnector';
-import { BBNConfig, BTCConfig, ExternalConnector, IBBNProvider, IBTCProvider, IProvider } from '../core/types';
+import { BBNConfig, BTCConfig, ExternalConnector, HashMap, IBBNProvider, IBTCProvider, IProvider } from '../core/types';
 interface ChainConfig<K extends string = string, P extends IProvider = IProvider, C = any> {
     chain: K;
     name?: string;
@@ -10,6 +10,7 @@ interface ChainConfig<K extends string = string, P extends IProvider = IProvider
 }
 export type ChainConfigArr = (ChainConfig<"BTC", IBTCProvider, BTCConfig> | ChainConfig<"BBN", IBBNProvider, BBNConfig>)[];
 interface ProviderProps {
+    storage: HashMap;
     context: any;
     config: Readonly<ChainConfigArr>;
     onError?: (e: Error) => void;
@@ -19,6 +20,6 @@ export interface Connectors {
     BBN: WalletConnector<"BBN", IBBNProvider, BBNConfig> | null;
 }
 export declare const Context: import('react').Context<Connectors>;
-export declare function ChainProvider({ children, context, config, onError }: PropsWithChildren<ProviderProps>): import("react/jsx-runtime").JSX.Element;
+export declare function ChainProvider({ storage, children, context, config, onError }: PropsWithChildren<ProviderProps>): import("react/jsx-runtime").JSX.Element;
 export declare const useChainProviders: () => Connectors;
 export {};

package/dist/context/LifecycleHooks.context.d.ts

@@ -0,0 +1,9 @@
+import { PropsWithChildren } from 'react';
+export interface LifeCycleHooksProps {
+    verifyBTCAddress?: (address: string) => Promise<boolean>;
+    acceptTermsOfService?: () => Promise<void>;
+}
+export declare function LifeCycleHooksProvider({ children, value }: PropsWithChildren<{
+    value?: LifeCycleHooksProps;
+}>): import("react/jsx-runtime").JSX.Element;
+export declare const useLifeCycleHooks: () => LifeCycleHooksProps;

package/dist/core/index.d.ts

@@ -1,6 +1,6 @@
 import { Wallet } from './Wallet';
 import { WalletConnector } from './WalletConnector';
-import { ChainMetadata, ExternalWalletProps, IProvider, WalletMetadata } from './types';
-export declare const createWallet: <P extends IProvider, C>(metadata: WalletMetadata<P, C>, context: any, config: C) => Promise<Wallet<P>>;
+import { ExternalWalletProps, IProvider, WalletConnectorProps, WalletProps } from './types';
+export declare const createWallet: <P extends IProvider, C>({ metadata, context, config }: WalletProps<P, C>) => Promise<Wallet<P>>;
 export declare const createExternalWallet: <P extends IProvider>({ id, name, icon, provider }: ExternalWalletProps<P>) => Wallet<P>;
-export declare const createWalletConnector: <N extends string, P extends IProvider, C>(metadata: ChainMetadata<N, P, C>, context: any, config: C) => Promise<WalletConnector<N, P, C>>;
+export declare const createWalletConnector: <N extends string, P extends IProvider, C>({ metadata, context, config, accountStorage, }: WalletConnectorProps<N, P, C>) => Promise<WalletConnector<N, P, C>>;

package/dist/core/storage.d.ts

@@ -0,0 +1,7 @@
+import { HashMap } from './types';
+/**
+ * Factory method instantiates an instance of persistent key value storage with predefined ttl value
+ * @param ttl - time to live in ms
+ * @returns - key value storage
+ */
+export declare const createAccountStorage: (ttl: number) => HashMap;

package/dist/core/types.d.ts

@@ -95,6 +95,17 @@ export interface ExternalWalletProps<P extends IProvider> {
     icon: string;
     provider: P;
 }
+export interface WalletConnectorProps<N extends string, P extends IProvider, C> {
+    metadata: ChainMetadata<N, P, C>;
+    context: any;
+    config: C;
+    accountStorage: HashMap;
+}
+export interface WalletProps<P extends IProvider, C> {
+    metadata: WalletMetadata<P, C>;
+    context: any;
+    config: C;
+}
 export interface WidgetProps<P extends IProvider = IProvider> {
     id: string;
     connector: IConnector;
@@ -106,23 +117,6 @@ export interface ExternalConnector<P extends IProvider = IProvider> {
     widget: WidgetComponent<P>;
 }
 export interface IBTCProvider extends IProvider {
-    /**
-     * Connects to the wallet and returns the instance of the wallet provider.
-     * Currently only supports "native segwit" and "taproot" address types.
-     * @returns A promise that resolves to an instance of the wrapper wallet provider in babylon friendly format.
-     * @throws An error if the wallet is not installed or if connection fails.
-     */
-    connectWallet(): Promise<void>;
-    /**
-     * Gets the address of the connected wallet.
-     * @returns A promise that resolves to the address of the connected wallet.
-     */
-    getAddress(): Promise<string>;
-    /**
-     * Gets the public key of the connected wallet.
-     * @returns A promise that resolves to the public key of the connected wallet.
-     */
-    getPublicKeyHex(): Promise<string>;
     /**
      * Signs the given PSBT in hex format.
      * @param psbtHex - The hex string of the unsigned PSBT to sign.
@@ -177,22 +171,6 @@ export interface IBTCProvider extends IProvider {
     getWalletProviderIcon(): Promise<string>;
 }
 export interface IBBNProvider extends IProvider {
-    /**
-     * Connects to the wallet and returns the instance of the wallet provider.
-     * @returns A promise that resolves to an instance of the wrapper wallet provider.
-     * @throws An error if the wallet is not installed or if connection fails.
-     */
-    connectWallet(): Promise<void>;
-    /**
-     * Gets the address of the connected wallet.
-     * @returns A promise that resolves to the address of the connected wallet.
-     */
-    getAddress(): Promise<string>;
-    /**
-     * Gets the public key of the connected wallet.
-     * @returns A promise that resolves to the public key of the connected wallet.
-     */
-    getPublicKeyHex(): Promise<string>;
     /**
      * Gets the name of the wallet provider.
      * @returns A promise that resolves to the name of the wallet provider.
@@ -211,4 +189,32 @@ export interface IBBNProvider extends IProvider {
      * @throws {Error} If wallet connection is not established or signer cannot be retrieved
      */
     getOfflineSigner(): Promise<OfflineAminoSigner & OfflineDirectSigner>;
+    /**
+     * Retrieves an offline signer that supports either Amino or Direct signing methods.
+     * This is required for compatibility with older wallets and hardware wallets (like Ledger) that do not support both signing methods.
+     * This signer is used for signing transactions offline before broadcasting them to the network.
+     *
+     * @returns {Promise<OfflineAminoSigner & OfflineDirectSigner>} A promise that resolves to a signer supporting either Amino or Direct signing
+     * @throws {Error} If wallet connection is not established or signer cannot be retrieved
+     */
+    getOfflineSignerAuto?(): Promise<OfflineAminoSigner | OfflineDirectSigner>;
+    /**
+     * Registers an event listener for the specified event.
+     * At the moment, only the "accountChanged" event is supported.
+     * @param eventName - The name of the event to listen for.
+     * @param callBack - The callback function to be executed when the event occurs.
+     */
+    on(eventName: string, callBack: () => void): void;
+    /**
+     * Unregisters an event listener for the specified event.
+     * @param eventName - The name of the event to listen for.
+     * @param callBack - The callback function to be executed when the event occurs.
+     */
+    off(eventName: string, callBack: () => void): void;
+}
+export interface HashMap {
+    get: (key: string) => string | undefined;
+    set: (key: string, value: any) => void;
+    has: (key: string) => boolean;
+    delete: (key: string) => boolean;
 }

package/dist/core/wallets/bbn/keplr/provider.d.ts

@@ -19,4 +19,7 @@ export declare class KeplrProvider implements IBBNProvider {
     getWalletProviderName(): Promise<string>;
     getWalletProviderIcon(): Promise<string>;
     getOfflineSigner(): Promise<OfflineAminoSigner & OfflineDirectSigner>;
+    getOfflineSignerAuto(): Promise<OfflineAminoSigner | OfflineDirectSigner>;
+    on: (eventName: string, callBack: () => void) => void;
+    off: (eventName: string, callBack: () => void) => void;
 }

package/dist/core/wallets/bbn/leap/provider.d.ts

@@ -14,4 +14,7 @@ export declare class LeapProvider implements IBBNProvider {
     getWalletProviderName(): Promise<string>;
     getWalletProviderIcon(): Promise<string>;
     getOfflineSigner(): Promise<OfflineAminoSigner & OfflineDirectSigner>;
+    getOfflineSignerAuto(): Promise<OfflineAminoSigner | OfflineDirectSigner>;
+    on: (eventName: string, callBack: () => void) => void;
+    off: (eventName: string, callBack: () => void) => void;
 }

package/dist/core/wallets/bbn/okx/provider.d.ts

@@ -14,4 +14,7 @@ export declare class OKXBabylonProvider implements IBBNProvider {
     getWalletProviderName(): Promise<string>;
     getWalletProviderIcon(): Promise<string>;
     getOfflineSigner(): Promise<OfflineAminoSigner & OfflineDirectSigner>;
+    getOfflineSignerAuto(): Promise<OfflineAminoSigner | OfflineDirectSigner>;
+    on: (eventName: string, callBack: () => void) => void;
+    off: (eventName: string, callBack: () => void) => void;
 }

package/dist/hooks/useWalletConnectors.d.ts

@@ -1,5 +1,10 @@
-import { IChain, IWallet } from '../core/types';
-export declare function useWalletConnectors(onError?: (e: Error) => void): {
+import { HashMap, IChain, IWallet } from '../core/types';
+interface Props {
+    accountStorage: HashMap;
+    onError?: (e: Error) => void;
+}
+export declare function useWalletConnectors({ accountStorage, onError }: Props): {
     connect: (chain: IChain, wallet: IWallet) => Promise<void>;
     disconnect: (chainId: string) => Promise<void>;
 };
+export {};