@tronweb3/tronwallet-adapter-onekey

@tronweb3/tronwallet-adapter-onekey

This package provides an adapter to enable TRON DApps to connect to the OneKey extension and OneKey app wallet.

Demo

import { OneKeyAdapter } from '@tronweb3/tronwallet-adapter-onekey';

const adapter = new OneKeyAdapter();

// connect to OneKey
await adapter.connect();

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

// create a send TRX transaction
const unSignedTransaction = await window.$onekey.tron.tronWeb.transactionBuilder.sendTrx(
    targetAddress,
    100,
    adapter.address
);

// using adapter to sign the transaction
const signedTransaction = await adapter.signTransaction(unSignedTransaction);

// broadcast the transaction
await window.$onekey.tron.tronWeb.trx.sendRawTransaction(signedTransaction);

Documentation

API

• constructor(config: OneKeyAdapterConfig)

interface OneKeyAdapterConfig {
    /**
     * Set if open Wallet's website when wallet is not installed.
     * Default is true.
     */
    openUrlWhenWalletNotFound?: boolean;

    /**
     * Timeout in millisecond for checking if OneKey is supported.
     * Default is 2 * 1000ms
     * Must be a finite number between 0 and 600000 (10 minutes);
     * anything else throws at construction.
     */
    checkTimeout?: number;
}

• 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

OneKeyAdapter 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 OneKeyAdapter({
    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

• Only wallets imported by mnemonic can be used on the TRON network.
• OneKey Extension only supports Mainnet and Shasta testnet (the latter is mislabeled as "Nile testnet").
• OneKey Extension doesn't implement multiSign() and switchChain().
• OneKey Extension only supports the following events: accountsChanged, chainChanged, connect, disconnect.
• Deeplink is not supported.

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