@txnlab/use-wallet 0.1.23 → 1.0.0

package/README.md

@@ -12,7 +12,6 @@ React hooks for using Algorand compatible wallets with web applications.
 - [WalletConnect](https://walletconnect.com)
 - [KMD](https://developer.algorand.org/docs/rest-apis/kmd)
 
-
 ## Demo
 
 Preview a basic implementation in [Storybook](https://txnlab.github.io/use-wallet) or check out [this example](https://github.com/gabrielkuettel/use-wallet-example).
@@ -45,64 +44,106 @@ Install peer dependencies (if needed)
 npm install algosdk @blockshake/defly-connect @perawallet/connect @randlabs/myalgo-connect @walletconnect/client algorand-walletconnect-qrcode-modal @json-rpc-tools/utils
 ```
 
-### Set up the wallet providers
+### Set up the Wallet Provider
+
+In `app.js`, initialize the Wallet Provider so that the `useWallet` hook can be used in the child components, and use the `reconnectProviders` function to restore sessions for users returning to the app. 
+
 
 ```jsx
 import React from "react";
-import { useConnectWallet } from "@txnlab/use-wallet";
+import {
+  reconnectProviders,
+  initializeProviders,
+  WalletProvider,
+} from "@txnlab/use-wallet";
 
-function App() {
-  const { providers, reconnectProviders, accounts, activeAccount } = useConnectWallet();
+const walletProviders = initializeProviders();
 
+export default function App() {
   // Reconnect the session when the user returns to the dApp
   React.useEffect(() => {
-    reconnectProviders();
+    reconnectProviders(walletProviders);
   }, []);
 
-  // Use these properties to display connected accounts to users.
-  // They are reactive and presisted to local storage.
-  React.useEffect(() => {
-    console.log("connected accounts", accounts);
-    console.log("active account", activeAccount);
-  });
+  return (
+    <WalletProvider value={walletProviders}>
+      ...
+    </WalletProvider>);
+}
+```
+
+The `reconnectProviders` function is used to restore session states of wallets that rely on the `WalletConnect` protocol.
+
+By default, all of the supported providers except for `KMD` are returned by `useConnectWallet`. An array can be passed to `initializeProviders` to determine which providers your dApp supports, as shown below.
+
+```jsx
+import { initializeProviders, PROVIDER_ID } from "@txnlab/use-wallet";
+
+const walletProviders = initializeProviders([
+  PROVIDER_ID.KMD_WALLET,
+  PROVIDER_ID.WALLET_CONNECT,
+]);
+```
+
+For more configuration options, see [Provider Configuration](#provider-configuration).
+
+### Connect
+
+Map through the `providers` object to list the providers and enable users to connect. 
+
+```jsx
+import React from "react";
+import { useWallet } from "@txnlab/use-wallet";
+
+export default function Connect() {
+  const { providers, activeAccount } = useWallet();
 
   // Map through the providers.
   // Render account information and "connect", "set active", and "disconnect" buttons.
   // Finally, map through the `accounts` property to render a dropdown for each connected account.
   return (
     <div>
-      {providers.map((provider) => (
-        <div key={"provider-" + provider.id}>
+      {providers?.map((provider) => (
+        <div key={"provider-" + provider.metadata.id}>
           <h4>
-            <img width={30} height={30} src={provider.icon} />
-            {provider.name} {provider.isActive && "[active]"}
+            <img width={30} height={30} alt="" src={provider.metadata.icon} />
+            {provider.metadata.name} {provider.isActive && "[active]"}
           </h4>
           <div>
             <button onClick={provider.connect} disabled={provider.isConnected}>
               Connect
             </button>
-            <button onClick={provider.disconnect} disabled={!provider.isConnected}>
-              Disonnect
+            <button
+              onClick={provider.disconnect}
+              disabled={!provider.isConnected}
+            >
+              Disconnect
             </button>
-            <button onClick={provider.setActive} disabled={!provider.isConnected || provider.isActive}>
+            <button
+              onClick={provider.setActiveProvider}
+              disabled={!provider.isConnected || provider.isActive}
+            >
               Set Active
             </button>
-            {provider.isActive && provider.accounts.length && (
-              <select
-                value={provider.activeAccount?.address}
-                onChange={(e) => provider.selectAccount(e.target.value)}
-              >
-                {provider.accounts.map((account) => (
-                  <option value={account.address}>{account.address}</option>
-                ))}
-              </select>
-             )}
+            <div>
+              {provider.isActive && provider.accounts.length && (
+                <select
+                  value={activeAccount?.address}
+                  onChange={(e) => provider.setActiveAccount(e.target.value)}
+                >
+                  {provider.accounts.map((account) => (
+                    <option key={account.address} value={account.address}>{account.address}</option>
+                  ))}
+                </select>
+              )}
+            </div>
           </div>
         </div>
       ))}
     </div>
   );
 }
+
 ```
 
 Each provider has two connection states: `isConnected` and `isActive`.
@@ -111,30 +152,30 @@ Each provider has two connection states: `isConnected` and `isActive`.
 
 `isActive` indicates that the provider is currently active and will be used to sign and send transactions when using the `useWallet` hook.
 
-By default, all of the supported providers except for `KMD` are returned by `useConnectWallet`. A configuration object can be passed to determine which providers your dApp suports, as shown below.
-
-```jsx
-import { useConnectWallet, PROVIDER_ID } from "@txnlab/use-wallet";
-
-...
-
-const { providers } = useConnectWallet({
-  providers: [
-    PROVIDER_ID.MYALGO_WALLET,
-    PROVIDER_ID.PERA_WALLET,
-    PROVIDER_ID.KMD_WALLET,
-  ],
-});
-```
+The `activeAccount` is the primary account that is currently active and will be used to sign and send transactions.
 
 ### Sign and send transactions
 
+Construct a transaction using `algosdk`, and sign and send the transaction using the `signTransactions` and `sendTransactions` functions provided by the `useWallet` hook.
+
 ```jsx
 import React from "react";
-import { useWallet } from "@txnlab/use-wallet";
-
-function Wallet() {
-  const { activeAccount, signTransactions, sendTransactions } = useWallet();
+import {
+  useWallet,
+  DEFAULT_NODE_BASEURL,
+  DEFAULT_NODE_TOKEN,
+  DEFAULT_NODE_PORT,
+} from "@txnlab/use-wallet";
+import algosdk from "algosdk";
+
+const algodClient = new algosdk.Algodv2(
+  DEFAULT_NODE_TOKEN,
+  DEFAULT_NODE_BASEURL,
+  DEFAULT_NODE_PORT
+);
+
+export default function Transact() {
+  const { activeAddress, signTransactions, sendTransactions } = useWallet();
 
   const sendTransaction = async (
     from?: string,
@@ -145,91 +186,180 @@ function Wallet() {
       throw new Error("Missing transaction params.");
     }
 
-    const params = await algodClient.getTransactionParams().do();
+    const suggestedParams = await algodClient.getTransactionParams().do();
 
-  // Construct a transaction to be signed and sent. 
     const transaction = algosdk.makePaymentTxnWithSuggestedParamsFromObject({
       from,
       to,
       amount,
-      suggestedParams: params,
+      suggestedParams,
     });
 
-    // Encode the transactions into a byte array.
     const encodedTransaction = algosdk.encodeUnsignedTransaction(transaction);
 
-    // Sign the transactions.
     const signedTransactions = await signTransactions([encodedTransaction]);
 
-    // Send the transactions.
-    const { id } = await sendTransactions(signedTransactions);
+    const waitRoundsToConfirm = 4;
+
+    const { id } = await sendTransactions(
+      signedTransactions,
+      waitRoundsToConfirm
+    );
 
     console.log("Successfully sent transaction. Transaction ID: ", id);
   };
 
-  if (!activeAccount) {
+  if (!activeAddress) {
     return <p>Connect an account first.</p>;
   }
 
   return (
     <div>
-      {
-        <button
-          onClick={() =>
-            sendTransaction(
-              activeAccount?.address,
-              activeAccount?.address,
-              1000
-            )
-          }
-          className="button"
-        >
-          Sign and send transactions
-        </button>
-      }
+      <button
+        onClick={() => sendTransaction(activeAddress, activeAddress, 1000)}
+        className="button"
+      >
+        Sign and send transactions
+      </button>
     </div>
   );
-};
+}
 ```
 
-## Environment Variables
+### Display account details
 
-By default, wallets will connect to Algorand [MainNet](https://developer.algorand.org/docs/get-details/algorand-networks/mainnet). You can change this behavior by setting the following environment variables:
+The `activeAccount` object can be used to display details for the currently active account. For convenience, the `activeAddress` property shows the currently active address.
 
-* `NODE_NETWORK` (defaults to `mainnet`, and can be set to `testnet`, `betanet`, or the name of a local network running in dev mode)
- 
-* `NODE_SERVER`
-
-* `NODE_TOKEN` 
+```jsx
+import React from "react";
+import { useWallet } from "@txnlab/use-wallet";
 
-* `NODE_PORT`
+export default function Account() {
+  const { activeAccount } = useWallet();
 
-Example `.env` file:
+  if (!activeAccount) {
+    return <p>No account active.</p>;
+  }
 
+  return (
+    <div>
+      <h4>Active Account</h4>
+      <p>
+        Name: <span>{activeAccount.name}</span>
+      </p>
+      <p>
+        Address: <span>{activeAccount.address}</span>
+      </p>
+      <p>
+        Provider: <span>{activeAccount.providerId}</span>
+      </p>
+    </div>
+  );
+}
 ```
-NODE_NETWORK=devmodenet
-NODE_SERVER=http://algod
-NODE_TOKEN=xxxxxxxxx
-NODE_PORT=8080
+
+## Provider Configuration
+
+The `initializeProviders` functon accepts a configuration object that can be used to configure the nodes that the providers use to send transactions, as shown below.
+
+```jsx
+const walletProviders = initializeProviders([], {
+  network: "devmodenet",
+  nodeServer: "http://algod",
+  nodeToken: "xxxxxxxxx",
+  nodePort: "8080",
+});
 ```
 
-### Create React App and Next.js
+Passing an empty array as the first argument enables all of the default providers. The `network` property should be specified as `betanet`, `testnet`, `mainnet` or the name of your local development network.
+
+For more custom configuration options, the providers can be configured individually by creating an object and passing it to the `WalletProvider` where the key contains the provider ID, and the value calls the `init` function of the provider client. See below for an example:
 
-In Create React App and Next.js projects, you'll need to add a prefix to these environment variables to expose them to the browser.
+```jsx
+...
 
-* `REACT_APP_` in [Create React App](https://create-react-app.dev/docs/adding-custom-environment-variables/)
+import {
+  PROVIDER_ID,
+  pera,
+  myalgo,
+} from "@txnlab/use-wallet";
 
-* `NEXT_PUBLIC_` in [Next.js](https://nextjs.org/docs/basic-features/environment-variables#exposing-environment-variables-to-the-browser)
+const walletProviders = {
+  [PROVIDER_ID.PERA]: pera.init({
+    clientOptions: {
+      shouldShowSignTxnToast: true,
+    },
+  }),
+  [PROVIDER_ID.MYALGO]: myalgo.init({
+    network: "devmodenet",
+    algodOptions: ["xxxxxxxxx", "http://algod", "8080"],
+    clientOptions: { disableLedgerNano: true },
+  }),
+};
 
-Example `.env` file in Create React App:
+... 
 
+<WalletProvider value={walletProviders}>
+  ...
+</WalletProvider>
 ```
-REACT_APP_NODE_NETWORK=devmodenet
-REACT_APP_NODE_SERVER=http://algod
-REACT_APP_NODE_TOKEN=xxxxxxxxx
-REACT_APP_NODE_PORT=8080
+
+## Static Imports
+
+By default, `use-wallet` dynamically imports all of the dependencies for the providiers, as well as `algosdk`, to reduce bundle size. 
+
+Some React frameworks, like [Remix](https://remix.run/), do not support dynamic imports. To get around this, those dependencies can be imported in your application and passed to the `useWallet` provider. See below for an example. 
+
+```jsx
+...
+
+import algosdk from "algosdk";
+import MyAlgoConnect from "@randlabs/myalgo-connect";
+import { PeraWalletConnect } from "@perawallet/connect";
+import { DeflyWalletConnect } from "@blockshake/defly-connect";
+import WalletConnect from "@walletconnect/client";
+import QRCodeModal from "algorand-walletconnect-qrcode-modal";
+
+const walletProviders = {
+  [PROVIDER_ID.PERA]: pera.init({
+    algosdkStatic: algosdk,
+    clientStatic: PeraWalletConnect,
+  }),
+  [PROVIDER_ID.MYALGO]: myalgo.init({
+    algosdkStatic: algosdk,
+    clientStatic: MyAlgoConnect,
+  }),
+  [PROVIDER_ID.DEFLY]: defly.init({
+    algosdkStatic: algosdk,
+    clientStatic: DeflyWalletConnect,
+  }),
+  [PROVIDER_ID.EXODUS]: exodus.init({
+    algosdkStatic: algosdk,
+  }),
+  [PROVIDER_ID.ALGOSIGNER]: algosigner.init({
+    algosdkStatic: algosdk,
+  }),
+  [PROVIDER_ID.WALLETCONNECT]: walletconnect.init({
+    algosdkStatic: algosdk,
+    clientStatic: WalletConnect,
+    modalStatic: QRCodeModal,
+  }),
+};
+
+export default function App() {
+  ...
+
+  return (
+    <WalletProvider value={walletProviders}>
+      ...
+    </WalletProvider>
+  );
+}
+
 ```
 
+Note that some of the providers do not require static imports to be provided. This is usually the case of providers that are browser extensions.
+
 ## Webpack 5
 
 1. Install `react-app-rewired` and the missing polyfills.
@@ -287,16 +417,44 @@ yarn install
 ### Demo in Storybook
 
 ```bash
-yarn storybook
+yarn dev
 
 ```
 
+To develop against a local version of `use-wallet` in your application, do the following:
+
 ### Build the library
 
 ```bash
 yarn build
 ```
 
+### Symlink the library
+
+In the root of `use-wallet` directory, run:
+
+```bash
+yarn link
+```
+
+In the root of your application, run:
+```bash
+yarn link @txnlab/use-wallet
+```
+
+### Symlink React 
+
+In the root of your application, run:
+```bash
+cd node_modules/react
+yarn link
+```
+
+In the root of `use-wallet` directory, run:
+```bash
+yarn link react
+```
+
 ## License
 
 See the [LICENSE](https://github.com/TxnLab/use-wallet/blob/main/LICENSE.md) file for license rights and limitations (MIT)

package/dist/cjs/algod/index.d.ts

@@ -1,9 +1,10 @@
 import type _algosdk from "algosdk";
+import type { AlgodClientOptions } from "../types";
 export declare const getAlgosdk: () => Promise<typeof _algosdk>;
-export declare const getAlgodClient: (algosdk: typeof _algosdk) => Promise<_algosdk.Algodv2>;
+export declare const getAlgodClient: (algosdk: typeof _algosdk, algodClientOptions?: AlgodClientOptions) => Promise<_algosdk.Algodv2>;
 export default class Algod {
     algosdk: typeof _algosdk;
     algodClient: _algosdk.Algodv2;
     constructor(algosdk: typeof _algosdk, algodClient: _algosdk.Algodv2);
-    static init(): Promise<Algod>;
+    static init(algodOptions?: AlgodClientOptions): Promise<Algod>;
 }

package/dist/cjs/clients/algosigner/client.d.ts

@@ -0,0 +1,35 @@
+import BaseWallet from "../base";
+import { PROVIDER_ID } from "../../constants";
+import type { TransactionsArray, Network } from "../../types";
+import type { AlgoSignerTransaction, AlgoSignerClientConstructor, InitParams } from "./types";
+declare class AlgoSignerClient extends BaseWallet {
+    #private;
+    network: Network;
+    constructor({ client, algosdk, algodClient, network, }: AlgoSignerClientConstructor);
+    static metadata: {
+        id: PROVIDER_ID;
+        name: string;
+        icon: string;
+        isWalletConnect: boolean;
+    };
+    static init({ algodOptions, algosdkStatic, network, }: InitParams): Promise<AlgoSignerClient | null>;
+    connect(): Promise<{
+        accounts: {
+            name: string;
+            address: string;
+            providerId: PROVIDER_ID;
+        }[];
+        id: PROVIDER_ID;
+        name: string;
+        icon: string;
+        isWalletConnect: boolean;
+    }>;
+    reconnect(onDisconnect: () => void): Promise<null>;
+    disconnect(): Promise<void>;
+    signTransactions(connectedAccounts: string[], transactions: Uint8Array[]): Promise<Uint8Array[]>;
+    /** @deprecated */
+    formatTransactionsArray(transactions: TransactionsArray): AlgoSignerTransaction[];
+    /** @deprecated */
+    signEncodedTransactions(transactions: TransactionsArray): Promise<Uint8Array[]>;
+}
+export default AlgoSignerClient;

package/dist/cjs/clients/algosigner/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const ICON: string;
+export declare const DEFAULT_NETWORK = "MainNet";

package/dist/cjs/clients/algosigner/index.d.ts

@@ -0,0 +1,2 @@
+import algosigner from "./client";
+export default algosigner;

package/dist/cjs/clients/algosigner/types.d.ts

@@ -0,0 +1,40 @@
+import type _algosdk from "algosdk";
+import { PROVIDER_ID } from "../../constants";
+import type { AlgodClientOptions, Network } from "../../types";
+export declare type WindowExtended = {
+    AlgoSigner: AlgoSigner;
+} & Window & typeof globalThis;
+export declare type AlgoSignerTransaction = {
+    txn: string;
+    signers?: [];
+    multisig?: string;
+};
+export declare type SupportedLedgers = "MainNet" | "TestNet" | "BetaNet" | string;
+export declare type AlgoSigner = {
+    connect: () => Promise<Record<string, never>>;
+    accounts: (ledger: {
+        ledger: SupportedLedgers;
+    }) => Promise<{
+        address: string;
+    }[]>;
+    signTxn: (transactions: AlgoSignerTransaction[]) => Promise<{
+        txID: string;
+        blob: string;
+    }[]>;
+    encoding: {
+        msgpackToBase64(transaction: Uint8Array): string;
+        byteArrayToString(transaction: Uint8Array): string;
+    };
+};
+export declare type AlgoSignerClientConstructor = {
+    client: AlgoSigner;
+    id: PROVIDER_ID;
+    algosdk: typeof _algosdk;
+    algodClient: _algosdk.Algodv2;
+    network: SupportedLedgers;
+};
+export declare type InitParams = {
+    algodOptions?: AlgodClientOptions;
+    algosdkStatic?: typeof _algosdk;
+    network?: Network;
+};

package/dist/{esm/clients → cjs/clients/base}/base.d.ts

@@ -1,29 +1,16 @@
 import type _algosdk from "algosdk";
-import { PROVIDER_ID } from "../constants";
-import type { WalletProvider, Asset, Wallet, AccountInfo, ConfirmedTxn, TransactionsArray, TxnInfo } from "../types";
-export interface BaseWalletInterface {
-    connect(onDisconnect: () => void): Promise<Wallet>;
-    healthCheck(): Promise<Record<string, never>>;
-    disconnect(): Promise<void>;
-    reconnect(onDisconnect: () => void): Promise<Wallet | null>;
-    decodeTransaction(txn: string, isSigned: boolean): _algosdk.Transaction;
-    logEncodedTransaction(txn: string, isSigned: boolean): void;
-    groupTransactionsBySender(transactions: TransactionsArray): Record<string, TxnInfo[]>;
-    signTransactions(connectedAccounts: string[], transactions: Array<Uint8Array>): Promise<Uint8Array[]>;
-    signEncodedTransactions(transactions: TransactionsArray): Promise<Uint8Array[]>;
-    sendRawTransactions(transactions: Uint8Array[], waitRoundsToConfirm?: number): Promise<ConfirmedTxn & {
-        id: string;
-    }>;
-    getAccountInfo(address: string): Promise<AccountInfo>;
-    getAssets(address: string): Promise<Asset[]>;
-    waitForConfirmation(txId: string, timeout?: number): Promise<ConfirmedTxn>;
-}
-declare abstract class BaseWallet implements BaseWalletInterface {
+import { PROVIDER_ID } from "../../constants";
+import type { Asset, Wallet, AccountInfo, TransactionsArray } from "../../types";
+declare abstract class BaseClient {
     algosdk: typeof _algosdk;
     algodClient: _algosdk.Algodv2;
     keepWCAlive: HTMLAudioElement;
-    protected abstract id: PROVIDER_ID;
-    protected abstract provider: WalletProvider;
+    static metadata: {
+        id: PROVIDER_ID;
+        name: string;
+        icon: string;
+        isWalletConnect: boolean;
+    };
     abstract connect(onDisconnect: () => void): Promise<Wallet>;
     abstract disconnect(): Promise<void>;
     abstract reconnect(onDisconnect: () => void): Promise<Wallet | null>;
@@ -39,7 +26,7 @@ declare abstract class BaseWallet implements BaseWalletInterface {
         "pool-error": string;
         txn: {
             sig: Uint8Array;
-            txn: import("../types").Txn;
+            txn: import("../../types").Txn;
         };
         txId: string;
     }>;
@@ -52,7 +39,7 @@ declare abstract class BaseWallet implements BaseWalletInterface {
         "pool-error": string;
         txn: {
             sig: Uint8Array;
-            txn: import("../types").Txn;
+            txn: import("../../types").Txn;
         };
         txId: string;
         id: any;
@@ -60,4 +47,4 @@ declare abstract class BaseWallet implements BaseWalletInterface {
     keepWCAliveStart(): void;
     keepWCAliveStop(): void;
 }
-export default BaseWallet;
+export default BaseClient;

package/dist/cjs/clients/base/index.d.ts

@@ -0,0 +1,2 @@
+import baseClient from "./base";
+export default baseClient;

package/dist/cjs/clients/defly/client.d.ts

@@ -0,0 +1,37 @@
+import type { Wallet } from "../../types";
+import { PROVIDER_ID } from "../../constants";
+import BaseWallet from "../base";
+import { TransactionsArray } from "../../types";
+import type { Network } from "../../types";
+import { DeflyTransaction, InitParams, DeflyWalletClientConstructor } from "./types";
+declare class DeflyWalletClient extends BaseWallet {
+    #private;
+    network: Network;
+    constructor({ client, algosdk, algodClient, network, }: DeflyWalletClientConstructor);
+    static metadata: {
+        id: PROVIDER_ID;
+        name: string;
+        icon: string;
+        isWalletConnect: boolean;
+    };
+    static init({ clientOptions, algodOptions, clientStatic, algosdkStatic, network, }: InitParams): Promise<DeflyWalletClient | null>;
+    connect(onDisconnect: () => void): Promise<Wallet>;
+    reconnect(onDisconnect: () => void): Promise<{
+        accounts: {
+            name: string;
+            address: string;
+            providerId: PROVIDER_ID;
+        }[];
+        id: PROVIDER_ID;
+        name: string;
+        icon: string;
+        isWalletConnect: boolean;
+    } | null>;
+    disconnect(): Promise<void>;
+    signTransactions(connectedAccounts: string[], transactions: Uint8Array[]): Promise<Uint8Array[]>;
+    /** @deprecated */
+    signEncodedTransactions(transactions: TransactionsArray): Promise<Uint8Array[]>;
+    /** @deprecated */
+    formatTransactionsArray(transactions: TransactionsArray): DeflyTransaction[];
+}
+export default DeflyWalletClient;

package/dist/cjs/clients/defly/constants.d.ts

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

package/dist/cjs/clients/defly/index.d.ts

@@ -0,0 +1,2 @@
+import defly from "./client";
+export default defly;