Function retrieveUserLoanInfo

    • retrieveUserLoanInfo(
          client: AlgodClient | IndexerClient,
          loanAppId: number,
          poolManagerAppId: number,
          oracle: Oracle,
          escrowAddr: string,
          additionalInterests?: Partial<Record<number, AssetAdditionalInterest>>,
      ): Promise<UserLoanInfo>

    • Returns information regarding the given user loan escrow.

      Parameters

      • client: AlgodClient | IndexerClient

        Algorand client to query

      • loanAppId: number

        loan application to query about

      • poolManagerAppId: number

        pool manager application to query about

      • oracle: Oracle

        oracle to query

      • escrowAddr: string

        account address for the loan escrow

      • OptionaladditionalInterests: Partial<Record<number, AssetAdditionalInterest>>

        optional additional interest to consider in loan net rate/yield

      Returns Promise<UserLoanInfo>

      Promise user loan info

    Settings

    Member Visibility