Struct LinearPayout

Source

pub struct LinearPayout;

Expand description

The LinearPayout model computes rewards using a linear function of the input asset.

Concept: Linear Transformation

§Formula

reward = (slope * input) + base_reward

§Characteristics:

Linear scaling: Reward grows proportionally with input.
Base offset: Ensures a minimum reward via base_reward.
Deterministic: Same inputs and parameters yield identical results.
Fixed-point safe: Uses fixed-point arithmetic for precision.
Context-driven: Controlled via LinearPayoutConfig.

§Applications:

Staking systems with base + proportional rewards
Incentive models with guaranteed minimum payout
Linear emission schedules
Reward shaping for participation-based systems

§Use Cases

Reward systems with a base incentive plus proportional scaling
Gradual incentive curves
Configurable emission policies

§Example:

let config = LinearPayoutConfig {
    slope: FixedU128::from_rational(1, 10), // 0.1x
    base_reward: FixedU128::from_integer(5),
};

let reward = LinearPayout::compute(100u128, Some(config));
// reward = (0.1 * 100) + 5 = 15
assert_eq!(reward, 15);

Trait Implementations§

Source §

impl Debug for LinearPayout

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Default for LinearPayout

Source §

fn default() -> LinearPayout

Returns the “default value” for a type. Read more

Source §

impl<FixedPoint, Asset> PurePluginModel<Asset, LinearPayoutConfig<FixedPoint>, Asset> for LinearPayout
where Asset: IntegerToFixed + FixedForInteger<FixedPoint = FixedPoint>, FixedPoint: FixedPointNumber,

Source §

fn compute( &self, input: Asset, context: &LinearPayoutConfig<FixedPoint>, ) -> Asset

Computes the model’s output for a given immutable input and context.

Auto Trait Implementations§

§

impl RefUnwindSafe for LinearPayout

§

impl UnwindSafe for LinearPayout

Blanket Implementations§

Source §

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

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

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

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

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

Source §

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

Source §

impl<T> From<T> for T

Source §

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

Source §

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

Source §

fn into(self) -> U

Calls U::from(self).

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

Source §

impl<T> IntoEither for T

Source §

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

Source §

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, U> IntoKey for T
where U: FromKey<T>,

§

fn into_key(self) -> U

Source §

impl<T, U, Tag> IntoTag<U, Tag> for T
where U: FromTag<T, Tag>, Tag: DiscriminantTag,

Source §

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.

Source §

impl<T, Time> Logging<Time> for T
where Time: Time,

Source §

const FALLBACK_TARGET: &'static str = "routine"

Default logging target if none is provided.

Most routines, especially offchain workers or background tasks, use this target for simplicity.

It allows a consistent place to look for routine logs without requiring every call to specify a target.

Note: This target is only a conveninence and may be somewhat vague. To ensure errors can still be traced accurately, the logged messages should include additional metadata (e.g., module name, error index, or contextual info) so that the source of the error can be identified even if the target is generic.

Source §

type Logger = DispatchError

The type taken and returned for logging.

We simply return the same [DispatchError] that was logged, so logging does not change control flow or error propagation.

DispatchError is used because in Substrate it encompasses all runtime errors - including module errors, token errors, arithmetic issues, and transactional boundaries - making it the universal substrate-side error representation.

Source §

type Level = LogLevel

The log level type.

We use the LogLevel enum to standardize severity levels (Info, Warn, Error, Debug) across all routine logs.

Source §

fn log( level: <T as Logging<Time>>::Level, err: &<T as Logging<Time>>::Logger, timestamp: Time, target: Option<&str>, fmt: Option<fn(Time, &<T as Logging<Time>>::Level, &str, &str) -> String>, ) -> <T as Logging<Time>>::Logger

Core logging function that all helpers delegate to. Read more

Source §

fn info( err: &Self::Logger, timestamp: Timestamp, target: Option<&str>, fmt: Option<fn(Timestamp, &Self::Level, &str, &str) -> String>, ) -> Self::Logger
where Self: Sized,

Logs an info-level message. Read more

Source §

fn warn( err: &Self::Logger, timestamp: Timestamp, target: Option<&str>, fmt: Option<fn(Timestamp, &Self::Level, &str, &str) -> String>, ) -> Self::Logger
where Self: Sized,

Logs a warning-level message. Read more

Source §

fn error( err: &Self::Logger, timestamp: Timestamp, target: Option<&str>, fmt: Option<fn(Timestamp, &Self::Level, &str, &str) -> String>, ) -> Self::Logger
where Self: Sized,

Logs an error-level message. Read more

Source §

fn debug( err: &Self::Logger, timestamp: Timestamp, target: Option<&str>, fmt: Option<fn(Timestamp, &Self::Level, &str, &str) -> String>, ) -> Self::Logger
where Self: Sized,

Logs a debug-level message. Read more

Source §

impl<T> Same for T

Source §

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

Source §

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

Source §

type Error = Infallible

The type returned in the event of a conversion error.

Source §

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

Performs the conversion.

Source §

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

Source §

type Error = >::Error

The type returned in the event of a conversion error.

Source §

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

Performs the conversion.

§

impl<T, U> TryIntoKey for T
where U: TryFromKey<T>,

§

type Error = >::Error

§

fn try_into_key(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

Source §

impl<Provider, Discriminant, T> DelegateVirtualDynBound<Provider, Discriminant> for T
where Provider: VirtualDynBound<Discriminant>, Discriminant: DiscriminantTag,

Source §

impl<Provider, Discriminant, T> DelegateVirtualStaticBound<Provider, Discriminant> for T
where Provider: VirtualStaticBound<Discriminant>, Discriminant: DiscriminantTag,

§

impl<T> JsonSchemaMaybe for T

§

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

§

Struct LinearPayoutCopy item path

§Formula

§Characteristics:

§Applications:

§Use Cases

§Example:

Trait Implementations§

impl Debug for LinearPayout

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

impl Default for LinearPayout

fn default() -> LinearPayout

impl<FixedPoint, Asset> PurePluginModel<Asset, LinearPayoutConfig<FixedPoint>, Asset> for LinearPayoutwhere Asset: IntegerToFixed + FixedForInteger<FixedPoint = FixedPoint>, FixedPoint: FixedPointNumber,

fn compute( &self, input: Asset, context: &LinearPayoutConfig<FixedPoint>, ) -> Asset

Auto Trait Implementations§

impl Freeze for LinearPayout

impl RefUnwindSafe for LinearPayout

impl Send for LinearPayout

impl Sync for LinearPayout

impl Unpin for LinearPayout

impl UnwindSafe for LinearPayout

Blanket Implementations§

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> CheckedConversion for T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

impl<T> IntoEither for T

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

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

impl<T, U> IntoKey<U> for Twhere U: FromKey<T>,

fn into_key(self) -> U

impl<T, U, Tag> IntoTag<U, Tag> for Twhere U: FromTag<T, Tag>, Tag: DiscriminantTag,

fn into_tag(self) -> U

impl<Src, Dest> IntoTuple<Dest> for Srcwhere Dest: FromTuple<Src>,

fn into_tuple(self) -> Dest

impl<T> IsType<T> for T

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

fn into_ref(&self) -> &T

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

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

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

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

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

impl<T, Time> Logging<Time> for Twhere Time: Time,

const FALLBACK_TARGET: &'static str = "routine"

type Logger = DispatchError

type Level = LogLevel

fn log( level: <T as Logging<Time>>::Level, err: &<T as Logging<Time>>::Logger, timestamp: Time, target: Option<&str>, fmt: Option<fn(Time, &<T as Logging<Time>>::Level, &str, &str) -> String>, ) -> <T as Logging<Time>>::Logger

fn info( err: &Self::Logger, timestamp: Timestamp, target: Option<&str>, fmt: Option<fn(Timestamp, &Self::Level, &str, &str) -> String>, ) -> Self::Loggerwhere Self: Sized,

fn warn( err: &Self::Logger, timestamp: Timestamp, target: Option<&str>, fmt: Option<fn(Timestamp, &Self::Level, &str, &str) -> String>, ) -> Self::Loggerwhere Self: Sized,

fn error( err: &Self::Logger, timestamp: Timestamp, target: Option<&str>, fmt: Option<fn(Timestamp, &Self::Level, &str, &str) -> String>, ) -> Self::Loggerwhere Self: Sized,

fn debug( err: &Self::Logger, timestamp: Timestamp, target: Option<&str>, fmt: Option<fn(Timestamp, &Self::Level, &str, &str) -> String>, ) -> Self::Loggerwhere Self: Sized,

impl<T> Same for T

type Output = T

impl<T> SaturatedConversion for T

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

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

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

type Error = Infallible

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

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

type Error = <U as TryFrom<T>>::Error

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

impl<T, U> TryIntoKey<U> for Twhere U: TryFromKey<T>,

type Error = <U as TryFromKey<T>>::Error

fn try_into_key(self) -> Result<U, <U as TryFromKey<T>>::Error>

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

fn unchecked_into(self) -> T

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

Struct LinearPayout

impl<FixedPoint, Asset> PurePluginModel<Asset, LinearPayoutConfig<FixedPoint>, Asset> for LinearPayout
where Asset: IntegerToFixed + FixedForInteger<FixedPoint = FixedPoint>, FixedPoint: FixedPointNumber,

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

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

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

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

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

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

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

impl<T, U> IntoKey<U> for T
where U: FromKey<T>,

impl<T, U, Tag> IntoTag<U, Tag> for T
where U: FromTag<T, Tag>, Tag: DiscriminantTag,

impl<Src, Dest> IntoTuple<Dest> for Src
where Dest: FromTuple<Src>,

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

impl<T, Time> Logging<Time> for T
where Time: Time,

fn info( err: &Self::Logger, timestamp: Timestamp, target: Option<&str>, fmt: Option<fn(Timestamp, &Self::Level, &str, &str) -> String>, ) -> Self::Logger
where Self: Sized,

fn warn( err: &Self::Logger, timestamp: Timestamp, target: Option<&str>, fmt: Option<fn(Timestamp, &Self::Level, &str, &str) -> String>, ) -> Self::Logger
where Self: Sized,

fn error( err: &Self::Logger, timestamp: Timestamp, target: Option<&str>, fmt: Option<fn(Timestamp, &Self::Level, &str, &str) -> String>, ) -> Self::Logger
where Self: Sized,

fn debug( err: &Self::Logger, timestamp: Timestamp, target: Option<&str>, fmt: Option<fn(Timestamp, &Self::Level, &str, &str) -> String>, ) -> Self::Logger
where Self: Sized,

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

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

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

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

impl<T, U> TryIntoKey<U> for T
where U: TryFromKey<T>,

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

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

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

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

impl<Provider, Discriminant, T> DelegateVirtualDynBound<Provider, Discriminant> for T
where Provider: VirtualDynBound<Discriminant>, Discriminant: DiscriminantTag,

impl<Provider, Discriminant, T> DelegateVirtualStaticBound<Provider, Discriminant> for T
where Provider: VirtualStaticBound<Discriminant>, Discriminant: DiscriminantTag,

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

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