Function prepareWithdrawFromPool

    • prepareWithdrawFromPool(
          pool: Pool,
          poolManagerAppId: number,
          userAddr: string,
          receiverAddr: string,
          fAssetAmount: number | bigint,
          receivedAssetAmount: number | bigint,
          params: SuggestedParams,
      ): Transaction[]

    • Returns a group transaction to withdraw from a user's wallet

      Parameters

      • pool: Pool

        pool to withdraw from

      • poolManagerAppId: number

        pool manager application

      • userAddr: string

        account address for the user

      • receiverAddr: string

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

      • fAssetAmount: number | bigint

        the amount of f asset to send to the pool

      • receivedAssetAmount: number | bigint

        the amount of asset to receive. Any excess f asset sent will be returned to the deposit escrow. If zero then interpreted as variable withdrawal.

      • params: SuggestedParams

        suggested params for the transactions with the fees overwritten

      Returns Transaction[]

      Transaction[] withdraw from user's wallet group transaction

    Settings

    Member Visibility