Skip to content

SdkLike.recover ​

ts
recover(invite: InviteCodeLike): Promise<RecoveryHandle>

Joins a federation again and restores its funds from the seed.

Parameters

NameTypeDescription
inviteInviteCodeLikeThe invite code of the federation to restore from the seed.

Returns. RecoveryHandle. An object with the federation handle and an operation that reports the progress of the recovery.

Throws. AlreadyJoined, FederationUnreachable, Timeout, UnsupportedFederation, Storage, FederationClosed. Each code has the caveat that the wallet may already have joined.

Example

example.ts
ts
import type { InviteCodeLike, SdkLike } from '@fedimint/react-native'

declare const sdk: SdkLike
declare const invite: InviteCodeLike

const { progress } = await sdk.recover(invite) 
console.log((await progress.awaitFinal()).tag)

Used in. Restore, step 03