Enum KeeperAction 

#[non_exhaustive]
#[repr(u8)]
pub enum KeeperAction<Address> {
    UpdateOraclePrices {
        prices: Vec<OraclePriceUpdateArgs>,
        publish_timestamp: UnixTimestampMicros,
    },
    UpdateMarkPrices {
        prices: Vec<MarkPriceUpdateArgs>,
        publish_timestamp: UnixTimestampMicros,
    },
    UpdatePremiumIndexes {
        market_ids: Vec<MarketId>,
    },
    UpdateOraclePricesWithPythProofs {
        prices: Vec<OraclePriceUpdateWithPythProofArgs>,
        publish_timestamp: UnixTimestampMicros,
    },
    UpdateFunding {
        market_ids: Vec<MarketId>,
    },
    AddTradingCredits {
        user_address: Address,
        amount: PositiveDecimal,
    },
    RemoveTradingCredits {
        user_address: Address,
        amount: PositiveDecimal,
    },
    UpdateUserFeeTier {
        address: Address,
        fee_tier: FeeTier,
    },
    UpdateUserFeeDiscountBps {
        address: Address,
        fee_discount_bps: u16,
    },
    SetCumulativeReferralRewards {
        address: Address,
        asset_id: AssetId,
        amount: PositiveDecimal,
    },
}

Keeper operations requiring specific admin privileges.

These operations are typically called by automated keepers/bots and require specific admin types (Pricing, Funding, Credits, FeeTier, Referrals). However, one can also update all admin addresses with it.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

UpdateOraclePrices

Update oracle prices (PricingAdmin).

Fields

prices: Vec<OraclePriceUpdateArgs>

publish_timestamp: UnixTimestampMicros

UpdateMarkPrices

Update mark prices (PricingAdmin).

Fields

prices: Vec<MarkPriceUpdateArgs>

publish_timestamp: UnixTimestampMicros

UpdatePremiumIndexes

Update premium indexes for markets (PricingAdmin).

Fields

market_ids: Vec<MarketId>

UpdateOraclePricesWithPythProofs

Update oracle prices using signed Pyth payloads (PricingAdmin).

Fields

prices: Vec<OraclePriceUpdateWithPythProofArgs>

publish_timestamp: UnixTimestampMicros

UpdateFunding

Update funding rates for markets (FundingAdmin).

Fields

market_ids: Vec<MarketId>

AddTradingCredits

Add trading credits to a user (CreditsAdmin).

Fields

user_address: Address

amount: PositiveDecimal

RemoveTradingCredits

Remove trading credits from a user (CreditsAdmin).

Fields

user_address: Address

amount: PositiveDecimal

UpdateUserFeeTier

Update user’s fee tier (FeeTierAdmin).

Fields

address: Address

fee_tier: FeeTier

UpdateUserFeeDiscountBps

Update a given user’s fee discount (in bps) (FeeTierAdmin).

Fields

address: Address

fee_discount_bps: u16

SetCumulativeReferralRewards

Set a user’s cumulative referral rewards to an absolute amount (ReferralsAdmin).

Fields

address: Address

asset_id: AssetId

amount: PositiveDecimal

Implementations

impl<Address> KeeperAction<Address>

pub fn required_admin_type(&self) -> AdminType

Returns the specific admin type required for this keeper operation.

Trait Implementations

impl<Address> AsRef<str> for KeeperAction<Address>

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl<Address> BorshDeserialize for KeeperAction<Address>

where Address: BorshDeserialize,

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<Address> BorshSerialize for KeeperAction<Address>

where Address: BorshSerialize,

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

impl<Address: Clone> Clone for KeeperAction<Address>

fn clone(&self) -> KeeperAction<Address>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Address: Debug> Debug for KeeperAction<Address>

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

Formats the value using the given formatter.

impl<'de, Address> Deserialize<'de> for KeeperAction<Address>

where Address: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<Address> EnumExt for KeeperAction<Address>

where Address: BorshDeserialize,

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

Deserialises given variant of an enum from the reader.

impl<'_enum, Address> From<&'_enum KeeperAction<Address>> for KeeperActionDiscriminants

fn from(val: &'_enum KeeperAction<Address>) -> KeeperActionDiscriminants

Converts to this type from the input type.

impl<Address> From<KeeperAction<Address>> for CallMessage<Address>

fn from(v: KeeperAction<Address>) -> Self

Converts to this type from the input type.

impl<Address> From<KeeperAction<Address>> for KeeperActionDiscriminants

fn from(val: KeeperAction<Address>) -> KeeperActionDiscriminants

Converts to this type from the input type.

impl<Address: Hash> Hash for KeeperAction<Address>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<Address: JsonSchema> JsonSchema for KeeperAction<Address>

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<Address: Ord> Ord for KeeperAction<Address>

fn cmp(&self, other: &KeeperAction<Address>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<Address: PartialEq> PartialEq for KeeperAction<Address>

fn eq(&self, other: &KeeperAction<Address>) -> 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<Address: PartialOrd> PartialOrd for KeeperAction<Address>

fn partial_cmp(&self, other: &KeeperAction<Address>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<Address> Serialize for KeeperAction<Address>

where Address: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<Address> UniversalWallet for KeeperAction<Address>

where __SovVirtualWallet_KeeperAction_UpdateOraclePrices: UniversalWallet, __SovVirtualWallet_KeeperAction_UpdateMarkPrices: UniversalWallet, __SovVirtualWallet_KeeperAction_UpdatePremiumIndexes: UniversalWallet, __SovVirtualWallet_KeeperAction_UpdateOraclePricesWithPythProofs: UniversalWallet, __SovVirtualWallet_KeeperAction_UpdateFunding: UniversalWallet, __SovVirtualWallet_KeeperAction_AddTradingCredits<Address>: UniversalWallet, __SovVirtualWallet_KeeperAction_RemoveTradingCredits<Address>: UniversalWallet, __SovVirtualWallet_KeeperAction_UpdateUserFeeTier<Address>: UniversalWallet, __SovVirtualWallet_KeeperAction_UpdateUserFeeDiscountBps<Address>: UniversalWallet, __SovVirtualWallet_KeeperAction_SetCumulativeReferralRewards<Address>: UniversalWallet, Self: 'static,

fn scaffold() -> Item<IndexLinking>

Generate the “scaffolding” of the item. If the item is a primtive, this is just the corresponding primtive. If the type is composed of other types, this is the container with all links set to Link::Placeholder.

fn get_child_links(schema: &mut Schema) -> Vec<Link>

Ensure that each type contained in the outer type (i.e. the type of each struct/tuple field) is added to the schema, and return a Link connecting the child to the parent.

fn get_child_templates(schema: &mut Schema) -> TransactionTemplateSet

Empty by default When derived by the macro, builds a template set from annotations on the fields + the field types’ own get_child_templates()

fn write_schema(schema: &mut Schema) -> Link

Writes the type to the schema if it is not already present and returns a link to it.

fn make_root_of(schema: &mut Schema)

Writes the type and all its children to the schema, if not already present, and sets the type as a root type. Generates any templates defined on that type.

fn make_linkable(schema: &mut Schema) -> Link

Gets a link to the type, writing the type to the schema if necessary.

fn id_override() -> Option<ItemId>

Override the type ID of the item. This should typically not be written by hand. Instead, use the OverrideSchema trait.

impl<Address: Eq> Eq for KeeperAction<Address>

impl<Address> StructuralPartialEq for KeeperAction<Address>