@txnlab/use-wallet 3.10.0 → 4.0.0-beta.2

package/dist/index.d.cts

@@ -37,32 +37,38 @@ declare class Logger {
 }
 declare const logger: Logger;
 
-declare enum NetworkId {
-    MAINNET = "mainnet",
-    TESTNET = "testnet",
-    BETANET = "betanet",
-    FNET = "fnet",
-    LOCALNET = "localnet",
-    VOIMAIN = "voimain",
-    ARAMIDMAIN = "aramidmain"
-}
 interface AlgodConfig {
     token: string | algosdk.AlgodTokenHeader | algosdk.CustomTokenHeader | algosdk.BaseHTTPClient;
     baseServer: string;
     port?: string | number;
     headers?: Record<string, string>;
 }
-type NetworkConfigMap = Record<NetworkId, AlgodConfig>;
-type NetworkConfig = Partial<AlgodConfig> | Partial<Record<NetworkId, Partial<AlgodConfig>>>;
+interface NetworkConfig {
+    name: string;
+    algod: AlgodConfig;
+    genesisHash?: string;
+    genesisId?: string;
+    isTestnet?: boolean;
+    caipChainId?: string;
+}
+declare const DEFAULT_NETWORKS: Record<string, NetworkConfig>;
+declare enum NetworkId {
+    MAINNET = "mainnet",
+    TESTNET = "testnet",
+    BETANET = "betanet",
+    FNET = "fnet",
+    LOCALNET = "localnet"
+}
 
 declare abstract class BaseWallet {
     readonly id: WalletId;
     readonly metadata: WalletMetadata;
+    protected readonly networks: Record<string, NetworkConfig>;
     protected store: Store<State>;
     protected getAlgodClient: () => algosdk.Algodv2;
     subscribe: (callback: (state: State) => void) => () => void;
     protected logger: ReturnType<typeof logger.createScopedLogger>;
-    protected constructor({ id, metadata, store, subscribe, getAlgodClient }: WalletConstructor<WalletId>);
+    protected constructor({ id, metadata, store, subscribe, getAlgodClient, networks }: WalletConstructor<WalletId>);
     static defaultMetadata: WalletMetadata;
     abstract connect(args?: Record<string, any>): Promise<WalletAccount[]>;
     abstract disconnect(): Promise<void>;
@@ -76,9 +82,11 @@ declare abstract class BaseWallet {
     get addresses(): string[];
     get activeAccount(): WalletAccount | null;
     get activeAddress(): string | null;
-    get activeNetwork(): NetworkId;
+    get activeNetwork(): string;
     get isConnected(): boolean;
     get isActive(): boolean;
+    get networkConfig(): Record<string, NetworkConfig>;
+    protected get activeNetworkConfig(): NetworkConfig;
     protected onDisconnect: () => void;
     protected manageWalletConnectSession: (action: "backup" | "restore", targetWalletId?: WalletId) => void;
 }
@@ -96,7 +104,7 @@ interface CustomWalletOptions {
 declare class CustomWallet extends BaseWallet {
     private provider;
     protected store: Store<State>;
-    constructor({ id, store, subscribe, getAlgodClient, options, metadata }: WalletConstructor<WalletId.CUSTOM>);
+    constructor({ id, store, subscribe, getAlgodClient, networks, options, metadata }: WalletConstructor<WalletId.CUSTOM>);
     static defaultMetadata: {
         name: string;
         icon: string;
@@ -117,7 +125,7 @@ declare class DeflyWallet extends BaseWallet {
     private client;
     private options;
     protected store: Store<State>;
-    constructor({ id, store, subscribe, getAlgodClient, options, metadata }: WalletConstructor<WalletId.DEFLY>);
+    constructor({ id, store, subscribe, getAlgodClient, options, metadata, networks }: WalletConstructor<WalletId.DEFLY>);
     static defaultMetadata: {
         name: string;
         icon: string;
@@ -132,6 +140,80 @@ declare class DeflyWallet extends BaseWallet {
     signTransactions: <T extends algosdk.Transaction[] | Uint8Array[]>(txnGroup: T | T[], indexesToSign?: number[]) => Promise<(Uint8Array | null)[]>;
 }
 
+declare abstract class AVMProvider extends BaseWallet {
+    avmWebClient: AVMWebProviderSDK.AVMWebClient | null;
+    protected avmWebProviderSDK: typeof AVMWebProviderSDK | null;
+    protected providerId: string;
+    constructor(args: WalletConstructor<WalletId> & {
+        providerId: string;
+    });
+    protected _initializeAVMWebProviderSDK(): Promise<typeof AVMWebProviderSDK>;
+    protected _initializeAVMWebClient(): Promise<AVMWebProviderSDK.AVMWebClient>;
+    protected _getGenesisHash(): Promise<string>;
+    protected _mapAVMWebProviderAccountToWalletAccounts(accounts: AVMWebProviderSDK.IAccount[]): WalletAccount[];
+    protected processTxns(txnGroup: algosdk.Transaction[], indexesToSign?: number[]): AVMWebProviderSDK.IARC0001Transaction[];
+    protected processEncodedTxns(txnGroup: Uint8Array[], indexesToSign?: number[]): AVMWebProviderSDK.IARC0001Transaction[];
+    /**
+     * Abstract methods
+     * These methods must be implemented by specific wallet providers
+     */
+    protected abstract _enable(): Promise<AVMWebProviderSDK.IEnableResult>;
+    protected abstract _disable(): Promise<AVMWebProviderSDK.IDisableResult>;
+    protected abstract _signTransactions(txns: AVMWebProviderSDK.IARC0001Transaction[]): Promise<AVMWebProviderSDK.ISignTransactionsResult>;
+    /**
+     * Common methods
+     * These methods can be overridden by specific wallet providers if needed
+     */
+    connect(): Promise<WalletAccount[]>;
+    disconnect(): Promise<void>;
+    resumeSession(): Promise<void>;
+    signTransactions<T extends algosdk.Transaction[] | Uint8Array[]>(txnGroup: T | T[], indexesToSign?: number[]): Promise<(Uint8Array | null)[]>;
+}
+
+declare class DeflyWebWallet extends AVMProvider {
+    constructor({ id, store, subscribe, getAlgodClient, metadata, networks }: WalletConstructor<WalletId.DEFLY_WEB>);
+    static defaultMetadata: {
+        name: string;
+        icon: string;
+    };
+    /**
+     * Calls the "enable" method on the provider. This method will timeout after 3 minutes.
+     * @returns {Promise<AVMWebProviderSDK.IEnableResult>} a promise that resolves to the result.
+     * @protected
+     * @throws {MethodCanceledError} if the method was cancelled by the user.
+     * @throws {MethodNotSupportedError} if the method is not supported for the configured network.
+     * @throws {MethodTimedOutError} if the method timed out by lack of response (>= 3 minutes).
+     * @throws {NetworkNotSupportedError} if the network is not supported for the configured network.
+     * @throws {UnknownError} if the response result is empty.
+     */
+    protected _enable(): Promise<AVMWebProviderSDK.IEnableResult>;
+    /**
+     * Calls the "disable" method on the provider. This method will timeout after 0.75 seconds.
+     * @returns {Promise<AVMWebProviderSDK.IDisableResult>} a promise that resolves to the result.
+     * @protected
+     * @throws {MethodNotSupportedError} if the method is not supported for the configured network.
+     * @throws {MethodTimedOutError} if the method timed out by lack of response (>= 3 minutes).
+     * @throws {NetworkNotSupportedError} if the network is not supported for the configured network.
+     * @throws {UnknownError} if the response result is empty.
+     */
+    protected _disable(): Promise<AVMWebProviderSDK.IDisableResult>;
+    /**
+     * Calls the "signTransactions" method to sign the supplied ARC-0001 transactions. This method will timeout after 3
+     * minutes.
+     * @returns {Promise<AVMWebProviderSDK.ISignTransactionsResult>} a promise that resolves to the result.
+     * @protected
+     * @throws {InvalidInputError} if computed group ID for the txns does not match the assigned group ID.
+     * @throws {InvalidGroupIdError} if the unsigned txns is malformed or not conforming to ARC-0001.
+     * @throws {MethodCanceledError} if the method was cancelled by the user.
+     * @throws {MethodNotSupportedError} if the method is not supported for the configured network.
+     * @throws {MethodTimedOutError} if the method timed out by lack of response (>= 3 minutes).
+     * @throws {NetworkNotSupportedError} if the network is not supported for the configured network.
+     * @throws {UnauthorizedSignerError} if a signer in the request is not authorized by the provider.
+     * @throws {UnknownError} if the response result is empty.
+     */
+    protected _signTransactions(txns: AVMWebProviderSDK.IARC0001Transaction[]): Promise<AVMWebProviderSDK.ISignTransactionsResult>;
+}
+
 /** @see https://docs.exodus.com/api-reference/algorand-provider-arc-api/ */
 interface EnableNetworkOpts {
     genesisID?: string;
@@ -163,7 +245,7 @@ declare class ExodusWallet extends BaseWallet {
     private client;
     private options;
     protected store: Store<State>;
-    constructor({ id, store, subscribe, getAlgodClient, options, metadata }: WalletConstructor<WalletId.EXODUS>);
+    constructor({ id, store, subscribe, getAlgodClient, options, metadata, networks }: WalletConstructor<WalletId.EXODUS>);
     static defaultMetadata: {
         name: string;
         icon: string;
@@ -177,51 +259,40 @@ declare class ExodusWallet extends BaseWallet {
     signTransactions: <T extends algosdk.Transaction[] | Uint8Array[]>(txnGroup: T | T[], indexesToSign?: number[]) => Promise<(Uint8Array | null)[]>;
 }
 
-declare function isAVMWebProviderSDKError(error: any): error is AVMWebProviderSDK.BaseARC0027Error;
 declare const KIBISIS_AVM_WEB_PROVIDER_ID = "f6d1c86b-4493-42fb-b88d-a62407b4cdf6";
 declare const ICON: string;
-declare class KibisisWallet extends BaseWallet {
-    avmWebClient: AVMWebProviderSDK.AVMWebClient | null;
-    protected avmWebProviderSDK: typeof AVMWebProviderSDK | null;
-    protected store: Store<State>;
-    constructor({ id, store, subscribe, getAlgodClient, metadata }: WalletConstructor<WalletId.KIBISIS>);
+declare class KibisisWallet extends AVMProvider {
+    constructor({ id, store, subscribe, getAlgodClient, metadata, networks }: WalletConstructor<WalletId.KIBISIS>);
     static defaultMetadata: {
         name: string;
         icon: string;
     };
     /**
-     * private functions
-     */
-    /**
-     * Calls the "disable" method on the provider. This method will timeout after 0.75 seconds.
-     * @returns {Promise<AVMWebProviderSDK.IDisableResult>} a promise that resolves to the result.
-     * @private
+     * Calls the "enable" method on the provider. This method will timeout after 3 minutes.
+     * @returns {Promise<AVMWebProviderSDK.IEnableResult>} a promise that resolves to the result.
+     * @protected
+     * @throws {MethodCanceledError} if the method was cancelled by the user.
      * @throws {MethodNotSupportedError} if the method is not supported for the configured network.
      * @throws {MethodTimedOutError} if the method timed out by lack of response (>= 3 minutes).
      * @throws {NetworkNotSupportedError} if the network is not supported for the configured network.
      * @throws {UnknownError} if the response result is empty.
      */
-    private _disable;
+    protected _enable(): Promise<AVMWebProviderSDK.IEnableResult>;
     /**
-     * Calls the "enable" method on the provider. This method will timeout after 3 minutes.
-     * @returns {Promise<AVMWebProviderSDK.IEnableResult>} a promise that resolves to the result.
-     * @private
-     * @throws {MethodCanceledError} if the method was cancelled by the user.
+     * Calls the "disable" method on the provider. This method will timeout after 0.75 seconds.
+     * @returns {Promise<AVMWebProviderSDK.IDisableResult>} a promise that resolves to the result.
+     * @protected
      * @throws {MethodNotSupportedError} if the method is not supported for the configured network.
      * @throws {MethodTimedOutError} if the method timed out by lack of response (>= 3 minutes).
      * @throws {NetworkNotSupportedError} if the network is not supported for the configured network.
      * @throws {UnknownError} if the response result is empty.
      */
-    private _enable;
-    private _getGenesisHash;
-    private _initializeAVMWebClient;
-    private _initializeAVMWebProviderSDK;
-    private _mapAVMWebProviderAccountToWalletAccounts;
+    protected _disable(): Promise<AVMWebProviderSDK.IDisableResult>;
     /**
      * Calls the "signTransactions" method to sign the supplied ARC-0001 transactions. This method will timeout after 3
      * minutes.
      * @returns {Promise<AVMWebProviderSDK.ISignTransactionsResult>} a promise that resolves to the result.
-     * @private
+     * @protected
      * @throws {InvalidInputError} if computed group ID for the txns does not match the assigned group ID.
      * @throws {InvalidGroupIdError} if the unsigned txns is malformed or not conforming to ARC-0001.
      * @throws {MethodCanceledError} if the method was cancelled by the user.
@@ -231,16 +302,7 @@ declare class KibisisWallet extends BaseWallet {
      * @throws {UnauthorizedSignerError} if a signer in the request is not authorized by the provider.
      * @throws {UnknownError} if the response result is empty.
      */
-    private _signTransactions;
-    /**
-     * public functions
-     */
-    connect(): Promise<WalletAccount[]>;
-    disconnect(): Promise<void>;
-    resumeSession(): Promise<void>;
-    private processTxns;
-    private processEncodedTxns;
-    signTransactions: <T extends algosdk.Transaction[] | Uint8Array[]>(txnGroup: T | T[], indexesToSign?: number[]) => Promise<(Uint8Array | null)[]>;
+    protected _signTransactions(txns: AVMWebProviderSDK.IARC0001Transaction[]): Promise<AVMWebProviderSDK.ISignTransactionsResult>;
 }
 
 interface KmdConstructor {
@@ -259,7 +321,7 @@ declare class KmdWallet extends BaseWallet {
     private walletId;
     private password;
     protected store: Store<State>;
-    constructor({ id, store, subscribe, getAlgodClient, options, metadata }: WalletConstructor<WalletId.KMD>);
+    constructor({ id, store, subscribe, getAlgodClient, networks, options, metadata }: WalletConstructor<WalletId.KMD>);
     static defaultMetadata: {
         name: string;
         icon: string;
@@ -282,7 +344,7 @@ declare class LiquidWallet extends BaseWallet {
     protected store: Store<State>;
     authClient: LiquidAuthClient | undefined | null;
     private options;
-    constructor({ id, store, subscribe, getAlgodClient, options, metadata }: WalletConstructor<WalletId.LIQUID>);
+    constructor({ id, store, subscribe, getAlgodClient, options, metadata, networks }: WalletConstructor<WalletId.LIQUID>);
     static defaultMetadata: {
         name: string;
         icon: string;
@@ -301,7 +363,7 @@ declare class LuteWallet extends BaseWallet {
     private client;
     private options;
     protected store: Store<State>;
-    constructor({ id, store, subscribe, getAlgodClient, options, metadata }: WalletConstructor<WalletId.LUTE>);
+    constructor({ id, store, subscribe, getAlgodClient, options, metadata, networks }: WalletConstructor<WalletId.LUTE>);
     static defaultMetadata: {
         name: string;
         icon: string;
@@ -328,7 +390,7 @@ declare class MagicAuth extends BaseWallet {
     private options;
     protected store: Store<State>;
     userInfo: MagicUserMetadata | null;
-    constructor({ id, store, subscribe, getAlgodClient, options, metadata }: WalletConstructor<WalletId.MAGIC>);
+    constructor({ id, store, subscribe, getAlgodClient, options, metadata, networks }: WalletConstructor<WalletId.MAGIC>);
     static defaultMetadata: {
         name: string;
         icon: string;
@@ -350,7 +412,7 @@ declare class MnemonicWallet extends BaseWallet {
     private account;
     private options;
     protected store: Store<State>;
-    constructor({ id, store, subscribe, getAlgodClient, options, metadata }: WalletConstructor<WalletId.MNEMONIC>);
+    constructor({ id, store, subscribe, getAlgodClient, options, metadata, networks }: WalletConstructor<WalletId.MNEMONIC>);
     static defaultMetadata: {
         name: string;
         icon: string;
@@ -378,7 +440,7 @@ declare class PeraWallet$1 extends BaseWallet {
     private client;
     private options;
     protected store: Store<State>;
-    constructor({ id, store, subscribe, getAlgodClient, options, metadata }: WalletConstructor<WalletId.PERA>);
+    constructor({ id, store, subscribe, getAlgodClient, options, metadata, networks }: WalletConstructor<WalletId.PERA>);
     static defaultMetadata: {
         name: string;
         icon: string;
@@ -404,7 +466,7 @@ declare class PeraWallet extends BaseWallet {
     private client;
     private options;
     protected store: Store<State>;
-    constructor({ id, store, subscribe, getAlgodClient, options, metadata }: WalletConstructor<WalletId.PERA2>);
+    constructor({ id, store, subscribe, getAlgodClient, options, metadata, networks }: WalletConstructor<WalletId.PERA2>);
     static defaultMetadata: {
         name: string;
         icon: string;
@@ -436,7 +498,7 @@ declare class WalletConnect extends BaseWallet {
     private modalOptions;
     private session;
     protected store: Store<State>;
-    constructor({ id, store, subscribe, getAlgodClient, options, metadata }: WalletConstructor<WalletId.WALLETCONNECT>);
+    constructor({ id, store, subscribe, getAlgodClient, options, metadata, networks }: WalletConstructor<WalletId.WALLETCONNECT>);
     static defaultMetadata: {
         name: string;
         icon: string;
@@ -469,6 +531,7 @@ declare class BiatecWallet extends WalletConnect {
 declare enum WalletId {
     BIATEC = "biatec",
     DEFLY = "defly",
+    DEFLY_WEB = "defly-web",
     CUSTOM = "custom",
     EXODUS = "exodus",
     KIBISIS = "kibisis",
@@ -485,6 +548,7 @@ type WalletMap = {
     [WalletId.BIATEC]: typeof BiatecWallet;
     [WalletId.CUSTOM]: typeof CustomWallet;
     [WalletId.DEFLY]: typeof DeflyWallet;
+    [WalletId.DEFLY_WEB]: typeof DeflyWebWallet;
     [WalletId.EXODUS]: typeof ExodusWallet;
     [WalletId.KIBISIS]: typeof KibisisWallet;
     [WalletId.KMD]: typeof KmdWallet;
@@ -500,6 +564,7 @@ type WalletOptionsMap = {
     [WalletId.BIATEC]: WalletConnectOptions;
     [WalletId.CUSTOM]: CustomWalletOptions;
     [WalletId.DEFLY]: DeflyWalletConnectOptions;
+    [WalletId.DEFLY_WEB]: Record<string, never>;
     [WalletId.EXODUS]: ExodusOptions;
     [WalletId.KIBISIS]: Record<string, never>;
     [WalletId.KMD]: KmdOptions;
@@ -537,6 +602,7 @@ interface BaseWalletConstructor {
     getAlgodClient: () => algosdk.Algodv2;
     store: Store<State>;
     subscribe: (callback: (state: State) => void) => () => void;
+    networks: Record<string, NetworkConfig>;
 }
 type WalletConstructor<T extends keyof WalletOptionsMap> = BaseWalletConstructor & {
     options?: WalletOptions<T>;
@@ -636,10 +702,10 @@ type WalletStateMap = Partial<Record<WalletId, WalletState>>;
 interface State {
     wallets: WalletStateMap;
     activeWallet: WalletId | null;
-    activeNetwork: NetworkId;
+    activeNetwork: string;
     algodClient: algosdk.Algodv2;
 }
-declare const defaultState: State;
+declare const DEFAULT_STATE: State;
 
 interface WalletManagerOptions {
     resetNetwork?: boolean;
@@ -648,20 +714,20 @@ interface WalletManagerOptions {
 }
 interface WalletManagerConfig {
     wallets?: SupportedWallet[];
-    network?: NetworkId;
-    algod?: NetworkConfig;
+    networks?: Record<string, NetworkConfig>;
+    defaultNetwork?: string;
     options?: WalletManagerOptions;
 }
 declare class WalletManager {
     _clients: Map<WalletId, BaseWallet>;
-    networkConfig: NetworkConfigMap;
+    networkConfig: Record<string, NetworkConfig>;
     store: Store<State>;
     subscribe: (callback: (state: State) => void) => () => void;
     options: {
         resetNetwork: boolean;
     };
     private logger;
-    constructor({ wallets, network, algod, options }?: WalletManagerConfig);
+    constructor({ wallets, networks, defaultNetwork, options }?: WalletManagerConfig);
     private initializeLogger;
     private determineLogLevel;
     get algodClient(): algosdk.Algodv2;
@@ -676,8 +742,9 @@ declare class WalletManager {
     private initNetworkConfig;
     private createAlgodClient;
     getAlgodClient: () => algosdk.Algodv2;
-    setActiveNetwork: (networkId: NetworkId) => Promise<void>;
-    get activeNetwork(): NetworkId;
+    setActiveNetwork: (networkId: string) => Promise<void>;
+    get activeNetwork(): string;
+    get networks(): Record<string, NetworkConfig>;
     get activeWallet(): BaseWallet | null;
     get activeWalletAccounts(): WalletAccount[] | null;
     get activeWalletAddresses(): string[] | null;
@@ -713,4 +780,4 @@ declare const webpackFallback: {
     'magic-sdk': boolean;
 };
 
-export { BaseWallet, type BaseWalletConstructor, type CustomProvider, CustomWallet, type CustomWalletOptions, DeflyWallet, type DeflyWalletConnectOptions, type EnableResult, type Exodus, type ExodusOptions, ExodusWallet, ICON, type JsonRpcRequest, KIBISIS_AVM_WEB_PROVIDER_ID, KibisisWallet, type KmdOptions, KmdWallet, LOCAL_STORAGE_MNEMONIC_KEY, LiquidWallet, LogLevel, MagicAuth, type MagicAuthClient, type MagicAuthOptions, type MnemonicOptions, MnemonicWallet, type MultisigMetadata, NetworkId, PeraWallet$1 as PeraWallet, type PeraWalletConnectOptions$1 as PeraWalletConnectOptions, SessionError, SignTxnsError, type SignTxnsResponse, type SignTxnsResult, type SignerTransaction, type State, StorageAdapter, type SupportedWallet, type SupportedWallets, type WalletAccount, type WalletConfig, type WalletConfigMap, WalletConnect, type WalletConnectOptions, type WalletConstructor, WalletId, type WalletIdConfig, WalletManager, type WalletManagerConfig, type WalletManagerOptions, type WalletMap, type WalletMetadata, type WalletOptions, type WalletOptionsMap, type WalletState, type WalletTransaction, type WindowExtended, defaultState, isAVMWebProviderSDKError, webpackFallback };
+export { BaseWallet, type BaseWalletConstructor, type CustomProvider, CustomWallet, type CustomWalletOptions, DEFAULT_NETWORKS, DEFAULT_STATE, DeflyWallet, type DeflyWalletConnectOptions, type EnableResult, type Exodus, type ExodusOptions, ExodusWallet, ICON, type JsonRpcRequest, KIBISIS_AVM_WEB_PROVIDER_ID, KibisisWallet, type KmdOptions, KmdWallet, LOCAL_STORAGE_MNEMONIC_KEY, LiquidWallet, LogLevel, MagicAuth, type MagicAuthClient, type MagicAuthOptions, type MnemonicOptions, MnemonicWallet, type MultisigMetadata, NetworkId, PeraWallet$1 as PeraWallet, type PeraWalletConnectOptions$1 as PeraWalletConnectOptions, SessionError, SignTxnsError, type SignTxnsResponse, type SignTxnsResult, type SignerTransaction, type State, StorageAdapter, type SupportedWallet, type SupportedWallets, type WalletAccount, type WalletConfig, type WalletConfigMap, WalletConnect, type WalletConnectOptions, type WalletConstructor, WalletId, type WalletIdConfig, WalletManager, type WalletManagerConfig, type WalletManagerOptions, type WalletMap, type WalletMetadata, type WalletOptions, type WalletOptionsMap, type WalletState, type WalletTransaction, type WindowExtended, webpackFallback };