SdkLike.join

join(invite: InviteCodeLike): Promise<FederationLike>

Joins a federation.

Parameters

Name	Type	Description
invite	InviteCodeLike	The invite code of the federation to join.

Returns. FederationLike. A handle to the joined federation. The federation is saved and running.

Throws. AlreadyJoined, FederationUnreachable, Timeout, UnsupportedFederation, FederationClosed, Storage. It also returns every error of preview.

Example

example.ts

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

declare const sdk: SdkLike
declare const invite: InviteCodeLike

const fed = await sdk.join(invite) 
console.log(fed.id())

Used in. Join, step 03, Quickstart, step 02