@txnlab/use-wallet 2.1.2 → 2.2.0

package/dist/esm/src/clients/custom/client.d.ts

@@ -0,0 +1,18 @@
+import BaseClient from '../base';
+import { PROVIDER_ID } from '../../constants';
+import type { Network } from '../../types/node';
+import type { InitParams } from '../../types/providers';
+import type { Metadata, Wallet } from '../../types/wallet';
+import type { CustomProvider, CustomWalletClientConstructor } from './types';
+declare class CustomWalletClient extends BaseClient {
+    network: Network;
+    providerProxy: CustomProvider;
+    static metadata: Metadata;
+    constructor({ providerProxy, metadata, algosdk, algodClient, network }: CustomWalletClientConstructor);
+    static init({ clientOptions, algodOptions, algosdkStatic, network }: InitParams<PROVIDER_ID.CUSTOM>): Promise<BaseClient | null>;
+    connect(): Promise<Wallet>;
+    disconnect(): Promise<void>;
+    reconnect(): Promise<Wallet | null>;
+    signTransactions(connectedAccounts: string[], txnGroups: Uint8Array[] | Uint8Array[][], indexesToSign?: number[], returnGroup?: boolean): Promise<Uint8Array[]>;
+}
+export default CustomWalletClient;

package/dist/esm/src/clients/custom/constants.d.ts

@@ -0,0 +1 @@
+export declare const ICON = "data:image/svg+xml,%3Csvg fill='%23000000' width='800px' height='800px' viewBox='0 0 24 24' id='wallet' data-name='Flat Line' xmlns='http://www.w3.org/2000/svg' class='icon flat-line'%3E%3Cpath id='secondary' d='M16,12h5V8H5A2,2,0,0,1,3,6V19a1,1,0,0,0,1,1H20a1,1,0,0,0,1-1V16H16a1,1,0,0,1-1-1V13A1,1,0,0,1,16,12Z' style='fill: rgb(44, 169, 188); stroke-width: 2;'%3E%3C/path%3E%3Cpath id='primary' d='M19,4H5A2,2,0,0,0,3,6H3A2,2,0,0,0,5,8H21' style='fill: none; stroke: rgb(0, 0, 0); stroke-linecap: round; stroke-linejoin: round; stroke-width: 2;'%3E%3C/path%3E%3Cpath id='primary-2' data-name='primary' d='M21,8V19a1,1,0,0,1-1,1H4a1,1,0,0,1-1-1V6A2,2,0,0,0,5,8Zm0,4H16a1,1,0,0,0-1,1v2a1,1,0,0,0,1,1h5Z' style='fill: none; stroke: rgb(0, 0, 0); stroke-linecap: round; stroke-linejoin: round; stroke-width: 2;'%3E%3C/path%3E%3C/svg%3E";

package/dist/esm/src/clients/custom/index.d.ts

@@ -0,0 +1,2 @@
+import custom from './client';
+export default custom;

package/dist/esm/src/clients/custom/types.d.ts

@@ -0,0 +1,25 @@
+import type algosdk from 'algosdk';
+import type { Network } from '../../types/node';
+import type { Metadata, Wallet } from '../../types/wallet';
+export type CustomOptions = {
+    name: string;
+    icon?: string;
+    getProvider: (params: {
+        network?: Network;
+        algod?: algosdk.Algodv2;
+        algosdkStatic?: typeof algosdk;
+    }) => CustomProvider;
+};
+export type CustomProvider = {
+    connect(metadata: Metadata): Promise<Wallet>;
+    disconnect(): Promise<void>;
+    reconnect(metadata: Metadata): Promise<Wallet | null>;
+    signTransactions(connectedAccounts: string[], txnGroups: Uint8Array[] | Uint8Array[][], indexesToSign?: number[], returnGroup?: boolean): Promise<Uint8Array[]>;
+};
+export type CustomWalletClientConstructor = {
+    providerProxy: CustomProvider;
+    metadata: Metadata;
+    algosdk: typeof algosdk;
+    algodClient: algosdk.Algodv2;
+    network: Network;
+};

package/dist/esm/src/clients/index.d.ts

@@ -7,8 +7,10 @@ import algosigner from './algosigner';
 import walletconnect from './walletconnect2';
 import kmd from './kmd';
 import mnemonic from './mnemonic';
-export { pera, myalgo, defly, exodus, algosigner, walletconnect, kmd, mnemonic };
+import { CustomProvider } from './custom/types';
+import custom from './custom';
+export { pera, myalgo, defly, exodus, algosigner, walletconnect, kmd, mnemonic, custom, CustomProvider };
 declare const _default: {
-    [x: string]: typeof pera | typeof myalgo | typeof defly | typeof exodus | typeof algosigner | typeof walletconnect | typeof kmd | typeof mnemonic | typeof daffi;
+    [x: string]: typeof pera | typeof myalgo | typeof defly | typeof exodus | typeof algosigner | typeof walletconnect | typeof kmd | typeof mnemonic | typeof custom | typeof daffi;
 };
 export default _default;

package/dist/esm/src/constants/constants.d.ts

@@ -1,6 +1,7 @@
 import { Network } from '../types/node';
 export declare enum PROVIDER_ID {
     KMD = "kmd",
+    CUSTOM = "custom",
     PERA = "pera",
     DAFFI = "daffi",
     MYALGO = "myalgo",

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

@@ -9,8 +9,10 @@ import PeraWalletClient from '../clients/pera/client';
 import WalletConnectClient from '../clients/walletconnect2/client';
 import { PROVIDER_ID } from '../constants';
 import type { Account, ClientOptions } from '../types';
+import CustomWalletClient from '../clients/custom/client';
 type ClientTypeMap = {
     [PROVIDER_ID.ALGOSIGNER]: AlgoSignerClient;
+    [PROVIDER_ID.CUSTOM]: CustomWalletClient;
     [PROVIDER_ID.DAFFI]: DaffiWalletClient;
     [PROVIDER_ID.DEFLY]: DeflyWalletClient;
     [PROVIDER_ID.EXODUS]: ExodusClient;
@@ -26,6 +28,7 @@ export declare const createDaffiMockInstance: (clientOptions?: ClientOptions, ac
 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 createCustomMockInstance: (clientOptions?: ClientOptions, accounts?: Array<Account>) => CustomWalletClient;
 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;

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

@@ -14,6 +14,7 @@ import type { MyAlgoConnectOptions } from '../clients/myalgo/types';
 import type { DaffiWalletConnectOptions } from '../clients/daffi/types';
 import type { NonEmptyArray } from './utilities';
 import type BaseClient from '../clients/base';
+import type { CustomOptions } from '../clients/custom/types';
 export type ProviderConfigMapping = {
     [PROVIDER_ID.PERA]: {
         clientOptions?: PeraWalletConnectOptions;
@@ -50,6 +51,11 @@ export type ProviderConfigMapping = {
         clientStatic?: undefined;
         getDynamicClient?: undefined;
     };
+    [PROVIDER_ID.CUSTOM]: {
+        clientOptions?: CustomOptions;
+        clientStatic?: undefined;
+        getDynamicClient?: undefined;
+    };
     [PROVIDER_ID.ALGOSIGNER]: {
         clientOptions?: undefined;
         clientStatic?: undefined;
@@ -97,7 +103,7 @@ type DynamicClient<T> = {
 type OneOfStaticOrDynamicClient<T> = StaticClient<T> | DynamicClient<T>;
 type ProviderDef = (ProviderConfig<PROVIDER_ID.PERA> & OneOfStaticOrDynamicClient<typeof PeraWalletConnect>) | (ProviderConfig<PROVIDER_ID.DEFLY> & OneOfStaticOrDynamicClient<typeof DeflyWalletConnect>) | (ProviderConfig<PROVIDER_ID.DAFFI> & OneOfStaticOrDynamicClient<typeof DaffiWalletConnect>) | (ProviderConfig<PROVIDER_ID.WALLETCONNECT> & OneOfStaticOrDynamicClient<typeof WalletConnectModalSign> & {
     clientOptions: WalletConnectModalSignOptions;
-}) | (ProviderConfig<PROVIDER_ID.MYALGO> & OneOfStaticOrDynamicClient<typeof MyAlgoConnect>) | ProviderConfig<PROVIDER_ID.EXODUS> | ProviderConfig<PROVIDER_ID.KMD> | PROVIDER_ID.EXODUS | PROVIDER_ID.KMD | PROVIDER_ID.ALGOSIGNER | PROVIDER_ID.MNEMONIC;
+}) | (ProviderConfig<PROVIDER_ID.MYALGO> & OneOfStaticOrDynamicClient<typeof MyAlgoConnect>) | ProviderConfig<PROVIDER_ID.EXODUS> | ProviderConfig<PROVIDER_ID.KMD> | ProviderConfig<PROVIDER_ID.CUSTOM> | PROVIDER_ID.EXODUS | PROVIDER_ID.KMD | PROVIDER_ID.ALGOSIGNER | PROVIDER_ID.MNEMONIC | PROVIDER_ID.CUSTOM;
 export type ProvidersArray = NonEmptyArray<ProviderDef>;
 export type WalletClient = BaseClient;
 export type SupportedProviders = Partial<Record<PROVIDER_ID, WalletClient | null>>;

package/dist/index.d.ts

@@ -69,6 +69,7 @@ type RawTxnResponse = {
 
 declare enum PROVIDER_ID {
     KMD = "kmd",
+    CUSTOM = "custom",
     PERA = "pera",
     DAFFI = "daffi",
     MYALGO = "myalgo",
@@ -280,6 +281,29 @@ declare abstract class BaseClient {
     keepWCAliveStop(): void;
 }
 
+type CustomOptions = {
+    name: string;
+    icon?: string;
+    getProvider: (params: {
+        network?: Network;
+        algod?: algosdk.Algodv2;
+        algosdkStatic?: typeof algosdk;
+    }) => CustomProvider;
+};
+type CustomProvider = {
+    connect(metadata: Metadata): Promise<Wallet>;
+    disconnect(): Promise<void>;
+    reconnect(metadata: Metadata): Promise<Wallet | null>;
+    signTransactions(connectedAccounts: string[], txnGroups: Uint8Array[] | Uint8Array[][], indexesToSign?: number[], returnGroup?: boolean): Promise<Uint8Array[]>;
+};
+type CustomWalletClientConstructor = {
+    providerProxy: CustomProvider;
+    metadata: Metadata;
+    algosdk: typeof algosdk;
+    algodClient: algosdk.Algodv2;
+    network: Network;
+};
+
 type ProviderConfigMapping = {
     [PROVIDER_ID.PERA]: {
         clientOptions?: PeraWalletConnectOptions;
@@ -316,6 +340,11 @@ type ProviderConfigMapping = {
         clientStatic?: undefined;
         getDynamicClient?: undefined;
     };
+    [PROVIDER_ID.CUSTOM]: {
+        clientOptions?: CustomOptions;
+        clientStatic?: undefined;
+        getDynamicClient?: undefined;
+    };
     [PROVIDER_ID.ALGOSIGNER]: {
         clientOptions?: undefined;
         clientStatic?: undefined;
@@ -363,7 +392,7 @@ type DynamicClient<T> = {
 type OneOfStaticOrDynamicClient<T> = StaticClient<T> | DynamicClient<T>;
 type ProviderDef = (ProviderConfig<PROVIDER_ID.PERA> & OneOfStaticOrDynamicClient<typeof PeraWalletConnect>) | (ProviderConfig<PROVIDER_ID.DEFLY> & OneOfStaticOrDynamicClient<typeof DeflyWalletConnect>) | (ProviderConfig<PROVIDER_ID.DAFFI> & OneOfStaticOrDynamicClient<typeof DaffiWalletConnect>) | (ProviderConfig<PROVIDER_ID.WALLETCONNECT> & OneOfStaticOrDynamicClient<typeof WalletConnectModalSign> & {
     clientOptions: WalletConnectModalSignOptions;
-}) | (ProviderConfig<PROVIDER_ID.MYALGO> & OneOfStaticOrDynamicClient<typeof MyAlgoConnect>) | ProviderConfig<PROVIDER_ID.EXODUS> | ProviderConfig<PROVIDER_ID.KMD> | PROVIDER_ID.EXODUS | PROVIDER_ID.KMD | PROVIDER_ID.ALGOSIGNER | PROVIDER_ID.MNEMONIC;
+}) | (ProviderConfig<PROVIDER_ID.MYALGO> & OneOfStaticOrDynamicClient<typeof MyAlgoConnect>) | ProviderConfig<PROVIDER_ID.EXODUS> | ProviderConfig<PROVIDER_ID.KMD> | ProviderConfig<PROVIDER_ID.CUSTOM> | PROVIDER_ID.EXODUS | PROVIDER_ID.KMD | PROVIDER_ID.ALGOSIGNER | PROVIDER_ID.MNEMONIC | PROVIDER_ID.CUSTOM;
 type ProvidersArray = NonEmptyArray<ProviderDef>;
 type WalletClient = BaseClient;
 type SupportedProviders = Partial<Record<PROVIDER_ID, WalletClient | null>>;
@@ -677,6 +706,18 @@ declare class MnemonicWalletClient extends BaseClient {
     signEncodedTransactions(_transactions: TransactionsArray): Promise<Uint8Array[]>;
 }
 
+declare class CustomWalletClient extends BaseClient {
+    network: Network;
+    providerProxy: CustomProvider;
+    static metadata: Metadata;
+    constructor({ providerProxy, metadata, algosdk, algodClient, network }: CustomWalletClientConstructor);
+    static init({ clientOptions, algodOptions, algosdkStatic, network }: InitParams<PROVIDER_ID.CUSTOM>): Promise<BaseClient | null>;
+    connect(): Promise<Wallet>;
+    disconnect(): Promise<void>;
+    reconnect(): Promise<Wallet | null>;
+    signTransactions(connectedAccounts: string[], txnGroups: Uint8Array[] | Uint8Array[][], indexesToSign?: number[], returnGroup?: boolean): Promise<Uint8Array[]>;
+}
+
 declare function useWallet(): {
     clients: Partial<Record<PROVIDER_ID, BaseClient | null>> | null;
     providers: Provider[] | null;
@@ -714,4 +755,4 @@ interface InitializeProvidersOptions {
 }
 declare function useInitializeProviders({ providers, nodeConfig, algosdkStatic, debug }: InitializeProvidersOptions): Partial<Record<PROVIDER_ID, BaseClient | null>> | null;
 
-export { Account, AccountInfo, AlgodClientOptions, Asset, ClientOptions, CommonInitParams, ConfirmedTxn, DEFAULT_NETWORK, DEFAULT_NODE_BASEURL, DEFAULT_NODE_PORT, DEFAULT_NODE_TOKEN, DecodedSignedTransaction, DecodedTransaction, InitParams, Metadata, Network, NodeConfig, PROVIDER_ID, Provider, ProviderConfig, ProviderConfigMapping, ProvidersArray, PublicNetwork, RawTxnResponse, SupportedProviders, TransactionsArray, Txn, TxnInfo, TxnType, Wallet, WalletClient, _default as WalletProvider, AlgoSignerClient as algosigner, DeflyWalletClient as defly, encodeNFDTransactionsArray, ExodusClient as exodus, KMDWalletClient as kmd, MnemonicWalletClient as mnemonic, MyAlgoWalletClient as myalgo, PeraWalletClient as pera, reconnectProviders, useInitializeProviders, useWallet, WalletConnectClient as walletconnect };
+export { Account, AccountInfo, AlgodClientOptions, Asset, ClientOptions, CommonInitParams, ConfirmedTxn, CustomProvider, DEFAULT_NETWORK, DEFAULT_NODE_BASEURL, DEFAULT_NODE_PORT, DEFAULT_NODE_TOKEN, DecodedSignedTransaction, DecodedTransaction, InitParams, Metadata, Network, NodeConfig, PROVIDER_ID, Provider, ProviderConfig, ProviderConfigMapping, ProvidersArray, PublicNetwork, RawTxnResponse, SupportedProviders, TransactionsArray, Txn, TxnInfo, TxnType, Wallet, WalletClient, _default as WalletProvider, AlgoSignerClient as algosigner, CustomWalletClient as custom, DeflyWalletClient as defly, encodeNFDTransactionsArray, ExodusClient as exodus, KMDWalletClient as kmd, MnemonicWalletClient as mnemonic, MyAlgoWalletClient as myalgo, PeraWalletClient as pera, reconnectProviders, useInitializeProviders, useWallet, WalletConnectClient as walletconnect };

package/package.json

@@ -12,11 +12,11 @@
     "url": "https://github.com/txnlab/use-wallet/issues"
   },
   "homepage": "https://txnlab.github.io/use-wallet",
-  "version": "2.1.2",
+  "version": "2.2.0",
   "description": "React hooks for using Algorand compatible wallets in dApps.",
   "scripts": {
     "dev": "yarn storybook",
-    "build": "rm -rf dist && rollup -c",
+    "build": "rimraf dist && rollup -c",
     "test": "jest",
     "lint": "eslint '**/*.{js,ts,tsx}'",
     "format": "prettier --check '**/*.{js,ts,tsx}'",
@@ -41,7 +41,7 @@
     "@perawallet/connect": "^1.2.1",
     "@randlabs/myalgo-connect": "^1.4.2",
     "@release-it/conventional-changelog": "^7.0.0",
-    "@rollup/plugin-commonjs": "^23.0.2",
+    "@rollup/plugin-commonjs": "^25.0.0",
     "@rollup/plugin-node-resolve": "^15.0.1",
     "@storybook/addon-actions": "^6.5.16",
     "@storybook/addon-essentials": "^6.5.16",
@@ -60,6 +60,7 @@
     "algosdk": "^2.1.0",
     "babel-jest": "^29.1.2",
     "babel-loader": "^9.0.0",
+    "buffer": "^6.0.3",
     "commitizen": "4.3.0",
     "css-loader": "^6.5.1",
     "cz-conventional-changelog": "3.3.0",
@@ -80,6 +81,7 @@
     "react-dom": "^18.2.0",
     "release-it": "^16.1.0",
     "require-from-string": "^2.0.2",
+    "rimraf": "^5.0.1",
     "rollup": "^3.3.0",
     "rollup-plugin-analyzer": "^4.0.0",
     "rollup-plugin-dts": "^5.0.0",