bitcoin-wallet-connector 0.1.0

package/src/BitcoinWalletAdapterConnector.ts

@@ -0,0 +1,166 @@
+import { AvailabilitySubscription } from "./utils/createAdapterAvailability"
+import { BitcoinWalletAdapterError } from "./utils/error"
+import { StateChannel, StateChannelListener } from "./utils/StateChannel"
+import {
+  WalletAdapter,
+  WalletAdapterNotConnectedError,
+  WalletAdapterStatic,
+} from "./WalletAdapters.types"
+
+const previousConnectWalletAdapterIdLocalStorageKey =
+  "app:BitcoinWalletAdapterConnector:previousConnectWallet"
+
+export interface ConnectInfo {
+  adapterId: string
+  adapter: WalletAdapter
+}
+
+export type AdapterEntry = readonly [string, WalletAdapter]
+
+export class BitcoinWalletAdapterConnector {
+  private availableAdaptersState = new StateChannel<AdapterEntry[]>([])
+  private connectedInfoState = new StateChannel<null | ConnectInfo>(null)
+  private autoConnectRunning = false
+  private availabilitySubscriptions: AvailabilitySubscription[] = []
+  private adapterOrder = new Map<string, number>()
+
+  constructor(private Adapters: WalletAdapterStatic<WalletAdapter>[]) {
+    this.adapterOrder = new Map(
+      Adapters.map((adapter, index) => [adapter.adapterId, index]),
+    )
+    this.initializeAdapterAvailability()
+  }
+
+  dispose(): void {
+    this.availabilitySubscriptions.forEach(s => s.unsubscribe())
+    this.availabilitySubscriptions = []
+    this.availableAdaptersState = new StateChannel<AdapterEntry[]>([])
+    this.connectedInfoState = new StateChannel<null | ConnectInfo>(null)
+  }
+
+  subscribeAvailableAdapters(
+    listener: StateChannelListener<AdapterEntry[]>,
+  ): AvailabilitySubscription {
+    return this.availableAdaptersState.subscribe(listener)
+  }
+  getAvailableAdapters(): AdapterEntry[] {
+    return this.availableAdaptersState.getValue()
+  }
+
+  subscribeConnectedInfo(
+    listener: StateChannelListener<null | ConnectInfo>,
+  ): AvailabilitySubscription {
+    return this.connectedInfoState.subscribe(listener)
+  }
+  getConnectedInfo(): null | ConnectInfo {
+    return this.connectedInfoState.getValue()
+  }
+
+  private initializeAdapterAvailability(): void {
+    this.availabilitySubscriptions = this.Adapters.map(Adapter => {
+      return Adapter.getAdapter().subscribe(adapter => {
+        this.addOrUpdateAvailableAdapter(Adapter.adapterId, adapter)
+      })
+    })
+  }
+
+  private addOrUpdateAvailableAdapter(
+    adapterId: string,
+    adapter: WalletAdapter,
+  ): void {
+    this.availableAdaptersState.update(current => {
+      const next = [...current]
+      const existingIndex = current.findIndex(([id]) => id === adapterId)
+      if (existingIndex === -1) {
+        next.push([adapterId, adapter] as const)
+      } else {
+        next[existingIndex] = [adapterId, adapter] as const
+      }
+
+      next.sort(
+        (a, b) =>
+          (this.adapterOrder.get(a[0]) ?? Number.MAX_SAFE_INTEGER) -
+          (this.adapterOrder.get(b[0]) ?? Number.MAX_SAFE_INTEGER),
+      )
+      return next
+    })
+
+    void this.autoConnect()
+  }
+
+  async connect(adapterId: string, adapter: WalletAdapter): Promise<void> {
+    const finalAdapter = adapter
+
+    await finalAdapter.connect().catch(err => {
+      if (err instanceof BitcoinWalletAdapterError) {
+        alert(err.message)
+        return
+      }
+      throw err
+    })
+
+    localStorage.setItem(
+      previousConnectWalletAdapterIdLocalStorageKey,
+      adapterId,
+    )
+
+    this.connectedInfoState.setValue({ adapterId, adapter: finalAdapter })
+  }
+
+  async disconnect(): Promise<void> {
+    const info = this.connectedInfoState.getValue()
+    if (info == null) return
+    await this.disconnectAdapter(info.adapter)
+    this.connectedInfoState.setValue(null)
+  }
+  private async disconnectAdapter(adapter: WalletAdapter): Promise<void> {
+    await adapter.disconnect()
+    localStorage.removeItem(previousConnectWalletAdapterIdLocalStorageKey)
+  }
+
+  private async autoConnect(): Promise<void> {
+    if (this.isConnected || this.autoConnectRunning) return
+
+    const previousAdapterId = this.previousConnectedWallet
+    if (previousAdapterId == null) return
+
+    const adapter = this.availableAdaptersState
+      .getValue()
+      .find(a => a[0] === previousAdapterId)?.[1]
+    if (adapter == null) return
+
+    this.autoConnectRunning = true
+    try {
+      await adapter.getAddresses()
+    } catch (err: unknown) {
+      if (err instanceof WalletAdapterNotConnectedError) {
+        this.autoConnectRunning = false
+        return
+      }
+
+      this.autoConnectRunning = false
+      throw err
+    }
+
+    try {
+      await this.connect(previousAdapterId, adapter)
+    } finally {
+      this.autoConnectRunning = false
+    }
+  }
+
+  private get previousConnectedWallet(): string | undefined {
+    const adapterId =
+      localStorage.getItem(previousConnectWalletAdapterIdLocalStorageKey) ||
+      undefined
+
+    if (this.Adapters.some(adapter => adapter.adapterId === adapterId)) {
+      return adapterId
+    }
+    return undefined
+  }
+
+  private get isConnected(): boolean {
+    return this.connectedInfoState.getValue() != null
+  }
+}

package/src/WalletAdapters.types.ts

@@ -0,0 +1,154 @@
+import { Availability } from "./utils/createAdapterAvailability"
+
+export enum WalletAdapterBitcoinNetwork {
+  MAINNET = "mainnet",
+  TESTNET = "testnet",
+  UNKNOWN = "unknown",
+}
+
+export enum WalletAdapterAddressPurpose {
+  Bitcoin = "bitcoin",
+  Ordinals = "ordinals",
+  BRC20 = "brc20",
+  Runes = "runes",
+}
+
+// prettier-ignore
+export enum WalletAdapterAddressType {
+  P2SH_P2WPKH = "p2sh-p2wpkh", // aka Nested SegWit
+  P2WPKH = "p2wpkh",           // aka Native SegWit
+  P2TR = "p2tr",               // aka Taproot
+  P2PKH = "p2pkh",             // aka Legacy
+}
+
+export enum SignMessageAlgorithm {
+  ECDSA = "ECDSA",
+  BIP322 = "BIP322",
+}
+export type SignMessageResult =
+  | SignMessageResult.ECDSA
+  | SignMessageResult.BIP322
+export namespace SignMessageResult {
+  export interface ECDSA {
+    algorithm: SignMessageAlgorithm.ECDSA
+    result: string
+    address: string
+    publicKey: string
+  }
+
+  export interface BIP322 {
+    algorithm: SignMessageAlgorithm.BIP322
+    result: string
+    address: string
+  }
+}
+
+export interface WalletAdapterAddressBasic {
+  addressType: WalletAdapterAddressType
+  address: string
+  scriptPubKey: string
+}
+
+export interface WalletAdapterAddressWithPublicKey {
+  /**
+   * Some wallet may won't give us the public key of the address, like Xverse
+   */
+  publicKey: string
+}
+
+export interface WalletAdapterAddressWithRedeemScript {
+  /**
+   * Some address is SH address, which requires redeem script to spend, like Xverse
+   */
+  redeemScript: string
+}
+
+export interface WalletAdapterAddressWithTapInternalKey {
+  /**
+   * Some address is taproot address, which requires taproot internal key to spend.
+   */
+  tapInternalKey: string
+}
+
+export interface WalletAdapterAddress extends Partial<
+  WalletAdapterAddressWithPublicKey &
+    WalletAdapterAddressWithRedeemScript &
+    WalletAdapterAddressWithTapInternalKey
+> {
+  addressType: WalletAdapterAddressType
+  address: string
+  scriptPubKey: string
+  network: WalletAdapterBitcoinNetwork
+  purposes: WalletAdapterAddressPurpose[]
+}
+
+export interface WalletAdapterMetadata {
+  name: string
+  iconUrl: Promise<string>
+  websiteUrl: string
+  downloadUrl: string
+}
+
+export interface WalletAdapterStatic<T extends WalletAdapter> {
+  adapterId: string
+  metadata: WalletAdapterMetadata
+  getAdapter(): Availability<T>
+}
+
+export type WalletAdapter_onAddressesChanged_callback = (data: {
+  addresses: WalletAdapterAddress[]
+}) => void
+
+export interface WalletAdapter {
+  connect(): Promise<void>
+
+  disconnect(): Promise<void>
+
+  getAddresses(): Promise<WalletAdapterAddress[]>
+  onAddressesChanged(callback: WalletAdapter_onAddressesChanged_callback): {
+    unsubscribe: () => void
+  }
+
+  signMessage(address: string, message: string): Promise<SignMessageResult>
+
+  readonly sendBitcoinFeeRateCapability:
+    | "unavailable"
+    | "available"
+    | "required"
+  sendBitcoin(
+    fromAddress: string,
+    receiverAddress: string,
+    satoshiAmount: bigint,
+    options?: { feeRate?: number },
+  ): Promise<{ txid: string }>
+
+  readonly sendInscriptionFeeRateCapability:
+    | "unavailable"
+    | "available"
+    | "required"
+  sendInscription?(
+    fromAddress: string,
+    receiverAddress: string,
+    inscriptionId: string,
+    options?: { feeRate?: number },
+  ): Promise<{ txid: string }>
+
+  signAndFinalizePsbt(
+    psbtHex: string,
+    signIndices: [address: string, signIndex: number][],
+  ): Promise<{ signedPsbtHex: string }>
+}
+
+export class WalletAdapterErrorBase extends Error {
+  constructor(message: string) {
+    super(message)
+    this.name = "WalletAdapterErrorBase"
+  }
+}
+
+export class WalletAdapterNotConnectedError extends WalletAdapterErrorBase {
+  constructor(walletName: string, message?: string) {
+    super(message ?? `Wallet ${walletName} is not connected`)
+    this.name = "WalletAdapterNotConnectedError"
+  }
+}

package/src/_/leather.svg

@@ -0,0 +1,4 @@
+<svg width="128" height="128" viewBox="0 0 128 128" fill="none" xmlns="http://www.w3.org/2000/svg">
+<rect width="128" height="128" rx="26.8387" fill="#12100F"/>
+<path d="M74.9171 52.7114C82.4766 51.5408 93.4087 43.5804 93.4087 37.3761C93.4087 35.5031 91.8968 34.2154 89.6871 34.2154C85.5004 34.2154 78.4061 40.5368 74.9171 52.7114ZM39.911 83.4991C30.0256 83.4991 29.2115 93.3324 39.0969 93.3324C43.5163 93.3324 48.8661 91.5764 51.6573 88.4157C47.5868 84.9038 44.2141 83.4991 39.911 83.4991ZM102.829 79.2848C103.41 95.7907 95.0369 105.039 80.8484 105.039C72.4748 105.039 68.2881 101.878 59.333 96.0249C54.681 101.176 45.8423 105.039 38.5154 105.039C13.2785 105.039 14.3252 72.8463 40.0273 72.8463C45.3771 72.8463 49.9128 74.2511 55.7277 77.88L59.5656 64.4177C43.7489 60.0864 35.8405 47.9118 43.6326 30.4693H56.1929C49.215 42.0586 53.9832 51.6578 62.822 52.7114C67.5903 35.7372 77.8246 22.509 91.4316 22.509C99.1074 22.509 105.155 27.5428 105.155 36.6737C105.155 51.3066 86.0819 63.2471 71.6607 64.4177L65.7295 85.3721C72.4748 93.2153 91.199 100.824 91.199 79.2848H102.829Z" fill="#F5F1ED"/>
+</svg>

package/src/_/unisat.svg

@@ -0,0 +1,31 @@
+<svg width="180" height="180" viewBox="0 0 180 180" fill="none" xmlns="http://www.w3.org/2000/svg">
+<rect width="180" height="180" fill="black"/>
+<g clip-path="url(#clip0_10050_4171)">
+<path d="M113.66 29.2897L143.97 59.3097C146.55 61.8597 147.82 64.4397 147.78 67.0397C147.74 69.6397 146.63 72.0097 144.46 74.1597C142.19 76.4097 139.74 77.5497 137.12 77.5997C134.5 77.6397 131.9 76.3797 129.32 73.8297L98.3199 43.1297C94.7999 39.6397 91.3999 37.1697 88.1299 35.7197C84.8599 34.2697 81.4199 34.0397 77.8199 35.0397C74.2099 36.0297 70.3399 38.5797 66.1899 42.6797C60.4699 48.3497 57.7399 53.6697 58.0199 58.6397C58.2999 63.6097 61.1399 68.7697 66.5299 74.0997L97.7799 105.06C100.39 107.64 101.67 110.22 101.63 112.78C101.59 115.35 100.47 117.72 98.2599 119.91C96.0599 122.09 93.6299 123.23 90.9899 123.32C88.3499 123.41 85.7199 122.16 83.1199 119.58L52.8099 89.5597C47.8799 84.6797 44.3199 80.0597 42.1299 75.6997C39.9399 71.3397 39.1199 66.4097 39.6899 60.9097C40.1999 56.1997 41.7099 51.6397 44.2299 47.2197C46.7399 42.7997 50.3399 38.2797 55.0099 33.6497C60.5699 28.1397 65.8799 23.9197 70.9399 20.9797C75.9899 18.0397 80.8799 16.4097 85.5999 16.0697C90.3299 15.7297 94.9899 16.6697 99.5999 18.8897C104.21 21.1097 108.89 24.5697 113.65 29.2897H113.66Z" fill="url(#paint0_linear_10050_4171)"/>
+<path d="M66.1099 150.42L35.8099 120.4C33.2299 117.84 31.9599 115.27 31.9999 112.67C32.0399 110.07 33.1499 107.7 35.3199 105.55C37.5899 103.3 40.0399 102.16 42.6599 102.11C45.2799 102.07 47.8799 103.32 50.4599 105.88L81.4499 136.58C84.9799 140.07 88.3699 142.54 91.6399 143.99C94.9099 145.44 98.3499 145.66 101.96 144.67C105.57 143.68 109.44 141.13 113.59 137.02C119.31 131.35 122.04 126.03 121.76 121.06C121.48 116.09 118.64 110.93 113.25 105.59L96.5999 89.2401C93.9899 86.6601 92.7099 84.0801 92.7499 81.5201C92.7899 78.9501 93.9099 76.5801 96.1199 74.3901C98.3199 72.2101 100.75 71.0701 103.39 70.9801C106.03 70.8901 108.66 72.1401 111.26 74.7201L126.96 90.1301C131.89 95.0101 135.45 99.6301 137.64 103.99C139.83 108.35 140.65 113.28 140.08 118.78C139.57 123.49 138.06 128.05 135.54 132.47C133.03 136.89 129.43 141.41 124.76 146.04C119.2 151.55 113.89 155.77 108.83 158.71C103.77 161.65 98.8799 163.29 94.1499 163.63C89.4199 163.97 84.7599 163.03 80.1499 160.81C75.5399 158.59 70.8599 155.13 66.0999 150.41L66.1099 150.42Z" fill="url(#paint1_linear_10050_4171)"/>
+<path d="M85.0099 72.9592C91.1568 72.9592 96.1399 67.9761 96.1399 61.8292C96.1399 55.6823 91.1568 50.6992 85.0099 50.6992C78.863 50.6992 73.8799 55.6823 73.8799 61.8292C73.8799 67.9761 78.863 72.9592 85.0099 72.9592Z" fill="url(#paint2_radial_10050_4171)"/>
+</g>
+<defs>
+<linearGradient id="paint0_linear_10050_4171" x1="138.985" y1="46.7795" x2="45.0529" y2="88.5233" gradientUnits="userSpaceOnUse">
+<stop stop-color="#201C1B"/>
+<stop offset="0.36" stop-color="#77390D"/>
+<stop offset="0.67" stop-color="#EA8101"/>
+<stop offset="1" stop-color="#F4B852"/>
+</linearGradient>
+<linearGradient id="paint1_linear_10050_4171" x1="43.3812" y1="134.167" x2="152.231" y2="101.771" gradientUnits="userSpaceOnUse">
+<stop stop-color="#1F1D1C"/>
+<stop offset="0.37" stop-color="#77390D"/>
+<stop offset="0.67" stop-color="#EA8101"/>
+<stop offset="1" stop-color="#F4FB52"/>
+</linearGradient>
+<radialGradient id="paint2_radial_10050_4171" cx="0" cy="0" r="1" gradientUnits="userSpaceOnUse" gradientTransform="translate(85.0099 61.8392) scale(11.13)">
+<stop stop-color="#F4B852"/>
+<stop offset="0.33" stop-color="#EA8101"/>
+<stop offset="0.64" stop-color="#77390D"/>
+<stop offset="1" stop-color="#211C1D"/>
+</radialGradient>
+<clipPath id="clip0_10050_4171">
+<rect width="115.77" height="147.7" fill="white" transform="translate(32 16)"/>
+</clipPath>
+</defs>
+</svg>

package/src/adapters/BitgetWalletAdapter.impl.ts

@@ -0,0 +1,22 @@
+import {
+  UnisatCompatibleProviderAPI,
+  UnisatCompatibleWalletAdapterImpl,
+} from "../utils/UnisatCompatibleWalletAdapterImpl"
+import { WalletAdapter } from "../WalletAdapters.types"
+
+/**
+ * Derivation path (BIP-44): m/44'/0'/0'/0/ address_index
+ */
+export class BitgetWalletAdapterImpl
+  extends UnisatCompatibleWalletAdapterImpl
+  implements WalletAdapter
+{
+  constructor(provider: UnisatCompatibleProviderAPI) {
+    /**
+     * Bitget Provider API:
+     *
+     * https://web3.bitget.com/zh-CN/docs/provider-api/btc.html
+     */
+    super(provider, "Bitget")
+  }
+}

package/src/adapters/BitgetWalletAdapter.ts

@@ -0,0 +1,44 @@
+import { createAvailability } from "../utils/createAdapterAvailability"
+import type { UnisatCompatibleProviderAPI } from "../utils/UnisatCompatibleWalletAdapterImpl"
+import type {
+  WalletAdapter,
+  WalletAdapterMetadata,
+  WalletAdapterStatic,
+} from "../WalletAdapters.types"
+
+/**
+ * Derivation path (BIP-44): m/44'/0'/0'/0/ address_index
+ */
+
+const adapterId = "bitget.bitcoin"
+
+/**
+ * https://web3.bitget.com/en/docs/wallet/brand-assets.html
+ */
+const metadata: WalletAdapterMetadata = {
+  name: "Bitget",
+  iconUrl: import("../_/bitget.png").then(m => m.default),
+  websiteUrl: "https://web3.bitget.com/",
+  downloadUrl: "https://web3.bitget.com/en/wallet-download",
+}
+
+const availability = createAvailability<
+  UnisatCompatibleProviderAPI,
+  WalletAdapter
+>({
+  getPrecondition: () =>
+    (window as any).bitkeep?.unisat == null
+      ? null
+      : { value: (window as any).bitkeep.unisat },
+  initializer: async provider => {
+    const { BitgetWalletAdapterImpl } =
+      await import("./BitgetWalletAdapter.impl")
+    return new BitgetWalletAdapterImpl(provider)
+  },
+})
+
+export const BitgetWalletAdapter: WalletAdapterStatic<WalletAdapter> = {
+  adapterId,
+  metadata,
+  getAdapter: () => availability,
+}