@aptos-labs/wallet-adapter-react

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

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 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
submitTransaction

Usage

Install Dependencies

Install wallet dependencies you want to include in your app. To do that, you can look at our supported wallets list. 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.

import { SomeAptosWallet } from "some-aptos-wallet-package";

Import the AptosWalletAdapterProvider.

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)

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

import { useWallet } from "@aptos-labs/wallet-adapter-react";

Then you can use the exported properties

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 with instructions on how to use it.

Examples

Initialize Aptos

const aptosConfig = new AptosConfig({ network: Network.TESTNET });
const aptos = new Aptos(aptosConfig);

connect(walletName)

const onConnect = async (walletName) => {
  await connect(walletName);
};

<button onClick={() => onConnect(wallet.name)}>{wallet.name}</button>;

disconnect()

<button onClick={disconnect}>Disconnect</button>

signAndSubmitTransaction(payload)

const onSignAndSubmitTransaction = async () => {
  const response = await signAndSubmitTransaction({
    sender: account.address,
    data: {
      function: "0x1::coin::transfer",
      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>;

signAndSubmitBCSTransaction(payload)

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>;

signMessage(payload)

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

<div>{account?.address}</div>
<div>{account?.publicKey}</div>

Network

<div>{network?.name}</div>

Wallet

<div>{wallet?.name}</div>
<div>{wallet?.icon}</div>
<div>{wallet?.url}</div>

Wallets

{
  wallets.map((wallet) => <p>{wallet.name}</p>);
}

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>;

signMessageAndVerify(payload)

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>;