utils | @xbacked-dao/xbacked-sdk

Index

Variables

Functions

Variables

Const VAULTS

VAULTS: { MainNet: { algo: { assetDecimals: undefined; liquidatorDiscount: number; new_algo_vault: boolean; new_asa_vault: boolean; vaultId: number }; coop: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }; gAlgo: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }; goBtc: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }; goEth: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }; link: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }; mAlgo: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }; meldGold: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }; oldAlgo: { assetDecimals: undefined; deprecated: boolean; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }; silver$: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }; wrappedAvax: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }; wrappedSol: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number } }; TestNet: { algo: { assetDecimals: undefined; liquidatorDiscount: number; new_algo_vault: boolean; new_asa_vault: boolean; vaultId: number }; coop: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }; gAlgo: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }; goBtc: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }; goEth: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }; link: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }; mAlgo: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }; meldGold: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }; oldAlgo: { assetDecimals: undefined; liquidatorDiscount: number; new_algo_vault: boolean; new_asa_vault: boolean; vaultId: number }; silver$: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }; wrappedAvax: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }; wrappedSol: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number } } } = ...

Type declaration

MainNet: { algo: { assetDecimals: undefined; liquidatorDiscount: number; new_algo_vault: boolean; new_asa_vault: boolean; vaultId: number }; coop: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }; gAlgo: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }; goBtc: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }; goEth: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }; link: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }; mAlgo: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }; meldGold: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }; oldAlgo: { assetDecimals: undefined; deprecated: boolean; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }; silver$: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }; wrappedAvax: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }; wrappedSol: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number } }
- algo: { assetDecimals: undefined; liquidatorDiscount: number; new_algo_vault: boolean; new_asa_vault: boolean; vaultId: number }
  - assetDecimals: undefined
  - liquidatorDiscount: number
  - new_algo_vault: boolean
  - new_asa_vault: boolean
  - vaultId: number
- coop: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }
  - assetDecimals: number
  - assetId: number
  - liquidatorDiscount: number
  - new_asa_vault: boolean
  - vaultId: number
- gAlgo: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }
  - assetDecimals: number
  - assetId: number
  - liquidatorDiscount: number
  - new_asa_vault: boolean
  - vaultId: number
- goBtc: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }
  - assetDecimals: number
  - assetId: number
  - liquidatorDiscount: number
  - new_asa_vault: boolean
  - vaultId: number
- goEth: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }
  - assetDecimals: number
  - assetId: number
  - liquidatorDiscount: number
  - new_asa_vault: boolean
  - vaultId: number
- link: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }
  - assetDecimals: number
  - assetId: number
  - liquidatorDiscount: number
  - new_asa_vault: boolean
  - vaultId: number
- mAlgo: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }
  - assetDecimals: number
  - assetId: number
  - liquidatorDiscount: number
  - new_asa_vault: boolean
  - vaultId: number
- meldGold: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }
  - assetDecimals: number
  - assetId: number
  - liquidatorDiscount: number
  - new_asa_vault: boolean
  - vaultId: number
- oldAlgo: { assetDecimals: undefined; deprecated: boolean; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }
  - assetDecimals: undefined
  - deprecated: boolean
  - liquidatorDiscount: number
  - new_asa_vault: boolean
  - vaultId: number
- silver$: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }
  - assetDecimals: number
  - assetId: number
  - liquidatorDiscount: number
  - new_asa_vault: boolean
  - vaultId: number
- wrappedAvax: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }
  - assetDecimals: number
  - assetId: number
  - liquidatorDiscount: number
  - new_asa_vault: boolean
  - vaultId: number
- wrappedSol: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }
  - assetDecimals: number
  - assetId: number
  - liquidatorDiscount: number
  - new_asa_vault: boolean
  - vaultId: number
TestNet: { algo: { assetDecimals: undefined; liquidatorDiscount: number; new_algo_vault: boolean; new_asa_vault: boolean; vaultId: number }; coop: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }; gAlgo: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }; goBtc: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }; goEth: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }; link: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }; mAlgo: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }; meldGold: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }; oldAlgo: { assetDecimals: undefined; liquidatorDiscount: number; new_algo_vault: boolean; new_asa_vault: boolean; vaultId: number }; silver$: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }; wrappedAvax: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }; wrappedSol: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number } }
- algo: { assetDecimals: undefined; liquidatorDiscount: number; new_algo_vault: boolean; new_asa_vault: boolean; vaultId: number }
  - assetDecimals: undefined
  - liquidatorDiscount: number
  - new_algo_vault: boolean
  - new_asa_vault: boolean
  - vaultId: number
- coop: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }
  - assetDecimals: number
  - assetId: number
  - liquidatorDiscount: number
  - new_asa_vault: boolean
  - vaultId: number
- gAlgo: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }
  - assetDecimals: number
  - assetId: number
  - liquidatorDiscount: number
  - new_asa_vault: boolean
  - vaultId: number
- goBtc: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }
  - assetDecimals: number
  - assetId: number
  - liquidatorDiscount: number
  - new_asa_vault: boolean
  - vaultId: number
- goEth: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }
  - assetDecimals: number
  - assetId: number
  - liquidatorDiscount: number
  - new_asa_vault: boolean
  - vaultId: number
- link: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }
  - assetDecimals: number
  - assetId: number
  - liquidatorDiscount: number
  - new_asa_vault: boolean
  - vaultId: number
- mAlgo: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }
  - assetDecimals: number
  - assetId: number
  - liquidatorDiscount: number
  - new_asa_vault: boolean
  - vaultId: number
- meldGold: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }
  - assetDecimals: number
  - assetId: number
  - liquidatorDiscount: number
  - new_asa_vault: boolean
  - vaultId: number
- oldAlgo: { assetDecimals: undefined; liquidatorDiscount: number; new_algo_vault: boolean; new_asa_vault: boolean; vaultId: number }
  - assetDecimals: undefined
  - liquidatorDiscount: number
  - new_algo_vault: boolean
  - new_asa_vault: boolean
  - vaultId: number
- silver$: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }
  - assetDecimals: number
  - assetId: number
  - liquidatorDiscount: number
  - new_asa_vault: boolean
  - vaultId: number
- wrappedAvax: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }
  - assetDecimals: number
  - assetId: number
  - liquidatorDiscount: number
  - new_asa_vault: boolean
  - vaultId: number
- wrappedSol: { assetDecimals: number; assetId: number; liquidatorDiscount: number; new_asa_vault: boolean; vaultId: number }
  - assetDecimals: number
  - assetId: number
  - liquidatorDiscount: number
  - new_asa_vault: boolean
  - vaultId: number

Const backends

backends: { stabilityPool: any; vault: any } = ...

Type declaration

stabilityPool: any
vault: any

Const deprecatedVaults

deprecatedVaults: { MainNet: { algo: { deprecated: boolean; liquidatorDiscount: number; vaultId: number }; gAlgo: { assetDecimals: number; assetId: number; deprecated: boolean; liquidatorDiscount: number; vaultId: number }; goBtc: { assetDecimals: number; assetId: number; deprecated: boolean; large_cp_vault_asa: boolean; liquidatorDiscount: number; vaultId: number }; goEth: { assetDecimals: number; assetId: number; deprecated: boolean; large_cp_vault_asa: boolean; liquidatorDiscount: number; vaultId: number }; meldGold: { assetDecimals: number; assetId: number; deprecated: boolean; liquidatorDiscount: number; vaultId: number; z_p_f_vault_asa: boolean }; silver$: { assetDecimals: number; assetId: number; liquidatorDiscount: number; vaultId: number; z_p_f_vault_asa: boolean } }; TestNet: { algo: { liquidatorDiscount: number; vaultId: number }; gAlgo: { assetDecimals: number; assetId: number; liquidatorDiscount: number; vaultId: number }; goBtc: { assetDecimals: number; assetId: number; large_cp_vault_asa: boolean; liquidatorDiscount: number; vaultId: number }; goEth: { assetDecimals: number; assetId: number; large_cp_vault_asa: boolean; liquidatorDiscount: number; vaultId: number }; meldGold: { assetDecimals: number; assetId: number; liquidatorDiscount: number; vaultId: number; z_p_f_vault_asa: boolean }; silver$: { assetDecimals: number; assetId: number; liquidatorDiscount: number; vaultId: number; z_p_f_vault_asa: boolean } } } = ...

Type declaration

MainNet: { algo: { deprecated: boolean; liquidatorDiscount: number; vaultId: number }; gAlgo: { assetDecimals: number; assetId: number; deprecated: boolean; liquidatorDiscount: number; vaultId: number }; goBtc: { assetDecimals: number; assetId: number; deprecated: boolean; large_cp_vault_asa: boolean; liquidatorDiscount: number; vaultId: number }; goEth: { assetDecimals: number; assetId: number; deprecated: boolean; large_cp_vault_asa: boolean; liquidatorDiscount: number; vaultId: number }; meldGold: { assetDecimals: number; assetId: number; deprecated: boolean; liquidatorDiscount: number; vaultId: number; z_p_f_vault_asa: boolean }; silver$: { assetDecimals: number; assetId: number; liquidatorDiscount: number; vaultId: number; z_p_f_vault_asa: boolean } }
- algo: { deprecated: boolean; liquidatorDiscount: number; vaultId: number }
  - deprecated: boolean
  - liquidatorDiscount: number
  - vaultId: number
- gAlgo: { assetDecimals: number; assetId: number; deprecated: boolean; liquidatorDiscount: number; vaultId: number }
  - assetDecimals: number
  - assetId: number
  - deprecated: boolean
  - liquidatorDiscount: number
  - vaultId: number
- goBtc: { assetDecimals: number; assetId: number; deprecated: boolean; large_cp_vault_asa: boolean; liquidatorDiscount: number; vaultId: number }
  - assetDecimals: number
  - assetId: number
  - deprecated: boolean
  - large_cp_vault_asa: boolean
  - liquidatorDiscount: number
  - vaultId: number
- goEth: { assetDecimals: number; assetId: number; deprecated: boolean; large_cp_vault_asa: boolean; liquidatorDiscount: number; vaultId: number }
  - assetDecimals: number
  - assetId: number
  - deprecated: boolean
  - large_cp_vault_asa: boolean
  - liquidatorDiscount: number
  - vaultId: number
- meldGold: { assetDecimals: number; assetId: number; deprecated: boolean; liquidatorDiscount: number; vaultId: number; z_p_f_vault_asa: boolean }
  - assetDecimals: number
  - assetId: number
  - deprecated: boolean
  - liquidatorDiscount: number
  - vaultId: number
  - z_p_f_vault_asa: boolean
- silver$: { assetDecimals: number; assetId: number; liquidatorDiscount: number; vaultId: number; z_p_f_vault_asa: boolean }
  - assetDecimals: number
  - assetId: number
  - liquidatorDiscount: number
  - vaultId: number
  - z_p_f_vault_asa: boolean
TestNet: { algo: { liquidatorDiscount: number; vaultId: number }; gAlgo: { assetDecimals: number; assetId: number; liquidatorDiscount: number; vaultId: number }; goBtc: { assetDecimals: number; assetId: number; large_cp_vault_asa: boolean; liquidatorDiscount: number; vaultId: number }; goEth: { assetDecimals: number; assetId: number; large_cp_vault_asa: boolean; liquidatorDiscount: number; vaultId: number }; meldGold: { assetDecimals: number; assetId: number; liquidatorDiscount: number; vaultId: number; z_p_f_vault_asa: boolean }; silver$: { assetDecimals: number; assetId: number; liquidatorDiscount: number; vaultId: number; z_p_f_vault_asa: boolean } }
- algo: { liquidatorDiscount: number; vaultId: number }
  - liquidatorDiscount: number
  - vaultId: number
- gAlgo: { assetDecimals: number; assetId: number; liquidatorDiscount: number; vaultId: number }
  - assetDecimals: number
  - assetId: number
  - liquidatorDiscount: number
  - vaultId: number
- goBtc: { assetDecimals: number; assetId: number; large_cp_vault_asa: boolean; liquidatorDiscount: number; vaultId: number }
  - assetDecimals: number
  - assetId: number
  - large_cp_vault_asa: boolean
  - liquidatorDiscount: number
  - vaultId: number
- goEth: { assetDecimals: number; assetId: number; large_cp_vault_asa: boolean; liquidatorDiscount: number; vaultId: number }
  - assetDecimals: number
  - assetId: number
  - large_cp_vault_asa: boolean
  - liquidatorDiscount: number
  - vaultId: number
- meldGold: { assetDecimals: number; assetId: number; liquidatorDiscount: number; vaultId: number; z_p_f_vault_asa: boolean }
  - assetDecimals: number
  - assetId: number
  - liquidatorDiscount: number
  - vaultId: number
  - z_p_f_vault_asa: boolean
- silver$: { assetDecimals: number; assetId: number; liquidatorDiscount: number; vaultId: number; z_p_f_vault_asa: boolean }
  - assetDecimals: number
  - assetId: number
  - liquidatorDiscount: number
  - vaultId: number
  - z_p_f_vault_asa: boolean

Functions

addrFromBox

addrFromBox(box: any): string

- Defined in utils.ts:426
Parameters
- box: any
Returns string

addrToBox

addrToBox(addr: string): string

- Defined in utils.ts:438
Parameters
- addr: string
Returns string

calcCollateralRatio

calcCollateralRatio(collateral: number, collateralPrice: number, vaultDebt: number, decimals: number): number

- Defined in utils.ts:344
Parameters
- collateral: number
  
  Collateral tokens in micro units
- collateralPrice: number
  
  Collateral price in micro units
- vaultDebt: number
  
  Vault debt in micro units
- decimals: number
Returns number
The vaults current collateral ratio in decimal form (1 = 100%)

calcCollateralRatioAfterLiquidation

calcCollateralRatioAfterLiquidation(collateral: number, collateralPrice: number, debtPayout: number, vaultDebt: number, decimals: number, DISCOUNT_RATE: number): number

- Defined in utils.ts:370
Parameters
- collateral: number
  
  Collateral tokens in micro units
- collateralPrice: number
  
  Collateral price in micro units
- debtPayout: number
  
  Debt Payout in micro units
- vaultDebt: number
  
  Vault Debt in micro units
- decimals: number
- DISCOUNT_RATE: number
Returns number
Collateral ratio in decimal form (1 = 100%)

calcDiscountPrice

calcDiscountPrice(collateralPrice: number, DISCOUNT_RATE: number): number

- Defined in utils.ts:359
Parameters
- collateralPrice: number
  
  Collateral price in micro units
- DISCOUNT_RATE: number
Returns number
The discount price for a liquidation in micro units

calcMaxDebtPayout

calcMaxDebtPayout(collateral: number, collateralPrice: number, vaultDebt: number, decimals: number, minimumCollateralRatio: number, discountRate: number): number

- Defined in utils.ts:312
Parameters
- collateral: number
  
  Collateral tokens in micro units
- collateralPrice: number
  
  Current collateral price in micro units
- vaultDebt: number
  
  Vault debt in micro units
- decimals: number
  
  the amount of decimals the ASA has, default is 6
- minimumCollateralRatio: number
  
  the maximum CR liquidations can take a vault to
- discountRate: number
  
  the vault discount rate
Returns number
The maximum amount of debt you can pay to drive the CR back to 120%, considering collateral goes down on each liquidation.

calculateInterestAccrued

calculateInterestAccrued(now: number, lastAccruedInterestTime: number, vaultDebt: number, VAULT_INTEREST_RATE: number): number

- Defined in utils.ts:412
Parameters
- now: number
- lastAccruedInterestTime: number
- vaultDebt: number
- VAULT_INTEREST_RATE: number
Returns number

convertFromMicroUnits

convertFromMicroUnits(val: number, decimals?: number): number

- Defined in utils.ts:292
Converts number from microunits

Parameters
- val: number
  
  Number to be converted from microunits
- decimals: number = 6
Returns number
Number that has been converted from microunits

convertToMicroUnits

convertToMicroUnits(val: number, decimals?: number): number

- Defined in utils.ts:283
Converts number to microunits

Parameters
- val: number
  
  Number to be converted to microunits
- decimals: number = 6
Returns number
Number that has been converted to microunits

getAllAccounts

getAllAccounts(applicationId: number, indexer: any, accounts: any[], nextToken: string): Promise<any[]>

- Defined in utils.ts:394
Recursive function to collect all accounts opted into a given application id

Parameters
- applicationId: number
- indexer: any
  
  The algosdk indexer client
- accounts: any[]
  
  Current accounts collected
- nextToken: string
  
  Next token to use with paginaiton
Returns Promise<any[]>
Array of all accounts opted into a vault applicaiton