Update docs in account and protocol modules

thesis · Jun 11, 2024 · 1bdf00f · 1bdf00f
1 parent d621a4a
commit 1bdf00f
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 7 deletions.
diff --git a/sdk/src/modules/account.ts b/sdk/src/modules/account.ts
@@ -103,15 +103,15 @@ export default class Account {
   }
 
   /**
-   * @returns Value of the basis for calculating final BTC balance in 1e18
-   *          precision.
+   * @returns Balance of the account's stBTC shares (in 1e18 precision).
    */
   async sharesBalance() {
     return this.#contracts.stBTC.balanceOf(this.#ethereumAddress)
   }
 
   /**
-   * @returns Maximum withdraw value in 1e8 satoshi precision.
+   * @returns Balance of Bitcoin position in Acre estimated based on the
+   *          account's stBTC shares (in 1e8 satoshi precision).
    */
   async estimatedBitcoinBalance() {
     return toSatoshi(
@@ -120,9 +120,8 @@ export default class Account {
   }
 
   /**
-   * @returns All deposits associated with the Bitcoin address that returns the
-   *          Bitcoin Provider. They include all deposits: queued, initialized
-   *          and finalized.
+   * @returns All deposits associated with the account. They include all
+   *          deposits: queued, initialized and finalized.
    */
   async getDeposits(): Promise<Deposit[]> {
     const subgraphData = await this.#acreSubgraphApi.getDepositsByOwner(

diff --git a/sdk/src/modules/protocol.ts b/sdk/src/modules/protocol.ts
@@ -26,7 +26,7 @@ export default class Protocol {
   /**
    * Estimates the deposit fee based on the provided amount.
    * @param amount Amount to deposit in satoshi.
-   * @returns Deposit fee grouped by tBTC and Acre networks in 1e8 satoshi
+   * @returns Deposit fee grouped by tBTC and Acre protocols in 1e8 satoshi
    *          precision and total deposit fee value.
    */
   async estimateDepositFee(amount: bigint): Promise<DepositFee> {