@txnlab/use-wallet 1.3.1 → 2.0.0-alpha.0

package/dist/cjs/src/store/state/clientStore.d.ts

@@ -1,26 +1,5 @@
 /// <reference types="react" />
-import BaseWallet from '../../clients/base';
-declare const ClientContext: import("react").Context<Partial<{
-    kmd: Promise<BaseWallet | null>;
-    pera: Promise<BaseWallet | null>;
-    daffi: Promise<BaseWallet | null>;
-    myalgo: Promise<BaseWallet | null>;
-    algosigner: Promise<BaseWallet | null>;
-    defly: Promise<BaseWallet | null>;
-    exodus: Promise<BaseWallet | null>;
-    walletconnect: Promise<BaseWallet | null>;
-    mnemonic: Promise<BaseWallet | null>;
-}> | null>;
+declare const ClientContext: import("react").Context<Partial<Record<import("../..").PROVIDER_ID, import("../../clients/base/base").default | null>> | null>;
 export { ClientContext };
-declare const _default: import("react").Provider<Partial<{
-    kmd: Promise<BaseWallet | null>;
-    pera: Promise<BaseWallet | null>;
-    daffi: Promise<BaseWallet | null>;
-    myalgo: Promise<BaseWallet | null>;
-    algosigner: Promise<BaseWallet | null>;
-    defly: Promise<BaseWallet | null>;
-    exodus: Promise<BaseWallet | null>;
-    walletconnect: Promise<BaseWallet | null>;
-    mnemonic: Promise<BaseWallet | null>;
-}> | null>;
+declare const _default: import("react").Provider<Partial<Record<import("../..").PROVIDER_ID, import("../../clients/base/base").default | null>> | null>;
 export default _default;

package/dist/cjs/src/testUtils/createWrapper.d.ts

@@ -0,0 +1,6 @@
+import React, { ComponentType, ReactNode } from 'react';
+interface CreatedWrapperProps {
+    children: ReactNode;
+}
+export declare function createWrapper<P>(Wrapper: ComponentType<P>, props: P): React.FC<CreatedWrapperProps>;
+export {};

package/dist/cjs/src/testUtils/mockAccounts.d.ts

@@ -0,0 +1,3 @@
+import { Account } from 'src/types';
+import { PROVIDER_ID } from 'src/constants';
+export declare const mockAccounts: (providerId: PROVIDER_ID, qty?: number) => Account[];

package/dist/cjs/src/testUtils/mockClients.d.ts

@@ -0,0 +1,33 @@
+import AlgoSignerClient from '../clients/algosigner/client';
+import DaffiWalletClient from '../clients/daffi/client';
+import DeflyWalletClient from '../clients/defly/client';
+import ExodusClient from '../clients/exodus/client';
+import KMDWalletClient from '../clients/kmd/client';
+import MnemonicWalletClient from '../clients/mnemonic/client';
+import MyAlgoWalletClient from '../clients/myalgo/client';
+import PeraWalletClient from '../clients/pera/client';
+import WalletConnectClient from '../clients/walletconnect2/client';
+import { PROVIDER_ID } from '../constants';
+import type { Account, ClientOptions } from '../types';
+declare type ClientTypeMap = {
+    [PROVIDER_ID.ALGOSIGNER]: AlgoSignerClient;
+    [PROVIDER_ID.DAFFI]: DaffiWalletClient;
+    [PROVIDER_ID.DEFLY]: DeflyWalletClient;
+    [PROVIDER_ID.EXODUS]: ExodusClient;
+    [PROVIDER_ID.KMD]: KMDWalletClient;
+    [PROVIDER_ID.MNEMONIC]: MnemonicWalletClient;
+    [PROVIDER_ID.MYALGO]: MyAlgoWalletClient;
+    [PROVIDER_ID.PERA]: PeraWalletClient;
+    [PROVIDER_ID.WALLETCONNECT]: WalletConnectClient;
+};
+export declare const createMockClient: <T extends PROVIDER_ID>(providerId: T, clientOptions?: ClientOptions, accounts?: Array<Account>) => ClientTypeMap[T];
+export declare const createAlgoSignerMockInstance: (clientOptions?: ClientOptions, accounts?: Array<Account>) => AlgoSignerClient;
+export declare const createDaffiMockInstance: (clientOptions?: ClientOptions, accounts?: Array<Account>) => DaffiWalletClient;
+export declare const createDeflyMockInstance: (clientOptions?: ClientOptions, accounts?: Array<Account>) => DeflyWalletClient;
+export declare const createExodusMockInstance: (clientOptions?: ClientOptions, accounts?: Array<Account>) => ExodusClient;
+export declare const createKmdMockInstance: (clientOptions?: ClientOptions, accounts?: Array<Account>) => KMDWalletClient;
+export declare const createMnemonicMockInstance: (clientOptions?: ClientOptions, accounts?: Array<Account>) => MnemonicWalletClient;
+export declare const createMyAlgoMockInstance: (clientOptions?: ClientOptions, accounts?: Array<Account>) => MyAlgoWalletClient;
+export declare const createPeraMockInstance: (clientOptions?: ClientOptions, accounts?: Array<Account>) => PeraWalletClient;
+export declare const createWalletConnectMockInstance: (clientOptions?: ClientOptions, accounts?: Array<Account>) => WalletConnectClient;
+export {};

package/dist/cjs/src/types/index.d.ts

@@ -1,3 +1,4 @@
 export * from './api';
 export * from './node';
 export * from './wallet';
+export * from './providers';

package/dist/cjs/src/types/node.d.ts

@@ -1,5 +1,6 @@
 import type algosdk from 'algosdk';
-export declare type Network = 'betanet' | 'testnet' | 'mainnet' | string;
+export declare type PublicNetwork = 'betanet' | 'testnet' | 'mainnet';
+export declare type Network = PublicNetwork | string;
 export declare type Txn = {
     apaa: Uint8Array;
     apas: number[];

package/dist/cjs/src/types/providers.d.ts

@@ -0,0 +1,71 @@
+import { PROVIDER_ID } from '../constants';
+import type { PeraWalletConnect } from '@perawallet/connect';
+import type { DeflyWalletConnect } from '@blockshake/defly-connect';
+import type { DaffiWalletConnect } from '@daffiwallet/connect';
+import type SignClient from '@walletconnect/sign-client';
+import type MyAlgoConnect from '@randlabs/myalgo-connect';
+import type { WalletConnectModal } from '@walletconnect/modal';
+import { AlgodClientOptions, Network } from './node';
+import type algosdk from 'algosdk';
+import type { PeraWalletConnectOptions } from '../clients/pera/types';
+import { DeflyWalletConnectOptions } from '../clients/defly/types';
+import { ExodusOptions } from '../clients/exodus/types';
+import { KmdOptions } from '../clients/kmd/types';
+import { MyAlgoConnectOptions } from '../clients/myalgo/types';
+import { WalletConnectModalOptions, WalletConnectOptions } from '../clients/walletconnect2/types';
+import { DaffiWalletConnectOptions } from '../clients/daffi/types';
+export declare type ProviderConfigMapping = {
+    [PROVIDER_ID.PERA]: {
+        clientOptions?: PeraWalletConnectOptions;
+        clientStatic?: typeof PeraWalletConnect;
+    };
+    [PROVIDER_ID.DAFFI]: {
+        clientOptions?: DaffiWalletConnectOptions;
+        clientStatic?: typeof DaffiWalletConnect;
+    };
+    [PROVIDER_ID.DEFLY]: {
+        clientOptions?: DeflyWalletConnectOptions;
+        clientStatic?: typeof DeflyWalletConnect;
+    };
+    [PROVIDER_ID.WALLETCONNECT]: {
+        clientOptions?: WalletConnectOptions;
+        clientStatic?: typeof SignClient;
+        modalStatic?: typeof WalletConnectModal;
+        modalOptions?: WalletConnectModalOptions;
+    };
+    [PROVIDER_ID.MYALGO]: {
+        clientOptions?: MyAlgoConnectOptions;
+        clientStatic?: typeof MyAlgoConnect;
+    };
+    [PROVIDER_ID.EXODUS]: {
+        clientOptions?: ExodusOptions;
+    };
+    [PROVIDER_ID.KMD]: {
+        clientOptions?: KmdOptions;
+    };
+    [PROVIDER_ID.ALGOSIGNER]: Record<string, never>;
+    [PROVIDER_ID.MNEMONIC]: Record<string, never>;
+};
+/**
+ * Enforces correct configuration given for each provider. For example,
+ * if `id` is `PROVIDER_ID.PERA`, then `clientOptions` must be of type
+ * `PeraWalletConnectOptions`.
+ *
+ * @todo install `tsd` to test TypeScript type definitions in CI
+ */
+export declare type ProviderConfig<T extends keyof ProviderConfigMapping> = {
+    [K in T]: {
+        id: K;
+    } & ProviderConfigMapping[K];
+}[T];
+export declare type CommonInitParams = {
+    network?: Network;
+    algodOptions?: AlgodClientOptions;
+    algosdkStatic?: typeof algosdk;
+};
+export declare type NodeConfig = {
+    network: Network;
+    nodeServer: string;
+    nodeToken?: string;
+    nodePort?: string;
+};

package/dist/cjs/src/types/wallet.d.ts

@@ -1,5 +1,5 @@
 import { PROVIDER_ID } from '../constants';
-import type BaseWallet from '../clients/base';
+import type BaseClient from '../clients/base';
 export interface Account {
     providerId: PROVIDER_ID;
     name: string;
@@ -50,5 +50,7 @@ export declare type Metadata = {
     icon: string;
     isWalletConnect: boolean;
 };
-export declare type WalletClient = BaseWallet;
-export { PROVIDER_ID };
+export declare type ClientOptions = Record<string, any>;
+export declare type WalletClient = BaseClient;
+export declare type SupportedProviders = Partial<Record<PROVIDER_ID, WalletClient | null>>;
+export {};

package/dist/cjs/src/utils/clearAccounts.d.ts

@@ -1,2 +1,2 @@
-import { PROVIDER_ID } from '../types';
+import { PROVIDER_ID } from '../constants';
 export declare const clearAccounts: (id: PROVIDER_ID) => void;

package/dist/cjs/src/utils/encodeNFDTransactionArray.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/cjs/src/utils/initializeProviders.d.ts

@@ -1,13 +1,3 @@
 import type algosdk from 'algosdk';
-import { PROVIDER_ID, WalletClient, Network } from '../types';
-declare type SupportedProviders = {
-    [x: string]: Promise<WalletClient | null>;
-};
-declare type NodeConfig = {
-    network: Network;
-    nodeServer: string;
-    nodeToken?: string;
-    nodePort?: string;
-};
-export declare const initializeProviders: (providers?: PROVIDER_ID[], nodeConfig?: NodeConfig, algosdkStatic?: typeof algosdk) => SupportedProviders;
-export {};
+import { NodeConfig, ProviderConfig, ProviderConfigMapping, SupportedProviders } from '../types';
+export declare const initializeProviders: <T extends keyof ProviderConfigMapping>(providers?: (T | ProviderConfig<T>)[] | undefined, nodeConfig?: NodeConfig, algosdkStatic?: typeof algosdk) => Promise<SupportedProviders>;

package/dist/cjs/src/utils/initializeProviders.test.d.ts

@@ -0,0 +1,4 @@
+/**
+ * @jest-environment jsdom
+ */
+export {};

package/dist/cjs/src/utils/providers.d.ts

@@ -1,3 +1,3 @@
-import { PROVIDER_ID } from 'src/constants';
+import { PROVIDER_ID } from '../constants';
 export declare const getActiveProviders: () => PROVIDER_ID[];
 export declare const isActiveProvider: (id: PROVIDER_ID) => boolean;

package/dist/cjs/src/utils/providers.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/cjs/src/utils/reconnectProviders.d.ts

@@ -1,6 +1,2 @@
-import { WalletClient } from '../types';
-declare type SupportedProviders = {
-    [x: string]: Promise<WalletClient | null>;
-};
+import type { SupportedProviders } from '../types';
 export declare const reconnectProviders: (providers: SupportedProviders) => Promise<void>;
-export {};

package/dist/cjs/src/utils/reconnectProviders.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/cjs/src/utils/types.d.ts

@@ -0,0 +1,2 @@
+import { PublicNetwork } from 'src/types';
+export declare const isPublicNetwork: (network: string) => network is PublicNetwork;