Skip to content

Documentation / expo / EmbeddedWalletActions

Type alias: EmbeddedWalletActions

EmbeddedWalletActions: Object

Type declaration

create

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

Create an embedded wallet for this user.

Parameters

args?: CreateOrRecoverEmbeddedWalletProps

Returns

Promise<OAuthProviderType | 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<OAuthProviderType>

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

Returns

Promise<OAuthProviderType>

PrivyEmbeddedWalletProvider the EIP-1193 provider

recover

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

Parameters

args?: CreateOrRecoverEmbeddedWalletProps

Returns

Promise<OAuthProviderType | 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<OAuthProviderType>

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

Parameters

password: string

Returns

Promise<OAuthProviderType>

The EIP-1193 provider.

setRecovery

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

Parameters

args: SetRecoveryProps

Returns

Promise<OAuthProviderType | 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.