TConnectEtherlinkProvider

Configure and use TConnectEtherlinkProvider

The TConnectEtherlinkProvider class is a provider implementation that requires specific configuration options passed to its constructor during instantiation. Note that the bridgeUrl parameter must always be set to "https://tconnect.io", as this is the hosted location of the bridge.

Here’s the full definition of the TConnectEtherlinkProviderOptions interface:

// Interface definition for TConnectEtherlinkProviderOptions
interface TConnectEtherlinkProviderOptions {
  // The name of your application.
  appName: string;
  // The URL linking to your application's website or homepage.
  appUrl: string;
  // (Optional) A URL pointing to an icon that represents your application.
  appIcon?: string;
  // The URL of the bridge server used for communication.
  bridgeUrl: string;
  // The API key required for authentication and access to the provider's services.
  apiKey: string;
  // The Network you will connected to
  // Default: Ghostnet
  network: EtherlinkNetwork;
  // (Optional) The wallet application, represented by the `EtherlinkWalletApp` type.
  walletApp?: EtherlinkWalletApp;
}

Understanding the walletApp Parameter

The walletApp parameter is optional and specifies the wallet application the user intends to connect to. This parameter uses the EtherlinkWalletApp type, which represents supported wallet applications. Providing this parameter allows the provider to optimize and streamline the connection process for the specified wallet.

If the walletApp parameter is omitted, the provider will attempt to connect to any available wallet. In such cases, the connection is established via a connection string provided by the bridge. (See more details here.)

Example of initializing the TConnectEtherlinkProvider

// Import provider
import { EtherlinkWalletApp,  } from '@tconnect.io/etherlink-provider';
import { TConnectEtherlinkProvider } from '@tconnect.io/etherlink-provider';

const app: EtherlinkWalletApp = 'metaMask';
// Initialize provider
const provider = new TConnectEtherlinkProvider({
	appName: 'Example App',
	appUrl: 'https://your-domain.io',
	bridgeUrl: 'https://tconnect.io',
	apiKey: 'PRIVATE_API_KEY',
	walletApp: app,
	network: 'ghostnet',
});

This function demonstrates how to connect to the wallet using the initialized provider and handle potential errors:

async function myAsyncFunction() {
  try {
    // Connect to wallet
    await provider.connect();
  } catch (error) {
    console.error("Error connecting to wallet:", error);
  }
}