Struct CapGroup

pub struct CapGroup {
    pub absolute_cap: Option<NonZeroU128>,
    pub relative_cap: Option<Wad>,
}

A cap group defines maximum allocation limits for a set of markets.

Caps are optional - None means no limit for that cap type. When both caps are set, the effective cap is the minimum of the two.

Fields

absolute_cap: Option<NonZeroU128>

Absolute cap in underlying asset units. None means no absolute cap.

relative_cap: Option<Wad>

Relative cap as a WAD fraction of total vault assets (1e18 = 100%). None means no relative cap.

Implementations

impl CapGroup

pub fn builder() -> CapGroupBuilder<((), ())>

Create a builder for building CapGroup. On the builder, call .absolute_cap(...)(optional), .relative_cap(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of CapGroup.

impl CapGroup

pub fn is_unlimited(&self) -> bool

pub fn effective_cap(&self, total_assets: u128) -> u128

Compute the effective cap for a cap group given total vault assets.

Returns u128::MAX if the cap group is unlimited.

pub fn can_allocate( &self, current_principal: u128, amount: u128, total_assets: u128, ) -> bool

Check if an allocation is allowed under cap group constraints.

pub fn enforce( &self, current_principal: u128, amount: u128, total_assets: u128, ) -> Result<(), CapGroupError>

Enforce cap group constraints on an allocation.

pub fn available_capacity( &self, current_principal: u128, total_assets: u128, ) -> u128

Compute the maximum additional amount that can be allocated to a cap group.

Trait Implementations

impl BorshDeserialize for CapGroup

fn deserialize_reader<__R: Read>(reader: &mut __R) -> Result<Self, Error>

fn deserialize(buf: &mut &[u8]) -> Result<Self, Error>

Deserializes this instance from a given slice of bytes. Updates the buffer to point at the remaining bytes.

fn try_from_slice(v: &[u8]) -> Result<Self, Error>

Deserialize this instance from a slice of bytes.

fn try_from_reader<R>(reader: &mut R) -> Result<Self, Error>

where R: Read,

impl BorshSchema for CapGroup

fn declaration() -> Declaration

Get the name of the type without brackets.

fn add_definitions_recursively( definitions: &mut BTreeMap<Declaration, Definition>, )

Recursively, using DFS, add type definitions required for this type. Type definition partially explains how to serialize/deserialize a type.

impl BorshSerialize for CapGroup

fn serialize<__W: Write>(&self, writer: &mut __W) -> Result<(), Error>

impl Clone for CapGroup

fn clone(&self) -> CapGroup

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CapGroup

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

Formats the value using the given formatter.

impl Default for CapGroup

fn default() -> CapGroup

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CapGroup

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<CapGroup> for CapGroupRecord

fn from(cap: CapGroup) -> Self

Converts to this type from the input type.

impl JsonSchema for CapGroup

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for CapGroup

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for CapGroup

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for CapGroup

impl StructuralPartialEq for CapGroup