Bitcoin native experience

dapp/src/acre-react/hooks/useStakeFlow.ts

@@ -1,16 +1,14 @@
 import { useCallback, useState } from "react"
 import {
   StakeInitialization,
-  EthereumAddress,
   DepositorProxy,
   DepositReceipt,
 } from "@acre-btc/sdk"
 import { useAcreContext } from "./useAcreContext"
 
 export type UseStakeFlowReturn = {
   initStake: (
-    bitcoinRecoveryAddress: string,
-    ethereumAddress: string,
+    bitcoinAddress: string,
     referral: number,
     depositor?: DepositorProxy,
   ) => Promise<void>
@@ -33,16 +31,14 @@ export function useStakeFlow(): UseStakeFlowReturn {
 
   const initStake = useCallback(
     async (
-      bitcoinRecoveryAddress: string,
-      ethereumAddress: string,
+      bitcoinAddress: string,
       referral: number,
       depositor?: DepositorProxy,
     ) => {
       if (!acre || !isInitialized) throw new Error("Acre SDK not defined")
 
       const initializedStakeFlow = await acre.staking.initializeStake(
-        bitcoinRecoveryAddress,
-        EthereumAddress.from(ethereumAddress),
+        bitcoinAddress,
         referral,
         depositor,
       )

sdk/package.json

@@ -26,8 +26,9 @@
     "typescript": "^5.3.2"
   },
   "dependencies": {
-    "@keep-network/tbtc-v2.ts": "2.4.0-dev.3",
     "@acre-btc/contracts": "workspace:*",
+    "@keep-network/tbtc-v2.ts": "2.4.0-dev.3",
+    "@orangekit/sdk": "1.0.0-beta.8",
     "ethers": "^6.10.0"
   }
 }

sdk/src/acre.ts

@@ -1,4 +1,5 @@
 import { TBTC } from "@keep-network/tbtc-v2.ts"
+import { OrangeKitSdk } from "@orangekit/sdk"
 import { AcreContracts } from "./lib/contracts"
 import { ChainEIP712Signer } from "./lib/eip712-signer"
 import {
@@ -12,6 +13,8 @@ import { EthereumSignerCompatibleWithEthersV5 } from "./lib/utils"
 class Acre {
   readonly #tbtc: TBTC
 
+  readonly #orangeKit: OrangeKitSdk
+
   readonly #messageSigner: ChainEIP712Signer
 
   public readonly contracts: AcreContracts
@@ -22,26 +25,32 @@ class Acre {
     _contracts: AcreContracts,
     _messageSigner: ChainEIP712Signer,
     _tbtc: TBTC,
+    _orangeKit: OrangeKitSdk,
   ) {
     this.contracts = _contracts
     this.#tbtc = _tbtc
+    this.#orangeKit = _orangeKit
     this.#messageSigner = _messageSigner
     this.staking = new StakingModule(
       this.contracts,
       this.#messageSigner,
       this.#tbtc,
+      this.#orangeKit,
     )
   }
 
   static async initializeEthereum(
     signer: EthereumSignerCompatibleWithEthersV5,
     network: EthereumNetwork,
   ): Promise<Acre> {
+    const chainId = await signer.getChainId()
+
     const tbtc = await Acre.#getTBTCEthereumSDK(signer, network)
+    const orangeKit = await Acre.#getOrangeKitSDK(chainId)
     const contracts = getEthereumContracts(signer, network)
     const messages = new EthereumEIP712Signer(signer)
 
-    return new Acre(contracts, messages, tbtc)
+    return new Acre(contracts, messages, tbtc, orangeKit)
   }
 
   static #getTBTCEthereumSDK(
@@ -62,6 +71,14 @@ class Acre {
         return TBTC.initializeMainnet(signer)
     }
   }
+
+  static #getOrangeKitSDK(chainId: number): Promise<OrangeKitSdk> {
+    return OrangeKitSdk.init(
+      chainId,
+      // TODO: pass rpc url as config.
+      "https://eth-mainnet.g.alchemy.com/v2/<YOUR_API_KEY>",
+    )
+  }
 }
 
 // eslint-disable-next-line import/prefer-default-export

sdk/src/modules/staking/index.ts

@@ -1,4 +1,9 @@
-import { ChainIdentifier, TBTC } from "@keep-network/tbtc-v2.ts"
+import {
+  ChainIdentifier,
+  EthereumAddress,
+  TBTC,
+} from "@keep-network/tbtc-v2.ts"
+import { OrangeKitSdk } from "@orangekit/sdk"
 import { AcreContracts, DepositorProxy, DepositFees } from "../../lib/contracts"
 import { ChainEIP712Signer } from "../../lib/eip712-signer"
 import { StakeInitialization } from "./stake-initialization"
@@ -32,43 +37,68 @@ class StakingModule {
    */
   readonly #tbtc: TBTC
 
+  /**
+   * OrangeKit SDK.
+   */
+  readonly #orangeKit: OrangeKitSdk
+
   constructor(
     _contracts: AcreContracts,
     _messageSigner: ChainEIP712Signer,
     _tbtc: TBTC,
+    _orangeKit: OrangeKitSdk,
   ) {
     this.#contracts = _contracts
     this.#messageSigner = _messageSigner
     this.#tbtc = _tbtc
+    this.#orangeKit = _orangeKit
   }
 
   /**
-   * Initializes the Acre staking process.
-   * @param bitcoinRecoveryAddress P2PKH or P2WPKH Bitcoin address that can be
-   *                               used for emergency recovery of the deposited
-   *                               funds.
-   * @param staker The address to which the stBTC shares will be minted.
+   * Initializes the Acre deposit process.
+   * @param depositor The Bitcoin depositor address. Supported addresses:
+   *        `P2WPKH`, `P2PKH`, `P2SH-P2WPKH`.
    * @param referral Data used for referral program.
    * @param depositorProxy Depositor proxy used to initiate the deposit.
-   * @returns Object represents the staking process.
+   * @param bitcoinRecoveryAddress `P2PKH` or `P2WPKH` Bitcoin address that can
+   *        be used for emergency recovery of the deposited funds. If
+   *        `undefined` the `depositor` address is used as bitcoin recovery
+   *        address then the `depositor` must be `P2WPKH` or `P2PKH`.
+   * @returns Object represents the deposit process.
    */
   async initializeStake(
-    bitcoinRecoveryAddress: string,
-    staker: ChainIdentifier,
+    depositor: string,
     referral: number,
     depositorProxy?: DepositorProxy,
+    bitcoinRecoveryAddress?: string,
   ) {
+    // TODO: If we want to handle other chains we should create the wrapper for
+    // OrangeKit SDK to return `ChainIdentifier` from `predictAddress` fn. Or we
+    // can create `EVMChainIdentifier` class and use it as a type in `modules`
+    // and `lib`. Currently we support only `Ethereum` so here we force to
+    // `EthereumAddress`.
+    const depositOwnerChainAddress = EthereumAddress.from(
+      await this.#orangeKit.predictAddress(depositor),
+    )
+
+    // tBTC-v2 SDK will handle Bitcoin address validation and throw an error if
+    // address is not supported.
+    const finalBitcoinRecoveryAddress = bitcoinRecoveryAddress ?? depositor
+
     const deposit = await this.#tbtc.deposits.initiateDepositWithProxy(
-      bitcoinRecoveryAddress,
+      finalBitcoinRecoveryAddress,
       depositorProxy ?? this.#contracts.bitcoinDepositor,
-      this.#contracts.bitcoinDepositor.encodeExtraData(staker, referral),
+      this.#contracts.bitcoinDepositor.encodeExtraData(
+        depositOwnerChainAddress,
+        referral,
+      ),
     )
 
     return new StakeInitialization(
       this.#contracts,
       this.#messageSigner,
-      bitcoinRecoveryAddress,
-      staker,
+      finalBitcoinRecoveryAddress,
+      depositOwnerChainAddress,
       deposit,
     )
   }

sdk/test/modules/staking.test.ts

@@ -1,5 +1,6 @@
 import { BitcoinTxHash } from "@keep-network/tbtc-v2.ts"
 import { ethers } from "ethers"
+import { OrangeKitSdk } from "@orangekit/sdk"
 import {
   AcreContracts,
   StakingModule,
@@ -100,11 +101,13 @@ describe("Staking", () => {
   const contracts: AcreContracts = new MockAcreContracts()
   const messageSigner = new MockMessageSigner()
   const tbtc = new MockTBTC()
+  const orangeKit = {} as OrangeKitSdk
 
   const staking: StakingModule = new StakingModule(
     contracts,
     messageSigner,
     tbtc,
+    orangeKit,
   )
 
   describe("initializeStake", () => {
@@ -142,11 +145,7 @@ describe("Staking", () => {
 
         messageSigner.sign = jest.fn().mockResolvedValue(mockedSignedMessage)
 
-        result = await staking.initializeStake(
-          bitcoinRecoveryAddress,
-          staker,
-          referral,
-        )
+        result = await staking.initializeStake(bitcoinRecoveryAddress, referral)
       })
 
       it("should encode extra data", () => {
@@ -370,7 +369,6 @@ describe("Staking", () => {
 
         result = await staking.initializeStake(
           bitcoinRecoveryAddress,
-          staker,
           referral,
           customDepositorProxy,
         )