refactor: add tests and transition to labeled units, mantissa values

Author: coreyar

package.json

@@ -51,7 +51,7 @@
     "@venusprotocol/governance-contracts": "^1.0.0",
     "@venusprotocol/isolated-pools": "1.0.0",
     "@venusprotocol/oracle": "^1.4.1",
-    "@venusprotocol/venus-protocol": "^0.6.0",
+    "@venusprotocol/venus-protocol": "^3.0.0-dev.7",
     "assemblyscript": "0.19.23",
     "chai": "^4.3.6",
     "eslint": "^8.25.0",

subgraphs/venus/package.json

@@ -11,12 +11,12 @@
   ],
   "scripts": {
     "codegen": "graph codegen",
-    "create:local": "graph create venusprotocol/venus-subgraph --node http://127.0.0.1:8020",
-    "build:local": "graph build --ipfs http://localhost:5001",
-    "build:mainnet": "graph build --ipfs https://api.thegraph.com/ipfs/ ",
-    "deploy:local": "npx mustache config/local.json template.yaml > subgraph.yaml && graph deploy venusprotocol/venus-subgraph --debug --ipfs http://localhost:5001 --node http://127.0.0.1:8020/",
-    "deploy:testnet": "npx mustache config/testnet.json template.yaml > subgraph.yaml && graph deploy venusprotocol/venus-subgraph-chapel --debug --ipfs https://api.thegraph.com/ipfs/ --node https://api.thegraph.com/deploy/",
-    "deploy:mainnet": "npx mustache config/mainnet.json template.yaml > subgraph.yaml && graph deploy venusprotocol/venus-subgraph --debug --ipfs https://api.thegraph.com/ipfs/ --node https://api.thegraph.com/deploy/",
+    "create:local": "LOCAL=true npx graph create venusprotocol/venus-subgraph --node http://127.0.0.1:8020/",
+    "build:local": "LOCAL=true npx graph build --ipfs http://127.0.0.1:5001",
+    "build:mainnet": "npx graph build --ipfs https://api.thegraph.com/ipfs/ ",
+    "deploy:local": "LOCAL=true npx mustache config/local.json template.yaml > subgraph.yaml && npx graph deploy venusprotocol/venus-isolated-pools --debug --ipfs http://127.0.0.1:5001 --node http://127.0.0.1:8020/",
+    "deploy:testnet": "npx mustache config/testnet.json template.yaml > subgraph.yaml && npx graph deploy venusprotocol/venus-isolated-pools-chapel --debug --ipfs https://api.thegraph.com/ipfs/ --node https://api.thegraph.com/deploy/",
+    "deploy:mainnet": "npx mustache config/mainnet.json template.yaml > subgraph.yaml && npx graph deploy venusprotocol/venus-isolated-pools --debug --ipfs https://api.thegraph.com/ipfs/ --node https://api.thegraph.com/deploy/",
     "prepare:local": "npx mustache config/local.json template.yaml > subgraph.yaml",
     "prepare:testnet": "npx mustache config/testnet.json template.yaml > subgraph.yaml",
     "prepare:mainnet": "npx mustache config/mainnet.json template.yaml > subgraph.yaml",

subgraphs/venus/schema.graphql

@@ -20,27 +20,27 @@ Market stores all high level variables for a vToken market
 type Market @entity {
     #Fields that match Venus API
     "Borrow rate per block"
-    borrowRate: BigDecimal!
+    borrowRateMantissa: BigInt!
     "The vToken contract balance of BEP20 or BNB"
     cash: BigDecimal!
     "Collateral factor determining how much one can borrow"
     collateralFactor: BigDecimal!
     "Exchange rate of tokens / vTokens"
-    exchangeRate:  BigDecimal!
+    exchangeRateMantissa:  BigInt!
     "Address of the interest rate model"
     interestRateModelAddress: Bytes!
     "Name of the vToken"
     name: String!
     "Reserves stored in the contract"
-    reservesWei: BigInt!
+    reservesMantissa: BigInt!
     "Supply rate per block"
-    supplyRate: BigDecimal!
+    supplyRateMantissa: BigInt!
     "VToken symbol"
     symbol: String!
     "VToken address"
     id: ID!
     "Borrows in the market"
-    totalBorrows: BigDecimal!
+    treasuryTotalBorrowsMantissa: BigInt!
     "VToken supply. VTokens have 8 decimals"
     totalSupply: BigDecimal!
     "Underlying token address"
@@ -58,7 +58,7 @@ type Market @entity {
     "Timestamp the market was most recently updated"
     blockTimestamp: Int!
     "The history of the markets borrow index return (Think S&P 500)"
-    borrowIndex: BigDecimal!
+    borrowIndexMantissa: BigInt!
     "The factor determining interest that goes to reserves"
     reserveFactor: BigInt!
     "Underlying token price in USD"
@@ -67,6 +67,8 @@ type Market @entity {
     underlyingDecimals: Int!
     "Total XVS Distributed for this market"
     totalXvsDistributedMantissa: BigInt!
+    "vToken decimal length"
+    vTokenDecimals: Int!
 }
 
 """
@@ -120,11 +122,11 @@ type AccountVToken @entity {
     "VToken balance of the user"
     vTokenBalance: BigDecimal!
     "Total amount of underlying supplied"
-    totalUnderlyingSupplied: BigDecimal!
+    totalUnderlyingSuppliedMantissa: BigInt!
     "Total amount of underling redeemed"
-    totalUnderlyingRedeemed: BigDecimal!
+    totalUnderlyingRedeemedMantissa: BigInt!
     "The value of the borrow index upon users last interaction"
-    accountBorrowIndex: BigDecimal!
+    accountBorrowIndexMantissa: BigInt!
     "Total amount underlying borrowed, exclusive of interest"
     totalUnderlyingBorrowed: BigDecimal!
     "Total amount underlying repaid"

subgraphs/venus/src/constants/index.ts

@@ -1,7 +1,31 @@
 import { BigDecimal, BigInt } from '@graphprotocol/graph-ts';
+import { exponentToBigDecimal } from '../utilities';
+
+export const BORROW = 'BORROW';
+export const MINT = 'MINT';
+export const REDEEM = 'REDEEM';
+export const REPAY = 'REPAY';
+export const SEIZE = 'SEIZE';
+export const LIQUIDATE = 'LIQUIDATE';
+export const TRANSFER = 'TRANSFER';
+export const ENTER_MARKET = 'ENTER_MARKET';
+export const EXIT_MARKET = 'EXIT_MARKET';
 
 export const mantissaFactor = 18;
-export const vTokenDecimals = 8;
+export const mantissaFactorBigDecimal: BigDecimal = exponentToBigDecimal(mantissaFactor);
+
 export const zeroBigDecimal = BigDecimal.fromString('0');
 export const zeroBigInt32 = BigInt.fromString('0');
 export const oneBigInt = BigInt.fromString('1');
+
+export const Actions = [
+  MINT,
+  REDEEM,
+  BORROW,
+  REPAY,
+  SEIZE,
+  LIQUIDATE,
+  TRANSFER,
+  ENTER_MARKET,
+  EXIT_MARKET,
+];

subgraphs/venus/src/mappings/comptroller.ts

@@ -18,7 +18,7 @@ import { createAccount, createMarket } from '../operations/create';
 import { getOrCreateComptroller } from '../operations/getOrCreate';
 import { updateCommonVTokenStats } from '../operations/update';
 import { ensureComptrollerSynced } from '../utilities';
-import { mantissaFactorBD } from '../utilities/exponentToBigDecimal';
+import { mantissaFactorBigDecimal } from '../constants';
 
 export const handleMarketListed = (event: MarketListed): void => {
   // Dynamically index all new listed tokens
@@ -112,7 +112,7 @@ export const handleNewCollateralFactor = (event: NewCollateralFactor): void => {
   if (market != null) {
     market.collateralFactor = event.params.newCollateralFactorMantissa
       .toBigDecimal()
-      .div(mantissaFactorBD);
+      .div(mantissaFactorBigDecimal);
     market.save();
   }
 };

subgraphs/venus/src/mappings/vtoken.ts

@@ -22,12 +22,11 @@ import {
   Transfer,
 } from '../../generated/templates/VToken/VToken';
 import { nullAddress } from '../constants/addresses';
-import { vTokenDecimals } from '../constants';
 import { createAccount } from '../operations/create';
 import { createMarket } from '../operations/create';
 import { updateCommonVTokenStats } from '../operations/update';
 import { updateMarket } from '../operations/update';
-import { exponentToBigDecimal, vTokenDecimalsBD } from '../utilities/exponentToBigDecimal';
+import { exponentToBigDecimal } from '../utilities/exponentToBigDecimal';
 
 /* Account supplies assets into market and receives vTokens in exchange
  *
@@ -52,9 +51,11 @@ export const handleMint = (event: Mint): void => {
     .concat('-')
     .concat(event.transactionLogIndex.toString());
 
+  const vTokenDecimals = market.vTokenDecimals;
+
   let vTokenAmount = event.params.mintTokens
     .toBigDecimal()
-    .div(vTokenDecimalsBD)
+    .div(exponentToBigDecimal(vTokenDecimals))
     .truncate(vTokenDecimals);
   let underlyingAmount = event.params.mintAmount
     .toBigDecimal()
@@ -89,14 +90,15 @@ export const handleRedeem = (event: Redeem): void => {
   if (!market) {
     market = createMarket(event.address.toHexString());
   }
+  let vTokenDecimals = market.vTokenDecimals;
   let redeemID = event.transaction.hash
     .toHexString()
     .concat('-')
     .concat(event.transactionLogIndex.toString());
 
   let vTokenAmount = event.params.redeemTokens
     .toBigDecimal()
-    .div(vTokenDecimalsBD)
+    .div(exponentToBigDecimal(vTokenDecimals))
     .truncate(vTokenDecimals);
   let underlyingAmount = event.params.redeemAmount
     .toBigDecimal()
@@ -157,7 +159,7 @@ export const handleBorrow = (event: Borrow): void => {
     .div(exponentToBigDecimal(market.underlyingDecimals))
     .truncate(market.underlyingDecimals);
 
-  vTokenStats.accountBorrowIndex = market.borrowIndex;
+  vTokenStats.accountBorrowIndexMantissa = market.borrowIndexMantissa;
   vTokenStats.totalUnderlyingBorrowed = vTokenStats.totalUnderlyingBorrowed.plus(borrowAmountBD);
   vTokenStats.save();
 
@@ -232,7 +234,7 @@ export const handleRepayBorrow = (event: RepayBorrow): void => {
     .div(exponentToBigDecimal(market.underlyingDecimals))
     .truncate(market.underlyingDecimals);
 
-  vTokenStats.accountBorrowIndex = market.borrowIndex;
+  vTokenStats.accountBorrowIndexMantissa = market.borrowIndexMantissa;
   vTokenStats.totalUnderlyingRepaid = vTokenStats.totalUnderlyingRepaid.plus(repayAmountBD);
   vTokenStats.save();
 
@@ -311,10 +313,10 @@ export const handleLiquidateBorrow = (event: LiquidateBorrow): void => {
     .toHexString()
     .concat('-')
     .concat(event.transactionLogIndex.toString());
-
+  let vTokenDecimals = marketRepayToken.vTokenDecimals;
   let vTokenAmount = event.params.seizeTokens
     .toBigDecimal()
-    .div(vTokenDecimalsBD)
+    .div(exponentToBigDecimal(vTokenDecimals))
     .truncate(vTokenDecimals);
   let underlyingRepayAmount = event.params.repayAmount
     .toBigDecimal()
@@ -359,11 +361,14 @@ export const handleTransfer = (event: Transfer): void => {
   if (market.accrualBlockNumber != event.block.number.toI32()) {
     market = updateMarket(event.address, event.block.number.toI32(), event.block.timestamp.toI32());
   }
-
-  let amountUnderlying = market.exchangeRate.times(
-    event.params.amount.toBigDecimal().div(vTokenDecimalsBD),
+  let vTokenDecimals = market.vTokenDecimals;
+  let amountUnderlying = market.exchangeRateMantissa.times(
+    event.params.amount,
   );
-  let amountUnderylingTruncated = amountUnderlying.truncate(market.underlyingDecimals);
+  // const exchangeRateBigDecimal = getExchangeRateBigDecimal(exchangeRate, underlyingDecimals);
+  // const amountUnderlyingMantissa = exchangeRateBigDecimal
+  //   .times(exponentToBigDecimal(underlyingDecimals))
+  //   .times(amount.toBigDecimal());
 
   // Checking if the tx is FROM the vToken contract (i.e. this will not run when minting)
   // If so, it is a mint, and we don't need to run these calculations
@@ -387,11 +392,11 @@ export const handleTransfer = (event: Transfer): void => {
     );
 
     vTokenStatsFrom.vTokenBalance = vTokenStatsFrom.vTokenBalance.minus(
-      event.params.amount.toBigDecimal().div(vTokenDecimalsBD).truncate(vTokenDecimals),
+      event.params.amount.toBigDecimal().div(exponentToBigDecimal(vTokenDecimals)).truncate(vTokenDecimals),
     );
 
-    vTokenStatsFrom.totalUnderlyingRedeemed =
-      vTokenStatsFrom.totalUnderlyingRedeemed.plus(amountUnderylingTruncated);
+    vTokenStatsFrom.totalUnderlyingRedeemedMantissa =
+      vTokenStatsFrom.totalUnderlyingRedeemedMantissa.plus(amountUnderlying);
     vTokenStatsFrom.save();
   }
 
@@ -419,11 +424,11 @@ export const handleTransfer = (event: Transfer): void => {
     );
 
     vTokenStatsTo.vTokenBalance = vTokenStatsTo.vTokenBalance.plus(
-      event.params.amount.toBigDecimal().div(vTokenDecimalsBD).truncate(vTokenDecimals),
+      event.params.amount.toBigDecimal().div(exponentToBigDecimal(vTokenDecimals)).truncate(vTokenDecimals),
     );
 
-    vTokenStatsTo.totalUnderlyingSupplied =
-      vTokenStatsTo.totalUnderlyingSupplied.plus(amountUnderylingTruncated);
+    vTokenStatsTo.totalUnderlyingSuppliedMantissa =
+      vTokenStatsTo.totalUnderlyingSuppliedMantissa.plus(amountUnderlying);
     vTokenStatsTo.save();
   }
 
@@ -433,7 +438,7 @@ export const handleTransfer = (event: Transfer): void => {
     .concat(event.transactionLogIndex.toString());
 
   let transfer = new TransferEvent(transferID);
-  transfer.amount = event.params.amount.toBigDecimal().div(vTokenDecimalsBD);
+  transfer.amount = event.params.amount.toBigDecimal().div(exponentToBigDecimal(vTokenDecimals));
   transfer.to = event.params.to;
   transfer.from = event.params.from;
   transfer.blockNumber = event.block.number.toI32();

subgraphs/venus/src/operations/create.ts

@@ -3,49 +3,49 @@ import { Address, BigDecimal, BigInt, log } from '@graphprotocol/graph-ts';
 import { Account, AccountVToken, Market } from '../../generated/schema';
 import { BEP20 } from '../../generated/templates/VToken/BEP20';
 import { VToken } from '../../generated/templates/VToken/VToken';
+import { VBep20Storage } from '../../generated/templates/VToken/VBep20Storage';
 import { zeroBigInt32, zeroBigDecimal } from '../constants';
 import { nullAddress, vBnbAddress } from '../constants/addresses';
 import { getUnderlyingPrice } from '../utilities/getUnderlyingPrice';
 
-export const createAccountVToken = (
-  vTokenStatsID: string,
+export function createAccountVToken(
+  accountVTokenId: string,
   symbol: string,
   account: string,
-  marketID: string,
-): AccountVToken => {
-  const vTokenStats = new AccountVToken(vTokenStatsID);
-  vTokenStats.symbol = symbol;
-  vTokenStats.market = marketID;
-  vTokenStats.account = account;
-  vTokenStats.accrualBlockNumber = BigInt.fromI32(0);
-  // we need to set an initial real onchain value to this otherwise it will never
-  // be accurate
-  const vTokenContract = BEP20.bind(Address.fromString(marketID));
-  vTokenStats.vTokenBalance = new BigDecimal(vTokenContract.balanceOf(Address.fromString(account)));
-  // log.debug('[createAccountVToken] vTokenBalance: {}, account: {}, vToken: {}', [vTokenStats.vTokenBalance.toString(), account, marketID]);
+  marketId: string,
+): AccountVToken {
+  const accountVToken = new AccountVToken(accountVTokenId);
+  accountVToken.symbol = symbol;
+  accountVToken.market = marketId;
+  accountVToken.account = account;
+  accountVToken.accrualBlockNumber = BigInt.fromI32(0);
+  // we need to set an initial real onchain value to this otherwise it will never be accurate
+  const vTokenContract = BEP20.bind(Address.fromString(marketId));
+  accountVToken.vTokenBalance = new BigDecimal(vTokenContract.balanceOf(Address.fromString(account)));
 
-  vTokenStats.totalUnderlyingSupplied = zeroBigDecimal;
-  vTokenStats.totalUnderlyingRedeemed = zeroBigDecimal;
-  vTokenStats.accountBorrowIndex = zeroBigDecimal;
-  vTokenStats.totalUnderlyingBorrowed = zeroBigDecimal;
-  vTokenStats.totalUnderlyingRepaid = zeroBigDecimal;
-  vTokenStats.storedBorrowBalance = zeroBigDecimal;
-  vTokenStats.enteredMarket = false;
-  return vTokenStats;
+  accountVToken.totalUnderlyingSuppliedMantissa = zeroBigInt32;
+  accountVToken.totalUnderlyingRedeemedMantissa = zeroBigInt32;
+  accountVToken.accountBorrowIndexMantissa = zeroBigInt32;
+  accountVToken.totalUnderlyingBorrowed = zeroBigDecimal;
+  accountVToken.totalUnderlyingRepaid = zeroBigDecimal;
+  accountVToken.storedBorrowBalance = zeroBigDecimal;
+  accountVToken.enteredMarket = false;
+  return accountVToken;
 };
 
-export const createAccount = (accountID: string): Account => {
-  const account = new Account(accountID);
+export function createAccount(accountId: string): Account {
+  const account = new Account(accountId);
   account.countLiquidated = 0;
   account.countLiquidator = 0;
   account.hasBorrowed = false;
   account.save();
   return account;
 };
 
-export const createMarket = (marketAddress: string): Market => {
+export function createMarket(marketAddress: string): Market {
   let market: Market;
   const contract = VToken.bind(Address.fromString(marketAddress));
+  const marketBep20Storage = VBep20Storage.bind(Address.fromString(marketAddress))
 
   log.debug('[createMarket] market address: {}', [marketAddress]);
 
@@ -61,7 +61,7 @@ export const createMarket = (marketAddress: string): Market => {
     // It is all other VBEP20 contracts
   } else {
     market = new Market(marketAddress);
-    market.underlyingAddress = contract.underlying();
+    market.underlyingAddress = marketBep20Storage.underlying();
     log.debug('[createMarket] market underlying address: {}', [
       market.underlyingAddress.toHexString(),
     ]);
@@ -75,26 +75,28 @@ export const createMarket = (marketAddress: string): Market => {
     market.underlyingPriceUSD = underlyingValue.underlyingPriceUsd;
   }
 
+  market.vTokenDecimals = contract.decimals();
+
   const interestRateModelAddress = contract.try_interestRateModel();
   const reserveFactor = contract.try_reserveFactorMantissa();
 
-  market.borrowRate = zeroBigDecimal;
+  market.borrowRateMantissa = zeroBigInt32;
   market.cash = zeroBigDecimal;
   market.collateralFactor = zeroBigDecimal;
-  market.exchangeRate = zeroBigDecimal;
+  market.exchangeRateMantissa = zeroBigInt32;
   market.interestRateModelAddress = interestRateModelAddress.reverted
     ? nullAddress
     : interestRateModelAddress.value;
   market.name = contract.name();
-  market.reservesWei = BigInt.fromI32(0);
-  market.supplyRate = zeroBigDecimal;
+  market.reservesMantissa = BigInt.fromI32(0);
+  market.supplyRateMantissa = zeroBigInt32;
   market.symbol = contract.symbol();
-  market.totalBorrows = zeroBigDecimal;
+  market.treasuryTotalBorrowsMantissa = zeroBigInt32;
   market.totalSupply = zeroBigDecimal;
 
   market.accrualBlockNumber = 0;
   market.blockTimestamp = 0;
-  market.borrowIndex = zeroBigDecimal;
+  market.borrowIndexMantissa = zeroBigInt32;
   market.reserveFactor = reserveFactor.reverted ? BigInt.fromI32(0) : reserveFactor.value;
   market.totalXvsDistributedMantissa = zeroBigInt32;