Class AbstractClientWallet<TAdditionalOpts, TConnectParams>`Abstract`

Type Parameters

TAdditionalOpts extends Record<string, any> = {}
TConnectParams extends Record<string, any> = {}

Hierarchy

Constructors

constructor

new AbstractClientWallet<TAdditionalOpts, TConnectParams>(walletId, options?): AbstractClientWallet<TAdditionalOpts, TConnectParams>
Type Parameters
- TAdditionalOpts extends Record<string, any> = {}
- TConnectParams extends Record<string, any> = {}
Parameters
- walletId: string
- Optional options: WalletOptions<TAdditionalOpts>
Returns AbstractClientWallet<TAdditionalOpts, TConnectParams>
Overrides AbstractWallet.constructor
- Defined in packages/wallets/src/evm/wallets/base.ts:49

Properties

`Private` #connectParams

#connectParams: undefined | ConnectParams<TConnectParams>

`Protected` chains

chains: Chain[]

`Protected` dappMetadata

dappMetadata: DAppMetaData

`Protected` `Optional` options

options?: WalletOptions<TAdditionalOpts>

type

type: "evm" = "evm"

walletId

walletId: string

`Protected` walletStorage

walletStorage: AsyncStorage

`Static` meta

meta: WalletMeta

Methods

`Private` #connect

#connect(isAutoConnect, connectOptions?): Promise<string>
Parameters
- isAutoConnect: boolean
- Optional connectOptions: ConnectParams<TConnectParams>
Returns Promise<string>
- Defined in packages/wallets/src/evm/wallets/base.ts:98

`Private` #subscribeToEvents

#subscribeToEvents(connector): Promise<void>
Parameters
- connector: Connector<{}>
Returns Promise<void>
- Defined in packages/wallets/src/evm/wallets/base.ts:150

`Private` #trackConnection

#trackConnection(address): void
Parameters
- address: string
Returns void
- Defined in packages/wallets/src/evm/wallets/base.ts:140

autoConnect

autoConnect(connectOptions?): Promise<string>
tries to auto connect to the wallet
Parameters
- Optional connectOptions: ConnectParams<TConnectParams>
Returns Promise<string>
- Defined in packages/wallets/src/evm/wallets/base.ts:66

connect

connect(connectOptions?): Promise<string>
connect to the wallet
Parameters
- Optional connectOptions: ConnectParams<TConnectParams>
Returns Promise<string>
- Defined in packages/wallets/src/evm/wallets/base.ts:79

disconnect

disconnect(): Promise<void>
Returns Promise<void>
- Defined in packages/wallets/src/evm/wallets/base.ts:181

getAddress

getAddress(): Promise<string>
Returns Promise<string>
the account address from connected wallet
Inherited from AbstractWallet.getAddress
- Defined in packages/wallets/src/evm/wallets/abstract.ts:75

getBalance

getBalance(currencyAddress?): Promise<{
    decimals: number;
    displayValue: string;
    name: string;
    symbol: string;
    value: BigNumber;
}>
Parameters
- currencyAddress: string = NATIVE_TOKEN_ADDRESS
Returns Promise<{
    decimals: number;
    displayValue: string;
    name: string;
    symbol: string;
    value: BigNumber;
}>
the native token balance of the connected wallet
Inherited from AbstractWallet.getBalance
- Defined in packages/wallets/src/evm/wallets/abstract.ts:83

getChainId

getChainId(): Promise<number>
Returns Promise<number>
the chain id from connected wallet
Inherited from AbstractWallet.getChainId
- Defined in packages/wallets/src/evm/wallets/abstract.ts:106

getConnectParams

getConnectParams(): undefined | ConnectParams<TConnectParams>
Returns undefined | ConnectParams<TConnectParams>
- Defined in packages/wallets/src/evm/wallets/base.ts:90

`Protected` `Abstract` getConnector

getConnector(): Promise<Connector<TConnectParams>>
Returns Promise<Connector<TConnectParams>>
- Defined in packages/wallets/src/evm/wallets/base.ts:61

getMeta

getMeta(): WalletMeta
Returns WalletMeta
- Defined in packages/wallets/src/evm/wallets/base.ts:45

getOptions

getOptions(): undefined | WalletOptions<TAdditionalOpts>
Returns undefined | WalletOptions<TAdditionalOpts>
- Defined in packages/wallets/src/evm/wallets/base.ts:94

getPersonalWallet

getPersonalWallet(): undefined | EVMWallet
If the wallet uses a personal wallet under the hood, return it

Returns undefined | EVMWallet
- Defined in packages/wallets/src/evm/wallets/base.ts:212

getSigner

getSigner(): Promise<Signer>
Returns Promise<Signer>
Overrides AbstractWallet.getSigner
- Defined in packages/wallets/src/evm/wallets/base.ts:173

signMessage

signMessage(message): Promise<string>
Parameters
- message: string | Bytes
Returns Promise<string>
the signature of the message
Inherited from AbstractWallet.signMessage
- Defined in packages/wallets/src/evm/wallets/abstract.ts:146

switchChain

switchChain(chainId): Promise<void>
Parameters
- chainId: number
Returns Promise<void>
- Defined in packages/wallets/src/evm/wallets/base.ts:190

transfer

transfer(to, amount, currencyAddress?): Promise<Omit<TransactionResultWithMetadata<unknown>, "data">>
Parameters
- to: string
- amount: string | number
- currencyAddress: string = NATIVE_TOKEN_ADDRESS
Returns Promise<Omit<TransactionResultWithMetadata<unknown>, "data">>
Inherited from AbstractWallet.transfer
- Defined in packages/wallets/src/evm/wallets/abstract.ts:111

updateChains

updateChains(chains): Promise<void>
Parameters
- chains: Chain[]
Returns Promise<void>
- Defined in packages/wallets/src/evm/wallets/base.ts:201

verifySignature

verifySignature(message, signature, address, chainId?): Promise<boolean>
verify the signature of a message
Parameters
- message: string
- signature: string
- address: string
- Optional chainId: number
Returns Promise<boolean>
true if the signature is valid, false otherwise
Inherited from AbstractWallet.verifySignature
- Defined in packages/wallets/src/evm/wallets/abstract.ts:155

Class AbstractClientWallet<TAdditionalOpts, TConnectParams>Abstract

Type Parameters

TAdditionalOpts extends Record<string, any> = {}

TConnectParams extends Record<string, any> = {}

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

TAdditionalOpts extends Record<string, any> = {}

TConnectParams extends Record<string, any> = {}

Parameters

walletId: string

Optional options: WalletOptions<TAdditionalOpts>

Returns AbstractClientWallet<TAdditionalOpts, TConnectParams>

Properties

Private #connectParams

Protected chains

Protected dappMetadata

Protected Optional options

type

walletId

Protected walletStorage

Static meta

Methods

Private #connect

Parameters

isAutoConnect: boolean

Optional connectOptions: ConnectParams<TConnectParams>

Returns Promise<string>

Private #subscribeToEvents

Parameters

connector: Connector<{}>

Returns Promise<void>

Private #trackConnection

Parameters

address: string

Returns void

autoConnect

Parameters

Optional connectOptions: ConnectParams<TConnectParams>

Returns Promise<string>

connect

Parameters

Optional connectOptions: ConnectParams<TConnectParams>

Returns Promise<string>

disconnect

Returns Promise<void>

getAddress

Returns Promise<string>

getBalance

Parameters

currencyAddress: string = NATIVE_TOKEN_ADDRESS

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

getChainId

Returns Promise<number>

getConnectParams

Returns undefined | ConnectParams<TConnectParams>

Protected Abstract getConnector

Returns Promise<Connector<TConnectParams>>

getMeta

Returns WalletMeta

getOptions

Returns undefined | WalletOptions<TAdditionalOpts>

getPersonalWallet

Returns undefined | EVMWallet

getSigner

Returns Promise<Signer>

signMessage

Parameters

message: string | Bytes

Returns Promise<string>

switchChain

Parameters

chainId: number

Returns Promise<void>

transfer

Class AbstractClientWallet<TAdditionalOpts, TConnectParams>`Abstract`

`Optional` options: WalletOptions<TAdditionalOpts>

`Private` #connectParams

`Protected` chains

`Protected` dappMetadata

`Protected` `Optional` options

`Protected` walletStorage

`Static` meta

`Private` #connect

`Optional` connectOptions: ConnectParams<TConnectParams>

`Private` #subscribeToEvents

`Private` #trackConnection

`Optional` connectOptions: ConnectParams<TConnectParams>

`Optional` connectOptions: ConnectParams<TConnectParams>

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

`Protected` `Abstract` getConnector

`Optional` chainId: number