@txnlab/use-wallet 2.3.1 → 2.4.0

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

@@ -4,13 +4,14 @@ import myalgo from './myalgo';
 import defly from './defly';
 import exodus from './exodus';
 import algosigner from './algosigner';
+import lute from './lute';
 import walletconnect from './walletconnect2';
 import kmd from './kmd';
 import mnemonic from './mnemonic';
 import { CustomProvider } from './custom/types';
 import custom from './custom';
-export { pera, myalgo, defly, exodus, algosigner, walletconnect, kmd, mnemonic, custom, CustomProvider };
+export { pera, myalgo, defly, exodus, algosigner, lute, 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 custom | typeof daffi;
+    [x: string]: typeof pera | typeof myalgo | typeof defly | typeof exodus | typeof algosigner | typeof lute | typeof walletconnect | typeof kmd | typeof mnemonic | typeof custom | typeof daffi;
 };
 export default _default;

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

@@ -0,0 +1,34 @@
+import { PROVIDER_ID } from '../../constants';
+import { DecodedSignedTransaction, DecodedTransaction, Network } from '../../types/node';
+import type { InitParams } from '../../types/providers';
+import BaseClient from '../base';
+import type { LuteClientConstructor, LuteConnectOptions } from './types';
+declare class LuteClient extends BaseClient {
+    #private;
+    clientOptions?: LuteConnectOptions;
+    network: Network;
+    constructor({ metadata, client, clientOptions, algosdk, algodClient, network }: LuteClientConstructor);
+    static metadata: {
+        id: PROVIDER_ID;
+        name: string;
+        icon: string;
+        isWalletConnect: boolean;
+    };
+    static init({ clientOptions, algodOptions, clientStatic, getDynamicClient, algosdkStatic, network }: InitParams<PROVIDER_ID.LUTE>): Promise<BaseClient | null>;
+    connect(): Promise<{
+        accounts: {
+            name: string;
+            address: string;
+            providerId: PROVIDER_ID;
+        }[];
+        id: PROVIDER_ID;
+        name: string;
+        icon: string;
+        isWalletConnect: boolean;
+    }>;
+    reconnect(): Promise<null>;
+    disconnect(): Promise<void>;
+    shouldSignTxnObject(txn: DecodedTransaction | DecodedSignedTransaction, addresses: string[], indexesToSign: number[] | undefined, idx: number): boolean;
+    signTransactions(connectedAccounts: string[], transactions: Uint8Array[], indexesToSign?: number[], returnGroup?: boolean): Promise<Uint8Array[]>;
+}
+export default LuteClient;

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

@@ -0,0 +1 @@
+export declare const ICON: string;

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

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

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

@@ -0,0 +1,15 @@
+import type algosdk from 'algosdk';
+import type { Network } from '../../types/node';
+import type { Metadata } from '../../types/wallet';
+import type LuteConnect from 'lute-connect';
+export type LuteConnectOptions = {
+    siteName: string;
+};
+export type LuteClientConstructor = {
+    metadata: Metadata;
+    client: LuteConnect;
+    clientOptions?: LuteConnectOptions;
+    algosdk: typeof algosdk;
+    algodClient: algosdk.Algodv2;
+    network: Network;
+};

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

@@ -4,6 +4,7 @@ export declare enum PROVIDER_ID {
     CUSTOM = "custom",
     PERA = "pera",
     DAFFI = "daffi",
+    LUTE = "lute",
     MYALGO = "myalgo",
     ALGOSIGNER = "algosigner",
     DEFLY = "defly",

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

@@ -2,6 +2,7 @@ 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 LuteClient from '../clients/lute/client';
 import KMDWalletClient from '../clients/kmd/client';
 import MnemonicWalletClient from '../clients/mnemonic/client';
 import MyAlgoWalletClient from '../clients/myalgo/client';
@@ -21,12 +22,14 @@ type ClientTypeMap = {
     [PROVIDER_ID.MYALGO]: MyAlgoWalletClient;
     [PROVIDER_ID.PERA]: PeraWalletClient;
     [PROVIDER_ID.WALLETCONNECT]: WalletConnectClient;
+    [PROVIDER_ID.LUTE]: LuteClient;
 };
 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 createLuteMockInstance: (clientOptions?: ClientOptions, accounts?: Array<Account>) => LuteClient;
 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;

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

@@ -2,6 +2,7 @@ import type { 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 LuteConnect from 'lute-connect';
 import type MyAlgoConnect from '@randlabs/myalgo-connect';
 import type { WalletConnectModalSign, WalletConnectModalSignOptions } from '@walletconnect/modal-sign-html';
 import type algosdk from 'algosdk';
@@ -10,6 +11,7 @@ import type { PeraWalletConnectOptions } from '../clients/pera/types';
 import type { DeflyWalletConnectOptions } from '../clients/defly/types';
 import type { ExodusOptions } from '../clients/exodus/types';
 import type { KmdOptions } from '../clients/kmd/types';
+import type { LuteConnectOptions } from '../clients/lute/types';
 import type { MyAlgoConnectOptions } from '../clients/myalgo/types';
 import type { DaffiWalletConnectOptions } from '../clients/daffi/types';
 import type { NonEmptyArray } from './utilities';
@@ -36,6 +38,11 @@ export type ProviderConfigMapping = {
         clientStatic?: typeof WalletConnectModalSign;
         getDynamicClient?: () => Promise<typeof WalletConnectModalSign>;
     };
+    [PROVIDER_ID.LUTE]: {
+        clientOptions?: LuteConnectOptions;
+        clientStatic?: typeof LuteConnect;
+        getDynamicClient?: () => Promise<typeof LuteConnect>;
+    };
     [PROVIDER_ID.MYALGO]: {
         clientOptions?: MyAlgoConnectOptions;
         clientStatic?: typeof MyAlgoConnect;
@@ -101,7 +108,9 @@ type DynamicClient<T> = {
     getDynamicClient: () => Promise<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> & {
+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.LUTE> & OneOfStaticOrDynamicClient<typeof LuteConnect> & {
+    clientOptions: LuteConnectOptions;
+}) | (ProviderConfig<PROVIDER_ID.WALLETCONNECT> & OneOfStaticOrDynamicClient<typeof WalletConnectModalSign> & {
     clientOptions: WalletConnectModalSignOptions;
 }) | (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>;

package/dist/index.d.ts

@@ -2,6 +2,7 @@ import algosdk from 'algosdk';
 import { PeraWalletConnect } from '@perawallet/connect';
 import { DeflyWalletConnect } from '@blockshake/defly-connect';
 import { DaffiWalletConnect } from '@daffiwallet/connect';
+import LuteConnect from 'lute-connect';
 import MyAlgoConnect from '@randlabs/myalgo-connect';
 import { WalletConnectModalSignOptions, WalletConnectModalSign } from '@walletconnect/modal-sign-html';
 import React from 'react';
@@ -72,6 +73,7 @@ declare enum PROVIDER_ID {
     CUSTOM = "custom",
     PERA = "pera",
     DAFFI = "daffi",
+    LUTE = "lute",
     MYALGO = "myalgo",
     ALGOSIGNER = "algosigner",
     DEFLY = "defly",
@@ -213,6 +215,18 @@ type KMDWalletClientConstructor = {
     network: Network;
 };
 
+type LuteConnectOptions = {
+    siteName: string;
+};
+type LuteClientConstructor = {
+    metadata: Metadata;
+    client: LuteConnect;
+    clientOptions?: LuteConnectOptions;
+    algosdk: typeof algosdk;
+    algodClient: algosdk.Algodv2;
+    network: Network;
+};
+
 /**
  * Helpful resources:
  * https://github.com/randlabs/myalgo-connect
@@ -325,6 +339,11 @@ type ProviderConfigMapping = {
         clientStatic?: typeof WalletConnectModalSign;
         getDynamicClient?: () => Promise<typeof WalletConnectModalSign>;
     };
+    [PROVIDER_ID.LUTE]: {
+        clientOptions?: LuteConnectOptions;
+        clientStatic?: typeof LuteConnect;
+        getDynamicClient?: () => Promise<typeof LuteConnect>;
+    };
     [PROVIDER_ID.MYALGO]: {
         clientOptions?: MyAlgoConnectOptions;
         clientStatic?: typeof MyAlgoConnect;
@@ -390,7 +409,9 @@ type DynamicClient<T> = {
     getDynamicClient: () => Promise<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> & {
+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.LUTE> & OneOfStaticOrDynamicClient<typeof LuteConnect> & {
+    clientOptions: LuteConnectOptions;
+}) | (ProviderConfig<PROVIDER_ID.WALLETCONNECT> & OneOfStaticOrDynamicClient<typeof WalletConnectModalSign> & {
     clientOptions: WalletConnectModalSignOptions;
 }) | (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>;
@@ -611,6 +632,35 @@ declare class AlgoSignerClient extends BaseClient {
     getAuthAddress(address: string): string | undefined;
 }
 
+declare class LuteClient extends BaseClient {
+    #private;
+    clientOptions?: LuteConnectOptions;
+    network: Network;
+    constructor({ metadata, client, clientOptions, algosdk, algodClient, network }: LuteClientConstructor);
+    static metadata: {
+        id: PROVIDER_ID;
+        name: string;
+        icon: string;
+        isWalletConnect: boolean;
+    };
+    static init({ clientOptions, algodOptions, clientStatic, getDynamicClient, algosdkStatic, network }: InitParams<PROVIDER_ID.LUTE>): Promise<BaseClient | null>;
+    connect(): Promise<{
+        accounts: {
+            name: string;
+            address: string;
+            providerId: PROVIDER_ID;
+        }[];
+        id: PROVIDER_ID;
+        name: string;
+        icon: string;
+        isWalletConnect: boolean;
+    }>;
+    reconnect(): Promise<null>;
+    disconnect(): Promise<void>;
+    shouldSignTxnObject(txn: DecodedTransaction | DecodedSignedTransaction, addresses: string[], indexesToSign: number[] | undefined, idx: number): boolean;
+    signTransactions(connectedAccounts: string[], transactions: Uint8Array[], indexesToSign?: number[], returnGroup?: boolean): Promise<Uint8Array[]>;
+}
+
 type WalletConnectClientConstructor = {
     metadata: Metadata;
     client: WalletConnectModalSign;
@@ -759,4 +809,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, 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, 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 };
+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, WalletProvider, AlgoSignerClient as algosigner, CustomWalletClient as custom, DeflyWalletClient as defly, encodeNFDTransactionsArray, ExodusClient as exodus, KMDWalletClient as kmd, LuteClient as lute, MnemonicWalletClient as mnemonic, MyAlgoWalletClient as myalgo, PeraWalletClient as pera, reconnectProviders, useInitializeProviders, useWallet, WalletConnectClient as walletconnect };

package/package.json

@@ -1,18 +1,8 @@
 {
   "name": "@txnlab/use-wallet",
-  "publishConfig": {
-    "access": "public",
-    "registry": "https://registry.npmjs.org/"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/txnlab/use-wallet"
-  },
-  "bugs": {
-    "url": "https://github.com/txnlab/use-wallet/issues"
-  },
-  "homepage": "https://txnlab.github.io/use-wallet",
-  "version": "2.3.1",
+  "author": "TxnLab, Inc.",
+  "version": "2.4.0",
+  "license": "MIT",
   "description": "React hooks for using Algorand compatible wallets in dApps.",
   "scripts": {
     "dev": "yarn storybook",
@@ -28,8 +18,27 @@
     "pre-release": "yarn lint && yarn format && yarn check-types && yarn test && yarn build",
     "release": "release-it"
   },
-  "author": "txnlab",
-  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/txnlab/use-wallet"
+  },
+  "bugs": {
+    "url": "https://github.com/txnlab/use-wallet/issues"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "types": "dist/index.d.ts",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "immer": "^9.0.15",
+    "zustand": "^4.3.8"
+  },
   "devDependencies": {
     "@babel/core": "^7.16.0",
     "@babel/preset-env": "^7.16.4",
@@ -37,7 +46,6 @@
     "@babel/preset-typescript": "^7.16.0",
     "@blockshake/defly-connect": "^1.1.5",
     "@daffiwallet/connect": "^1.0.3",
-    "@mdx-js/react": "^2.3.0",
     "@perawallet/connect": "^1.2.1",
     "@randlabs/myalgo-connect": "^1.4.2",
     "@release-it/conventional-changelog": "^7.0.0",
@@ -58,8 +66,6 @@
     "@typescript-eslint/parser": "^5.55.0",
     "@walletconnect/modal-sign-html": "^2.5.4",
     "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",
@@ -70,17 +76,15 @@
     "eslint-plugin-react": "^7.32.2",
     "eslint-plugin-react-hooks": "^4.6.0",
     "gh-pages": "^5.0.0",
-    "html-webpack-plugin": "^5.5.0",
-    "identity-obj-proxy": "^3.0.0",
     "jest": "^29.1.2",
     "jest-canvas-mock": "^2.5.0",
     "jest-environment-jsdom": "^29.3.1",
+    "lute-connect": "^1.0.7",
     "postcss": "^8.4.17",
     "prettier": "2.8.8",
     "react": "^18.2.0",
     "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",
@@ -122,16 +126,6 @@
       "optional": true
     }
   },
-  "main": "dist/cjs/index.js",
-  "module": "dist/esm/index.js",
-  "files": [
-    "dist"
-  ],
-  "types": "dist/index.d.ts",
-  "dependencies": {
-    "immer": "^9.0.15",
-    "zustand": "^4.3.8"
-  },
   "config": {
     "commitizen": {
       "path": "cz-conventional-changelog"