Keyboard shortcuts

Press ← or → to navigate between chapters

Press ? to show this help

Press Esc to hide this help

IShrineSafeDispatcherTrait

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait

Part of the group: dispatchers

pub trait IShrineSafeDispatcherTrait<T>

Trait functions

get_yin

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::get_yin

fn get_yin(self: T, user: ContractAddress) -> Result<Wad, Array<felt252>>

get_total_yin

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::get_total_yin

fn get_total_yin(self: T) -> Result<Wad, Array<felt252>>

get_yin_spot_price

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::get_yin_spot_price

fn get_yin_spot_price(self: T) -> Result<Wad, Array<felt252>>

get_yang_total

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::get_yang_total

fn get_yang_total(self: T, yang: ContractAddress) -> Result<Wad, Array<felt252>>

get_protocol_owned_yang_amt

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::get_protocol_owned_yang_amt

fn get_protocol_owned_yang_amt(self: T, yang: ContractAddress) -> Result<Wad, Array<felt252>>

get_protocol_owned_troves_debt

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::get_protocol_owned_troves_debt

fn get_protocol_owned_troves_debt(self: T) -> Result<Wad, Array<felt252>>

get_yangs_count

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::get_yangs_count

fn get_yangs_count(self: T) -> Result<u32, Array<felt252>>

get_deposit

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::get_deposit

fn get_deposit(self: T, yang: ContractAddress, trove_id: u64) -> Result<Wad, Array<felt252>>

get_trove_deposits

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::get_trove_deposits

fn get_trove_deposits(self: T, trove_id: u64) -> Result<Span<YangBalance>, Array<felt252>>

get_shrine_deposits

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::get_shrine_deposits

fn get_shrine_deposits(self: T) -> Result<Span<YangBalance>, Array<felt252>>

get_budget

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::get_budget

fn get_budget(self: T) -> Result<SignedWad, Array<felt252>>

get_yang_price

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::get_yang_price

fn get_yang_price(
    self: T, yang: ContractAddress, interval: u64,
) -> Result<(Wad, Wad), Array<felt252>>

get_yang_rate

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::get_yang_rate

fn get_yang_rate(self: T, yang: ContractAddress, rate_era: u64) -> Result<Ray, Array<felt252>>

get_current_rate_era

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::get_current_rate_era

fn get_current_rate_era(self: T) -> Result<u64, Array<felt252>>

get_minimum_trove_value

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::get_minimum_trove_value

fn get_minimum_trove_value(self: T) -> Result<Wad, Array<felt252>>

get_debt_ceiling

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::get_debt_ceiling

fn get_debt_ceiling(self: T) -> Result<Wad, Array<felt252>>

get_multiplier

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::get_multiplier

fn get_multiplier(self: T, interval: u64) -> Result<(Ray, Ray), Array<felt252>>

get_yang_suspension_status

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::get_yang_suspension_status

fn get_yang_suspension_status(
    self: T, yang: ContractAddress,
) -> Result<YangSuspensionStatus, Array<felt252>>

get_yang_threshold

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::get_yang_threshold

fn get_yang_threshold(self: T, yang: ContractAddress) -> Result<Ray, Array<felt252>>

get_recovery_mode_target_factor

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::get_recovery_mode_target_factor

fn get_recovery_mode_target_factor(self: T) -> Result<Ray, Array<felt252>>

get_recovery_mode_buffer_factor

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::get_recovery_mode_buffer_factor

fn get_recovery_mode_buffer_factor(self: T) -> Result<Ray, Array<felt252>>

get_redistributions_count

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::get_redistributions_count

fn get_redistributions_count(self: T) -> Result<u32, Array<felt252>>

get_trove_redistribution_id

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::get_trove_redistribution_id

fn get_trove_redistribution_id(self: T, trove_id: u64) -> Result<u32, Array<felt252>>

get_redistribution_for_yang

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::get_redistribution_for_yang

fn get_redistribution_for_yang(
    self: T, yang: ContractAddress, redistribution_id: u32,
) -> Result<Wad, Array<felt252>>

is_recovery_mode

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::is_recovery_mode

fn is_recovery_mode(self: T) -> Result<bool, Array<felt252>>

get_live

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::get_live

fn get_live(self: T) -> Result<bool, Array<felt252>>

add_yang

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::add_yang

fn add_yang(
    self: T,
    yang: ContractAddress,
    threshold: Ray,
    start_price: Wad,
    initial_rate: Ray,
    initial_yang_amt: Wad,
) -> Result<(), Array<felt252>>

set_threshold

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::set_threshold

fn set_threshold(self: T, yang: ContractAddress, new_threshold: Ray) -> Result<(), Array<felt252>>

suspend_yang

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::suspend_yang

fn suspend_yang(self: T, yang: ContractAddress) -> Result<(), Array<felt252>>

unsuspend_yang

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::unsuspend_yang

fn unsuspend_yang(self: T, yang: ContractAddress) -> Result<(), Array<felt252>>

update_rates

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::update_rates

fn update_rates(
    self: T, yangs: Span<ContractAddress>, new_rates: Span<Ray>,
) -> Result<(), Array<felt252>>

advance

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::advance

fn advance(self: T, yang: ContractAddress, price: Wad) -> Result<(), Array<felt252>>

set_multiplier

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::set_multiplier

fn set_multiplier(self: T, multiplier: Ray) -> Result<(), Array<felt252>>

set_minimum_trove_value

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::set_minimum_trove_value

fn set_minimum_trove_value(self: T, value: Wad) -> Result<(), Array<felt252>>

set_debt_ceiling

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::set_debt_ceiling

fn set_debt_ceiling(self: T, ceiling: Wad) -> Result<(), Array<felt252>>

adjust_budget

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::adjust_budget

fn adjust_budget(self: T, amount: SignedWad) -> Result<(), Array<felt252>>

update_yin_spot_price

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::update_yin_spot_price

fn update_yin_spot_price(self: T, new_price: Wad) -> Result<(), Array<felt252>>

kill

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::kill

fn kill(self: T) -> Result<(), Array<felt252>>

set_recovery_mode_target_factor

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::set_recovery_mode_target_factor

fn set_recovery_mode_target_factor(self: T, factor: Ray) -> Result<(), Array<felt252>>

set_recovery_mode_buffer_factor

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::set_recovery_mode_buffer_factor

fn set_recovery_mode_buffer_factor(self: T, factor: Ray) -> Result<(), Array<felt252>>

deposit

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::deposit

fn deposit(self: T, yang: ContractAddress, trove_id: u64, amount: Wad) -> Result<(), Array<felt252>>

withdraw

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::withdraw

fn withdraw(
    self: T, yang: ContractAddress, trove_id: u64, amount: Wad,
) -> Result<(), Array<felt252>>

forge

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::forge

fn forge(
    self: T, user: ContractAddress, trove_id: u64, amount: Wad, max_forge_fee_pct: Wad,
) -> Result<(), Array<felt252>>

melt

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::melt

fn melt(self: T, user: ContractAddress, trove_id: u64, amount: Wad) -> Result<(), Array<felt252>>

seize

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::seize

fn seize(self: T, yang: ContractAddress, trove_id: u64, amount: Wad) -> Result<(), Array<felt252>>

redistribute

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::redistribute

fn redistribute(
    self: T, trove_id: u64, debt_to_redistribute: Wad, pct_value_to_redistribute: Ray,
) -> Result<(), Array<felt252>>

inject

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::inject

fn inject(self: T, receiver: ContractAddress, amount: Wad) -> Result<(), Array<felt252>>

eject

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::eject

fn eject(self: T, burner: ContractAddress, amount: Wad) -> Result<(), Array<felt252>>

get_shrine_health

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::get_shrine_health

fn get_shrine_health(self: T) -> Result<Health, Array<felt252>>

get_current_yang_price

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::get_current_yang_price

fn get_current_yang_price(self: T, yang: ContractAddress) -> Result<(Wad, Wad, u64), Array<felt252>>

get_current_multiplier

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::get_current_multiplier

fn get_current_multiplier(self: T) -> Result<(Ray, Ray, u64), Array<felt252>>

get_forge_fee_pct

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::get_forge_fee_pct

fn get_forge_fee_pct(self: T) -> Result<Wad, Array<felt252>>

is_healthy

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::is_healthy

fn is_healthy(self: T, trove_id: u64) -> Result<bool, Array<felt252>>

get_max_forge

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::get_max_forge

fn get_max_forge(self: T, trove_id: u64) -> Result<Wad, Array<felt252>>

get_trove_health

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::get_trove_health

fn get_trove_health(self: T, trove_id: u64) -> Result<Health, Array<felt252>>

get_trove_base_threshold

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::get_trove_base_threshold

fn get_trove_base_threshold(self: T, trove_id: u64) -> Result<Ray, Array<felt252>>

get_redistributed_debt_for_trove

Fully qualified path: opus::interfaces::shrine::IShrineSafeDispatcherTrait::get_redistributed_debt_for_trove

fn get_redistributed_debt_for_trove(self: T, trove_id: u64) -> Result<Wad, Array<felt252>>