Class EmbeddedWallet

Hierarchy

AbstractClientWallet<EmbeddedWalletAdditionalOptions, EmbeddedWalletConnectionArgs>
- EmbeddedWallet

Constructors

constructor

new EmbeddedWallet(options): EmbeddedWallet
Parameters
- options: EmbeddedWalletOptions
Returns EmbeddedWallet
Overrides AbstractClientWallet.constructor
- Defined in packages/wallets/src/evm/wallets/embedded-wallet.ts:68

Properties

`Private` #connectParams

#connectParams: undefined | ConnectParams<EmbeddedWalletConnectionArgs>

chain

chain: Pick<Chain, "chainId" | "rpc">

`Protected` chains

chains: Chain[]

`Optional` connector

connector?: Connector<{}>

Type declaration

`Protected` dappMetadata

dappMetadata: DAppMetaData

`Protected` `Optional` options

options?: WalletOptions<EmbeddedWalletAdditionalOptions>

type

type: "evm" = "evm"

walletId

walletId: string

`Protected` walletStorage

walletStorage: AsyncStorage

`Static` id

id: string = ...

`Static` meta

meta: {
iconURL: string;
name: string;
} = ...

Type declaration

iconURL: string
name: string

Accessors

walletName

get walletName(): "Embedded Wallet"
Returns "Embedded Wallet"
- Defined in packages/wallets/src/evm/wallets/embedded-wallet.ts:62

Methods

`Private` #connect

#connect(isAutoConnect, connectOptions?): Promise<string>
Parameters
- isAutoConnect: boolean
- Optional connectOptions: ConnectParams<EmbeddedWalletConnectionArgs>
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

authenticate

authenticate(params): Promise<AuthResult>
Parameters
- params: AuthParams
Returns Promise<AuthResult>
- Defined in packages/wallets/src/evm/wallets/embedded-wallet.ts:147

autoConnect

autoConnect(connectOptions?): Promise<string>
tries to auto connect to the wallet
Parameters
- Optional connectOptions: ConnectParams<EmbeddedWalletConnectionArgs>
Returns Promise<string>
Overrides AbstractClientWallet.autoConnect
- Defined in packages/wallets/src/evm/wallets/embedded-wallet.ts:99

connect

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

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 | ConnectParams<EmbeddedWalletConnectionArgs>
Returns undefined | ConnectParams<EmbeddedWalletConnectionArgs>
Overrides AbstractClientWallet.getConnectParams
- Defined in packages/wallets/src/evm/wallets/embedded-wallet.ts:110

`Protected` getConnector

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

getEmail

getEmail(): Promise<undefined | string>
Returns Promise<undefined | string>
- Defined in packages/wallets/src/evm/wallets/embedded-wallet.ts:126

getEmbeddedWalletSDK

getEmbeddedWalletSDK(): Promise<EmbeddedWalletSdk>
Returns Promise<EmbeddedWalletSdk>
- Defined in packages/wallets/src/evm/wallets/embedded-wallet.ts:131

getLastUsedAuthStrategy

getLastUsedAuthStrategy(): Promise<null | "iframe" | "jwt" | "email_verification" | EmbeddedWalletOauthStrategy | "iframe_email_verification">
Returns Promise<null | "iframe" | "jwt" | "email_verification" | EmbeddedWalletOauthStrategy | "iframe_email_verification">
- Defined in packages/wallets/src/evm/wallets/embedded-wallet.ts:164

getMeta

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

getOptions

getOptions(): undefined | WalletOptions<EmbeddedWalletAdditionalOptions>
Returns undefined | WalletOptions<EmbeddedWalletAdditionalOptions>
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

getRecoveryInformation

getRecoveryInformation(): Promise<AuthDetails>
Returns Promise<AuthDetails>
- Defined in packages/wallets/src/evm/wallets/embedded-wallet.ts:137

getSigner

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

sendVerificationEmail

sendVerificationEmail(__namedParameters): Promise<SendEmailOtpReturnType>
Parameters
- __namedParameters: {
  email: string;
  }
  - email: string
Returns Promise<SendEmailOtpReturnType>
- Defined in packages/wallets/src/evm/wallets/embedded-wallet.ts:142

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

`Static` sendVerificationEmail

sendVerificationEmail(options): Promise<SendEmailOtpReturnType>
Sends a verification email to the provided email address.
Parameters
- options: {
  clientId: string;
  email: string;
  }
  - clientId: string
  - email: string
Returns Promise<SendEmailOtpReturnType>
Information on the user's status and whether they are a new user.
Example
```
sendVerificationEmail({ email: 'test@example.com', clientId: 'yourClientId' })
  .then(() => console.log('Verification email sent successfully.'))
  .catch(error => console.error('Failed to send verification email:', error));
```
- Defined in packages/wallets/src/evm/wallets/embedded-wallet.ts:51

Class EmbeddedWallet

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: EmbeddedWalletOptions

Returns EmbeddedWallet

Properties

Private #connectParams

chain

Protected chains

Optional connector

Type declaration

Protected dappMetadata

Protected Optional options

type

walletId

Protected walletStorage

Static id

Static meta

Type declaration

iconURL: string

name: string

Accessors

walletName

Returns "Embedded Wallet"

Methods

Private #connect

Parameters

isAutoConnect: boolean

Optional connectOptions: ConnectParams<EmbeddedWalletConnectionArgs>

Returns Promise<string>

Private #subscribeToEvents

Parameters

connector: Connector<{}>

Returns Promise<void>

Private #trackConnection

Parameters

address: string

Returns void

authenticate

Parameters

params: AuthParams

Returns Promise<AuthResult>

autoConnect

Parameters

Optional connectOptions: ConnectParams<EmbeddedWalletConnectionArgs>

Returns Promise<string>

connect

Parameters

Optional connectOptions: ConnectParams<EmbeddedWalletConnectionArgs>

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<EmbeddedWalletConnectionArgs>

Protected getConnector

Returns Promise<Connector<{}>>

getEmail

Returns Promise<undefined | string>

getEmbeddedWalletSDK

Returns Promise<EmbeddedWalletSdk>

getLastUsedAuthStrategy

Returns Promise<null | "iframe" | "jwt" | "email_verification" | EmbeddedWalletOauthStrategy | "iframe_email_verification">

getMeta

Returns WalletMeta

getOptions

`Private` #connectParams

`Protected` chains

`Optional` connector

`Protected` dappMetadata

`Protected` `Optional` options

`Protected` walletStorage

`Static` id

`Static` meta

`Private` #connect

`Optional` connectOptions: ConnectParams<EmbeddedWalletConnectionArgs>

`Private` #subscribeToEvents

`Private` #trackConnection

`Optional` connectOptions: ConnectParams<EmbeddedWalletConnectionArgs>

`Optional` connectOptions: ConnectParams<EmbeddedWalletConnectionArgs>

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

`Protected` getConnector

__namedParameters: {
email: string;
}

`Optional` chainId: number

`Static` sendVerificationEmail

options: {
clientId: string;
email: string;
}