@martins-finance/venus-js
Version:
A JavaScript SDK for Ethereum and the Venus Protocol.
341 lines • 16.7 kB
JavaScript
"use strict";
var __assign = (this && this.__assign) || function () {
__assign = Object.assign || function(t) {
for (var s, i = 1, n = arguments.length; i < n; i++) {
s = arguments[i];
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
t[p] = s[p];
}
return t;
};
return __assign.apply(this, arguments);
};
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (_) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
exports.__esModule = true;
exports.onMarketEntered = exports.liquidationIncentive = exports.closeFactor = exports.getAccountLiquidity = exports.liquidateBorrowAllowed = exports.checkMembership = exports.getAssetsIn = exports.exitMarket = exports.enterMarkets = void 0;
/**
* @file Comptroller
* @desc These methods facilitate interactions with the Comptroller smart
* contract.
*/
var ethers_1 = require("ethers");
var eth = require("./eth");
var helpers_1 = require("./helpers");
var constants_1 = require("./constants");
var util_1 = require("./util");
/**
* Enters the user's address into Venus Protocol markets.
*
* @param {any[]} markets An array of strings of markets to enter, meaning use
* those supplied assets as collateral.
* @param {CallOptions} [options] Call options and Ethers.js overrides for the
* transaction. A passed `gasLimit` will be used in both the `approve` (if
* not supressed) and `mint` transactions.
*
* @returns {object} Returns an Ethers.js transaction object of the enterMarkets
* transaction.
*
* @example
*
* ```
* const venus = new Venus(window.ethereum);
*
* (async function () {
* const trx = await venus.enterMarkets(Venus.SXP); // Use [] for multiple
* bnbt'Ethers.js transaction object', trx);
* })().catch(console.error);
* ```
*/
function enterMarkets(markets, options) {
if (markets === void 0) { markets = []; }
if (options === void 0) { options = {}; }
return __awaiter(this, void 0, void 0, function () {
var errorPrefix, addresses, i, comptrollerAddress, parameters, trxOptions;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, helpers_1.netId(this)];
case 1:
_a.sent();
errorPrefix = 'Venus [enterMarkets] | ';
if (typeof markets === 'string') {
markets = [markets];
}
if (!Array.isArray(markets)) {
throw Error(errorPrefix + 'Argument `markets` must be an array or string.');
}
addresses = [];
for (i = 0; i < markets.length; i++) {
if (markets[i][0] !== 'v') {
markets[i] = 'v' + markets[i];
}
if (!constants_1.cTokens.includes(markets[i])) {
throw Error(errorPrefix + 'Provided market `' + markets[i] + '` is not a recognized vToken.');
}
addresses.push(constants_1.address[this._network.name][markets[i]]);
}
comptrollerAddress = constants_1.address[this._network.name].Comptroller;
parameters = [addresses];
trxOptions = __assign({ _compoundProvider: this._provider, abi: constants_1.abi.Comptroller }, options);
return [2 /*return*/, eth.trx(comptrollerAddress, 'enterMarkets', parameters, trxOptions)];
}
});
});
}
exports.enterMarkets = enterMarkets;
/**
* Exits the user's address from a Venus Protocol market.
*
* @param {string} market A string of the symbol of the market to exit.
* @param {CallOptions} [options] Call options and Ethers.js overrides for the
* transaction. A passed `gasLimit` will be used in both the `approve` (if
* not supressed) and `mint` transactions.
*
* @returns {object} Returns an Ethers.js transaction object of the exitMarket
* transaction.
*
* @example
*
* ```
* const venus = new Venus(window.ethereum);
*
* (async function () {
* const trx = await venus.exitMarket(Venus.SXP);
* bnbt'Ethers.js transaction object', trx);
* })().catch(console.error);
* ```
*/
function exitMarket(market, options) {
if (options === void 0) { options = {}; }
return __awaiter(this, void 0, void 0, function () {
var errorPrefix, cTokenAddress, comptrollerAddress, parameters, trxOptions;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, helpers_1.netId(this)];
case 1:
_a.sent();
errorPrefix = 'Venus [exitMarkets] | ';
if (typeof market !== 'string' || market === '') {
throw Error(errorPrefix + 'Argument `market` must be a string of a cToken market name.');
}
if (market[0] !== 'v') {
market = 'v' + market;
}
if (!constants_1.cTokens.includes(market)) {
throw Error(errorPrefix + 'Provided market `' + market + '` is not a recognized cToken.');
}
cTokenAddress = constants_1.address[this._network.name][market];
comptrollerAddress = constants_1.address[this._network.name].Comptroller;
parameters = [cTokenAddress];
trxOptions = __assign({ _compoundProvider: this._provider, abi: constants_1.abi.Comptroller }, options);
return [2 /*return*/, eth.trx(comptrollerAddress, 'exitMarket', parameters, trxOptions)];
}
});
});
}
exports.exitMarket = exitMarket;
// eslint-disable-next-line @typescript-eslint/no-explicit-any
function getAssetsIn(account) {
return __awaiter(this, void 0, void 0, function () {
var errorPrefix, comptrollerAddress, parameters, trxOptions, assetsIn, assets, _i, assetsIn_1, address_1;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, helpers_1.netId(this)];
case 1:
_a.sent();
errorPrefix = 'Venus [getAssetsIn] | ';
if (typeof account !== 'string') {
throw Error(errorPrefix + 'Argument `account` must be a string.');
}
try {
account = util_1.toChecksumAddress(account);
}
catch (e) {
throw Error(errorPrefix + 'Argument `account` must be a valid Ethereum address.');
}
comptrollerAddress = constants_1.address[this._network.name].Comptroller;
parameters = [account];
trxOptions = {
_compoundProvider: this._provider,
abi: constants_1.abi.Comptroller
};
return [4 /*yield*/, eth.read(comptrollerAddress, 'getAssetsIn', parameters, trxOptions)];
case 2:
assetsIn = _a.sent();
assets = [];
for (_i = 0, assetsIn_1 = assetsIn; _i < assetsIn_1.length; _i++) {
address_1 = assetsIn_1[_i];
assets.push({ name: util_1.getAssetNameByAddress(address_1, this._network.name), address: address_1 });
}
return [2 /*return*/, assets];
}
});
});
}
exports.getAssetsIn = getAssetsIn;
function checkMembership(account, token_address) {
return __awaiter(this, void 0, void 0, function () {
var comptrollerAddress, parameters, trxOptions;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, helpers_1.netId(this)];
case 1:
_a.sent();
comptrollerAddress = constants_1.address[this._network.name].Comptroller;
parameters = [account, token_address];
trxOptions = {
_compoundProvider: this._provider,
abi: constants_1.abi.Comptroller
};
return [4 /*yield*/, eth.read(comptrollerAddress, 'checkMembership', parameters, trxOptions)];
case 2: return [2 /*return*/, _a.sent()];
}
});
});
}
exports.checkMembership = checkMembership;
function liquidateBorrowAllowed(vTokenBorrowed, vTokenCollateral, liquidator, borrower, repayAmount, options) {
if (options === void 0) { options = {}; }
return __awaiter(this, void 0, void 0, function () {
var comptrollerAddress, parameters, trxOptions;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, helpers_1.netId(this)];
case 1:
_a.sent();
comptrollerAddress = constants_1.address[this._network.name].Comptroller;
parameters = [vTokenBorrowed, vTokenCollateral, liquidator, borrower, repayAmount];
trxOptions = __assign({ _compoundProvider: this._provider, abi: constants_1.abi.Comptroller }, options);
return [4 /*yield*/, eth.read(comptrollerAddress, 'liquidateBorrowAllowed', parameters, trxOptions)];
case 2: return [2 /*return*/, _a.sent()];
}
});
});
}
exports.liquidateBorrowAllowed = liquidateBorrowAllowed;
function getAccountLiquidity(account, options) {
if (options === void 0) { options = {}; }
return __awaiter(this, void 0, void 0, function () {
var comptrollerAddress, parameters, trxOptions, response, error, liquidity, shortfall, liquidityBalance;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, helpers_1.netId(this)];
case 1:
_a.sent();
comptrollerAddress = constants_1.address[this._network.name].Comptroller;
parameters = [account];
trxOptions = __assign({ _compoundProvider: this._provider, abi: constants_1.abi.Comptroller }, options);
return [4 /*yield*/, eth.read(comptrollerAddress, 'getAccountLiquidity', parameters, trxOptions)];
case 2:
response = _a.sent();
error = response[0], liquidity = response[1], shortfall = response[2];
if (!ethers_1.ethers.BigNumber.from(error).isZero()) {
throw new Error("Error on network call. CODE: {error}");
}
liquidityBalance = ethers_1.ethers.BigNumber.from(liquidity).sub(ethers_1.ethers.BigNumber.from(shortfall));
return [2 /*return*/, ethers_1.ethers.utils.formatEther(liquidityBalance)];
}
});
});
}
exports.getAccountLiquidity = getAccountLiquidity;
function closeFactor() {
return __awaiter(this, void 0, void 0, function () {
var comptrollerAddress, trxOptions, closeFactorMantissa;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, helpers_1.netId(this)];
case 1:
_a.sent();
comptrollerAddress = constants_1.address[this._network.name].Comptroller;
trxOptions = {
_compoundProvider: this._provider,
abi: constants_1.abi.Comptroller
};
return [4 /*yield*/, eth.read(comptrollerAddress, 'closeFactorMantissa', [], trxOptions)];
case 2:
closeFactorMantissa = _a.sent();
return [2 /*return*/, ethers_1.ethers.utils.formatEther(closeFactorMantissa)];
}
});
});
}
exports.closeFactor = closeFactor;
function liquidationIncentive() {
return __awaiter(this, void 0, void 0, function () {
var comptrollerAddress, trxOptions, liquidationIncentiveMantissa;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, helpers_1.netId(this)];
case 1:
_a.sent();
comptrollerAddress = constants_1.address[this._network.name].Comptroller;
trxOptions = {
_compoundProvider: this._provider,
abi: constants_1.abi.Comptroller
};
return [4 /*yield*/, eth.read(comptrollerAddress, 'liquidationIncentiveMantissa', [], trxOptions)];
case 2:
liquidationIncentiveMantissa = _a.sent();
return [2 /*return*/, ethers_1.ethers.utils.formatEther(liquidationIncentiveMantissa)];
}
});
});
}
exports.liquidationIncentive = liquidationIncentive;
function onMarketEntered(fromBlock, toBlock) {
if (toBlock === void 0) { toBlock = null; }
return __awaiter(this, void 0, void 0, function () {
var comptrollerAddress, trxOptions;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, helpers_1.netId(this)];
case 1:
_a.sent();
comptrollerAddress = constants_1.address[this._network.name].Comptroller;
trxOptions = {
_compoundProvider: this._provider,
abi: constants_1.abi.Comptroller
};
return [4 /*yield*/, eth.filter(comptrollerAddress, 'MarketEntered', [fromBlock, toBlock], trxOptions)];
case 2: return [2 /*return*/, _a.sent()];
}
});
});
}
exports.onMarketEntered = onMarketEntered;
//# sourceMappingURL=comptroller.js.map