Struct Contract

pub struct Contract {
    pub market: Market,
    /* private fields */
}

Fields

market: Market

Implementations

impl Contract

Internal helpers.

pub fn retrieve_price_pair(&self) -> Promise

pub fn price_pair(&self, oracle_response: OracleResponse) -> PricePair

pub fn execute_supply( &mut self, account_id: AccountId, amount: BorrowAssetAmount, )

pub fn execute_collateralize( &mut self, account_id: AccountId, amount: CollateralAssetAmount, price_pair: &PricePair, )

pub fn execute_repay( &mut self, account_id: AccountId, amount: BorrowAssetAmount, price_pair: &PricePair, ) -> BorrowAssetAmount

Returns the amount that should be returned to the account.

impl Contract

External helpers.

pub const GAS_BORROW_01_CONSUME_PRICE: Gas

pub const GAS_BORROW_02_FINALIZE: Gas

pub const GAS_EXECUTE_NEXT_SUPPLY_WITHDRAWAL_REQUEST_01_FINALIZE: Gas

pub const GAS_COLLATERALIZE_TRANSFER_CALL_01_CONSUME_PRICE: Gas

pub const GAS_REPAY_TRANSFER_CALL_01_CONSUME_PRICE: Gas

pub const GAS_LIQUIDATE_TRANSFER_CALL_01_CONSUME_PRICE: Gas

pub const GAS_LIQUIDATE_TRANSFER_CALL_02_FINALIZE: Gas

pub const GAS_WITHDRAW_COLLATERAL_01_CONSUME_PRICE: Gas

pub const GAS_WITHDRAW_COLLATERAL_02_FINALIZE: Gas

pub const GAS_WITHDRAW_STATIC_YIELD_01_FINALIZE: Gas

pub fn borrow_01_consume_price( &mut self, account_id: AccountId, amount: BorrowAssetAmount, oracle_response: OracleResponse, ) -> Promise

pub fn borrow_02_finalize( &mut self, account_id: AccountId, initial_borrow: InitialBorrow, )

pub fn execute_next_supply_withdrawal_request_01_finalize( &mut self, resolutions: Vec<Withdrawal>, result: WithdrawalQueueExecutionResult, ) -> WithdrawalQueueExecutionResult

pub fn collateralize_transfer_call_01_consume_price( &mut self, account_id: AccountId, amount: CollateralAssetAmount, return_style: ReturnStyle, oracle_response: OracleResponse, ) -> Value

pub fn repay_transfer_call_01_consume_price( &mut self, account_id: AccountId, amount: BorrowAssetAmount, return_style: ReturnStyle, oracle_response: OracleResponse, ) -> Value

pub fn liquidate_transfer_call_01_consume_price( &mut self, liquidator_id: AccountId, amount: BorrowAssetAmount, msg: LiquidateMsg, return_style: ReturnStyle, oracle_response: OracleResponse, ) -> Promise

pub fn liquidate_transfer_call_02_finalize( &mut self, refund: BorrowAssetAmount, return_style: ReturnStyle, ) -> Value

Called during liquidation process; checks whether the transfer of collateral to the liquidator was successful.

pub fn withdraw_collateral_01_consume_price( &mut self, account_id: AccountId, amount: CollateralAssetAmount, oracle_response: OracleResponse, ) -> Promise

pub fn withdraw_collateral_02_finalize( &mut self, account_id: AccountId, amount: CollateralAssetAmount, )

pub fn withdraw_static_yield_01_finalize( &mut self, account_id: AccountId, amount: BorrowAssetAmount, )

impl Contract

pub fn ext(account_id: AccountId) -> ContractExt

API for calling this contract’s functions in a subsequent execution.

pub fn ext_on(promise: Promise) -> ContractExt

pub fn ext_self() -> ContractExt

Convenience method for creating a cross-contract call to the current contract.

Equivalent to Self::ext(near_sdk::env::current_account_id()).

impl Contract

pub fn contract_source_metadata()

impl Contract

pub fn new(configuration: MarketConfiguration) -> Contract

Methods from Deref<Target = Market>

pub fn borrowed(&self) -> FungibleAssetAmount<BorrowAsset>

pub fn total_incoming(&self) -> FungibleAssetAmount<BorrowAsset>

pub fn incoming_at( &self, snapshot_index: u32, ) -> FungibleAssetAmount<BorrowAsset>

pub fn get_last_finalized_snapshot(&self) -> &Snapshot

pub fn current_snapshot(&self) -> Snapshot

pub fn snapshot(&mut self) -> SnapshotProof

pub fn single_snapshot_fee( &self, amount: FungibleAssetAmount<BorrowAsset>, ) -> Option<FungibleAssetAmount<BorrowAsset>>

pub fn interest_rate(&self) -> Decimal

pub fn get_borrow_asset_available_to_borrow( &self, ) -> FungibleAssetAmount<BorrowAsset>

pub fn iter_supply_positions( &self, ) -> impl Iterator<Item = (AccountId, SupplyPosition)>

pub fn supply_position_ref( &self, account_id: AccountId, ) -> Option<SupplyPositionRef<&Market>>

pub fn supply_position_guard( &mut self, _proof: SnapshotProof, account_id: AccountId, ) -> Option<SupplyPositionGuard<'_>>

pub fn get_or_create_supply_position_guard( &mut self, _proof: SnapshotProof, account_id: AccountId, ) -> SupplyPositionGuard<'_>

pub fn cleanup_supply_position(&mut self, account_id: &AccountId) -> bool

pub fn iter_borrow_positions( &self, ) -> impl Iterator<Item = (AccountId, BorrowPosition)>

pub fn borrow_position_ref( &self, account_id: AccountId, ) -> Option<BorrowPositionRef<&Market>>

pub fn borrow_position_guard( &mut self, _proof: SnapshotProof, account_id: AccountId, ) -> Option<BorrowPositionGuard<'_>>

pub fn get_or_create_borrow_position_guard( &mut self, _proof: SnapshotProof, account_id: AccountId, ) -> BorrowPositionGuard<'_>

pub fn cleanup_borrow_position(&mut self, account_id: &AccountId) -> bool

pub fn record_borrow_asset_protocol_yield( &mut self, amount: FungibleAssetAmount<BorrowAsset>, )

pub fn record_borrow_asset_yield_distribution( &mut self, amount: FungibleAssetAmount<BorrowAsset>, )

pub fn accumulate_static_yield( &mut self, account_id: &AccountId, snapshot_limit: u32, ) -> Result<(), UnknownAccount>

Accumulate static yield for an account.

Errors

• When the account is not configured to earn static yield.

Trait Implementations

impl BorshDeserialize for Contract

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 Contract

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 Contract

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

impl ContractState for Contract

fn state_key() -> &'static [u8]

fn state_exists() -> bool

fn state_read() -> Option<Self>

where Self: BorshDeserialize,

fn state_write(&self) -> bool

where Self: BorshSerialize,

impl Default for Contract

fn default() -> Self

Returns the “default value” for a type.

impl Deref for Contract

type Target = Market

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Contract

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl FungibleTokenReceiver for Contract

fn ft_on_transfer( &mut self, sender_id: AccountId, amount: U128, msg: String, ) -> PromiseOrValue<U128>

Called by fungible token contract after ft_transfer_call was initiated by sender_id of the given amount with the transfer message given in msg field. The amount of tokens were already transferred to this contract account and ready to be used.

impl Hook<Contract, Nep145ForceUnregister<'_>> for Contract

fn hook<R>( _: &mut Self, _: &Nep145ForceUnregister<'_>, _: impl FnOnce(&mut Self) -> R, ) -> R

Execute a function with hooks.

impl MarketExternalInterface for Contract

fn create_supply_withdrawal_request(&mut self, amount: BorrowAssetAmount)

If the predecessor has already entered the queue, calling this function will reset the position to the back of the queue.

fn get_configuration(&self) -> MarketConfiguration

Retrieve the market configuration.

fn get_current_snapshot(&self) -> Snapshot

Retrieve the current snapshot (in progress; not yet finalized).

fn get_finalized_snapshots_len(&self) -> u32

Retrieve the count of finalized snapshots.

fn get_borrow_asset_metrics(&self) -> BorrowAssetMetrics

Retrieve current contract metrics about borrow asset deposit, availability, usage, etc.

fn list_borrow_positions( &self, offset: Option<u32>, count: Option<u32>, ) -> HashMap<AccountId, BorrowPosition>

Retrieve a map of borrow positions.

fn list_finalized_snapshots( &self, offset: Option<u32>, count: Option<u32>, ) -> Vec<&Snapshot>

Retrieve a list of finalized snapshots.

fn list_supply_positions( &self, offset: Option<u32>, count: Option<u32>, ) -> HashMap<AccountId, SupplyPosition>

Retrieves a set of supply positions.

fn get_borrow_position(&self, account_id: AccountId) -> Option<BorrowPosition>

Retrieve a specific borrow position, with estimated fees.

fn get_borrow_position_pending_interest( &self, account_id: AccountId, snapshot_limit: Option<u32>, ) -> Option<BorrowAssetAmount>

Estimate the pending interest on the borrow position, that is, the amount of interest that would accrue on the record if an accumulation were to be run.

fn get_borrow_status( &self, account_id: AccountId, oracle_response: OracleResponse, ) -> Option<BorrowStatus>

Retrieves the status of a borrow position (healthy or in liquidation) given some asset prices.

fn borrow(&mut self, amount: BorrowAssetAmount) -> Promise

Transfers amount of borrow asset tokens to the caller, provided their borrow position will still be sufficiently collateralized.

fn withdraw_collateral(&mut self, amount: CollateralAssetAmount) -> Promise

Transfers amount of collateral asset tokens to the caller, provided their borrow position will still be sufficiently collateralized.

fn apply_interest( &mut self, account_id: Option<AccountId>, snapshot_limit: Option<u32>, )

Applies interest to the predecessor’s borrow record. Not likely to be used in real life, since there it does not affect the final interest calculation, and rounds fractional interest UP.

fn get_supply_position(&self, account_id: AccountId) -> Option<SupplyPosition>

Retrieves a supply position record, with estimated yield.

fn get_supply_position_pending_yield( &self, account_id: AccountId, snapshot_limit: Option<u32>, ) -> Option<BorrowAssetAmount>

fn cancel_supply_withdrawal_request(&mut self)

Removes a supply position from the withdrawal queue.

fn execute_next_supply_withdrawal_request( &mut self, batch_limit: Option<u32>, ) -> PromiseOrValue<WithdrawalQueueExecutionResult>

Attempts to fulfill the first withdrawal request in the queue.

fn get_supply_withdrawal_request_status( &self, account_id: AccountId, ) -> Option<WithdrawalRequestStatus>

Retrieves the status of a withdrawal request in the queue.

fn get_supply_withdrawal_queue_status(&self) -> WithdrawalQueueStatus

Retrieves the status of the withdrawal queue.

fn harvest_yield( &mut self, account_id: Option<AccountId>, mode: Option<HarvestYieldMode>, ) -> BorrowAssetAmount

Claim any distributed yield to the supply record.

fn get_last_yield_rate(&self) -> Decimal

This value is an expected average over time. Supply positions actually earn all of their yield the instant it is distributed.

fn get_static_yield( &self, account_id: AccountId, ) -> Option<Accumulator<BorrowAsset>>

Retrieves the amount of yield earned by an account statically configured to earn yield (e.g. [MarketConfiguration::yield_weights] or [MarketConfiguration::protocol_account_id]).

fn accumulate_static_yield( &mut self, account_id: Option<AccountId>, snapshot_limit: Option<u32>, )

Accumulates yield for an account that earns static yield.

fn withdraw_static_yield( &mut self, amount: Option<BorrowAssetAmount>, ) -> Promise

Attempts to withdraw the amount of yield earned by an account statically configured to earn yield (e.g. [MarketConfiguration::yield_weights] or [MarketConfiguration::protocol_account_id]).

impl Nep145 for Contract

fn storage_deposit( &mut self, account_id: Option<AccountId>, registration_only: Option<bool>, ) -> StorageBalance

Payable method that receives an attached deposit of NEAR for a given account.

fn storage_withdraw(&mut self, amount: Option<NearToken>) -> StorageBalance

Withdraw specified amount of available NEAR for predecessor account. This method is safe to call, and does not remove data.

fn storage_unregister(&mut self, force: Option<bool>) -> bool

Unregister the predecessor account and withdraw all available NEAR.

fn storage_balance_of(&self, account_id: AccountId) -> Option<StorageBalance>

Returns the storage balance for the given account, or None if the account is not registered.

fn storage_balance_bounds(&self) -> StorageBalanceBounds

Returns minimum and maximum allowed balance amounts to interact with this contract. See [StorageBalanceBounds] for more details.

impl Nep145ControllerInternal for Contract

type ForceUnregisterHook = (Contract, ())

NEP-145 lifecycle hook.

fn root() -> Slot<()>

Root storage slot.

fn slot_balance_bounds() -> Slot<StorageBalanceBounds>

Storage slot for balance bounds.

fn slot_account(account_id: &AccountIdRef) -> Slot<StorageBalance>

Storage slot for individual account balance.

impl Nep245Receiver for Contract

fn mt_on_transfer( &mut self, sender_id: AccountId, previous_owner_ids: Vec<AccountId>, token_ids: Vec<TokenId>, amounts: Vec<U128>, msg: String, ) -> PromiseOrValue<Vec<U128>>

Take some action after receiving a multi token.