CreditFacility_v1

A credit facility that allows users to borrow collateral tokens against issuance tokens. Source: src/core/modules/CreditFacility_v1.sol. Interfaces: ICreditFacility_v1, IReservePathModule_v1.

Functions

borrow

function borrow(uint requestedLoanAmount_) external returns (uint loanId_, uint netAmountOut_);

Borrow collateral tokens against locked issuance tokens Parameters

Name	Type	Description
`requestedLoanAmount_`	`uint`	The amount of collateral tokens to borrow

Returns

Name	Type	Description
`loanId_`	`uint`	The ID of the created loan
`netAmountOut_`	`uint`	Net collateral transferred (after borrowing fee)

ICreditFacility_v1.sol#L318

borrowFor

function borrowFor(
    address receiver_,
    uint requestedLoanAmount_
) external returns (uint loanId_, uint netAmountOut_);

Borrow collateral tokens on behalf of another user Parameters

Name	Type	Description
`receiver_`	`address`	The address of the user on whose behalf the loan is opened
`requestedLoanAmount_`	`uint`	The amount of collateral tokens to borrow

Returns

Name	Type	Description
`loanId_`	`uint`	The ID of the created loan
`netAmountOut_`	`uint`	Net collateral transferred (after borrowing fee)

ICreditFacility_v1.sol#L327

buyAndBorrow

function buyAndBorrow(
    uint amount_,
    uint loops_,
    bool consolidate_,
    uint minAmountOut_
) external returns (uint[] memory loanIds_, uint remainingCollateral_);

Buy issuance tokens and borrow with loops Parameters

Name	Type	Description
`amount_`	`uint`	The amount of collateral to use
`loops_`	`uint`	The number of buy-borrow loop iterations (must be >= 1)
`consolidate_`	`bool`	Whether to consolidate all loans after
`minAmountOut_`	`uint`	Minimum total issuance tokens to receive (slippage)

Returns

Name	Type	Description
`loanIds_`	`uint[]`	Array of loan IDs (single if consolidated)
`remainingCollateral_`	`uint`	Collateral left unused and returned to caller

ICreditFacility_v1.sol#L338

buyAndBorrowFor

function buyAndBorrowFor(
    address receiver_,
    uint amount_,
    uint loops_,
    bool consolidate_,
    uint minAmountOut_
) external returns (uint[] memory loanIds_, uint remainingCollateral_);

Buy issuance tokens and borrow with loops for user Parameters

Name	Type	Description
`receiver_`	`address`	The address on whose behalf to perform operation
`amount_`	`uint`	The amount of collateral to use
`loops_`	`uint`	The number of buy-borrow loop iterations (must be >= 1)
`consolidate_`	`bool`	Whether to consolidate all loans after
`minAmountOut_`	`uint`	Minimum total issuance tokens to receive (slippage)

Returns

Name	Type	Description
`loanIds_`	`uint[]`	Array of loan IDs (single if consolidated)
`remainingCollateral_`	`uint`	Collateral left unused and returned to caller

ICreditFacility_v1.sol#L353

consolidateLoans

function consolidateLoans(uint[] calldata loanIds_) external returns (uint newLoanId_);

Consolidate multiple loans into a single loan Parameters

Name	Type	Description
`loanIds_`	`uint[]`	Array of loan IDs to consolidate (min 2)

Returns

Name	Type	Description
`newLoanId_`	`uint`	The ID of the newly created loan

ICreditFacility_v1.sol#L406

rebalanceLoan

function rebalanceLoan(uint loanId_) external returns (uint releasedReserveAmount_);

Rebalance a loan when either referenceCurve increased or LTV changed Parameters

Name	Type	Description
`loanId_`	`uint`	The loan identifier

Returns

Name	Type	Description
`releasedReserveAmount_`	`uint`	Amount of additional collateral released (gross, before fee)

ICreditFacility_v1.sol#L396

repay

function repay(uint loanId_, uint repaymentAmount_) external;

Repay a specific loan by ID (partial or full) Parameters

Name	Type	Description
`loanId_`	`uint`	The ID of the loan to repay
`repaymentAmount_`	`uint`	The amount of collateral to repay. If greater than remaining loan amount, the function will only repay the exact remaining amount.

ICreditFacility_v1.sol#L371

repayFor

function repayFor(uint loanId_, uint repaymentAmount_) external;

Repays an active loan with the caller’s collateral. Parameters

Name	Type	Description
`loanId_`	`uint`	The active loan identifier.
`repaymentAmount_`	`uint`	Non-zero maximum collateral amount to repay.

ICreditFacility_v1.sol#L385

setBorrowingFeeRate

function setBorrowingFeeRate(uint newFeeRate_) external;

Set the borrowing fee rate Parameters

Name	Type	Description
`newFeeRate_`	`uint`	The new fee rate in bps (e.g., 100 = 1%)

ICreditFacility_v1.sol#L423

setLoanToValueRatio

function setLoanToValueRatio(uint newLoanToValueRatio_) external;

Set the loan-to-value ratio Parameters

Name	Type	Description
`newLoanToValueRatio_`	`uint`	The new LTV ratio (in basis points)

ICreditFacility_v1.sol#L415

setMaxLoops

function setMaxLoops(uint newMaxLoops_) external;

Set the maximum loop count allowed for buyAndBorrow operations Parameters

Name	Type	Description
`newMaxLoops_`	`uint`	The new maximum loop count (must be >= 1)

ICreditFacility_v1.sol#L419

transferLoan

function transferLoan(uint loanId_, address newBorrower_) external;

Transfer a loan to a new borrower Parameters

Name	Type	Description
`loanId_`	`uint`	The ID of the loan to transfer
`newBorrower_`	`address`	The address of the new borrower

ICreditFacility_v1.sol#L390

View functions

getBorrowingFeeRate

function getBorrowingFeeRate() external view returns (uint feeRate_);

Returns the borrowing fee rate Returns

Name	Type	Description
`feeRate_`	`uint`	The fee rate in basis points

ICreditFacility_v1.sol#L277

getLoan

function getLoan(uint loanId_) external view returns (Loan memory loan_);

Get details of a specific loan Parameters

Name	Type	Description
`loanId_`	`uint`	The loan ID

Returns

Name	Type	Description
`loan_`	`Loan`	The loan details

ICreditFacility_v1.sol#L282

getLoanToValueRatio

function getLoanToValueRatio() external view returns (uint ratio_);

Returns the loan-to-value ratio Returns

Name	Type	Description
`ratio_`	`uint`	The LTV ratio in basis points

ICreditFacility_v1.sol#L269

getMaxLoops

function getMaxLoops() external view returns (uint maxLoops_);

Returns the maximum loop count allowed Returns

Name	Type	Description
`maxLoops_`	`uint`	The maximum loop count

ICreditFacility_v1.sol#L273

getUserLoanIds

function getUserLoanIds(address user_) external view returns (uint[] memory loanIds_);

Get all active loan IDs for a user Parameters

Name	Type	Description
`user_`	`address`	The user address

Returns

Name	Type	Description
`loanIds_`	`uint[]`	Array of active loan IDs

ICreditFacility_v1.sol#L287

getUserLoans

function getUserLoans(address user_) external view returns (Loan[] memory loans_);

Get all active loans for a user Parameters

Name	Type	Description
`user_`	`address`	The user address

Returns

Name	Type	Description
`loans_`	`Loan[]`	Array of active loan details

ICreditFacility_v1.sol#L295

getUserTotalDebt

function getUserTotalDebt(
    address user_
) external view returns (uint totalDebt_, uint totalLockedTokens_, uint loanCount_);

Returns aggregate loan metrics for a user. Parameters

Name	Type	Description
`user_`	`address`	The user address.

Returns

Name	Type	Description
`totalDebt_`	`uint`	Sum of remaining loan amounts across all active loans.
`totalLockedTokens_`	`uint`	Sum of locked issuance tokens across all active loans.
`loanCount_`	`uint`	Number of active loans.

ICreditFacility_v1.sol#L306

isReservePathModule

function isReservePathModule() external pure returns (bool);

Identifies a CreditFacility or StakingManager reserve-path module. Returns

Name	Type	Description
	`bool`

IReservePathModule_v1.sol#L9

Events

BorrowingFeeRateUpdated

event BorrowingFeeRateUpdated(uint newFeeRate_);

Emitted when the borrowing fee rate is updated Parameters

Name	Type	Description
`newFeeRate_`	`uint`	The new fee rate in basis points

ICreditFacility_v1.sol#L154

DynamicFeeCalculatorUpdated

event DynamicFeeCalculatorUpdated(address newCalculator_);

Emitted when the dynamic fee calculator is updated Parameters

Name	Type	Description
`newCalculator_`	`address`	The new fee calculator address

ICreditFacility_v1.sol#L146

LoanClosed

event LoanClosed(uint indexed loanId_, address indexed borrower_);

Emitted when a loan is fully closed (repaid in full) Parameters

Name	Type	Description
`loanId_`	`uint indexed`	The unique loan identifier
`borrower_`	`address indexed`	The address of the borrower

ICreditFacility_v1.sol#L130

LoanCreated

event LoanCreated(
    uint indexed loanId_,
    address indexed borrower_,
    uint loanAmount_,
    uint lockedIssuanceTokens_
);

Emitted when a new loan is created Parameters

Name	Type	Description
`loanId_`	`uint indexed`	The unique loan identifier
`borrower_`	`address indexed`	The address of the borrower
`loanAmount_`	`uint`	The initial loan amount in collateral tokens
`lockedIssuanceTokens_`	`uint`	The issuance tokens locked as collateral

ICreditFacility_v1.sol#L76

LoanRebalanced

event LoanRebalanced(
    uint indexed loanId_,
    uint releasedReserveAmount_,
    uint newRemainingLoanAmount_
);

Emitted when a loan is rebalanced due to referenceCurve increase Parameters

Name	Type	Description
`loanId_`	`uint indexed`	The loan identifier
`releasedReserveAmount_`	`uint`	The additional collateral released to the borrower (gross, before fee)
`newRemainingLoanAmount_`	`uint`	The loan’s remaining amount after rebalance

ICreditFacility_v1.sol#L90

LoanRepaid

event LoanRepaid(
    uint indexed loanId_,
    address indexed borrower_,
    uint repaymentAmount_,
    uint issuanceTokensUnlocked_,
    uint remainingLoanAmount_,
    uint remainingLockedTokens_
);

Emitted when a loan is repaid (partial or full) Parameters

Name	Type	Description
`loanId_`	`uint indexed`	The unique loan identifier
`borrower_`	`address indexed`	The address of the borrower
`repaymentAmount_`	`uint`	The amount of collateral repaid
`issuanceTokensUnlocked_`	`uint`	The issuance tokens returned to borrower
`remainingLoanAmount_`	`uint`	The loan’s remaining amount after repayment
`remainingLockedTokens_`	`uint`	The loan’s remaining locked issuance tokens after repayment

ICreditFacility_v1.sol#L106

LoanRepaidBy

event LoanRepaidBy(uint indexed loanId_, address indexed payer_, uint amount_);

Identifies the payer of a repayFor payment. Parameters

Name	Type	Description
`loanId_`	`uint indexed`	The repaid loan identifier.
`payer_`	`address indexed`	Authenticated account that supplied the collateral.
`amount_`	`uint`	Actual collateral paid, capped at outstanding debt.

ICreditFacility_v1.sol#L123

LoansConsolidated

event LoansConsolidated(
    address indexed borrower_,
    uint[] oldLoanIds_,
    uint indexed newLoanId_,
    uint totalCollateralAmount_,
    uint totalLockedIssuanceTokens_
);

Emitted when multiple loans are consolidated Parameters

Name	Type	Description
`borrower_`	`address indexed`	The address of the borrower
`oldLoanIds_`	`uint[]`	Array of loan IDs that were consolidated
`newLoanId_`	`uint indexed`	The ID of the new consolidated loan
`totalCollateralAmount_`	`uint`	Total collateral in the new loan
`totalLockedIssuanceTokens_`	`uint`	Total issuance tokens locked in the new loan

ICreditFacility_v1.sol#L173

LoanToValueRatioLowered

event LoanToValueRatioLowered(uint previousRatio_, uint newRatio_);

Emitted when the loan-to-value ratio is lowered Parameters

Name	Type	Description
`previousRatio_`	`uint`	The previous LTV ratio (in basis points)
`newRatio_`	`uint`	The new (lower) LTV ratio (in basis points)

ICreditFacility_v1.sol#L142

LoanToValueRatioUpdated

event LoanToValueRatioUpdated(uint newRatio_);

Emitted when the loan-to-value ratio is updated Parameters

Name	Type	Description
`newRatio_`	`uint`	The new LTV ratio (in basis points)

ICreditFacility_v1.sol#L134

LoanTransferred

event LoanTransferred(
    uint indexed loanId_,
    address indexed previousBorrower_,
    address indexed newBorrower_
);

Emitted when a loan is transferred to a new borrower Parameters

Name	Type	Description
`loanId_`	`uint indexed`	The unique loan identifier
`previousBorrower_`	`address indexed`	The address of the previous borrower
`newBorrower_`	`address indexed`	The address of the new borrower

ICreditFacility_v1.sol#L160

MaxLoopsUpdated

event MaxLoopsUpdated(uint newMaxLoops_);

Emitted when the maximum loop count is updated Parameters

Name	Type	Description
`newMaxLoops_`	`uint`	The new maximum loop count

ICreditFacility_v1.sol#L150

Errors

Module__CreditFacility_BorrowAmountTooSmall

error Module__CreditFacility_BorrowAmountTooSmall(uint requested_, uint minimumRequired_);

Borrow amount is too small (would result in zero fee). Parameters

Name	Type	Description
`requested_`	`uint`	The requested borrow amount.
`minimumRequired_`	`uint`	The minimum amount to generate a non-zero fee.

ICreditFacility_v1.sol#L244

Module__CreditFacility_EscrowLoan

error Module__CreditFacility_EscrowLoan();

Third-party repayment cannot change a Presale escrow loan. ICreditFacility_v1.sol#L116

Module__CreditFacility_FeeTooHigh

error Module__CreditFacility_FeeTooHigh(uint provided_, uint maximum_);

Fee rate exceeds the maximum allowed cap Parameters

Name	Type	Description
`provided_`	`uint`	The fee rate that was provided
`maximum_`	`uint`	The maximum allowed fee rate

ICreditFacility_v1.sol#L193

Module__CreditFacility_InsufficientCollateralForLoops

error Module__CreditFacility_InsufficientCollateralForLoops();

Insufficient collateral to complete requested loops ICreditFacility_v1.sol#L215

Module__CreditFacility_InsufficientIssuanceTokensReceived

error Module__CreditFacility_InsufficientIssuanceTokensReceived();

Insufficient issuance tokens received from purchase ICreditFacility_v1.sol#L218

Module__CreditFacility_InsufficientLoansToConsolidate

error Module__CreditFacility_InsufficientLoansToConsolidate();

Cannot consolidate a single loan (need at least 2) ICreditFacility_v1.sol#L252

Module__CreditFacility_InvalidBorrowAmount

error Module__CreditFacility_InvalidBorrowAmount();

Amount cannot be zero ICreditFacility_v1.sol#L188

Module__CreditFacility_InvalidFeeCalculatorAddress

error Module__CreditFacility_InvalidFeeCalculatorAddress();

Invalid fee calculator address ICreditFacility_v1.sol#L206

Module__CreditFacility_InvalidFeeRate

error Module__CreditFacility_InvalidFeeRate();

Fee rate exceeds maximum allowed (10000 bps = 100%) ICreditFacility_v1.sol#L185

Module__CreditFacility_InvalidLoanId

error Module__CreditFacility_InvalidLoanId();

Invalid loan ID or loan does not belong to caller ICreditFacility_v1.sol#L227

Module__CreditFacility_InvalidLoansForConsolidation

error Module__CreditFacility_InvalidLoansForConsolidation();

One or more loans are invalid or don’t belong to caller ICreditFacility_v1.sol#L255

Module__CreditFacility_InvalidLoopCount

error Module__CreditFacility_InvalidLoopCount();

Loop count must be at least 1 ICreditFacility_v1.sol#L209

Module__CreditFacility_InvalidReceiver

error Module__CreditFacility_InvalidReceiver();

Invalid receiver address for borrowFor function ICreditFacility_v1.sol#L233

Module__CreditFacility_InvalidTokenReceiver

error Module__CreditFacility_InvalidTokenReceiver();

Invalid token receiver address ICreditFacility_v1.sol#L236

Module__CreditFacility_InvalidTransferRecipient

error Module__CreditFacility_InvalidTransferRecipient();

Cannot transfer loan to an invalid recipient ICreditFacility_v1.sol#L221

Module__CreditFacility_LoanNotFoundInUserLoans

error Module__CreditFacility_LoanNotFoundInUserLoans();

Loan ID not found in user’s loan list ICreditFacility_v1.sol#L230

Module__CreditFacility_LoanToValueRatioTooHigh

error Module__CreditFacility_LoanToValueRatioTooHigh(uint attempted_, uint maximum_);

Loan-to-value ratio cannot exceed 100% (10,000 bps). Parameters

Name	Type	Description
`attempted_`	`uint`	The attempted LTV ratio.
`maximum_`	`uint`	The maximum allowed (10,000).

ICreditFacility_v1.sol#L198

Module__CreditFacility_NoCollateralAvailable

error Module__CreditFacility_NoCollateralAvailable();

No collateral tokens available for the user ICreditFacility_v1.sol#L212

Module__CreditFacility_NoIssuanceTokensReceived

error Module__CreditFacility_NoIssuanceTokensReceived();

No issuance tokens received in iteration ICreditFacility_v1.sol#L224

Module__CreditFacility_NoLoansToConsolidate

error Module__CreditFacility_NoLoansToConsolidate();

Cannot consolidate with an empty array of loan IDs ICreditFacility_v1.sol#L249

Module__CreditFacility_NoSegmentsConfigured

error Module__CreditFacility_NoSegmentsConfigured();

No segments are configured in the DBC FM ICreditFacility_v1.sol#L203

Module__CreditFacility_NothingToRebalance

error Module__CreditFacility_NothingToRebalance();

The loan has no collateral to rebalance ICreditFacility_v1.sol#L239

Module__CreditFacility_SlippageExceeded

error Module__CreditFacility_SlippageExceeded(uint received_, uint minimum_);

Slippage protection: tokens minted below minimum Parameters

Name	Type	Description
`received_`	`uint`	The actual tokens received
`minimum_`	`uint`	The minimum tokens required

ICreditFacility_v1.sol#L260