References
MetaMaskWallet

MetaMaskWallet

Wallet interface for connecting to MetaMask Wallet extension or mobile app.

Example


import { MetaMaskWallet } from "@thirdweb-dev/wallets";
 
async function connectMetaMask() {
  const wallet = new MetaMaskWallet();
  await wallet.connect();
}


class MetaMaskWallet extends AbstractClientWallet<MetamaskAdditionalOptions> {}

Defined in


function constructor(options: MetamaskWalletOptions): MetaMaskWallet;

Parameters

The options object contains the following properties:

clientId (recommended)

Provide clientId to use the thirdweb RPCs for given chains You can create a client ID for your application from thirdweb dashboard.

Provide clientId to use the thirdweb RPCs for given chains

You can create a client ID for your application from thirdweb dashboard .

projectId (recommended)

This is only relevant if you want to use WalletConnect for connecting to MetaMask mobile app when MetaMask is not injected.

This projectId can be obtained at cloud.walletconnect.com . It is highly recommended to use your own project id and only use the default one for testing purposes.

chains (optional)

Provide an array of chains you want to support.

Must be an array of Chain objects, from the @thirdweb-dev/chains package.

Defaults to defaultChains ( import { defaultChains } from "@thirdweb-dev/chains" )

dappMetadata (optional)

Information about your app that the wallet will display when your app tries to connect to it.

Must be an object containing name , url , and optionally description and logoUrl properties.


import { MetaMaskWallet } from "@thirdweb-dev/wallets";
 
const walletWithOptions = new MetaMaskWallet({
  dappMetadata: {
    name: "thirdweb powered dApp",
    url: "https://thirdweb.com",
    description: "thirdweb powered dApp",
    logoUrl: "https://thirdweb.com/favicon.ico",
  },
});

qrcode (optional)

Whether to display the Wallet Connect QR code Modal for connecting to MetaMask on mobile if MetaMask is not injected.

Must be a boolean . Defaults to true .

qrModalOptions

options to customize the Wallet Connect QR Code Modal ( only relevant when qrcode is true )

Type


let options: MetamaskWalletOptions;

Returns


let returnType: MetaMaskWallet;

Methods

Defined in

Connect to the MetaMask wallet using a QR code if the user does not have the Metamask extension installed.

You can use this method to display a QR code. User can scan the QR code from the MetaMask mobile app to connect to your dapp.

Example


metamask.connectWithQrCode({
  chainId: 1,
  onQrCodeUri(qrCodeUri) {
    // render the QR code with `qrCodeUri`
  },
  onConnected(accountAddress) {
    // update UI to show connected state
  },
});


function connectWithQrCode(
  options: ConnectWithQrCodeArgs,
): Promise<void>;

Parameters

The options object contains the following properties/method:

chainId (optional)

If provided, MetaMask will prompt the user to switch to the network with the given chainId after connecting.

onQrCodeUri

A callback to get the QR code URI to display to the user.

onConnected

A callback that is called when the user has connected their wallet using the QR code.

Type


let options: ConnectWithQrCodeArgs;

Returns


let returnType: Promise<void>;

Defined in

MetaMask extension on desktop supports switching accounts. This method will trigger the MetaMask extension to show the account switcher Modal


function switchAccount(): Promise<void>;

Returns


let returnType: Promise<void>;

Inherited Methods

Inherited from AbstractClientWallet.addListener


function addListener(
  event: T,
  fn: (
    ...args: ArgumentMap<WalletEvents>[Extract<T, keyof WalletEvents>]
  ) => void,
  context?: any,
): this;

Parameters

Type


let event: T;

Type


let fn: (
  ...args: ArgumentMap<WalletEvents>[Extract<T, keyof WalletEvents>]
) => void;

Type


let context: any;

Returns


let returnType: this;

Defined in

Inherited from AbstractClientWallet.autoConnect

auto-connect the wallet if possible


function autoConnect(connectOptions?: {
  chainId?: number;
}): Promise<string>;

Parameters

Type


let connectOptions: { chainId?: number };

Returns


let returnType: Promise<string>;

Defined in

Inherited from AbstractClientWallet.connect

Connect wallet


function connect(connectOptions?: {
  chainId?: number;
}): Promise<string>;

Parameters

Options for connecting to the wallet

Type


let connectOptions: { chainId?: number };

Returns


let returnType: Promise<string>;

Defined in

Inherited from AbstractClientWallet.disconnect

Disconnect the wallet


function disconnect(): Promise<void>;

Returns


let returnType: Promise<void>;

Inherited from AbstractClientWallet.emit

Calls each of the listeners registered for a given event.


function emit(
  event: T,
  ...args: ArgumentMap<WalletEvents>[Extract<T, keyof WalletEvents>]
): boolean;

Parameters

Type


let event: T;

Type


let args: ArgumentMap<WalletEvents>[Extract<T, keyof WalletEvents>];

Returns


let returnType: boolean;

Inherited from AbstractClientWallet.eventNames

Return an array listing the events for which the emitter has registered listeners.


function eventNames(): Array<keyof WalletEvents>;

Returns


let returnType: Array<keyof WalletEvents>;

Defined in

Inherited from AbstractClientWallet.getAddress

Returns the account address of the connected wallet


function getAddress(): Promise<string>;

Returns


let returnType: Promise<string>;

Defined in

Inherited from AbstractClientWallet.getBalance

Returns the balance of the connected wallet for the specified token address. If no token address is specified, it returns the balance of the native token


function getBalance(
  tokenAddress: string,
): Promise<{
  decimals: number;
  displayValue: string;
  name: string;
  symbol: string;
  value: BigNumber;
}>;

Parameters

The contract address of the token

Type


let tokenAddress: string;

Returns


let returnType: Promise<{
  decimals: number;
  displayValue: string;
  name: string;
  symbol: string;
  value: BigNumber;
}>;

Defined in

Inherited from AbstractClientWallet.getChainId

Returns the chain id of the network that the wallet is connected to


function getChainId(): Promise<number>;

Returns


let returnType: Promise<number>;

Defined in

Inherited from AbstractClientWallet.getPersonalWallet

If the wallet uses another "personal wallet" under the hood, return it

This is only useful for wallets like Safe or Smart Wallet uses a "personal wallet" under the hood to sign transactions. This method returns that wallet


function getPersonalWallet(): undefined | EVMWallet;

Returns


let returnType: undefined | EVMWallet;

Defined in

Inherited from AbstractClientWallet.getSigner

Get ethers Signer object of the connected wallet


function getSigner(): Promise<Signer>;

Returns


let returnType: Promise<Signer>;

Inherited from AbstractClientWallet.listenerCount

Return the number of listeners listening to a given event.


function listenerCount(event: keyof WalletEvents): number;

Parameters

Type


let event: keyof WalletEvents;

Returns


let returnType: number;

Inherited from AbstractClientWallet.listeners

Return the listeners registered for a given event.


function listeners(
  event: T,
): Array<
  (
    ...args: ArgumentMap<WalletEvents>[Extract<T, keyof WalletEvents>]
  ) => void
>;

Parameters

Type


let event: T;

Returns


let returnType: Array<
  (
    ...args: ArgumentMap<WalletEvents>[Extract<T, keyof WalletEvents>]
  ) => void
>;

Inherited from AbstractClientWallet.off


function off(
  event: T,
  fn?: (
    ...args: ArgumentMap<WalletEvents>[Extract<T, keyof WalletEvents>]
  ) => void,
  context?: any,
  once?: boolean,
): this;

Parameters

Type


let event: T;

Type


let fn: (
  ...args: ArgumentMap<WalletEvents>[Extract<T, keyof WalletEvents>]
) => void;

Type


let context: any;

Type


let once: boolean;

Returns


let returnType: this;

Inherited from AbstractClientWallet.on

Add a listener for a given event.


function on(
  event: T,
  fn: (
    ...args: ArgumentMap<WalletEvents>[Extract<T, keyof WalletEvents>]
  ) => void,
  context?: any,
): this;

Parameters

Type


let event: T;

Type


let fn: (
  ...args: ArgumentMap<WalletEvents>[Extract<T, keyof WalletEvents>]
) => void;

Type


let context: any;

Returns


let returnType: this;

Inherited from AbstractClientWallet.once

Add a one-time listener for a given event.


function once(
  event: T,
  fn: (
    ...args: ArgumentMap<WalletEvents>[Extract<T, keyof WalletEvents>]
  ) => void,
  context?: any,
): this;

Parameters

Type


let event: T;

Type


let fn: (
  ...args: ArgumentMap<WalletEvents>[Extract<T, keyof WalletEvents>]
) => void;

Type


let context: any;

Returns


let returnType: this;

Inherited from AbstractClientWallet.removeAllListeners

Remove all listeners, or those of the specified event.


function removeAllListeners(event?: keyof WalletEvents): this;

Parameters

Type


let event: keyof WalletEvents;

Returns


let returnType: this;

Inherited from AbstractClientWallet.removeListener

Remove the listeners of a given event.


function removeListener(
  event: T,
  fn?: (
    ...args: ArgumentMap<WalletEvents>[Extract<T, keyof WalletEvents>]
  ) => void,
  context?: any,
  once?: boolean,
): this;

Parameters

Type


let event: T;

Type


let fn: (
  ...args: ArgumentMap<WalletEvents>[Extract<T, keyof WalletEvents>]
) => void;

Type


let context: any;

Type


let once: boolean;

Returns


let returnType: this;

Defined in

Inherited from AbstractClientWallet.signMessage

Sign a message with the connected wallet and return the signature


function signMessage(message: string | Bytes): Promise<string>;

Parameters

The message to sign

Type


let message: string | Bytes;

Returns


let returnType: Promise<string>;

The signature

Defined in

Inherited from AbstractClientWallet.switchChain

Switch to different Network/Blockchain in the connected wallet


function switchChain(chainId: number): Promise<void>;

Parameters

The chainId of the network to switch to

Type


let chainId: number;

Returns


let returnType: Promise<void>;

Defined in

Inherited from AbstractClientWallet.transfer

Transfers some amount of tokens to the specified address


function transfer(
  to: string,
  amount: string | number,
  currencyAddress: string,
): Promise<Omit<TransactionResultWithMetadata<unknown>, "data">>;

Parameters

The address to transfer the amount to

Type


let to: string;

The amount to transfer

Type


let amount: string | number;

The contract address of the token to transfer. If not specified, it defaults to the native token

Type


let currencyAddress: string;

Returns


let returnType: Promise<
  Omit<TransactionResultWithMetadata<unknown>, "data">
>;

The transaction result

Defined in

Inherited from AbstractClientWallet.updateChains

Update the chains supported by the wallet. This is useful if wallet was initialized with some chains and this needs to be updated without re-initializing the wallet


function updateChains(chains: Array<Chain>): Promise<void>;

Parameters

Type


let chains: Array<Chain>;

Returns


let returnType: Promise<void>;

Defined in

Inherited from AbstractClientWallet.verifySignature

Verify the signature of a message. It returns true if the signature is valid, false otherwise


function verifySignature(
  message: string,
  signature: string,
  address: string,
  _chainId?: number,
): Promise<boolean>;

Parameters

The message to verify

Type


let message: string;

The signature to verify

Type


let signature: string;

The address to verify the signature against

Type


let address: string;

Type


let _chainId: number;

Returns


let returnType: Promise<boolean>;

Properties

Defined in


let walletId: string;


let prefixed: string | boolean;

Was this page helpful?

Need help?
Visit our support site
Watch our
Video Tutorials
View our
Changelog

Subscribe for the latest dev updates

MetaMaskWallet

Example

Signature

Constructor

Signature

Parameters

options

clientId (recommended)

projectId (recommended)

chains (optional)

dappMetadata (optional)

qrcode (optional)

qrModalOptions

Type

Returns

Return Type

Methods

connectWithQrCode

Example

Signature

Parameters

options

chainId (optional)

onQrCodeUri

onConnected

Type

Returns

Return Type

switchAccount

Signature

Returns

Return Type

Inherited Methods

addListener

Signature

Parameters

event

Type

fn

Type

context

Type

Returns

Return Type

autoConnect

Signature

Parameters

connectOptions

Type

Returns

Return Type

connect

Signature

Parameters

connectOptions

Type

Returns

Return Type

disconnect

Signature

Returns

Return Type

emit

Signature

Parameters

event

Type

args

Type

Returns

Return Type

eventNames

Signature

Returns

Return Type

getAddress

Signature

Returns

Return Type

getBalance