-
Notifications
You must be signed in to change notification settings - Fork 2
/
Vault.ts
151 lines (146 loc) · 5.74 KB
/
Vault.ts
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
import { Account } from './Account';
import {
vault as vaultBackend,
vaultAsa,
z_p_f_vaultAsa,
large_cp_vault_asa,
new_algo_vault,
new_asa_vault,
} from '@xbacked-dao/xbacked-contracts';
import { VaultReturnParams, ReachUserVault, UserVaultReturnParams, VaultParameters } from './interfaces';
import { VAULTS } from './utils';
function isSafeKeyOfQ(s: string): s is keyof typeof VAULTS.MainNet {
return Object.keys(VAULTS.MainNet).includes(s);
}
type AsaVault = {
decimals: number;
z_p_f_vault_asa?: boolean;
large_cp_vault_asa?: boolean;
new_asa_vault?: boolean;
}
/**
* The Parameters returned from the staate of a contract
*/
/**
* An abstraction of an Xusd contract
*/
export class Vault {
/** @property Unique identifier for the contract */
readonly id: number | undefined;
backend: any;
asaVault?: AsaVault;
constructor(params: VaultParameters) {
if (isSafeKeyOfQ(params.name)) {
this.id = VAULTS[params.network][params.name].vaultId;
const asaVault =
VAULTS[params.network][params.name]?.new_asa_vault === false
? undefined
: {
decimals:
VAULTS[params.network][params.name].assetDecimals === undefined
? 6
: VAULTS[params.network][params.name].assetDecimals,
z_p_f_vault_asa: false,
large_cp_vault_asa: false,
new_asa_vault: VAULTS[params.network][params.name]?.new_asa_vault,
};
if (asaVault) {
if (asaVault?.z_p_f_vault_asa) {
this.backend = z_p_f_vaultAsa;
} else if (asaVault?.large_cp_vault_asa) {
this.backend = large_cp_vault_asa;
} else if (asaVault?.new_asa_vault) {
this.backend = new_asa_vault;
} else {
this.backend = vaultAsa;
}
this.asaVault = { ...asaVault, decimals: asaVault?.decimals === undefined ? 6 : asaVault?.decimals };
} else {
if (params.name === 'oldAlgo') {
this.backend = vaultBackend;
} else {
this.backend = new_algo_vault;
}
}
} else {
throw Error('Wrong param for name');
}
}
/**
* Used to get the state of the contract
* @param params Contains key account of type [[Account]] that will be used to read state from the contract
* @returns State information of type [[VaultReturnParams]]
*/
async getState(params: { account: Account }): Promise<VaultReturnParams> {
const ctc = params.account.reachAccount.contract(this.backend, this.id);
const get = ctc.v.State;
const stateView = await get.read();
if (stateView[0] === 'None') {
throw new Error('the view returned none');
}
const vaultState = stateView[1];
return {
LIQUIDATION_COLLATERAL_RATIO: vaultState.LIQUIDATION_COLLATERAL_RATIO.toNumber(),
MINIMUM_COLLATERAL_RATIO: vaultState.MINIMUM_COLLATERAL_RATIO.toNumber(),
VAULT_INTEREST_RATE: vaultState?.VAULT_INTEREST_RATE?.toNumber(),
hotState: {
accruedInterest: vaultState.hotState.accruedInterest.toNumber(),
totalVaultDebt: vaultState.hotState.totalVaultDebt.toNumber(),
},
coldState: {
accruedFees: vaultState.coldState.accruedFees.toNumber(),
collateralPrice: vaultState.coldState.collateralPrice.toNumber(),
redeemableVaults: vaultState.coldState.redeemableVaults?.map((v: any[]) => v[1]),
proposalTime: vaultState.coldState.proposalTime.toNumber(),
contractState: vaultState.coldState.contractState.toNumber(),
feeStructure: vaultState.coldState.feeStructure.map((feeSplit: any) => feeSplit.toNumber()),
minimumDebtAmount: vaultState.coldState.minimumDebtAmount.toNumber(),
maximumCollateralValue: vaultState.coldState.maximumCollateralValue.toNumber(),
vaultInterestRate: vaultState.coldState?.vaultInterestRate?.toNumber(),
},
addresses: {
govStakersAddress: params.account.reachStdLib.formatAddress(vaultState.addresses.govStakersAddress),
liquidationStakersAddress: params.account.reachStdLib.formatAddress(vaultState.addresses.stabilityPoolAddress),
oracleAddress: params.account.reachStdLib.formatAddress(vaultState.addresses.oracleAddress),
adminAddress: params.account.reachStdLib.formatAddress(vaultState.addresses.adminAddress),
daoAddress: params.account.reachStdLib.formatAddress(vaultState.addresses.treasuryAddress),
},
};
}
/**
*
* @param params Contains keys account that indicates the account that will be used to read the information from the contract and address that indicates the address of the contract to be read from
* @returns User information of type [[UserVaultReturnParams]]
*/
async getUserInfo(params: { account: Account; address: string }): Promise<UserVaultReturnParams> {
const ctc = params.account.reachAccount.contract(this.backend, this.id);
const get = ctc.v.State;
const stateView = await get.readVault(params.address);
if (!stateView[1] || stateView[1][0] === 'None') {
return {
collateral: 0,
liquidating: false,
vaultDebt: 0,
redeemable: false,
vaultFound: false,
lastAccruedInterestTime: 0,
};
}
const vaultState = stateView[1][1];
return { ...Vault.parseUserInfo(vaultState), vaultFound: true };
}
/**
*
* @param vaultState type of [[UserVaultReturnParams]]
* @returns type of [[ReachUserVault]]
*/
static parseUserInfo(vaultState: any): ReachUserVault {
return {
collateral: vaultState.collateral.toNumber(),
liquidating: vaultState.liquidating,
vaultDebt: vaultState.vaultDebt.toNumber(),
redeemable: vaultState.redeemable,
lastAccruedInterestTime: vaultState.lastAccruedInterestTime.toNumber(),
};
}
}