Skip to main content

SimpleLoan

@liquidium/client


@liquidium/client / SimpleLoan

Interface: SimpleLoan

Defined in: packages/client/src/modules/simple-loans/types.ts:439

Hydrated simple loan state plus generated quote targets.

Properties

borrow

borrow: SimpleLoanBorrow

Defined in: packages/client/src/modules/simple-loans/types.ts:453

Borrow-side pool, asset, chain, decimals, requested amount, and destination.


collateral

collateral: SimpleLoanCollateral

Defined in: packages/client/src/modules/simple-loans/types.ts:451

Collateral-side pool, asset, decimals, and requested credited amount.


initialDeposit

initialDeposit: SimpleLoanInitialDeposit

Defined in: packages/client/src/modules/simple-loans/types.ts:457

Current actionable initial collateral deposit quote.


loanId

loanId: bigint

Defined in: packages/client/src/modules/simple-loans/types.ts:441

Canister-assigned loan id.


position

position: SimpleLoanPositionSummary

Defined in: packages/client/src/modules/simple-loans/types.ts:461

Current lending position state for the generated profile.


profileId

profileId: string

Defined in: packages/client/src/modules/simple-loans/types.ts:447

Generated profile principal used by the simple loan.


ref

ref: string

Defined in: packages/client/src/modules/simple-loans/types.ts:443

Short user-facing reference derived from loanId.


refundDestination

refundDestination: LiquidiumAccount

Defined in: packages/client/src/modules/simple-loans/types.ts:455

Destination used for collateral refunds or withdrawals.


repayment

repayment: SimpleLoanRepayment

Defined in: packages/client/src/modules/simple-loans/types.ts:459

Current repayment quote. Amount fields are zero when the loan has no debt.


status

status: LiquidiumStatus

Defined in: packages/client/src/modules/simple-loans/types.ts:445

Shared lifecycle status for display and flow control.


terms

terms: SimpleLoanTerms

Defined in: packages/client/src/modules/simple-loans/types.ts:449

Immutable loan terms.