@babylonlabs-io/wallet-connector 0.4.2 → 0.5.1

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.
@@ -134,12 +139,15 @@ interface IBTCProvider extends IProvider {
   getNetwork(): Promise<Network>;
 
   /**
-   * Signs a message using the specified signing method.
+   * Signs a message using either BIP322-Simple or ECDSA signing method.
    * @param message - The message to sign.
    * @param type - The signing method to use.
    * @returns A promise that resolves to the signed message.
    */
-  signMessage(message: string, type: "ecdsa"): Promise<string>;
+  signMessage(
+    message: string,
+    type: "bip322-simple" | "ecdsa",
+  ): Promise<string>;
 
   /**
    * Retrieves the inscriptions for the connected wallet.
@@ -180,25 +188,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.

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/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/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.
@@ -141,12 +135,12 @@ export interface IBTCProvider extends IProvider {
      */
     getNetwork(): Promise<Network>;
     /**
-     * Signs a message using the specified signing method.
+     * Signs a message using either BIP322-Simple or ECDSA signing method.
      * @param message - The message to sign.
      * @param type - The signing method to use.
      * @returns A promise that resolves to the signed message.
      */
-    signMessage(message: string, type: "ecdsa"): Promise<string>;
+    signMessage(message: string, type: "bip322-simple" | "ecdsa"): Promise<string>;
     /**
      * Retrieves the inscriptions for the connected wallet.
      * @returns A promise that resolves to an array of inscriptions.
@@ -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.
@@ -234,3 +212,9 @@ export interface IBBNProvider extends IProvider {
      */
     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/btc/okx/provider.d.ts

@@ -12,7 +12,7 @@ export declare class OKXProvider implements IBTCProvider {
     signPsbt: (psbtHex: string) => Promise<string>;
     signPsbts: (psbtsHexes: string[]) => Promise<string[]>;
     getNetwork: () => Promise<Network>;
-    signMessage: (message: string, type: "ecdsa") => Promise<string>;
+    signMessage: (message: string, type: "bip322-simple" | "ecdsa") => Promise<string>;
     getInscriptions: () => Promise<InscriptionIdentifier[]>;
     on: (eventName: string, callBack: () => void) => any;
     off: (eventName: string, callBack: () => void) => any;

package/dist/core/wallets/btc/onekey/provider.d.ts

@@ -11,7 +11,7 @@ export declare class OneKeyProvider implements IBTCProvider {
     signPsbt: (psbtHex: string) => Promise<string>;
     signPsbts: (psbtsHexes: string[]) => Promise<string[]>;
     getNetwork: () => Promise<Network>;
-    signMessage: (message: string, type: "ecdsa") => Promise<string>;
+    signMessage: (message: string, type: "bip322-simple" | "ecdsa") => Promise<string>;
     getInscriptions: () => Promise<InscriptionIdentifier[]>;
     on: (eventName: string, callBack: () => void) => any;
     off: (eventName: string, callBack: () => void) => any;

package/dist/core/wallets/btc/unisat/provider.d.ts

@@ -12,7 +12,7 @@ export declare class UnisatProvider implements IBTCProvider {
     signPsbts: (psbtsHexes: string[]) => Promise<string[]>;
     private getSignPsbtDefaultOptions;
     getNetwork: () => Promise<Network>;
-    signMessage: (message: string, type: "ecdsa") => Promise<string>;
+    signMessage: (message: string, type: "bip322-simple" | "ecdsa") => Promise<string>;
     getInscriptions: () => Promise<InscriptionIdentifier[]>;
     on: (eventName: string, callBack: () => void) => any;
     off: (eventName: string, callBack: () => void) => any;

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 {};