-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add okx bitcoin connector (#3408)
- Loading branch information
Showing
11 changed files
with
559 additions
and
396 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| --- | ||
| '@reown/appkit-scaffold-ui': patch | ||
| '@reown/appkit': patch | ||
| '@reown/appkit-core': patch | ||
| '@reown/appkit-ui': patch | ||
| '@reown/appkit-adapter-ethers': patch | ||
| '@reown/appkit-adapter-ethers5': patch | ||
| '@reown/appkit-adapter-solana': patch | ||
| '@reown/appkit-adapter-wagmi': patch | ||
| '@reown/appkit-utils': patch | ||
| '@reown/appkit-cdn': patch | ||
| 'appkit-cli': patch | ||
| '@reown/appkit-common': patch | ||
| '@reown/appkit-experimental': patch | ||
| '@reown/appkit-polyfills': patch | ||
| '@reown/appkit-siwe': patch | ||
| '@reown/appkit-siwx': patch | ||
| '@reown/appkit-wallet': patch | ||
| --- | ||
|
|
||
| Add Bitcoin OKX Wallet connector |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
176 changes: 176 additions & 0 deletions
176
packages/adapters/bitcoin/src/connectors/OKXConnector.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,176 @@ | ||
| import type { CaipNetwork } from '@reown/appkit-common' | ||
| import type { BitcoinConnector } from '../utils/BitcoinConnector.js' | ||
| import { ProviderEventEmitter } from '../utils/ProviderEventEmitter.js' | ||
| import type { RequestArguments } from '@reown/appkit-core' | ||
| import { MethodNotSupportedError } from '../errors/MethodNotSupportedError.js' | ||
| import { bitcoin } from '@reown/appkit/networks' | ||
| import { UnitsUtil } from '../utils/UnitsUtil.js' | ||
|
|
||
| export class OKXConnector extends ProviderEventEmitter implements BitcoinConnector { | ||
| public readonly id = 'OKX' | ||
| public readonly name = 'OKX Wallet' | ||
| public readonly chain = 'bip122' | ||
| public readonly type = 'ANNOUNCED' | ||
| public readonly imageUrl: string | ||
|
|
||
| public readonly provider = this | ||
|
|
||
| private readonly wallet: OKXConnector.Wallet | ||
| private readonly requestedChains: CaipNetwork[] = [] | ||
| private readonly getActiveNetwork: () => CaipNetwork | undefined | ||
|
|
||
| constructor({ | ||
| wallet, | ||
| requestedChains, | ||
| getActiveNetwork, | ||
| imageUrl | ||
| }: OKXConnector.ConstructorParams) { | ||
| super() | ||
| this.wallet = wallet | ||
| this.requestedChains = requestedChains | ||
| this.getActiveNetwork = getActiveNetwork | ||
| this.imageUrl = imageUrl | ||
| } | ||
|
|
||
| public get chains() { | ||
| return this.requestedChains.filter(chain => chain.caipNetworkId === bitcoin.caipNetworkId) | ||
| } | ||
|
|
||
| public async connect(): Promise<string> { | ||
| const result = await this.wallet.connect() | ||
|
|
||
| this.bindEvents() | ||
|
|
||
| return result.address | ||
| } | ||
|
|
||
| public async disconnect(): Promise<void> { | ||
| this.unbindEvents() | ||
| await this.wallet.disconnect() | ||
| } | ||
|
|
||
| public async getAccountAddresses(): Promise<BitcoinConnector.AccountAddress[]> { | ||
| const accounts = await this.wallet.getAccounts() | ||
|
|
||
| return accounts.map(account => ({ | ||
| address: account, | ||
| purpose: 'payment' | ||
| })) | ||
| } | ||
|
|
||
| public async signMessage(params: BitcoinConnector.SignMessageParams): Promise<string> { | ||
| return this.wallet.signMessage(params.message) | ||
| } | ||
|
|
||
| public async sendTransfer(params: BitcoinConnector.SendTransferParams): Promise<string> { | ||
| const network = this.getActiveNetwork() | ||
|
|
||
| if (!network) { | ||
| throw new Error('No active network available') | ||
| } | ||
|
|
||
| const from = (await this.wallet.getAccounts())[0] | ||
|
|
||
| if (!from) { | ||
| throw new Error('No account available') | ||
| } | ||
|
|
||
| const result = await this.wallet.send({ | ||
| from, | ||
| to: params.recipient, | ||
| value: UnitsUtil.parseSatoshis(params.amount, network) | ||
| }) | ||
|
|
||
| return result.txhash | ||
| } | ||
|
|
||
| public async signPSBT( | ||
| params: BitcoinConnector.SignPSBTParams | ||
| ): Promise<BitcoinConnector.SignPSBTResponse> { | ||
| const psbtHex = Buffer.from(params.psbt, 'base64').toString('hex') | ||
|
|
||
| const signedPsbtHex = await this.wallet.signPsbt(psbtHex) | ||
|
|
||
| let txid: string | undefined = undefined | ||
| if (params.broadcast) { | ||
| txid = await this.wallet.pushPsbt(signedPsbtHex) | ||
| } | ||
|
|
||
| return { | ||
| psbt: Buffer.from(signedPsbtHex, 'hex').toString('base64'), | ||
| txid | ||
| } | ||
| } | ||
|
|
||
| public request<T>(_args: RequestArguments): Promise<T> { | ||
| return Promise.reject(new MethodNotSupportedError(this.id, 'request')) | ||
| } | ||
|
|
||
| private bindEvents(): void { | ||
| this.unbindEvents() | ||
|
|
||
| this.wallet.on('accountChanged', account => { | ||
| if (typeof account === 'object' && account && 'address' in account) { | ||
| this.emit('accountsChanged', [account.address]) | ||
| } | ||
| }) | ||
| this.wallet.on('disconnect', () => { | ||
| this.emit('disconnect') | ||
| }) | ||
| } | ||
|
|
||
| private unbindEvents(): void { | ||
| this.wallet.removeAllListeners() | ||
| } | ||
|
|
||
| public static getWallet(params: OKXConnector.GetWalletParams): OKXConnector | undefined { | ||
| // eslint-disable-next-line @typescript-eslint/no-explicit-any | ||
| const okxwallet = (window as any)?.okxwallet | ||
| const wallet = okxwallet?.bitcoin | ||
| /** | ||
| * OKX doesn't provide a way to get the image URL specifally for bitcoin | ||
| * so we use the icon for cardano as a fallback | ||
| */ | ||
| const imageUrl = okxwallet?.cardano?.icon || '' | ||
|
|
||
| if (wallet) { | ||
| return new OKXConnector({ wallet, imageUrl, ...params }) | ||
| } | ||
|
|
||
| return undefined | ||
| } | ||
| } | ||
|
|
||
| export namespace OKXConnector { | ||
| export type ConstructorParams = { | ||
| wallet: Wallet | ||
| requestedChains: CaipNetwork[] | ||
| getActiveNetwork: () => CaipNetwork | undefined | ||
| imageUrl: string | ||
| } | ||
|
|
||
| export type Wallet = { | ||
| /* | ||
| * This interface doesn't include all available methods | ||
| * Reference: https://www.okx.com/web3/build/docs/sdks/chains/bitcoin/provider | ||
| */ | ||
| connect(): Promise<{ address: string; publicKey: string }> | ||
| disconnect(): Promise<void> | ||
| getAccounts(): Promise<string[]> | ||
| signMessage(signStr: string, type?: 'ecdsa' | 'bip322-simple'): Promise<string> | ||
| signPsbt(psbtHex: string): Promise<string> | ||
| pushPsbt(psbtHex: string): Promise<string> | ||
| send(params: { | ||
| from: string | ||
| to: string | ||
| value: string | ||
| satBytes?: string | ||
| memo?: string | ||
| memoPos?: number | ||
| }): Promise<{ txhash: string }> | ||
| on(event: string, listener: (param?: unknown) => void): void | ||
| removeAllListeners(): void | ||
| } | ||
|
|
||
| export type GetWalletParams = Omit<ConstructorParams, 'wallet' | 'imageUrl'> | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| import type { CaipNetwork } from '@reown/appkit-common' | ||
|
|
||
| export const UnitsUtil = { | ||
| parseSatoshis(amount: string, network: CaipNetwork): string { | ||
| const value = parseFloat(amount) / 10 ** network.nativeCurrency.decimals | ||
|
|
||
| // eslint-disable-next-line new-cap | ||
| return Intl.NumberFormat('en-US', { | ||
| maximumFractionDigits: network.nativeCurrency.decimals | ||
| }).format(value) | ||
| } | ||
| } |
Oops, something went wrong.