SatelliteConnectProvider()

SatelliteConnectProvider(props): Element

Defined in: satellite-react/src/providers/SatelliteConnectProvider.tsx:67 

Creates the Satellite Connect store (createSatelliteConnectStore from @tuwaio/satellite-core) and provides it to its children through SatelliteStoreContext. Read it with useSatelliteConnectStore.

The store is created once, on the first render, with rememberWallet (read once: change it later with the store’s setRememberWallet). When adapter or callbackAfterConnected changes, the new value is passed to the store’s updateParameters; the state is kept. Define adapters outside the component (or memoize them), so a render does not create new adapter objects. After mount the provider calls the store’s initializeAutoConnect(autoConnect ?? false) once, which cleans the recently connected list and, with autoConnect, restores the last active wallet without a prompt (a wallet saved without rememberWallet only until the tab closes) and disconnects the other connections its adapters opened in this page. Without autoConnect it disconnects nothing, so wallets connected in other tabs or by other stores of the page stay connected. Inside Safe{Wallet} it restores the Safe connector instead, with or without autoConnect. The store’s isAutoConnectFinished turns true when this is done. Render the chain watchers (EVMConnectorsWatcher from @tuwaio/satellite-react/evm, SolanaConnectorsWatcher from @tuwaio/satellite-react/solana) inside it to follow wallet changes.

Parameters

props

SatelliteConnectProviderProps

The store parameters, autoConnect and children. See SatelliteConnectProviderProps.

Returns

Element

The context provider.

Example

'use client';
 
import { SatelliteConnectProvider } from '@tuwaio/satellite-react';
import { satelliteSolanaAdapter } from '@tuwaio/satellite-solana';
import type { ReactNode } from 'react';
 
const solanaAdapter = satelliteSolanaAdapter({ rpcUrls: { devnet: 'https://api.devnet.solana.com' } });
 
export function Providers({ children }: { children: ReactNode }) {
  return (
    <SatelliteConnectProvider
      adapter={solanaAdapter}
      autoConnect
      callbackAfterConnected={(connection) => console.log('Connected:', connection.address)}
    >
      {children}
    </SatelliteConnectProvider>
  );
}