# @tronweb3/tronwallet-adapter-onekey

> Wallet adapter for OneKey Extension and App wallet.

Latest version **1.2.0** (published 2026-09-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install @tronweb3/tronwallet-adapter-onekey
pnpm add @tronweb3/tronwallet-adapter-onekey
yarn add @tronweb3/tronwallet-adapter-onekey
bun add @tronweb3/tronwallet-adapter-onekey
```

## Health

**Score 70/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; recently updated; high maintenance score; high quality score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 1.2.0 |
| Published | 2026-09-04 |
| First published | 2026-03-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=16 |
| Dependencies | 2 |
| Unpacked size | 236.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 80 |
| Author | tronweb3 |
| Maintainers | troncore, tronwallet-adapter |
| Keywords | TRON, TronWeb, OneKey |

## Links

- npm: https://www.npmjs.com/package/@tronweb3/tronwallet-adapter-onekey
- Repository: https://github.com/tronweb3/tronwallet-adapter
- Homepage: https://github.com/tronweb3/tronwallet-adapter#readme
- Issues: https://github.com/tronweb3/tronwallet-adapter/issues
- npm.io page: https://npm.io/package/@tronweb3/tronwallet-adapter-onekey

## Dependencies (2)

- [@tronweb3/tronwallet-abstract-adapter](https://npm.io/package/@tronweb3/tronwallet-abstract-adapter.md) ^1.3.0
- [@tronweb3/tronwallet-adapter-tronlink](https://npm.io/package/@tronweb3/tronwallet-adapter-tronlink.md) ^1.3.0

## Recent versions

- 1.2.0 (latest) — 2026-09-04
- 1.1.0 — 2026-06-11
- 1.0.0 — 2026-03-25

## README

# `@tronweb3/tronwallet-adapter-onekey`

This package provides an adapter to enable TRON DApps to connect to the [OneKey extension](https://chrome.google.com/webstore/detail/jnmbobjmhlngoefaiojfljckilhhlhcj) and OneKey app wallet.

## Demo

```typescript
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)`

```typescript
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:

    ```typescript
    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.

```typescript
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](https://walletadapter.org/docs/index.html).

### 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`](https://github.com/tronweb3/tronwallet-adapter/tree/main/packages/adapters/adapters)

---
_Source: https://npm.io/package/@tronweb3/tronwallet-adapter-onekey · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
