@multiplechain/solana-walletconnect

This package provides an adapter to enable Solana DApps to connect to WalletConnect.

Install

npm i @multiplechain/solana-walletconnect
# yarn add @multiplechain/solana-walletconnect

Demo

import { WalletConnectAdapter } from '@multiplechain/solana-walletconnect';

const adapter = new WalletConnectAdapter({
    network: 'devnet',
    options: {
        relayUrl: 'wss://relay.walletconnect.com',
        // example walletconnect app project ID
        projectId: 'project id',
        metadata: {
            name: 'Example App',
            description: 'Example App',
            url: 'https://yourdapp-url.com',
            icons: ['https://yourdapp-url.com/icon.png'],
        },
    }
});
// connect
await adapter.connect();

// then you can get address
console.log(adapter.address);

Documentation

API

• Constructor(config: WalletConnectAdapterConfig)

  interface WalletConnectAdapterConfig {
      /**
       * Network to use
       */
      network: 'mainnet-beta' | 'devnet' | 'testnet';
      /**
       * Options passed to WalletConnect client
       */
      options: {
          projectId: '<YOUR PROJECT ID>';
          // optional parameters
          relayUrl: '<YOUR RELAY URL>';
          metadata: {
              name: 'Wallet name';
              description: 'A short description for your wallet';
              url: "<YOUR WALLET'S URL>";
              icons: ["<URL TO WALLET'S LOGO/ICON>"];
          };
          qrcodeModalOptions?: {
              mobileLinks?: string[];
              desktopLinks?: string[];
              // optional parameters
          };
      };
  }

  More detail about WalletConnect client options please refer to the WalletConnect document.