ILoan
Asset Tokenization Studio Team
ILoan
Interface for managing on-chain loan metadata attached to a security token.
Stores a rich set of loan attributes (structure, interest, risk, collateral, and performance) that describe the underlying credit instrument. State-changing functions require ROLE_LOAN_MANAGER; initialisation requires DEFAULT_ADMIN_ROLE and is callable only once.
Methods
getLoanDetails
function getLoanDetails() external view returns (struct ILoan.LoanDetailsData loanDetailsData_)
Returns the current loan details.
Returns
| Name | Type | Description |
|---|---|---|
| loanDetailsData_ | ILoan.LoanDetailsData | The full loan descriptor currently stored on the token. |
initializeLoan
function initializeLoan(ILoan.LoanDetailsData _loanDetailsData) external nonpayable
Parameters
| Name | Type | Description |
|---|---|---|
| _loanDetailsData | ILoan.LoanDetailsData | undefined |
setLoanDetails
function setLoanDetails(ILoan.LoanDetailsData _loanDetailsData) external nonpayable
Parameters
| Name | Type | Description |
|---|---|---|
| _loanDetailsData | ILoan.LoanDetailsData | undefined |
Events
LoanDetailsSet
event LoanDetailsSet(ILoan.LoanDetailsData loanDetails)
Emitted when the loan details are updated by an authorised manager.
Parameters
| Name | Type | Description |
|---|---|---|
| loanDetails | ILoan.LoanDetailsData | The updated loan descriptor. |
LoanInitialized
event LoanInitialized(ILoan.LoanDetailsData loanDetailsData)
Emitted once when the Loan capability is initialised on a token.
Fires exclusively from initializeLoan after the storage write succeeds.
Parameters
| Name | Type | Description |
|---|---|---|
| loanDetailsData | ILoan.LoanDetailsData | The full loan descriptor written at initialisation. |