-
Notifications
You must be signed in to change notification settings - Fork 2
/
vaults.rs
198 lines (172 loc) · 7.36 KB
/
vaults.rs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
//! Vault
//!
//! This module is responsible for keeping track of the Hifi users that have open
//! positions and monitoring their debt healthiness.
use crate::EthersResult;
use ethers::prelude::*;
use hifi_liquidator_bindings::{BalanceSheet, OpenVaultFilter};
use serde::{Deserialize, Serialize};
use std::{collections::HashMap, sync::Arc};
use tracing::{debug, debug_span};
#[derive(Clone, Debug, Default, Serialize, Deserialize)]
/// Borrower's vault from BalanceSheet
pub struct Vault {
/// The borrower's debt recorded in fyTokens. Obtained by calling `getVaultDebt` on the BalanceSheet.
pub debt: U256,
/// The borrower's debt recorded in underlying. Obtained by dividing `debt` by the underlying precision scalar.
pub debt_in_underlying: U256,
/// Is the vault liquidatable? Obtained by calling `isAccountUnderwater` on the BalanceSheet.
pub is_account_underwater: bool,
/// The borrower's currently locked collateral. Obtained by calling `getVaultLockedCollateral`
/// on the BalanceSheet.
pub locked_collateral: U256,
}
impl Vault {
pub fn new_empty() -> Self {
Self {
debt: U256::zero(),
debt_in_underlying: U256::zero(),
is_account_underwater: false,
locked_collateral: U256::zero(),
}
}
}
#[derive(Clone)]
pub struct VaultsContainer<M> {
/// The BalanceSheet smart contract
pub balance_sheet: BalanceSheet<M>,
/// The fyTokens to monitor.
pub fy_tokens: Vec<Address>,
/// We use Multicall to batch together calls and have reduced stress on our RPC endpoint.
multicall: Multicall<M>,
/// Mapping of the Hifi accounts that have taken loans and might be liquidatable. The first address
/// is the FyToken, the second the borrower's account.
pub vaults: HashMap<Address, HashMap<Address, Vault>>,
}
impl<M: Middleware> VaultsContainer<M> {
/// Constructor
pub async fn new(
balance_sheet: Address,
client: Arc<M>,
fy_tokens: Vec<Address>,
multicall: Option<Address>,
vaults: HashMap<Address, HashMap<Address, Vault>>,
) -> Self {
let multicall = Multicall::new(client.clone(), multicall)
.await
.expect("Could not initialize Multicall");
VaultsContainer {
balance_sheet: BalanceSheet::new(balance_sheet, client),
fy_tokens,
multicall,
vaults,
}
}
pub fn get_vault(&self, fy_token: &Address, borrower: &Address) -> Option<&Vault> {
if let Some(inner_hash_map) = self.vaults.get(fy_token) {
inner_hash_map.get(borrower)
} else {
None
}
}
pub fn get_vaults_iterator(&self) -> impl Iterator<Item = (&Address, &Address, &Vault)> {
let mut vaults_iterator: Vec<(&Address, &Address, &Vault)> = vec![];
for (fy_token, inner_hash_map) in self.vaults.iter() {
for (borrower, vault) in inner_hash_map.iter() {
vaults_iterator.push((fy_token, borrower, vault));
}
}
vaults_iterator.into_iter()
}
/// Updates the vault's details by calling:
///
/// 1. getVaultDebt
/// 2. isAccountUnderwater
/// 3. getVaultLockedCollateral
pub async fn query_vault(&mut self, fy_token: Address, borrower: Address) -> EthersResult<Vault, M> {
let debt_call = self.balance_sheet.get_vault_debt(fy_token, borrower);
let is_account_underwater_call = self.balance_sheet.is_account_underwater(fy_token, borrower);
let locked_collateral_call = self.balance_sheet.get_vault_locked_collateral(fy_token, borrower);
// Batch the calls together.
let multicall: &mut Multicall<M> = self
.multicall
.clear_calls()
.add_call(debt_call)
.add_call(is_account_underwater_call)
.add_call(locked_collateral_call);
let (debt, is_account_underwater, locked_collateral): (U256, bool, U256) = multicall.call().await?;
// Scale the debt down by the underlying precision scalar. E.g. USDC has 6 decimals, so the debt is scaled
// from 1e20 (100 fYUSDC) to 1e8 (100 USDC). There is a loss of precision when scaling down, but we can
// safely neglect it.
// TODO: query the underlying precision scalar from the FyToken contract.
let usdc_precision_scalar =
U256::from_dec_str("1000000000000").expect("Creating U256 from decimal string must work");
let debt_in_underlying = debt / usdc_precision_scalar;
Ok(Vault {
debt,
debt_in_underlying,
is_account_underwater,
locked_collateral,
})
}
/// Indexes any new vaults which may have been opened since we last made this call. Then, it proceeds
/// to get the latest account details for each user.
pub async fn update_vaults(&mut self, from_block: U64, to_block: U64) -> EthersResult<(), M> {
let span = debug_span!("Monitoring");
let _enter = span.enter();
// 1. Get all new vaults (TODO: find a way to avoid having to do this).
let new_vault_tuples: Vec<OpenVaultFilter> = self
.balance_sheet
.open_vault_filter()
.from_block(from_block)
.to_block(to_block)
.query()
.await?;
// 2. Filter the vaults that don't belong to the fyTokens whitelisted the config.
let new_vault_tuples: Vec<(Address, Address)> = new_vault_tuples
.into_iter()
.filter_map(|event_log| {
if self.fy_tokens.contains(&event_log.fy_token) {
Some((event_log.fy_token, event_log.borrower))
} else {
None
}
})
.collect::<Vec<_>>();
// 3. Merge the new vaults with the existing vaults.
for new_vault_tuple in new_vault_tuples.iter() {
let fy_token = new_vault_tuple.0;
let borrower = new_vault_tuple.1;
self.insert_vault_if_not_exists(fy_token, borrower);
}
// 4. Update all vaults.
for (fy_token, inner_hash_map) in self.vaults.clone().iter() {
for borrower in inner_hash_map.keys().into_iter() {
let vault = self.query_vault(*fy_token, *borrower).await?;
self.vaults
.get_mut(fy_token)
.expect("Inner hash map must exist since we're iterating over the map")
.insert(*borrower, vault);
}
}
Ok(())
}
}
/// Private methods for the VaultsContainer struct
impl<M: Middleware> VaultsContainer<M> {
/// Insert the vault in the hash map if it doesn't exist.
fn insert_vault_if_not_exists(&mut self, fy_token: Address, borrower: Address) {
if let Some(inner_hash_map) = self.vaults.get_mut(&fy_token) {
if inner_hash_map.get(&borrower).is_none() {
inner_hash_map.insert(borrower, Vault::new_empty());
debug!(new_borrower = %borrower, in_fy_token = %fy_token);
}
} else {
let mut inner_hash_map = HashMap::<Address, Vault>::new();
inner_hash_map.insert(borrower, Vault::new_empty());
self.vaults.insert(fy_token, inner_hash_map);
debug!(new_fy_token = %fy_token);
debug!(new_borrower = %borrower, in_fy_token = %fy_token);
}
}
}