Class CryptoDefiWallet

Hierarchy

AbstractClientWallet<CryptoDefiWalletAdditionalOptions>
- CryptoDefiWallet

Constructors

constructor

new CryptoDefiWallet(options): CryptoDefiWallet
Parameters
- options: CryptoDefiWalletOptions
Returns CryptoDefiWallet
Overrides AbstractClientWallet.constructor
- Defined in packages/wallets/src/evm/wallets/crypto-defi-wallet.ts:53

Properties

`Private` #connectParams

#connectParams: undefined | {
chainId?: number;
}

Type declaration

Optional chainId?: number

`Optional` CryptoDefiWalletConnector

CryptoDefiWalletConnector?: CryptoDefiWalletConnector

`Protected` chains

chains: Chain[]

`Optional` connector

connector?: Connector<{}>

Type declaration

`Protected` dappMetadata

dappMetadata: DAppMetaData

isInjected

isInjected: boolean

`Protected` `Optional` options

options?: WalletOptions<CryptoDefiWalletAdditionalOptions>

type

type: "evm" = "evm"

`Optional` walletConnectConnector

walletConnectConnector?: WalletConnectConnector

walletId

walletId: string

`Protected` walletStorage

walletStorage: AsyncStorage

`Static` id

id: string = ...

`Static` meta

meta: WalletMeta

Accessors

walletName

get walletName(): "Crypto Defi wallet"
Returns "Crypto Defi wallet"
- Defined in packages/wallets/src/evm/wallets/crypto-defi-wallet.ts:49

Methods

`Private` #connect

#connect(isAutoConnect, connectOptions?): Promise<string>
Parameters
- isAutoConnect: boolean
- Optional connectOptions: {
  chainId?: number;
  }
  - Optional chainId?: number
Returns Promise<string>
Inherited from AbstractClientWallet.#connect
- Defined in packages/wallets/src/evm/wallets/base.ts:98

`Private` #subscribeToEvents

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

`Private` #trackConnection

#trackConnection(address): void
Parameters
- address: string
Returns void
Inherited from AbstractClientWallet.#trackConnection
- 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: {
  chainId?: number;
  }
  - Optional chainId?: number
Returns Promise<string>
Inherited from AbstractClientWallet.autoConnect
- Defined in packages/wallets/src/evm/wallets/base.ts:66

connect

connect(connectOptions?): Promise<string>
connect to the wallet
Parameters
- Optional connectOptions: {
  chainId?: number;
  }
  - Optional chainId?: number
Returns Promise<string>
Inherited from AbstractClientWallet.connect
- Defined in packages/wallets/src/evm/wallets/base.ts:79

connectWithQrCode

connectWithQrCode(options): Promise<void>

connect to wallet with QR code

Parameters

options: ConnectWithQrCodeArgs

Returns Promise<void>

Example

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

disconnect

disconnect(): Promise<void>
Returns Promise<void>
Inherited from AbstractClientWallet.disconnect
- 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 AbstractClientWallet.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 AbstractClientWallet.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 AbstractClientWallet.getChainId
- Defined in packages/wallets/src/evm/wallets/abstract.ts:106

getConnectParams

getConnectParams(): undefined | {
chainId?: number;
}
Returns undefined | {
chainId?: number;
}
Inherited from AbstractClientWallet.getConnectParams
- Defined in packages/wallets/src/evm/wallets/base.ts:90

`Protected` getConnector

getConnector(): Promise<Connector<{}>>
Returns Promise<Connector<{}>>
Overrides AbstractClientWallet.getConnector
- Defined in packages/wallets/src/evm/wallets/crypto-defi-wallet.ts:58

getMeta

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

getOptions

getOptions(): undefined | WalletOptions<CryptoDefiWalletAdditionalOptions>
Returns undefined | WalletOptions<CryptoDefiWalletAdditionalOptions>
Inherited from AbstractClientWallet.getOptions
- 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
Inherited from AbstractClientWallet.getPersonalWallet
- Defined in packages/wallets/src/evm/wallets/base.ts:212

getSigner

getSigner(): Promise<Signer>
Returns Promise<Signer>
Inherited from AbstractClientWallet.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 AbstractClientWallet.signMessage
- Defined in packages/wallets/src/evm/wallets/abstract.ts:146

switchChain

switchChain(chainId): Promise<void>
Parameters
- chainId: number
Returns Promise<void>
Inherited from AbstractClientWallet.switchChain
- 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 AbstractClientWallet.transfer
- Defined in packages/wallets/src/evm/wallets/abstract.ts:111

updateChains

updateChains(chains): Promise<void>
Parameters
- chains: Chain[]
Returns Promise<void>
Inherited from AbstractClientWallet.updateChains
- 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 AbstractClientWallet.verifySignature
- Defined in packages/wallets/src/evm/wallets/abstract.ts:155

Class CryptoDefiWallet

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: CryptoDefiWalletOptions

Returns CryptoDefiWallet

Properties

Private #connectParams

Type declaration

Optional chainId?: number

Optional CryptoDefiWalletConnector

Protected chains

Optional connector

Type declaration

Protected dappMetadata

isInjected

Protected Optional options

type

Optional walletConnectConnector

walletId

Protected walletStorage

Static id

Static meta

Accessors

walletName

Returns "Crypto Defi wallet"

Methods

Private #connect

Parameters

isAutoConnect: boolean

Optional connectOptions: { chainId?: number; }

Optional chainId?: number

Returns Promise<string>

Private #subscribeToEvents

Parameters

connector: Connector<{}>

Returns Promise<void>

Private #trackConnection

Parameters

address: string

Returns void

autoConnect

Parameters

Optional connectOptions: { chainId?: number; }

Optional chainId?: number

Returns Promise<string>

connect

Parameters

Optional connectOptions: { chainId?: number; }

Optional chainId?: number

Returns Promise<string>

connectWithQrCode

Parameters

options: ConnectWithQrCodeArgs

Returns Promise<void>

Example

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 | { chainId?: number; }

Protected getConnector

Returns Promise<Connector<{}>>

getMeta

Returns WalletMeta

getOptions

Returns undefined | WalletOptions<CryptoDefiWalletAdditionalOptions>

`Private` #connectParams

`Optional` chainId?: number

`Optional` CryptoDefiWalletConnector

`Protected` chains

`Optional` connector

`Protected` dappMetadata

`Protected` `Optional` options

`Optional` walletConnectConnector

`Protected` walletStorage

`Static` id

`Static` meta

`Private` #connect

`Optional` connectOptions: {
chainId?: number;
}

`Optional` chainId?: number

`Private` #subscribeToEvents

`Private` #trackConnection

`Optional` connectOptions: {
chainId?: number;
}

`Optional` chainId?: number

`Optional` connectOptions: {
chainId?: number;
}

`Optional` chainId?: number

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

Returns undefined | {
chainId?: number;
}

`Protected` getConnector

`Optional` chainId: number