Skip to content

Commit 936cfc6

Browse files
committed
docs: update bybit README.md and okx README.md
1 parent b19bd69 commit 936cfc6

File tree

5 files changed

+22
-19
lines changed

5 files changed

+22
-19
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ tronwallet-adapter
189189
| | ├─imtoken # adapter for imToken Wallet
190190
| | ├─gatewallet # adapter for gate.io Wallet
191191
| | ├─foxwallet # adapter for FoxWallet
192-
| | ├─bybitwallet # adapter for Bybit Wallet
192+
| | ├─bybit # adapter for Bybit Wallet
193193
| ├─react
194194
| | ├─react-hooks # react hooks to manage wallet state
195195
| | ├─react-ui # react ui components to select/connect wallets
@@ -224,7 +224,7 @@ You can use the `@tronweb3/tronwallet-adapters` package, or add the individual w
224224
| [imtoken](https://token.im/) | Adapter for imToken Wallet App(IOS and Android) | [`@tronweb3/tronwallet-adapter-imtoken`](https://www.npmjs.com/package/@tronweb3/tronwallet-adapter-imtoken) |
225225
| [gatewallet](https://www.gate.io/web3) | Adapter for gate.io Wallet App(IOS and Android) | [`@tronweb3/tronwallet-adapter-gatewallet`](https://www.npmjs.com/package/@tronweb3/tronwallet-adapter-gatewallet) |
226226
| [foxwallet](https://foxwallet.com/) | Adapter for Fox Wallet App(IOS and Android) | [`@tronweb3/tronwallet-adapter-foxwallet`](https://www.npmjs.com/package/@tronweb3/tronwallet-adapter-foxwallet) |
227-
| [bybit](https://www.bybit.com/en/web3/home) | Adapter for Bybit Wallet App(IOS and Android) and extension | [`@tronweb3/tronwallet-adapter-bybit`](https://www.npmjs.com/package/@tronweb3/tronwallet-adapter-bybit) |
227+
| [bybit](https://www.bybit.com/en/web3/home) | Adapter for Bybit Wallet App(IOS and Android) and Extension | [`@tronweb3/tronwallet-adapter-bybit`](https://www.npmjs.com/package/@tronweb3/tronwallet-adapter-bybit) |
228228

229229
### React Components
230230

packages/adapters/adapters/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ As `@tronweb3/tronwallet-adapters` exports adapter of each wallet , you can use
1818
| [`@tronweb3/tronwallet-adapter-imtoken`](https://npmjs.com/package/@tronweb3/tronwallet-adapter-imtoken) | adapter for [imToken](https://token.im/) | [View](https://github.com/web3-geek/tronwallet-adapter/tree/main/packages/adapters/imtoken) |
1919
| [`@tronweb3/tronwallet-adapter-gatewallet`](https://npmjs.com/package/@tronweb3/tronwallet-adapter-gatewallet) | adapter for [gate.io](https://www.gate.io/web3) | [View](https://github.com/web3-geek/tronwallet-adapter/tree/main/packages/adapters/gatewallet) |
2020
| [`@tronweb3/tronwallet-adapter-foxwallet`](https://npmjs.com/package/@tronweb3/tronwallet-adapter-foxwallet) | adapter for [FoxWallet](https://foxwallet.com/) | [View](https://github.com/web3-geek/tronwallet-adapter/tree/main/packages/adapters/foxwallet) |
21+
| [`@tronweb3/tronwallet-adapter-bybit`](https://npmjs.com/package/@tronweb3/tronwallet-adapter-bybit) | adapter for [Bybit Wallet](https://www.bybit.com/en/web3/home) | [View](https://github.com/web3-geek/tronwallet-adapter/tree/main/packages/adapters/bybit) |
2122

2223

2324
## Usage
@@ -341,3 +342,4 @@ Other adapters `Constructor` config api can be found in their source code `READM
341342
- [ImTokenAdapter](https://github.com/web3-geek/tronwallet-adapter/tree/main/packages/adapters/imtoken)
342343
- [GateWalletAdapter](https://github.com/web3-geek/tronwallet-adapter/tree/main/packages/adapters/gatewallet)
343344
- [FoxWalletAdapter](https://github.com/web3-geek/tronwallet-adapter/tree/main/packages/adapters/foxwallet)
345+
- [BybitWalletAdapter](https://github.com/web3-geek/tronwallet-adapter/tree/main/packages/adapters/bybit)

packages/adapters/bybit/README.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,39 @@
1-
# `@tronweb3/tronwallet-adapter-okxwallet`
1+
# `@tronweb3/tronwallet-adapter-bybit`
22

3-
This package provides an adapter to enable TRON DApps to connect to the [Okx Wallet extension](https://www.okx.com/download) and [Okx Wallet App](https://www.okx.com/download).
3+
This package provides an adapter to enable TRON DApps to connect to the [Bybit Wallet extension](https://chromewebstore.google.com/detail/bybit-wallet/pdliaogehgdbhbnmkklieghmmjkpigpa) and [Bybit Wallet App](https://www.bybit.com/en/web3/home).
44

55
## Demo
66

77
```typescript
8-
import { OkxWalletAdapter } from '@tronweb3/tronwallet-adapter-okxwallet';
8+
import { BybitWalletAdapter } from '@tronweb3/tronwallet-adapter-bybit';
99

10-
const adapter = new OkxWalletAdapter();
11-
// connect to TokenPocket
10+
const adapter = new BybitWalletAdapter();
11+
// connect to Bybit
1212
await adapter.connect();
1313

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

1717
// create a send TRX transaction
18-
const unSignedTransaction = await window.okxwallet.tronLink.tronWeb.transactionBuilder.sendTrx(
18+
const unSignedTransaction = await window.bybitWallet.tronLink.tronWeb.transactionBuilder.sendTrx(
1919
targetAddress,
2020
100,
2121
adapter.address
2222
);
2323
// using adapter to sign the transaction
2424
const signedTransaction = await adapter.signTransaction(unSignedTransaction);
2525
// broadcast the transaction
26-
await window.okxwallet.tronLink.tronWeb.trx.sendRawTransaction(signedTransaction);
26+
await window.bybitWallet.tronLink.tronWeb.trx.sendRawTransaction(signedTransaction);
2727
```
2828

2929
## Documentation
3030

3131
### API
3232

33-
- `Constructor(config: OkxWalletAdapterConfig)`
33+
- `Constructor(config: BybitWalletAdapterConfig)`
3434

3535
```typescript
36-
interface OkxWalletAdapterConfig {
36+
interface BybitWalletAdapterConfig {
3737
/**
3838
* Set if open Wallet's website when wallet is not installed.
3939
* Default is true.
@@ -76,10 +76,11 @@ interface OkxWalletAdapterConfig {
7676

7777
### Caveats
7878

79-
- OkxWallet App and Extension doesn't implement `signMessage()`, `multiSign()` and `switchChain()`.
80-
- OkxWallet Extension only support these: `accountsChanged`,`connect`,`disconnect`.
81-
- OkxWallet App does not support any events.
82-
- Deeplink only works for OKX App **version 6.1.38 or later** on Android.
83-
- **OKX Wallet App on IOS does not support TRON currently**.
79+
- Bybit Wallet App and Extension doesn't implement `multiSign()` and `switchChain()`.
80+
- Bybit Wallet Extension only support these: `accountsChanged`,`connect`,`disconnect`.
81+
- Bybit Wallet App does not support any events.
82+
- Currently deeplink can only open the app but not dapp browser.
83+
- Keyless Wallet doesn't support Dapp connection.
84+
- Currently deeplink can not open App Store when app is not installed.
8485

8586
For more information about tronwallet adapters, please refer to [`@tronweb3/tronwallet-adapters`](https://github.com/web3-geek/tronwallet-adapter/tree/main/packages/adapters/adapters)

packages/adapters/bybit/jest.config.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ export default {
1111
],
1212
},
1313
moduleNameMapper: {
14+
'bignumber\\.js': '$0',
1415
'(.+)\\.js': '$1',
1516
},
1617
extensionsToTreatAsEsm: ['.ts'],

packages/adapters/okxwallet/README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# `@tronweb3/tronwallet-adapter-okxwallet`
22

3-
This package provides an adapter to enable TRON DApps to connect to the [Okx Wallet extension](https://www.okx.com/download) and [Okx Wallet App](https://www.okx.com/download).
3+
This package provides an adapter to enable TRON DApps to connect to the [Okx Wallet extension](https://chromewebstore.google.com/detail/okx-wallet/mcohilncbfahbmgdjkbpemcciiolgcge) and [Okx Wallet App](https://www.okx.com/download).
44

55
## Demo
66

77
```typescript
88
import { OkxWalletAdapter } from '@tronweb3/tronwallet-adapter-okxwallet';
99

1010
const adapter = new OkxWalletAdapter();
11-
// connect to TokenPocket
11+
// connect to OkxWallet
1212
await adapter.connect();
1313

1414
// then you can get address
@@ -80,6 +80,5 @@ interface OkxWalletAdapterConfig {
8080
- OkxWallet Extension only support these: `accountsChanged`,`connect`,`disconnect`.
8181
- OkxWallet App does not support any events.
8282
- Deeplink only works for OKX App **version 6.1.38 or later** on Android.
83-
- **OKX Wallet App on IOS does not support TRON currently**.
8483

8584
For more information about tronwallet adapters, please refer to [`@tronweb3/tronwallet-adapters`](https://github.com/web3-geek/tronwallet-adapter/tree/main/packages/adapters/adapters)

0 commit comments

Comments
 (0)