Keyboard shortcuts

Press ← or → to navigate between chapters

Press ? to show this help

Press Esc to hide this help

IShrine

Fully qualified path: opus::interfaces::shrine::IShrine

pub trait IShrine<TContractState>

Trait functions

get_yin

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

fn get_yin(self: @TContractState, user: ContractAddress) -> Wad

get_total_yin

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

fn get_total_yin(self: @TContractState) -> Wad

get_yin_spot_price

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

fn get_yin_spot_price(self: @TContractState) -> Wad

get_yang_total

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

fn get_yang_total(self: @TContractState, yang: ContractAddress) -> Wad

get_protocol_owned_yang_amt

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

fn get_protocol_owned_yang_amt(self: @TContractState, yang: ContractAddress) -> Wad

get_protocol_owned_troves_debt

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

fn get_protocol_owned_troves_debt(self: @TContractState) -> Wad

get_yangs_count

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

fn get_yangs_count(self: @TContractState) -> u32

get_deposit

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

fn get_deposit(self: @TContractState, yang: ContractAddress, trove_id: u64) -> Wad

get_trove_deposits

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

fn get_trove_deposits(self: @TContractState, trove_id: u64) -> Span<YangBalance>

get_shrine_deposits

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

fn get_shrine_deposits(self: @TContractState) -> Span<YangBalance>

get_budget

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

fn get_budget(self: @TContractState) -> SignedWad

get_yang_price

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

fn get_yang_price(self: @TContractState, yang: ContractAddress, interval: u64) -> (Wad, Wad)

get_yang_rate

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

fn get_yang_rate(self: @TContractState, yang: ContractAddress, rate_era: u64) -> Ray

get_current_rate_era

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

fn get_current_rate_era(self: @TContractState) -> u64

get_minimum_trove_value

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

fn get_minimum_trove_value(self: @TContractState) -> Wad

get_debt_ceiling

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

fn get_debt_ceiling(self: @TContractState) -> Wad

get_multiplier

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

fn get_multiplier(self: @TContractState, interval: u64) -> (Ray, Ray)

get_yang_suspension_status

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

fn get_yang_suspension_status(self: @TContractState, yang: ContractAddress) -> YangSuspensionStatus

get_yang_threshold

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

fn get_yang_threshold(self: @TContractState, yang: ContractAddress) -> Ray

get_recovery_mode_target_factor

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

fn get_recovery_mode_target_factor(self: @TContractState) -> Ray

get_recovery_mode_buffer_factor

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

fn get_recovery_mode_buffer_factor(self: @TContractState) -> Ray

get_redistributions_count

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

fn get_redistributions_count(self: @TContractState) -> u32

get_trove_redistribution_id

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

fn get_trove_redistribution_id(self: @TContractState, trove_id: u64) -> u32

get_redistribution_for_yang

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

fn get_redistribution_for_yang(
    self: @TContractState, yang: ContractAddress, redistribution_id: u32,
) -> Wad

is_recovery_mode

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

fn is_recovery_mode(self: @TContractState) -> bool

get_live

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

fn get_live(self: @TContractState) -> bool

add_yang

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

fn add_yang(
    ref self: TContractState,
    yang: ContractAddress,
    threshold: Ray,
    start_price: Wad,
    initial_rate: Ray,
    initial_yang_amt: Wad,
)

set_threshold

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

fn set_threshold(ref self: TContractState, yang: ContractAddress, new_threshold: Ray)

suspend_yang

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

fn suspend_yang(ref self: TContractState, yang: ContractAddress)

unsuspend_yang

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

fn unsuspend_yang(ref self: TContractState, yang: ContractAddress)

update_rates

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

fn update_rates(ref self: TContractState, yangs: Span<ContractAddress>, new_rates: Span<Ray>)

advance

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

fn advance(ref self: TContractState, yang: ContractAddress, price: Wad)

set_multiplier

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

fn set_multiplier(ref self: TContractState, multiplier: Ray)

set_minimum_trove_value

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

fn set_minimum_trove_value(ref self: TContractState, value: Wad)

set_debt_ceiling

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

fn set_debt_ceiling(ref self: TContractState, ceiling: Wad)

adjust_budget

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

fn adjust_budget(ref self: TContractState, amount: SignedWad)

update_yin_spot_price

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

fn update_yin_spot_price(ref self: TContractState, new_price: Wad)

kill

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

fn kill(ref self: TContractState)

set_recovery_mode_target_factor

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

fn set_recovery_mode_target_factor(ref self: TContractState, factor: Ray)

set_recovery_mode_buffer_factor

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

fn set_recovery_mode_buffer_factor(ref self: TContractState, factor: Ray)

deposit

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

fn deposit(ref self: TContractState, yang: ContractAddress, trove_id: u64, amount: Wad)

withdraw

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

fn withdraw(ref self: TContractState, yang: ContractAddress, trove_id: u64, amount: Wad)

forge

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

fn forge(
    ref self: TContractState,
    user: ContractAddress,
    trove_id: u64,
    amount: Wad,
    max_forge_fee_pct: Wad,
)

melt

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

fn melt(ref self: TContractState, user: ContractAddress, trove_id: u64, amount: Wad)

seize

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

fn seize(ref self: TContractState, yang: ContractAddress, trove_id: u64, amount: Wad)

redistribute

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

fn redistribute(
    ref self: TContractState,
    trove_id: u64,
    debt_to_redistribute: Wad,
    pct_value_to_redistribute: Ray,
)

inject

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

fn inject(ref self: TContractState, receiver: ContractAddress, amount: Wad)

eject

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

fn eject(ref self: TContractState, burner: ContractAddress, amount: Wad)

get_shrine_health

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

fn get_shrine_health(self: @TContractState) -> Health

get_current_yang_price

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

fn get_current_yang_price(self: @TContractState, yang: ContractAddress) -> (Wad, Wad, u64)

get_current_multiplier

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

fn get_current_multiplier(self: @TContractState) -> (Ray, Ray, u64)

get_forge_fee_pct

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

fn get_forge_fee_pct(self: @TContractState) -> Wad

is_healthy

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

fn is_healthy(self: @TContractState, trove_id: u64) -> bool

get_max_forge

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

fn get_max_forge(self: @TContractState, trove_id: u64) -> Wad

get_trove_health

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

fn get_trove_health(self: @TContractState, trove_id: u64) -> Health

get_trove_base_threshold

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

fn get_trove_base_threshold(self: @TContractState, trove_id: u64) -> Ray

get_redistributed_debt_for_trove

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

fn get_redistributed_debt_for_trove(self: @TContractState, trove_id: u64) -> Wad