@tronweb3/tronwallet-adapter-imtoken

@tronweb3/tronwallet-adapter-imtoken

This package provides an adapter to enable TRON DApps to connect to the imToken Wallet App.

Demo

import { ImTokenAdapter } from '@tronweb3/tronwallet-adapter-imtoken';
import TronWeb from 'tronweb';
const tronWeb = new TronWeb({
    fullHost: 'https://api.trongrid.io',
    headers: { 'TRON-PRO-API-KEY': 'your api key' },
});

const adapter = new ImTokenAdapter();
// connect
await adapter.connect();

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

// create a send TRX transaction
const unSignedTransaction = await tronWeb.transactionBuilder.sendTrx(targetAddress, 100, adapter.address);
// using adapter to sign the transaction
const signedTransaction = await adapter.signTransaction(unSignedTransaction);
// broadcast the transaction
await tronWeb.trx.sendRawTransaction(signedTransaction);

Documentation

• Constructor(config: ImTokenAdapterConfig)

  interface ImTokenAdapterConfig {
      /**
       * Set if open Wallet's website when wallet is not installed.
       * Default is true.
       */
      openUrlWhenWalletNotFound?: boolean;
      /**
       * Timeout in millisecond for checking if ImToken wallet is supported.
       * Default is 2 * 1000ms
       * Must be a finite number between 0 and 600000 (10 minutes);
       * anything else throws at construction.
       */
      checkTimeout?: number;
      /**
       * Set if open ImToken app using DeepLink.
       * Default is true.
       */
      openAppWithDeeplink?: boolean;
  }

• network() method is supported to get current network information. The type of returned value is Network as follows:

  export enum NetworkType {
      Mainnet = 'Mainnet',
      Shasta = 'Shasta',
      Nile = 'Nile',
      /**
       * When use custom node
       */
      Unknown = 'Unknown',
  }
  
  export type Network = {
      networkType: NetworkType;
      chainId: string;
      fullNode: string;
      solidityNode: string;
      eventServer: string;
  };

Security Check

ImTokenAdapter supports an optional securityOptions field for detecting wallet risks before connect(). When enabled, the adapter fetches a remote risk configuration and calls onRiskDetected if the wallet is flagged.

const adapter = new ImTokenAdapter({
    securityOptions: {
        enabled: true,
        configUrls: ['https://your-server.com/security-config.json'],
        onRiskDetected: async ({ risks }) => {
            // Throw to block the connection, or log a warning
            throw new Error(`Wallet risk detected: ${risks[0].title}`);
        },
    },
});

For the full SecurityOptions API reference, see walletadapter.org/docs.

Caveats

• signMessage() is not supported in imToken Android App (v2.16).
• multiSign() and switchChain() are not supported in imToken App and will throw error when call them.
• imToken App will reload current page so there is no need to listen accountsChanged event.

For more information about tronwallet adapters, please refer to @tronweb3/tronwallet-adapters