References
LocalWallet

LocalWallet


class LocalWallet extends LocalWallet {}

Inherited from LocalWalletCore.constructor

Initialize the LocalWallet with the given options


function constructor(
  options?: WalletOptions<LocalWalletOptions>,
): LocalWallet;

Parameters

The options object contains the following properties:

clientId or secretKey (recommended)

Provide clientId or secretKey to use the thirdweb RPCs for given chains

If you are using the LocalWallet in a in frontend - provide a clientId , If you are using the LocalWallet in backend - you can provide a secretKey .

You can create a clientId / secretKey from thirdweb dashboard .

chain (optional)

Must be a Chain object, from the @thirdweb-dev/chains package. Defaults to Ethereum .

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 our default chains .

storage (optional)

This is the default storage for storing the private key, mnemonic or encrypted JSON. This can be implemented in any way you want, as long as it conforms to the AsyncStorage interface:

If omitted, defaults to browser local storage.


import { LocalWallet } from "@thirdweb-dev/wallets";
 
const customStorage = {
  getItem: (key) => {
    // Implement your own storage logic here
  },
  removeItem: (key) => {
    // Implement your own storage logic here
  },
  setItem: (key, value) => {
    // Implement your own storage logic here
  },
};
 
const walletWithOptions = new LocalWallet({
  storage: customStorage,
});

Type


let options: WalletOptions<LocalWalletOptions>;

Returns


let returnType: LocalWallet;

Methods

Defined in


function generate(): Promise<string>;

Returns


let returnType: Promise<string>;

Defined in


function getMeta(): { iconURL: string; name: string };

Returns


let returnType: { iconURL: string; name: string };

Inherited Methods

Inherited from LocalWalletCore.addListener


function addListener<T extends keyof WalletEvents>(
  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 LocalWalletCore.emit

Calls each of the listeners registered for a given event.


function emit<T extends keyof WalletEvents>(
  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 LocalWalletCore.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>;

Inherited from LocalWalletCore.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 LocalWalletCore.listeners

Return the listeners registered for a given event.


function listeners<T extends keyof WalletEvents>(
  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 LocalWalletCore.off


function off<T extends keyof WalletEvents>(
  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 LocalWalletCore.on

Add a listener for a given event.


function on<T extends keyof WalletEvents>(
  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 LocalWalletCore.once

Add a one-time listener for a given event.


function once<T extends keyof WalletEvents>(
  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 LocalWalletCore.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 LocalWalletCore.removeListener

Remove the listeners of a given event.


function removeListener<T extends keyof WalletEvents>(
  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;

Properties

Defined in


let meta: { iconURL: string; name: string };


type iconURL = string;


type name = 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

LocalWallet

Signature

Constructor

Signature

Parameters

options

clientId or secretKey (recommended)

chain (optional)

chains (optional)

storage (optional)

Type

Returns

Return Type

Methods

generate

Signature

Returns

Return Type

getMeta

Signature

Returns

Return Type

Inherited Methods

addListener

Signature

Parameters

event

Type

fn

Type

context

Type

Returns

Return Type

emit

Signature

Parameters

event

Type

args

Type

Returns

Return Type

eventNames

Signature

Returns

Return Type

listenerCount

Signature

Parameters

event

Type

Returns

Return Type

listeners

Signature

Parameters

event

Type

Returns

Return Type

off

Signature

Parameters

event

Type

fn

Type

context

Type

once

Type

Returns

Return Type

on

Signature

Parameters

event

Type

fn