@aptos-labs/wallet-adapter-react 2.0.0 → 2.1.1

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @aptos-labs/wallet-adapter-react
 
+## 2.1.1
+
+### Patch Changes
+
+- 6266a29: Consolidate options argument on signAndSubmitTransaction
+- Updated dependencies [6266a29]
+  - @aptos-labs/wallet-adapter-core@3.1.1
+
+## 2.1.0
+
+### Minor Changes
+
+- aa3d15a: Make sender optional when sign and submit single signer transaction
+
+### Patch Changes
+
+- Updated dependencies [6257015]
+- Updated dependencies [aa3d15a]
+  - @aptos-labs/wallet-adapter-core@3.1.0
+
 ## 2.0.0
 
 ### Major Changes

package/README.md

@@ -1,3 +1,5 @@
+> **_NOTE:_** This documentation is for Wallet Adapter `v2.0.0` and up that is fully comatible with the Aptos TypeScript SDK V2. For Wallet Adapter `v^1.*.*` refer to [this guide](./READMEV1.md)
+
 # Wallet Adapter React Provider
 
 A react provider wrapper for the Aptos Wallet Adapter
@@ -26,6 +28,7 @@ signMessage
 signTransaction
 signMessageAndVerify
 signAndSubmitBCSTransaction
+submitTransaction
 ```
 
 ### Usage
@@ -113,6 +116,13 @@ You can find it [here](../wallet-adapter-ant-design/) with instructions on how t
 
 #### Examples
 
+##### Initialize Aptos
+
+```js
+const aptosConfig = new AptosConfig({ network: Network.TESTNET });
+const aptos = new Aptos(aptosConfig);
+```
+
 ##### connect(walletName)
 
 ```js
@@ -132,61 +142,51 @@ const onConnect = async (walletName) => {
 ##### signAndSubmitTransaction(payload)
 
 ```js
-  const onSignAndSubmitTransaction = async () => {
-    const payload: Types.TransactionPayload = {
-      type: "entry_function_payload",
+const onSignAndSubmitTransaction = async () => {
+  const response = await signAndSubmitTransaction({
+    sender: account.address,
+    data: {
       function: "0x1::coin::transfer",
-      type_arguments: ["0x1::aptos_coin::AptosCoin"],
-      arguments: [account?.address, 1], // 1 is in Octas
-    };
-    const response = await signAndSubmitTransaction(payload);
-    // if you want to wait for transaction
-    try {
-      await aptosClient.waitForTransaction(response?.hash || "");
-    } catch (error) {
-      console.error(error);
-    }
-  };
+      typeArguments: ["0x1::aptos_coin::AptosCoin"],
+      functionArguments: [account.address, 1],
+    },
+  });
+  // if you want to wait for transaction
+  try {
+    await aptos.waitForTransaction({ transactionHash: response.hash });
+  } catch (error) {
+    console.error(error);
+  }
+};
 
 <button onClick={onSignAndSubmitTransaction}>
   Sign and submit transaction
-</button>
+</button>;
 ```
 
 ##### signAndSubmitBCSTransaction(payload)
 
 ```js
-   const onSignAndSubmitBCSTransaction = async () => {
-    const token = new TxnBuilderTypes.TypeTagStruct(
-      TxnBuilderTypes.StructTag.fromString("0x1::aptos_coin::AptosCoin")
-    );
-    const entryFunctionBCSPayload =
-      new TxnBuilderTypes.TransactionPayloadEntryFunction(
-        TxnBuilderTypes.EntryFunction.natural(
-          "0x1::coin",
-          "transfer",
-          [token],
-          [
-            BCS.bcsToBytes(
-              TxnBuilderTypes.AccountAddress.fromHex(account!.address)
-            ),
-            BCS.bcsSerializeUint64(2),
-          ]
-        )
-      );
-
-    const response = await signAndSubmitBCSTransaction(entryFunctionBCSPayload);
-    // if you want to wait for transaction
-    try {
-      await aptosClient.waitForTransaction(response?.hash || "");
-    } catch (error) {
-      console.error(error);
-    }
-  };
+const onSignAndSubmitBCSTransaction = async () => {
+  const response = await signAndSubmitTransaction({
+    sender: account.address,
+    data: {
+      function: "0x1::coin::transfer",
+      typeArguments: [parseTypeTag(APTOS_COIN)],
+      functionArguments: [AccountAddress.from(account.address), new U64(1)],
+    },
+  });
+  // if you want to wait for transaction
+  try {
+    await aptos.waitForTransaction({ transactionHash: response.hash });
+  } catch (error) {
+    console.error(error);
+  }
+};
 
 <button onClick={onSignAndSubmitTransaction}>
   Sign and submit BCS transaction
-</button>
+</button>;
 ```
 
 ##### signMessage(payload)
@@ -235,19 +235,17 @@ const onSignMessage = async () => {
 ##### signTransaction(payload)
 
 ```js
-  const onSignTransaction = async () => {
-    const payload: Types.TransactionPayload = {
-      type: "entry_function_payload",
-      function: "0x1::coin::transfer",
-      type_arguments: ["0x1::aptos_coin::AptosCoin"],
-      arguments: [account?.address, 1], // 1 is in Octas
-    };
-    const response = await signTransaction(payload);
+const onSignTransaction = async () => {
+  const payload = {
+    type: "entry_function_payload",
+    function: "0x1::coin::transfer",
+    type_arguments: ["0x1::aptos_coin::AptosCoin"],
+    arguments: [account?.address, 1], // 1 is in Octas
   };
+  const response = await signTransaction(payload);
+};
 
-<button onClick={onSignTransaction}>
-  Sign transaction
-</button>
+<button onClick={onSignTransaction}>Sign transaction</button>;
 ```
 
 ##### signMessageAndVerify(payload)

package/READMEV1.md

@@ -0,0 +1,267 @@
+> **_NOTE:_** This documentation is for Wallet Adapter `v^1.*.*`
+
+# Wallet Adapter React Provider
+
+A react provider wrapper for the Aptos Wallet Adapter
+
+Dapps that want to use the adapter should install this package and other supported wallet packages.
+
+### Support
+
+The react provider supports all [wallet standard](https://aptos.dev/guides/wallet-standard) functions and feature functions
+
+##### Standard functions
+
+```
+connect
+disconnect
+connected
+account
+network
+signAndSubmitTransaction
+signMessage
+```
+
+##### Feature functions - functions that may not be supported by all wallets
+
+```
+signTransaction
+signMessageAndVerify
+signAndSubmitBCSTransaction
+```
+
+### Usage
+
+#### Install Dependencies
+
+Install wallet dependencies you want to include in your app.
+To do that, you can look at our [supported wallets list](https://github.com/aptos-labs/aptos-wallet-adapter#supported-wallet-packages). Each wallet is a link to npm package where you can install it from.
+
+Next, install the `@aptos-labs/wallet-adapter-react`
+
+```
+pnpm i @aptos-labs/wallet-adapter-react
+```
+
+using npm
+
+```
+npm i @aptos-labs/wallet-adapter-react
+```
+
+#### Import dependencies
+
+On the `App.jsx` file,
+
+Import the installed wallets.
+
+```js
+import { SomeAptosWallet } from "some-aptos-wallet-package";
+```
+
+Import the `AptosWalletAdapterProvider`.
+
+```js
+import { AptosWalletAdapterProvider } from "@aptos-labs/wallet-adapter-react";
+```
+
+Wrap your app with the Provider, pass it the `plugins (wallets)` you want to have on your app as an array and a `autoConnect` option (set to false by default)
+
+```js
+const wallets = [new AptosWallet()];
+
+<AptosWalletAdapterProvider
+  plugins={wallets}
+  autoConnect={true}
+  onError={(error) => {
+    console.log("error", error);
+  }}
+>
+  <App />
+</AptosWalletAdapterProvider>;
+```
+
+#### Use Wallet
+
+On any page you want to use the wallet props, import `useWallet` from `@aptos-labs/wallet-adapter-react`
+
+```js
+import { useWallet } from "@aptos-labs/wallet-adapter-react";
+```
+
+Then you can use the exported properties
+
+```js
+const {
+  connect,
+  account,
+  network,
+  connected,
+  disconnect,
+  wallet,
+  wallets,
+  signAndSubmitTransaction,
+  signAndSubmitBCSTransaction,
+  signTransaction,
+  signMessage,
+  signMessageAndVerify,
+} = useWallet();
+```
+
+### Use a UI package (recommended)
+
+As part of the wallet adapter repo we provide a wallet connect UI package that provides a wallet connect button and a wallet select modal.
+You can find it [here](../wallet-adapter-ant-design/) with instructions on how to use it.
+
+#### Examples
+
+##### connect(walletName)
+
+```js
+const onConnect = async (walletName) => {
+  await connect(walletName);
+};
+
+<button onClick={() => onConnect(wallet.name)}>{wallet.name}</button>;
+```
+
+##### disconnect()
+
+```js
+<button onClick={disconnect}>Disconnect</button>
+```
+
+##### signAndSubmitTransaction(payload)
+
+```js
+  const onSignAndSubmitTransaction = async () => {
+    const payload: Types.TransactionPayload = {
+      type: "entry_function_payload",
+      function: "0x1::coin::transfer",
+      type_arguments: ["0x1::aptos_coin::AptosCoin"],
+      arguments: [account?.address, 1], // 1 is in Octas
+    };
+    const response = await signAndSubmitTransaction(payload);
+    // if you want to wait for transaction
+    try {
+      await aptosClient.waitForTransaction(response?.hash || "");
+    } catch (error) {
+      console.error(error);
+    }
+  };
+
+<button onClick={onSignAndSubmitTransaction}>
+  Sign and submit transaction
+</button>
+```
+
+##### signAndSubmitBCSTransaction(payload)
+
+```js
+   const onSignAndSubmitBCSTransaction = async () => {
+    const token = new TxnBuilderTypes.TypeTagStruct(
+      TxnBuilderTypes.StructTag.fromString("0x1::aptos_coin::AptosCoin")
+    );
+    const entryFunctionBCSPayload =
+      new TxnBuilderTypes.TransactionPayloadEntryFunction(
+        TxnBuilderTypes.EntryFunction.natural(
+          "0x1::coin",
+          "transfer",
+          [token],
+          [
+            BCS.bcsToBytes(
+              TxnBuilderTypes.AccountAddress.fromHex(account!.address)
+            ),
+            BCS.bcsSerializeUint64(2),
+          ]
+        )
+      );
+
+    const response = await signAndSubmitBCSTransaction(entryFunctionBCSPayload);
+    // if you want to wait for transaction
+    try {
+      await aptosClient.waitForTransaction(response?.hash || "");
+    } catch (error) {
+      console.error(error);
+    }
+  };
+
+<button onClick={onSignAndSubmitTransaction}>
+  Sign and submit BCS transaction
+</button>
+```
+
+##### signMessage(payload)
+
+```js
+const onSignMessage = async () => {
+  const payload = {
+    message: "Hello from Aptos Wallet Adapter",
+    nonce: "random_string",
+  };
+  const response = await signMessage(payload);
+};
+
+<button onClick={onSignMessage}>Sign message</button>;
+```
+
+##### Account
+
+```js
+<div>{account?.address}</div>
+<div>{account?.publicKey}</div>
+```
+
+##### Network
+
+```js
+<div>{network?.name}</div>
+```
+
+##### Wallet
+
+```js
+<div>{wallet?.name}</div>
+<div>{wallet?.icon}</div>
+<div>{wallet?.url}</div>
+```
+
+##### Wallets
+
+```js
+{
+  wallets.map((wallet) => <p>{wallet.name}</p>);
+}
+```
+
+##### signTransaction(payload)
+
+```js
+  const onSignTransaction = async () => {
+    const payload: Types.TransactionPayload = {
+      type: "entry_function_payload",
+      function: "0x1::coin::transfer",
+      type_arguments: ["0x1::aptos_coin::AptosCoin"],
+      arguments: [account?.address, 1], // 1 is in Octas
+    };
+    const response = await signTransaction(payload);
+  };
+
+<button onClick={onSignTransaction}>
+  Sign transaction
+</button>
+```
+
+##### signMessageAndVerify(payload)
+
+```js
+const onSignMessageAndVerify = async () => {
+  const payload = {
+    message: "Hello from Aptos Wallet Adapter",
+    nonce: "random_string",
+  };
+  const response = await signMessageAndVerify(payload);
+};
+
+<button onClick={onSignMessageAndVerify}>Sign message and verify</button>;
+```

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { AccountInfo, NetworkInfo, WalletName, WalletInfo, Wallet, InputGenerateTransactionData, InputGenerateTransactionOptions, AnyRawTransaction, Types, AccountAuthenticator, InputSubmitTransactionData, PendingTransactionResponse, SignMessagePayload, SignMessageResponse } from '@aptos-labs/wallet-adapter-core';
+import { AccountInfo, NetworkInfo, WalletName, WalletInfo, Wallet, InputTransactionData, AnyRawTransaction, Types, InputGenerateTransactionOptions, AccountAuthenticator, InputSubmitTransactionData, PendingTransactionResponse, SignMessagePayload, SignMessageResponse } from '@aptos-labs/wallet-adapter-core';
 export { NetworkName, Wallet, WalletName, WalletReadyState, isInAppBrowser, isMobile, isRedirectable } from '@aptos-labs/wallet-adapter-core';
 import { ReactNode, FC } from 'react';
 
@@ -11,7 +11,7 @@ interface WalletContextState {
     disconnect(): void;
     wallet: WalletInfo | null;
     wallets: ReadonlyArray<Wallet>;
-    signAndSubmitTransaction(transaction: InputGenerateTransactionData, options?: InputGenerateTransactionOptions): Promise<any>;
+    signAndSubmitTransaction(transaction: InputTransactionData): Promise<any>;
     signTransaction(transactionOrPayload: AnyRawTransaction | Types.TransactionPayload, asFeePayer?: boolean, options?: InputGenerateTransactionOptions): Promise<AccountAuthenticator>;
     submitTransaction(transaction: InputSubmitTransactionData): Promise<PendingTransactionResponse>;
     signMessage(message: SignMessagePayload): Promise<SignMessageResponse>;

package/dist/index.js

@@ -127,9 +127,9 @@ var AptosWalletAdapterProvider = ({
       return Promise.reject(error);
     }
   };
-  const signAndSubmitTransaction = async (transaction, options) => {
+  const signAndSubmitTransaction = async (transaction) => {
     try {
-      return await walletCore.signAndSubmitTransaction(transaction, options);
+      return await walletCore.signAndSubmitTransaction(transaction);
     } catch (error) {
       if (onError)
         onError(error);

package/dist/index.mjs

@@ -106,9 +106,9 @@ var AptosWalletAdapterProvider = ({
       return Promise.reject(error);
     }
   };
-  const signAndSubmitTransaction = async (transaction, options) => {
+  const signAndSubmitTransaction = async (transaction) => {
     try {
-      return await walletCore.signAndSubmitTransaction(transaction, options);
+      return await walletCore.signAndSubmitTransaction(transaction);
     } catch (error) {
       if (onError)
         onError(error);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aptos-labs/wallet-adapter-react",
-  "version": "2.0.0",
+  "version": "2.1.1",
   "description": "Aptos Wallet Adapter React Provider",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -37,7 +37,7 @@
     "@aptos-labs/wallet-adapter-tsconfig": "0.0.0"
   },
   "dependencies": {
-    "@aptos-labs/wallet-adapter-core": "3.0.0"
+    "@aptos-labs/wallet-adapter-core": "3.1.1"
   },
   "peerDependencies": {
     "react": "^18"

package/src/WalletProvider.tsx

@@ -15,13 +15,13 @@ import type {
   WalletInfo,
   InputGenerateTransactionOptions,
   AnyRawTransaction,
-  InputGenerateTransactionData,
   InputSubmitTransactionData,
   AccountAuthenticator,
   PendingTransactionResponse,
   SignMessageResponse,
   WalletName,
   Types,
+  InputTransactionData,
 } from "@aptos-labs/wallet-adapter-core";
 import { WalletCore } from "@aptos-labs/wallet-adapter-core";
 
@@ -131,11 +131,10 @@ export const AptosWalletAdapterProvider: FC<AptosWalletProviderProps> = ({
   };
 
   const signAndSubmitTransaction = async (
-    transaction: InputGenerateTransactionData,
-    options?: InputGenerateTransactionOptions
+    transaction: InputTransactionData
   ) => {
     try {
-      return await walletCore.signAndSubmitTransaction(transaction, options);
+      return await walletCore.signAndSubmitTransaction(transaction);
     } catch (error: any) {
       if (onError) onError(error);
       return Promise.reject(error);

package/src/useWallet.tsx

@@ -11,8 +11,8 @@ import {
   isRedirectable,
   isMobile,
   InputGenerateTransactionOptions,
-  InputGenerateTransactionData,
   AnyRawTransaction,
+  InputTransactionData,
   InputSubmitTransactionData,
   PendingTransactionResponse,
   AccountAuthenticator,
@@ -39,10 +39,7 @@ export interface WalletContextState {
   disconnect(): void;
   wallet: WalletInfo | null;
   wallets: ReadonlyArray<Wallet>;
-  signAndSubmitTransaction(
-    transaction: InputGenerateTransactionData,
-    options?: InputGenerateTransactionOptions
-  ): Promise<any>;
+  signAndSubmitTransaction(transaction: InputTransactionData): Promise<any>;
   signTransaction(
     transactionOrPayload: AnyRawTransaction | Types.TransactionPayload,
     asFeePayer?: boolean,