@txnlab/use-wallet 1.1.6 → 1.2.1

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import _algosdk, { Transaction } from 'algosdk';
+import _algosdk from 'algosdk';
 import * as react from 'react';
 import { PeraWalletConnect } from '@perawallet/connect';
 import _MyAlgoConnect from '@randlabs/myalgo-connect';
@@ -67,7 +67,8 @@ declare enum PROVIDER_ID {
     ALGOSIGNER = "algosigner",
     DEFLY = "defly",
     EXODUS = "exodus",
-    WALLETCONNECT = "walletconnect"
+    WALLETCONNECT = "walletconnect",
+    MNEMONIC = "mnemonic"
 }
 declare const DEFAULT_NETWORK: Network;
 declare const DEFAULT_NODE_BASEURL = "https://mainnet-api.algonode.cloud";
@@ -84,7 +85,6 @@ declare abstract class BaseClient {
     abstract disconnect(): Promise<void>;
     abstract reconnect(onDisconnect: () => void): Promise<Wallet | null>;
     abstract signTransactions(connectedAccounts: string[], transactions: Array<Uint8Array>, indexesToSign?: number[], returnGroup?: boolean): Promise<Uint8Array[]>;
-    abstract signEncodedTransactions(transactions: TransactionsArray): Promise<Uint8Array[]>;
     protected constructor(metadata: Metadata, algosdk: typeof _algosdk, algodClient: _algosdk.Algodv2);
     healthCheck(): Promise<{}>;
     getAccountInfo(address: string): Promise<AccountInfo>;
@@ -176,6 +176,7 @@ declare function useWallet(): {
         defly: Promise<BaseClient | null>;
         exodus: Promise<BaseClient | null>;
         walletconnect: Promise<BaseClient | null>;
+        mnemonic: Promise<BaseClient | null>;
     }> | null;
     providers: Provider[] | null;
     connectedAccounts: Account[];
@@ -202,18 +203,6 @@ declare function useWallet(): {
     groupTransactionsBySender: (transactions: TransactionsArray) => Promise<Record<string, any>>;
     getAccountInfo: () => Promise<AccountInfo>;
     getAssets: () => Promise<Asset[]>;
-    signEncodedTransactions: (transactions: TransactionsArray) => Promise<Uint8Array[]>;
-    sendRawTransactions: (transactions: Uint8Array[], waitRoundsToConfirm?: number) => Promise<{
-        "confirmed-round": number;
-        "global-state-delta": Record<string, unknown>[];
-        "pool-error": string;
-        txn: {
-            sig: Uint8Array;
-            txn: Txn;
-        };
-        txId: string;
-        id: any;
-    }>;
 };
 
 declare type SupportedProviders$1 = {
@@ -232,6 +221,9 @@ declare type SupportedProviders = {
 };
 declare const reconnectProviders: (providers: SupportedProviders) => Promise<void>;
 
+declare type NFDTransactionsArray = ["u" | "s", string][];
+declare function encodeNFDTransactionsArray(transactionsArray: NFDTransactionsArray): Uint8Array[];
+
 declare const _default: react.Provider<Partial<{
     kmd: Promise<BaseClient | null>;
     pera: Promise<BaseClient | null>;
@@ -240,27 +232,14 @@ declare const _default: react.Provider<Partial<{
     defly: Promise<BaseClient | null>;
     exodus: Promise<BaseClient | null>;
     walletconnect: Promise<BaseClient | null>;
+    mnemonic: Promise<BaseClient | null>;
 }> | null>;
 
-declare type ClientOptions$5 = {
+declare type ClientOptions$6 = {
     bridge?: string;
-    deep_link?: string;
-    app_meta?: {
-        logo: string;
-        name: string;
-        main_color: string;
-    };
     shouldShowSignTxnToast?: boolean;
+    chainId?: 416001 | 416002 | 416003 | 4160;
 };
-interface PeraTransaction {
-    txn: Transaction;
-    /**
-     * Optional list of addresses that must sign the transactions.
-     * Wallet skips to sign this txn if signers is empty array.
-     * If undefined, wallet tries to sign it.
-     */
-    signers?: string[];
-}
 declare type PeraWalletClientConstructor = {
     metadata: Metadata;
     client: PeraWalletConnect;
@@ -268,8 +247,8 @@ declare type PeraWalletClientConstructor = {
     algodClient: _algosdk.Algodv2;
     network: Network;
 };
-declare type InitParams$6 = {
-    clientOptions?: ClientOptions$5;
+declare type InitParams$7 = {
+    clientOptions?: ClientOptions$6;
     algodOptions?: AlgodClientOptions;
     clientStatic?: typeof PeraWalletConnect;
     algosdkStatic?: typeof _algosdk;
@@ -286,7 +265,7 @@ declare class PeraWalletClient extends BaseClient {
         icon: string;
         isWalletConnect: boolean;
     };
-    static init({ clientOptions, algodOptions, clientStatic, algosdkStatic, network, }: InitParams$6): Promise<PeraWalletClient | null>;
+    static init({ clientOptions, algodOptions, clientStatic, algosdkStatic, network, }: InitParams$7): Promise<PeraWalletClient | null>;
     connect(onDisconnect: () => void): Promise<Wallet>;
     reconnect(onDisconnect: () => void): Promise<{
         accounts: {
@@ -301,10 +280,6 @@ declare class PeraWalletClient extends BaseClient {
     } | null>;
     disconnect(): Promise<void>;
     signTransactions(connectedAccounts: string[], transactions: Uint8Array[], indexesToSign?: number[], returnGroup?: boolean): Promise<Uint8Array[]>;
-    /** @deprecated */
-    formatTransactionsArray(transactions: TransactionsArray): PeraTransaction[];
-    /** @deprecated */
-    signEncodedTransactions(transactions: TransactionsArray): Promise<Uint8Array[]>;
 }
 
 /**
@@ -319,11 +294,11 @@ declare type MyAlgoWalletClientConstructor = {
     algodClient: _algosdk.Algodv2;
     network: Network;
 };
-declare type ClientOptions$4 = {
+declare type ClientOptions$5 = {
     disableLedgerNano: boolean;
 };
-declare type InitParams$5 = {
-    clientOptions?: ClientOptions$4;
+declare type InitParams$6 = {
+    clientOptions?: ClientOptions$5;
     algodOptions?: AlgodClientOptions;
     clientStatic?: typeof _MyAlgoConnect;
     algosdkStatic?: typeof _algosdk;
@@ -345,7 +320,7 @@ declare class MyAlgoWalletClient extends BaseClient {
         icon: string;
         isWalletConnect: boolean;
     };
-    static init({ clientOptions, algodOptions, clientStatic, algosdkStatic, network, }: InitParams$5): Promise<MyAlgoWalletClient | null>;
+    static init({ clientOptions, algodOptions, clientStatic, algosdkStatic, network, }: InitParams$6): Promise<MyAlgoWalletClient | null>;
     connect(): Promise<{
         accounts: {
             providerId: PROVIDER_ID;
@@ -360,11 +335,9 @@ declare class MyAlgoWalletClient extends BaseClient {
     reconnect(): Promise<null>;
     disconnect(): Promise<void>;
     signTransactions(connectedAccounts: string[], transactions: Uint8Array[], indexesToSign?: number[], returnGroup?: boolean): Promise<Uint8Array[]>;
-    /** @deprecated */
-    signEncodedTransactions(transactions: TransactionsArray): Promise<Uint8Array[]>;
 }
 
-declare type ClientOptions$3 = {
+declare type ClientOptions$4 = {
     bridge?: string;
     deep_link?: string;
     app_meta?: {
@@ -374,15 +347,6 @@ declare type ClientOptions$3 = {
     };
     shouldShowSignTxnToast?: boolean;
 };
-declare type DeflyTransaction = {
-    txn: Transaction;
-    /**
-     * Optional list of addresses that must sign the transactions.
-     * Wallet skips to sign this txn if signers is empty array.
-     * If undefined, wallet tries to sign it.
-     */
-    signers?: string[];
-};
 declare type DeflyWalletClientConstructor = {
     metadata: Metadata;
     client: DeflyWalletConnect;
@@ -390,8 +354,8 @@ declare type DeflyWalletClientConstructor = {
     algodClient: _algosdk.Algodv2;
     network: Network;
 };
-declare type InitParams$4 = {
-    clientOptions?: ClientOptions$3;
+declare type InitParams$5 = {
+    clientOptions?: ClientOptions$4;
     algodOptions?: AlgodClientOptions;
     clientStatic?: typeof DeflyWalletConnect;
     algosdkStatic?: typeof _algosdk;
@@ -408,7 +372,7 @@ declare class DeflyWalletClient extends BaseClient {
         icon: string;
         isWalletConnect: boolean;
     };
-    static init({ clientOptions, algodOptions, clientStatic, algosdkStatic, network, }: InitParams$4): Promise<DeflyWalletClient | null>;
+    static init({ clientOptions, algodOptions, clientStatic, algosdkStatic, network, }: InitParams$5): Promise<DeflyWalletClient | null>;
     connect(onDisconnect: () => void): Promise<Wallet>;
     reconnect(onDisconnect: () => void): Promise<{
         accounts: {
@@ -423,13 +387,9 @@ declare class DeflyWalletClient extends BaseClient {
     } | null>;
     disconnect(): Promise<void>;
     signTransactions(connectedAccounts: string[], transactions: Uint8Array[], indexesToSign?: number[], returnGroup?: boolean): Promise<Uint8Array[]>;
-    /** @deprecated */
-    signEncodedTransactions(transactions: TransactionsArray): Promise<Uint8Array[]>;
-    /** @deprecated */
-    formatTransactionsArray(transactions: TransactionsArray): DeflyTransaction[];
 }
 
-declare type ClientOptions$2 = {
+declare type ClientOptions$3 = {
     onlyIfTrusted: boolean;
 };
 declare type Bytes = Readonly<Uint8Array>;
@@ -456,8 +416,8 @@ declare type ExodusClientConstructor = {
     onlyIfTrusted: boolean;
     network: Network;
 };
-declare type InitParams$3 = {
-    clientOptions?: ClientOptions$2;
+declare type InitParams$4 = {
+    clientOptions?: ClientOptions$3;
     algodOptions?: AlgodClientOptions;
     algosdkStatic?: typeof _algosdk;
     network?: Network;
@@ -473,7 +433,7 @@ declare class ExodusClient extends BaseClient {
         icon: string;
         isWalletConnect: boolean;
     };
-    static init({ clientOptions, algodOptions, algosdkStatic, network, }: InitParams$3): Promise<ExodusClient | null>;
+    static init({ clientOptions, algodOptions, algosdkStatic, network, }: InitParams$4): Promise<ExodusClient | null>;
     connect(): Promise<{
         accounts: {
             name: string;
@@ -488,8 +448,6 @@ declare class ExodusClient extends BaseClient {
     reconnect(onDisconnect: () => void): Promise<null>;
     disconnect(): Promise<void>;
     signTransactions(connectedAccounts: string[], transactions: Array<Uint8Array>, indexesToSign?: number[], returnGroup?: boolean): Promise<Uint8Array[]>;
-    /** @deprecated */
-    signEncodedTransactions(transactions: TransactionsArray): Promise<Uint8Array[]>;
 }
 
 declare type AlgoSignerTransaction = {
@@ -522,7 +480,7 @@ declare type AlgoSignerClientConstructor = {
     algodClient: _algosdk.Algodv2;
     network: SupportedLedgers;
 };
-declare type InitParams$2 = {
+declare type InitParams$3 = {
     algodOptions?: AlgodClientOptions;
     algosdkStatic?: typeof _algosdk;
     network?: Network;
@@ -538,7 +496,7 @@ declare class AlgoSignerClient extends BaseClient {
         icon: string;
         isWalletConnect: boolean;
     };
-    static init({ algodOptions, algosdkStatic, network, }: InitParams$2): Promise<AlgoSignerClient | null>;
+    static init({ algodOptions, algosdkStatic, network, }: InitParams$3): Promise<AlgoSignerClient | null>;
     connect(): Promise<{
         accounts: {
             name: string;
@@ -553,10 +511,6 @@ declare class AlgoSignerClient extends BaseClient {
     reconnect(onDisconnect: () => void): Promise<null>;
     disconnect(): Promise<void>;
     signTransactions(connectedAccounts: string[], transactions: Uint8Array[], indexesToSign?: number[], returnGroup?: boolean): Promise<Uint8Array[]>;
-    /** @deprecated */
-    formatTransactionsArray(transactions: TransactionsArray): AlgoSignerTransaction[];
-    /** @deprecated */
-    signEncodedTransactions(transactions: TransactionsArray): Promise<Uint8Array[]>;
 }
 
 interface IClientMeta {
@@ -582,7 +536,7 @@ interface IWalletConnectSession {
         close: () => void;
     };
 }
-declare type ClientOptions$1 = {
+declare type ClientOptions$2 = {
     bridge?: string;
     uri?: string;
     storageId?: string;
@@ -590,13 +544,8 @@ declare type ClientOptions$1 = {
     session?: IWalletConnectSession;
     clientMeta?: IClientMeta;
 };
-declare type WalletConnectTransaction = {
-    txn: string;
-    message?: string;
-    signers?: string[] | [];
-};
-declare type InitParams$1 = {
-    clientOptions?: ClientOptions$1;
+declare type InitParams$2 = {
+    clientOptions?: ClientOptions$2;
     algodOptions?: AlgodClientOptions;
     clientStatic?: typeof WalletConnect;
     modalStatic?: typeof QRCodeModal;
@@ -621,7 +570,7 @@ declare class WalletConnectClient extends BaseClient {
         icon: string;
         isWalletConnect: boolean;
     };
-    static init({ clientOptions, algodOptions, clientStatic, modalStatic, algosdkStatic, network, }: InitParams$1): Promise<WalletConnectClient | null>;
+    static init({ clientOptions, algodOptions, clientStatic, modalStatic, algosdkStatic, network, }: InitParams$2): Promise<WalletConnectClient | null>;
     connect(): Promise<Wallet>;
     reconnect(): Promise<{
         accounts: {
@@ -637,13 +586,9 @@ declare class WalletConnectClient extends BaseClient {
     check(): boolean;
     disconnect(): Promise<void>;
     signTransactions(connectedAccounts: string[], transactions: Uint8Array[], indexesToSign?: number[], returnGroup?: boolean): Promise<Uint8Array[]>;
-    /** @deprecarted */
-    formatTransactionsArray(transactions: TransactionsArray): WalletConnectTransaction[];
-    /** @deprecated */
-    signEncodedTransactions(transactions: TransactionsArray): Promise<Uint8Array[]>;
 }
 
-declare type ClientOptions = {
+declare type ClientOptions$1 = {
     wallet: string;
     password: string;
     host: string;
@@ -660,8 +605,8 @@ declare type KMDWalletClientConstructor = {
     password: string;
     network: Network;
 };
-declare type InitParams = {
-    clientOptions?: ClientOptions;
+declare type InitParams$1 = {
+    clientOptions?: ClientOptions$1;
     algodOptions?: AlgodClientOptions;
     algosdkStatic?: typeof _algosdk;
     network?: Network;
@@ -679,7 +624,7 @@ declare class KMDWalletClient extends BaseClient {
         icon: string;
         isWalletConnect: boolean;
     };
-    static init({ clientOptions, algodOptions, algosdkStatic, network, }: InitParams): Promise<KMDWalletClient | null>;
+    static init({ clientOptions, algodOptions, algosdkStatic, network, }: InitParams$1): Promise<KMDWalletClient | null>;
     connect(): Promise<Wallet>;
     disconnect(): Promise<void>;
     reconnect(): Promise<Wallet | null>;
@@ -688,8 +633,49 @@ declare class KMDWalletClient extends BaseClient {
     releaseToken(token: string): Promise<void>;
     listWallets(): Promise<Record<string, string>>;
     listAccounts(wallet: string, password: string): Promise<Array<Account>>;
+    getWalletId(): Promise<string>;
+    signTransactions(connectedAccounts: string[], transactions: Uint8Array[], indexesToSign?: number[], returnGroup?: boolean): Promise<Uint8Array[]>;
+}
+
+declare type ClientOptions = {
+    wallet: string;
+    password: string;
+    host: string;
+    token: string;
+    port: string;
+};
+declare type MnemonicWalletClientConstructor = {
+    metadata: Metadata;
+    id: PROVIDER_ID;
+    algosdk: typeof _algosdk;
+    algodClient: _algosdk.Algodv2;
+    network: Network;
+};
+declare type InitParams = {
+    clientOptions?: ClientOptions;
+    algodOptions?: AlgodClientOptions;
+    algosdkStatic?: typeof _algosdk;
+    network?: Network;
+};
+
+declare class MnemonicWalletClient extends BaseClient {
+    #private;
+    id: PROVIDER_ID;
+    network: Network;
+    constructor({ metadata, id, algosdk, algodClient, network, }: MnemonicWalletClientConstructor);
+    static metadata: {
+        id: PROVIDER_ID;
+        name: string;
+        icon: string;
+        isWalletConnect: boolean;
+    };
+    static init({ algodOptions, algosdkStatic, network, }: InitParams): Promise<MnemonicWalletClient | null>;
+    connect(): Promise<Wallet>;
+    disconnect(): Promise<void>;
+    reconnect(): Promise<Wallet | null>;
+    requestPassword(): Promise<string>;
     signTransactions(connectedAccounts: string[], transactions: Uint8Array[], indexesToSign?: number[], returnGroup?: boolean): Promise<Uint8Array[]>;
     signEncodedTransactions(transactions: TransactionsArray): Promise<Uint8Array[]>;
 }
 
-export { Account, AccountInfo, AlgodClientOptions, Asset, ConfirmedTxn, DEFAULT_NETWORK, DEFAULT_NODE_BASEURL, DEFAULT_NODE_PORT, DEFAULT_NODE_TOKEN, DecodedSignedTransaction, DecodedTransaction, Metadata, Network, PROVIDER_ID, Provider, TransactionsArray, Txn, TxnInfo, TxnType, Wallet, WalletClient, _default as WalletProvider, AlgoSignerClient as algosigner, DeflyWalletClient as defly, ExodusClient as exodus, initializeProviders, KMDWalletClient as kmd, MyAlgoWalletClient as myalgo, PeraWalletClient as pera, reconnectProviders, useWallet, WalletConnectClient as walletconnect };
+export { Account, AccountInfo, AlgodClientOptions, Asset, ConfirmedTxn, DEFAULT_NETWORK, DEFAULT_NODE_BASEURL, DEFAULT_NODE_PORT, DEFAULT_NODE_TOKEN, DecodedSignedTransaction, DecodedTransaction, Metadata, Network, PROVIDER_ID, Provider, TransactionsArray, Txn, TxnInfo, TxnType, Wallet, WalletClient, _default as WalletProvider, AlgoSignerClient as algosigner, DeflyWalletClient as defly, encodeNFDTransactionsArray, ExodusClient as exodus, initializeProviders, KMDWalletClient as kmd, MnemonicWalletClient as mnemonic, MyAlgoWalletClient as myalgo, PeraWalletClient as pera, reconnectProviders, useWallet, WalletConnectClient as walletconnect };

package/package.json

@@ -12,7 +12,7 @@
     "url": "https://github.com/txnlab/use-wallet/issues"
   },
   "homepage": "https://txnlab.github.io/use-wallet",
-  "version": "1.1.6",
+  "version": "1.2.1",
   "description": "React hooks for using Algorand compatible wallets in dApps.",
   "scripts": {
     "dev": "yarn storybook",
@@ -33,7 +33,7 @@
     "@blockshake/defly-connect": "^1.0.0",
     "@json-rpc-tools/utils": "^1.7.6",
     "@mdx-js/react": "^2.1.2",
-    "@perawallet/connect": "^1.0.7",
+    "@perawallet/connect": "^1.1.0",
     "@randlabs/myalgo-connect": "^1.4.2",
     "@rollup/plugin-commonjs": "^23.0.2",
     "@rollup/plugin-json": "^5.0.1",
@@ -79,7 +79,7 @@
   "peerDependencies": {
     "@blockshake/defly-connect": "^1.0.0",
     "@json-rpc-tools/utils": "^1.7.6",
-    "@perawallet/connect": "^1.0.7",
+    "@perawallet/connect": "^1.1.0",
     "@randlabs/myalgo-connect": "^1.4.2",
     "@walletconnect/client": "^1.8.0",
     "algorand-walletconnect-qrcode-modal": "^1.8.0",