Appearance

Documentation / expo / EmbeddedWalletActions

Type alias: EmbeddedWalletActions ​

EmbeddedWalletActions: Object

Type declaration ​

create ​

create: (args?) => Promise<PrivyUser | null>

Create an embedded wallet for this user.

Parameters ​

• args?: CreateOrRecoverEmbeddedWalletProps

Returns ​

Promise<PrivyUser | null>

The EIP-1193 provider. If using google-drive recovery on Android, this will return null due to an Android bug with AuthSession. Use the createWalletCallbacks to handle wallet creation success in such cases.

getProvider ​

getProvider: () => Promise<PrivyUser>

Return an EIP-1193 Provider for the Privy embedded wallet.

Returns ​

Promise<PrivyUser>

PrivyEmbeddedWalletProvider the EIP-1193 provider

recover ​

recover: (args?) => Promise<PrivyUser | null>

Parameters ​

• args?: CreateOrRecoverEmbeddedWalletProps

Returns ​

Promise<PrivyUser | null>

The EIP-1193 provider. If using google-drive recovery on Android, this will return null due to an Android bug with AuthSession. Use the recoverWalletCallbacks to handle wallet creation success in such cases.

Deprecated ​

Use the useRecoverEmbeddedWallet hook instead.

Recover the user's embedded wallet

setPassword ​

setPassword: (password) => Promise<PrivyUser>

@deprecated. Use setRecovery instead. Set recovery password for a user's existing embedded wallet

Parameters ​

• password: string

Returns ​

Promise<PrivyUser>

The EIP-1193 provider.

setRecovery ​

setRecovery: (args) => Promise<PrivyUser | null>

Parameters ​

• args: SetRecoveryProps

Returns ​

Promise<PrivyUser | null>

  • Returns a Promise that resolves to an EIP-1193 provider. If using Google Drive recovery on Android, this will return null due to an Android bug with AuthSession. Use the setWalletRecoveryCallbacks to handle wallet recovery setting success in such cases.

Deprecated ​

Use the useSetEmbeddedWalletRecovery hook instead.

Sets recovery for a user's existing embedded wallet.