Struct pallet_loans::pallet::Pallet

impl<T: Config> Pallet<T>

pub fn create( origin: OriginFor<T>, pool_id: T::PoolId, info: LoanInfo<T> ) -> DispatchResult

Creates a new loan against the collateral provided

The origin must be the owner of the collateral. This collateral will be transferred to the existing pool.

pub fn borrow( origin: OriginFor<T>, pool_id: T::PoolId, loan_id: T::LoanId, amount: PrincipalInput<T> ) -> DispatchResult

Transfers borrow amount to the borrower.

The origin must be the borrower of the loan. The borrow action should fulfill the borrow restrictions configured at types::LoanRestrictions. The amount will be transferred from pool reserve to borrower. The portfolio valuation of the pool is updated to reflect the new present value of the loan.

pub fn repay( origin: OriginFor<T>, pool_id: T::PoolId, loan_id: T::LoanId, amount: RepaidInput<T> ) -> DispatchResult

Transfers amount borrowed to the pool reserve.

The origin must be the borrower of the loan. The repay action should fulfill the repay restrictions configured at types::RepayRestrictions. If the repaying amount is more than current debt, only current debt is transferred. This does not apply to unscheduled_amount, which can be used to repay more than the outstanding debt. The portfolio valuation of the pool is updated to reflect the new present value of the loan.

pub fn write_off( origin: OriginFor<T>, pool_id: T::PoolId, loan_id: T::LoanId ) -> DispatchResult

Writes off an overdue loan.

This action will write off based on the configured write off policy. The write off action will only take effect if it writes down more (percentage or penalty) than the current write off status of the loan. This action will never writes up. i.e:

Write off by admin with percentage 0.5 and penalty 0.2
Time passes and the policy can be applied.
Write of with a policy that says: percentage 0.3, penaly 0.4
The loan is written off with the maximum between the policy and the current rule: percentage 0.5, penalty 0.4

No special permisions are required to this call. The portfolio valuation of the pool is updated to reflect the new present value of the loan.

pub fn admin_write_off( origin: OriginFor<T>, pool_id: T::PoolId, loan_id: T::LoanId, percentage: T::Rate, penalty: T::Rate ) -> DispatchResult

Writes off a loan from admin origin.

Forces a writing off of a loan if the percentage and penalty parameters respecting the policy values as the maximum. This action can write down/up the current write off status of the loan. If there is no active policy, an admin write off action can write up the write off status. But if there is a policy applied, the admin can only write up until the policy. Write down more than the policy is always allowed. The portfolio valuation of the pool is updated to reflect the new present value of the loan.

pub fn propose_loan_mutation( origin: OriginFor<T>, pool_id: T::PoolId, loan_id: T::LoanId, mutation: LoanMutation<T::Rate> ) -> DispatchResult

Propose a change. The change is not performed until you call Pallet::apply_loan_mutation().

pub fn apply_loan_mutation( origin: OriginFor<T>, pool_id: T::PoolId, change_id: T::Hash ) -> DispatchResult

Apply a proposed change identified by a change id. It will only perform the change if the requirements for it are fulfilled.

pub fn close( origin: OriginFor<T>, pool_id: T::PoolId, loan_id: T::LoanId ) -> DispatchResult

Closes a given loan

A loan only can be closed if it’s fully repaid by the loan borrower. Closing a loan gives back the collateral used for the loan to the borrower .

pub fn propose_write_off_policy( origin: OriginFor<T>, pool_id: T::PoolId, policy: BoundedVec<WriteOffRule<T::Rate>, T::MaxWriteOffPolicySize> ) -> DispatchResult

Updates the write off policy with write off rules.

The write off policy is used to automatically set a write off minimum value to the loan.

pub fn apply_write_off_policy( origin: OriginFor<T>, pool_id: T::PoolId, change_id: T::Hash ) -> DispatchResult

Apply a proposed change identified by a change id. It will only perform the change if the requirements for it are fulfilled.

pub fn update_portfolio_valuation( origin: OriginFor<T>, pool_id: T::PoolId ) -> DispatchResultWithPostInfo

Updates the porfolio valuation for the given pool

pub fn propose_transfer_debt( origin: OriginFor<T>, pool_id: T::PoolId, from_loan_id: T::LoanId, to_loan_id: T::LoanId, repaid_amount: RepaidInput<T>, borrow_amount: PrincipalInput<T> ) -> DispatchResult

Transfer debt from one loan to another loan, repaying from the first loan and borrowing the same amount from the second loan. from_loan_id is the loan used to repay. to_loan_id is the loan used to borrow. The repaid and borrow amount must match.

pub fn apply_transfer_debt( origin: OriginFor<T>, pool_id: T::PoolId, change_id: T::Hash ) -> DispatchResult

Transfer debt from one loan to another loan, repaying from the first loan and borrowing the same amount from the second loan. from_loan_id is the loan used to repay. to_loan_id is the loan used to borrow. The repaid and borrow amount must match.

pub fn increase_debt( origin: OriginFor<T>, pool_id: T::PoolId, loan_id: T::LoanId, amount: PrincipalInput<T> ) -> DispatchResult

Increase debt for a loan. Similar to Pallet::borrow() but without transferring from the pool.

The origin must be the borrower of the loan. The increase debt action should fulfill the borrow restrictions configured at types::LoanRestrictions. The portfolio valuation of the pool is updated to reflect the new present value of the loan.

pub fn decrease_debt( origin: OriginFor<T>, pool_id: T::PoolId, loan_id: T::LoanId, amount: RepaidInput<T> ) -> DispatchResult

Decrease debt for a loan. Similar to Pallet::repay() but without transferring from the pool.

The origin must be the borrower of the loan. The decrease debt action should fulfill the repay restrictions configured at types::LoanRestrictions. The portfolio valuation of the pool is updated to reflect the new present value of the loan.

impl<T: Config> Pallet<T>

Utility methods

pub fn registered_prices( pool_id: T::PoolId ) -> Result<BTreeMap<T::PriceId, PriceOf<T>>, DispatchError>

pub fn update_portfolio_valuation_for_pool( pool_id: T::PoolId, input_prices: PriceCollectionInput<T> ) -> Result<(T::Balance, u32), DispatchError>

pub fn get_active_loans_info( pool_id: T::PoolId ) -> Result<PortfolioInfoOf<T>, DispatchError>

pub fn get_active_loan_info( pool_id: T::PoolId, loan_id: T::LoanId ) -> Result<Option<ActiveLoanInfo<T>>, DispatchError>

pub fn expected_cashflows( pool_id: T::PoolId, loan_id: T::LoanId ) -> Result<Vec<CashflowPayment<T::Balance>>, DispatchError>

impl<T: Config> Pallet<T>

pub fn portfolio_valuation<KArg>( k: KArg ) -> PortfolioValuation<T::Balance, T::LoanId, T::MaxActiveLoansPerPool>
where KArg: EncodeLike<T::PoolId>,

An auto-generated getter for PortfolioValuation.

Trait Implementations§

impl<T: Config> BeforeAllRuntimeMigrations for Pallet<T>

fn before_all_runtime_migrations() -> Weight

Something that should happen before runtime migrations are executed.

fn clone(&self) -> Self

Returns a copy of the value. Read more

1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl<T> Debug for Pallet<T>

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

impl<T: Config> GetStorageVersion for Pallet<T>

type CurrentStorageVersion = StorageVersion

This will be filled out by the pallet macro. Read more

fn current_storage_version() -> Self::CurrentStorageVersion

Returns the current storage version as supported by the pallet.

fn on_chain_storage_version() -> StorageVersion

Returns the on-chain storage version of the pallet as stored in the storage.

fn on_initialize(_n: BlockNumber) -> Weight

Block initialization hook. This is called at the very beginning of block execution. Read more

fn on_finalize(_n: BlockNumber)

Block finalization hook. This is called at the very end of block execution. Read more

fn on_idle(_n: BlockNumber, _remaining_weight: Weight) -> Weight

Hook to consume a block’s idle time. This will run when the block is being finalized (before [Hooks::on_finalize]). Read more

fn on_runtime_upgrade() -> Weight

Hook executed when a code change (aka. a “runtime upgrade”) is detected by FRAME. Read more

fn offchain_worker(_n: BlockNumber)

Implementing this function on a pallet allows you to perform long-running tasks that are dispatched as separate threads, and entirely independent of the main wasm runtime. Read more

fn integrity_test()

Check the integrity of this pallet’s configuration. Read more

impl<T: Config> IntegrityTest for Pallet<T>

fn integrity_test()

See [Hooks::integrity_test].

fn offchain_worker(n: BlockNumberFor<T>)

This function is being called after every block import (when fully synced). Read more

fn on_finalize(n: BlockNumberFor<T>)

See [Hooks::on_finalize].

impl<T: Config> OnGenesis for Pallet<T>

fn on_genesis()

Something that should happen at genesis.

fn on_idle(n: BlockNumberFor<T>, remaining_weight: Weight) -> Weight

See [Hooks::on_idle].

fn on_initialize(n: BlockNumberFor<T>) -> Weight

See [Hooks::on_initialize].

impl<T: Config> OnRuntimeUpgrade for Pallet<T>

fn on_runtime_upgrade() -> Weight

See [Hooks::on_runtime_upgrade].

impl<T: Config> PalletInfoAccess for Pallet<T>

fn index() -> usize

Index of the pallet as configured in the runtime.

fn name() -> &'static str

Name of the pallet as configured in the runtime.

fn name_hash() -> [u8; 16]

Two128 hash of name.

fn module_name() -> &'static str

Name of the Rust module containing the pallet.

fn crate_version() -> CrateVersion

Version of the crate containing the pallet.

impl<T: Config> PalletsInfoAccess for Pallet<T>

fn count() -> usize

The number of pallets’ information that this type represents. Read more

fn infos() -> Vec<PalletInfoData>

All of the pallets’ information that this type represents.

impl<T> PartialEq for Pallet<T>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Config> PoolNAV<<T as Config>::PoolId, <T as Config>::Balance> for Pallet<T>

type ClassId = <T as Config>::ItemId

type RuntimeOrigin = <T as Config>::RuntimeOrigin

fn nav(pool_id: T::PoolId) -> Option<(T::Balance, Seconds)>

fn update_nav(pool_id: T::PoolId) -> Result<T::Balance, DispatchError>

fn initialise(_: OriginFor<T>, _: T::PoolId, _: T::ItemId) -> DispatchResult

impl<T: Config> PoolWriteOffPolicyMutate<<T as Config>::PoolId> for Pallet<T>

type Policy = BoundedVec<WriteOffRule<<T as Config>::Rate>, <T as Config>::MaxWriteOffPolicySize>

fn update(pool_id: T::PoolId, policy: Self::Policy) -> DispatchResult

Updates the policy with the new policy

impl<T: Config> StorageInfoTrait for Pallet<T>

fn storage_info() -> Vec<StorageInfo>

impl<T: Config> WhitelistedStorageKeys for Pallet<T>

fn whitelisted_storage_keys() -> Vec<TrackedStorageKey>

Returns a Vec<TrackedStorageKey> indicating the storage keys that should be whitelisted during benchmarking. This means that those keys will be excluded from the benchmarking performance calculation.

impl<T> Eq for Pallet<T>

Auto Trait Implementations§

impl<T> RefUnwindSafe for Pallet<T>
where T: RefUnwindSafe,

impl<T> Send for Pallet<T>
where T: Send,

impl<T> Sync for Pallet<T>
where T: Sync,

impl<T> Unpin for Pallet<T>
where T: Unpin,

impl<T> UnwindSafe for Pallet<T>
where T: UnwindSafe,

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CheckedConversion for T

fn checked_from<T>(t: T) -> Option<Self>
where Self: TryFrom<T>,

Convert from a value of T into an equivalent instance of Option<Self>. Read more

fn checked_into<T>(self) -> Option<T>
where Self: TryInto<T>,

Consume self to return Some equivalent value of Option<T>. Read more

impl<T> Conv for T

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more

impl<T> DynClone for T
where T: Clone,

fn __clone_box(&self, _: Private) -> *mut ()

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<T> FmtForward for T

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T, U> Into2 for T
where U: From2<T>,

fn into2(self) -> U

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<T> IsType<T> for T

fn from_ref(t: &T) -> &T

Cast reference.

fn into_ref(&self) -> &T

Cast reference.

fn from_mut(t: &mut T) -> &mut T

Cast mutable reference.

fn into_mut(&mut self) -> &mut T

Cast mutable reference.

impl<T, Outer> IsWrappedBy<Outer> for T
where Outer: AsRef<T> + AsMut<T> + From<T>, T: From<Outer>,

fn from_ref(outer: &Outer) -> &T

Get a reference to the inner from the outer.

fn from_mut(outer: &mut Outer) -> &mut T

Get a mutable reference to the inner from the outer.

impl<T> Pipe for T
where T: ?Sized,

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> R
where Self: BorrowMut, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.

impl<T> Pointable for T

const ALIGN: usize = _

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<T> SaturatedConversion for T

fn saturated_from<T>(t: T) -> Self
where Self: UniqueSaturatedFrom<T>,

Convert from a value of T into an equivalent instance of Self. Read more

fn saturated_into<T>(self) -> T
where Self: UniqueSaturatedInto<T>,

Consume self to return an equivalent value of T. Read more

impl<T> Tap for T

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more

fn tap_borrow(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow, B: ?Sized,

Immutable access to the Borrow of a value. Read more

fn tap_borrow_mut(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut, B: ?Sized,

Mutable access to the BorrowMut of a value. Read more

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.

fn tap_borrow_dbg(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.

fn tap_borrow_mut_dbg(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> TryConv for T

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more

impl<T, U> TryFrom for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

impl<T, U> TryInto for T
where U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<T, U> TryInto2 for T
where U: TryFrom2<T>,

type Error = >::Error

fn try_into2(self) -> Result<U, >::Error>

impl<S, T> UncheckedInto<T> for S
where T: UncheckedFrom<S>,

fn unchecked_into(self) -> T

The counterpart to unchecked_from.

impl<T, S> UniqueSaturatedInto<T> for S
where T: Bounded, S: TryInto<T>,

fn unique_saturated_into(self) -> T

Consume self to return an equivalent value of T.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more

impl<T> JsonSchemaMaybe for T

impl<T> MaybeDebug for T
where T: Debug,

impl<T> MaybeRefUnwindSafe for T
where T: RefUnwindSafe,