LoanFacet

Asset Tokenization Studio Team

LoanFacet

Diamond facet that exposes loan metadata management to the proxy.

Selectors exposed: - initializeLoan - setLoanDetails - getLoanDetails

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.

getStaticFunctionSelectors

function getStaticFunctionSelectors() external pure returns (bytes4[])

Gets all function selectors of a facet

Returns

Name	Type	Description
_0	bytes4[]	Face functions selectors

getStaticInterfaceIds

function getStaticInterfaceIds() external pure returns (bytes4[])

Gets all interfaces ids of a facet.

Returns

Name	Type	Description
_0	bytes4[]	Face interface ids

getStaticResolverKey

function getStaticResolverKey() external pure returns (bytes32 staticResolverKey_)

Gets the static resolver key

Returns

Name	Type	Description
staticResolverKey_	bytes32	Static resolver key

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.

Errors

AccountHasNoRole

error AccountHasNoRole(address account, bytes32 role)

Thrown when an account does not hold a required role.

Parameters

Name	Type	Description
account	address	The account that lacks the role.
role	bytes32	The role that is not held.

AssetNotOperational

error AssetNotOperational(bytes32 configId, uint256 versionId)

Raised by InitializerStorageWrapper.checkOperational (and the related isConfigVersionOperational helper) when an operation is attempted on a configuration version that has not yet been marked operational.

Parameters

Name	Type	Description
configId	bytes32	Resolver-proxy configuration whose operational status was checked.
versionId	uint256	Configuration version whose operational status was checked.

Deactivated

error Deactivated()

Thrown when an operation guarded by onlyActivated is attempted on a token whose deactivation flag has already been set.

FacetAlreadyRegistered

error FacetAlreadyRegistered(bytes32 facetId, uint256 lastVersion)

Raised when an initialiser tries to register a facet that already has a non-zero last registered version (i.e. the facet is being re-initialised on a fresh install).

Parameters

Name	Type	Description
facetId	bytes32	Identifier of the offending facet.
lastVersion	uint256	Last version recorded for that facet at the time of the check.

InvalidTimestamp

error InvalidTimestamp()

Reverts when a timestamp value is invalid.

Used for shared timestamp validation that is not tied to expiration.

IsPaused

error IsPaused()

Thrown when an operation that requires the token to be unpaused is attempted while the token is paused (own flag or any external pause contract).

UnrecognizedResolverProxyVersion

error UnrecognizedResolverProxyVersion(bytes8 _resolverProxyVersion)

Thrown when the provided proxy version does not match any BLR compatible standard.

Parameters

Name	Type	Description
_resolverProxyVersion	bytes8	proxy version that is not compatible with the BLR.

WalletRecovered

error WalletRecovered()

Thrown when attempting to recover a wallet that has already been recovered.

WrongDates

error WrongDates(uint256 firstDate, uint256 secondDate)

Reverts when two date values fail their required ordering constraint.

The expected relationship between both dates is defined by the caller's validation context.

Parameters

Name	Type	Description
firstDate	uint256	First date participating in the failed comparison.
secondDate	uint256	Second date participating in the failed comparison.

ZeroAddressNotAllowed

error ZeroAddressNotAllowed()

Reverts when the zero address is supplied where it is not permitted.

Prevents invalid account, contract, or recipient references.