Function prepareWithdrawFromDepositEscrowInDeposits

    • prepareWithdrawFromDepositEscrowInDeposits(
          depositsAppId: number,
          pool: Pool,
          poolManagerAppId: number,
          userAddr: string,
          escrowAddr: string,
          receiverAddr: string,
          amount: number | bigint,
          isfAssetAmount: boolean,
          remainDeposited: boolean,
          params: SuggestedParams,
      ): Transaction

    • Returns a transaction to withdraw from a deposits escrow

      Parameters

      • depositsAppId: number

        deposits application of escrow

      • pool: Pool

        pool to withdraw from

      • poolManagerAppId: number

        pool manager application

      • userAddr: string

        account address for the user

      • escrowAddr: string

        account address for the deposit escrow

      • receiverAddr: string

        account address to receive the withdrawal (typically the same as the user address)

      • amount: number | bigint

        the amount of asset / f asset to send to withdraw from escrow.

      • isfAssetAmount: boolean

        whether the amount to withdraw is expressed in terms of f asset or asset

      • remainDeposited: boolean

        whether receiver should get f asset or asset (cannot remain deposited and use asset amount)

      • params: SuggestedParams

        suggested params for the transactions with the fees overwritten

      Returns Transaction

      Transaction withdraw from deposit escrow transaction

    Settings

    Member Visibility