PrivateKeyWallet
Wallet interface to connect using a Private Key
import { PrivateKeyWallet } from "@thirdweb-dev/wallets"; // can be any ethers.js signerconst privateKey = process.env.PRIVATE_KEY;const wallet = new PrivateKeyWallet(privateKey);
Create instance of PrivateKeyWallet
function constructor( privateKey: string, secretKey?: string,
The chain or rpc url to connect to when querying the blockchain directly through this wallet.
Provide secretKey
to use the thirdweb RPCs for given chain
You can create a secret key from thirdweb dashboard .
let secretKey: string;
Get the ethers.js signer object used by the wallet
function getSigner(): Promise<Signer>;
AbstractWallet.addListener
function addListener( event: T, fn: ( ) => void, context?: any,): this;
let fn: () => void;
AbstractWallet.emit
Calls each of the listeners registered for a given event.
function emit( event: T,): boolean;
AbstractWallet.eventNames
Return an array listing the events for which the emitter has registered listeners.
AbstractWallet.getAddress
Returns the account address of the connected wallet
function getAddress(): Promise<string>;
AbstractWallet.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;}>;
AbstractWallet.getChainId
Returns the chain id of the network that the wallet is connected to
function getChainId(): Promise<number>;
AbstractWallet.listenerCount
Return the number of listeners listening to a given event.
AbstractWallet.listeners
Return the listeners registered for a given event.
function listeners( event: T,): Array< ( ) => void>;
let returnType: Array< ( ) => void>;
AbstractWallet.off
function off( event: T, fn?: ( ) => void, context?: any, once?: boolean,): this;
let fn: () => void;
AbstractWallet.on
Add a listener for a given event.
function on( event: T, fn: ( ) => void, context?: any,): this;
let fn: () => void;
AbstractWallet.once
Add a one-time listener for a given event.
function once( event: T, fn: ( ) => void, context?: any,): this;
let fn: () => void;
AbstractWallet.removeListener
Remove the listeners of a given event.
function removeListener( event: T, fn?: ( ) => void, context?: any, once?: boolean,): this;
let fn: () => void;
AbstractWallet.signMessage
Sign a message with the connected wallet and return the signature
function signMessage(message: string | Bytes): Promise<string>;
AbstractWallet.transfer
Transfers some amount of tokens to the specified address
function transfer( to: string, amount: string | number, currencyAddress: string,): Promise<Omit<TransactionResultWithMetadata<unknown>, "data">>;
AbstractWallet.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>;