CAI/cai_April_2024.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "id": "5866e8b8",
   "metadata": {},
   "source": [
    "## CAI - Colony Avalanche Index - Rebalancing data for April 2024"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "d6fc51ad",
   "metadata": {},
   "source": [
    "## Configuring packages"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 3,
   "id": "3be13cba",
   "metadata": {},
   "outputs": [],
   "source": [
    "import pandas as pd\n",
    "import decouple\n",
    "import sys\n",
    "sys.path.append('../')\n",
    "from methodology import MethodologyProd\n",
    "from pycoingecko import CoinGeckoAPI\n",
    "key =  decouple.config(\"CG_KEY\")\n",
    "cg = CoinGeckoAPI(api_key=key)"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "db58fc4e",
   "metadata": {},
   "source": [
    "## Index Variables"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 4,
   "id": "30bc6496",
   "metadata": {},
   "outputs": [],
   "source": [
    "date = '2024-04-01'\n",
    "min_mcap =  0.1e8\n",
    "min_weight = 0.005\n",
    "max_weight = 0.5\n",
    "circ_supply_threshold = 0.3\n",
    "liveness_threshold = 180 # In days\n",
    "liquidity_consistency = 90 # In days\n",
    "coingecko_category = [\"avalanche-ecosystem\"]\n",
    "\n",
    "# Calculating max slippage based on liquidity threshold\n",
    "liq = 2*1e6\n",
    "liq_os = liq / 2 # one-side liquidity \n",
    "trade_value_tiny = 1e2\n",
    "trade_value = 1e5\n",
    "max_slippage = (liq_os + trade_value_tiny) / (liq_os + trade_value) - 1\n",
    "# round to the nearest .01\n",
    "max_slippage = round(max_slippage, 2)\n",
    "\n",
    "# Dataframes to remove\n",
    "stablecoins = pd.DataFrame(cg.get_coins_markets('usd',category='stablecoins')).set_index('id')\n",
    "ctokens = pd.DataFrame(cg.get_coins_markets('usd',category='compound-tokens')).set_index('id')\n",
    "atokens = pd.DataFrame(cg.get_coins_markets('usd',category='aave-tokens')).set_index('id')\n",
    "\n",
    "methodology_class = MethodologyProd(\n",
    "                                date,\n",
    "                                1,\n",
    "                                \"avalanche\",\n",
    "                                \"0x48f88A3fE843ccb0b5003e70B4192c1d7448bEf0\",\n",
    "                                \"cai_benchmark_data\",\n",
    "                                \"cai_liquidities\",\n",
    "                                min_mcap,\n",
    "                                min_weight,\n",
    "                                max_weight,\n",
    "                                255,\n",
    "                                circ_supply_threshold,\n",
    "                                liveness_threshold,\n",
    "                                liquidity_consistency,\n",
    "                                max_slippage,\n",
    "                                coingecko_category)"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "53ff27b8",
   "metadata": {},
   "source": [
    "## Token inclusion criteria\n",
    "\n",
    "1. **Project and token characteristics**\n",
    "    1. The project’s token should have been listed on CoinGecko with pricing data at least 6 months prior to the date of inclusion in the index.\n",
    "    1. The project should have a token that is native to Avalanche. This excludes wrapped variants, where the underlying tokens are locked on an alt-L1.\n",
    "    1. The project should be a going concern, with a dedicated team actively building, supporting and maintaining the project.\n",
    "    1. No rebasing or deflationary tokens.\n",
    "    1. The project must be widely considered to be building a useful protocol or product. Projects that have ponzi characteristics at the core of their offering will not be considered.\n",
    "    1. Synthetic tokens which derive their value from external price feeds are not permissible.\n",
    "    1. The project’s token must not have the ability to pause token transfers.\n",
    "    1. The project’s protocol or product must have significant usage.\n",
    "    <br>\n",
    "1. **Pricing requirements**\n",
    "    1. Token should have a Chainlink price feed to allow for manipulation resistant pricing.\n",
    "    <br>\n",
    "1. **Token Supply requirements**\n",
    "    1. The project's token must have a circulating supply greater than 30% of the max supply. In cases where a token does not have a max supply, the minting mechanics would need to be assessed.\n",
    "    <br>\n",
    "1. **Liquidity Requirements**\n",
    "    1. The token must be listed on a supported exchange. \n",
    "    1. The token should have in aggregate at least $2mm of onchain liquidity across Trader Joe, Platypus, Pangolin.\n",
    "    1. The token must have shown consistent DeFi liquidity on Avalanche.\n",
    "    <br>\n",
    "1. **Security Requirements**\n",
    "    1. The project must have been audited by smart contract security professionals with the audit report(s) publicly available. Alternatively, the protocol must have been operating long enough to create a consensus about its safety in the decentralised finance community."
   ]
  },
  {
   "cell_type": "markdown",
   "id": "d7535726",
   "metadata": {},
   "source": [
    "## Run Methodology"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 5,
   "id": "10643ec6",
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Excluding coq-inu, pricing data available only for 113 < 180 days\n",
      "Excluding ox-fun, pricing data available only for 39 < 180 days\n",
      "Excluding raini-studios-token, pricing data available only for 124 < 180 days\n",
      "Excluding avax-has-no-chill, pricing data available only for 95 < 180 days\n",
      "Excluding miracle-play, pricing data available only for 144 < 180 days\n",
      "Excluding kimbo, pricing data available only for 102 < 180 days\n",
      "Excluding any-inu, pricing data available only for 88 < 180 days\n",
      "Excluding tech, pricing data available only for 23 < 180 days\n",
      "Excluding platypus-usd, pricing data available only for 13 < 180 days\n",
      "Manually calculating slippage for uniswap on avalanche\n",
      "havven on avalanche returned an invalid API response\n",
      "havven recorded no valid response across any platform\n",
      "axelar on avalanche returned an invalid API response\n",
      "axelar recorded no valid response across any platform\n",
      "Manually calculating slippage for 0x on avalanche\n",
      "Manually calculating slippage for woo-network on avalanche\n",
      "Manually calculating slippage for 1inch on avalanche\n",
      "Manually calculating slippage for compound-governance-token on avalanche\n",
      "Manually calculating slippage for basic-attention-token on avalanche\n",
      "Manually calculating slippage for pendle on avalanche\n",
      "Manually calculating slippage for uma on avalanche\n",
      "Manually calculating slippage for yearn-finance on avalanche\n",
      "Manually calculating slippage for balancer on avalanche\n",
      "cartesi on avalanche returned an invalid API response\n",
      "cartesi recorded no valid response across any platform\n",
      "allianceblock-nexera on avalanche returned an invalid API response\n",
      "allianceblock-nexera recorded no valid response across any platform\n",
      "Manually calculating slippage for orbs on avalanche\n",
      "Manually calculating slippage for insure on avalanche\n",
      "Manually calculating slippage for kyber-network-crystal on avalanche\n",
      "kyber-network-crystal on avalanche returned an invalid API response\n",
      "kyber-network-crystal recorded no valid response across any platform\n",
      "Manually calculating slippage for alpha-finance on avalanche\n",
      "Manually calculating slippage for beta-finance on avalanche\n",
      "ankreth on avalanche returned an invalid API response\n",
      "ankreth recorded no valid response across any platform\n",
      "idia on avalanche returned an invalid API response\n",
      "idia recorded no valid response across any platform\n",
      "Manually calculating slippage for xana on avalanche\n",
      "route on avalanche returned an invalid API response\n",
      "route recorded no valid response across any platform\n",
      "Manually calculating slippage for deapcoin on avalanche\n",
      "Manually calculating slippage for gamer-arena on avalanche\n",
      "Manually calculating slippage for step-app-fitfi on avalanche\n",
      "Manually calculating slippage for snowbank on avalanche\n",
      "Manually calculating slippage for ferrum-network on avalanche\n",
      "Manually calculating slippage for spookyswap on avalanche\n",
      "Manually calculating slippage for dextf on avalanche\n",
      "Manually calculating slippage for trustswap on avalanche\n",
      "build on avalanche returned an invalid API response\n",
      "build recorded no valid response across any platform\n",
      "Manually calculating slippage for everrise on avalanche\n",
      "chainlink did not meet the average three month liquidity threshold\n",
      "yield-yak did not meet the average three month liquidity threshold\n",
      "aave did not meet the average three month liquidity threshold\n",
      "ampleforth did not meet the average three month liquidity threshold\n",
      "trustswap did not meet the average three month liquidity threshold\n",
      "colony did not meet the average three month liquidity threshold\n",
      "xana did not meet the average three month liquidity threshold\n",
      "husky-avax did not meet the average three month liquidity threshold\n",
      "playa3ull-games-2 did not meet the average three month liquidity threshold\n",
      "osaka-protocol did not meet the average three month liquidity threshold\n",
      "pendle did not meet the average three month liquidity threshold\n",
      "spell-token did not meet the average three month liquidity threshold\n",
      "synapse-2 did not meet the average three month liquidity threshold\n",
      "orbs did not meet the average three month liquidity threshold\n",
      "everrise did not meet the average three month liquidity threshold\n",
      "domi did not meet the average three month liquidity threshold\n",
      "dexalot did not meet the average three month liquidity threshold\n",
      "gamer-arena did not meet the average three month liquidity threshold\n",
      "step-app-fitfi did not meet the average three month liquidity threshold\n",
      "defi-kingdoms did not meet the average three month liquidity threshold\n"
     ]
    },
    {
     "data": {
      "text/html": [
       "<div>\n",
       "<style scoped>\n",
       "    .dataframe tbody tr th:only-of-type {\n",
       "        vertical-align: middle;\n",
       "    }\n",
       "\n",
       "    .dataframe tbody tr th {\n",
       "        vertical-align: top;\n",
       "    }\n",
       "\n",
       "    .dataframe thead th {\n",
       "        text-align: right;\n",
       "    }\n",
       "</style>\n",
       "<table border=\"1\" class=\"dataframe\">\n",
       "  <thead>\n",
       "    <tr style=\"text-align: right;\">\n",
       "      <th></th>\n",
       "      <th>avalanche</th>\n",
       "      <th>optimal chain</th>\n",
       "      <th>best slippage</th>\n",
       "      <th>best slippage chain</th>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>id</th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>wrapped-avax</th>\n",
       "      <td>-0.002127</td>\n",
       "      <td>avalanche</td>\n",
       "      <td>-0.002127</td>\n",
       "      <td>avalanche</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>benqi-liquid-staked-avax</th>\n",
       "      <td>-0.002961</td>\n",
       "      <td>avalanche</td>\n",
       "      <td>-0.002961</td>\n",
       "      <td>avalanche</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>joe</th>\n",
       "      <td>-0.013979</td>\n",
       "      <td>avalanche</td>\n",
       "      <td>-0.013979</td>\n",
       "      <td>avalanche</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>avalaunch</th>\n",
       "      <td>-0.048350</td>\n",
       "      <td>avalanche</td>\n",
       "      <td>-0.048350</td>\n",
       "      <td>avalanche</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>benqi</th>\n",
       "      <td>-0.070172</td>\n",
       "      <td>avalanche</td>\n",
       "      <td>-0.070172</td>\n",
       "      <td>avalanche</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>colony</th>\n",
       "      <td>-0.160146</td>\n",
       "      <td>None</td>\n",
       "      <td>-0.160146</td>\n",
       "      <td>avalanche</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>chainlink</th>\n",
       "      <td>-0.186839</td>\n",
       "      <td>None</td>\n",
       "      <td>-0.186839</td>\n",
       "      <td>avalanche</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>playa3ull-games-2</th>\n",
       "      <td>-0.214202</td>\n",
       "      <td>None</td>\n",
       "      <td>-0.214202</td>\n",
       "      <td>avalanche</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>everrise</th>\n",
       "      <td>-0.310061</td>\n",
       "      <td>None</td>\n",
       "      <td>-0.310061</td>\n",
       "      <td>avalanche</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>gamer-arena</th>\n",
       "      <td>-0.371865</td>\n",
       "      <td>None</td>\n",
       "      <td>-0.371865</td>\n",
       "      <td>avalanche</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>domi</th>\n",
       "      <td>-0.382851</td>\n",
       "      <td>None</td>\n",
       "      <td>-0.382851</td>\n",
       "      <td>avalanche</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>xana</th>\n",
       "      <td>-0.573050</td>\n",
       "      <td>None</td>\n",
       "      <td>-0.573050</td>\n",
       "      <td>avalanche</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>trustswap</th>\n",
       "      <td>-0.595088</td>\n",
       "      <td>None</td>\n",
       "      <td>-0.595088</td>\n",
       "      <td>avalanche</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>orbs</th>\n",
       "      <td>-0.637071</td>\n",
       "      <td>None</td>\n",
       "      <td>-0.637071</td>\n",
       "      <td>avalanche</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>pendle</th>\n",
       "      <td>-0.706725</td>\n",
       "      <td>None</td>\n",
       "      <td>-0.706725</td>\n",
       "      <td>avalanche</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>step-app-fitfi</th>\n",
       "      <td>-0.828661</td>\n",
       "      <td>None</td>\n",
       "      <td>-0.828661</td>\n",
       "      <td>avalanche</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>spell-token</th>\n",
       "      <td>-0.857332</td>\n",
       "      <td>None</td>\n",
       "      <td>-0.857332</td>\n",
       "      <td>avalanche</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>aave</th>\n",
       "      <td>-0.886753</td>\n",
       "      <td>None</td>\n",
       "      <td>-0.886753</td>\n",
       "      <td>avalanche</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>dexalot</th>\n",
       "      <td>-0.895591</td>\n",
       "      <td>None</td>\n",
       "      <td>-0.895591</td>\n",
       "      <td>avalanche</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>defi-kingdoms</th>\n",
       "      <td>-0.902106</td>\n",
       "      <td>None</td>\n",
       "      <td>-0.902106</td>\n",
       "      <td>avalanche</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>sushi</th>\n",
       "      <td>-0.962121</td>\n",
       "      <td>None</td>\n",
       "      <td>-0.962121</td>\n",
       "      <td>avalanche</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>beta-finance</th>\n",
       "      <td>-0.966442</td>\n",
       "      <td>None</td>\n",
       "      <td>-0.966442</td>\n",
       "      <td>avalanche</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>balancer</th>\n",
       "      <td>-0.970841</td>\n",
       "      <td>None</td>\n",
       "      <td>-0.970841</td>\n",
       "      <td>avalanche</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>spookyswap</th>\n",
       "      <td>-0.975571</td>\n",
       "      <td>None</td>\n",
       "      <td>-0.975571</td>\n",
       "      <td>avalanche</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>alpha-finance</th>\n",
       "      <td>-0.983390</td>\n",
       "      <td>None</td>\n",
       "      <td>-0.983390</td>\n",
       "      <td>avalanche</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>insure</th>\n",
       "      <td>-0.988160</td>\n",
       "      <td>None</td>\n",
       "      <td>-0.988160</td>\n",
       "      <td>avalanche</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>frax-share</th>\n",
       "      <td>-0.994623</td>\n",
       "      <td>None</td>\n",
       "      <td>-0.994623</td>\n",
       "      <td>avalanche</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>woo-network</th>\n",
       "      <td>-0.994837</td>\n",
       "      <td>None</td>\n",
       "      <td>-0.994837</td>\n",
       "      <td>avalanche</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>ferrum-network</th>\n",
       "      <td>-0.994897</td>\n",
       "      <td>None</td>\n",
       "      <td>-0.994897</td>\n",
       "      <td>avalanche</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>uniswap</th>\n",
       "      <td>-0.994944</td>\n",
       "      <td>None</td>\n",
       "      <td>-0.994944</td>\n",
       "      <td>avalanche</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>1inch</th>\n",
       "      <td>-0.997716</td>\n",
       "      <td>None</td>\n",
       "      <td>-0.997716</td>\n",
       "      <td>avalanche</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>deapcoin</th>\n",
       "      <td>-0.999007</td>\n",
       "      <td>None</td>\n",
       "      <td>-0.999007</td>\n",
       "      <td>avalanche</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>dextf</th>\n",
       "      <td>-0.999066</td>\n",
       "      <td>None</td>\n",
       "      <td>-0.999066</td>\n",
       "      <td>avalanche</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>basic-attention-token</th>\n",
       "      <td>-0.999299</td>\n",
       "      <td>None</td>\n",
       "      <td>-0.999299</td>\n",
       "      <td>avalanche</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>yearn-finance</th>\n",
       "      <td>-0.999785</td>\n",
       "      <td>None</td>\n",
       "      <td>-0.999785</td>\n",
       "      <td>avalanche</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>0x</th>\n",
       "      <td>-0.999869</td>\n",
       "      <td>None</td>\n",
       "      <td>-0.999869</td>\n",
       "      <td>avalanche</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>compound-governance-token</th>\n",
       "      <td>-0.999900</td>\n",
       "      <td>None</td>\n",
       "      <td>-0.999900</td>\n",
       "      <td>avalanche</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>synapse-2</th>\n",
       "      <td>-0.999903</td>\n",
       "      <td>None</td>\n",
       "      <td>-0.999903</td>\n",
       "      <td>avalanche</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>uma</th>\n",
       "      <td>-0.999920</td>\n",
       "      <td>None</td>\n",
       "      <td>-0.999920</td>\n",
       "      <td>avalanche</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>maker</th>\n",
       "      <td>-0.999954</td>\n",
       "      <td>None</td>\n",
       "      <td>-0.999954</td>\n",
       "      <td>avalanche</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>ankr</th>\n",
       "      <td>-0.999968</td>\n",
       "      <td>None</td>\n",
       "      <td>-0.999968</td>\n",
       "      <td>avalanche</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>meld-2</th>\n",
       "      <td>-0.999999</td>\n",
       "      <td>None</td>\n",
       "      <td>-0.999999</td>\n",
       "      <td>avalanche</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>ampleforth</th>\n",
       "      <td>-1.000000</td>\n",
       "      <td>None</td>\n",
       "      <td>-1.000000</td>\n",
       "      <td>avalanche</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>xen-crypto</th>\n",
       "      <td>-1.000000</td>\n",
       "      <td>None</td>\n",
       "      <td>-1.000000</td>\n",
       "      <td>avalanche</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>the-graph</th>\n",
       "      <td>-1.000000</td>\n",
       "      <td>None</td>\n",
       "      <td>-1.000000</td>\n",
       "      <td>avalanche</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>euro-coin</th>\n",
       "      <td>-1.000000</td>\n",
       "      <td>None</td>\n",
       "      <td>-1.000000</td>\n",
       "      <td>avalanche</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>snowbank</th>\n",
       "      <td>-1.000000</td>\n",
       "      <td>None</td>\n",
       "      <td>-1.000000</td>\n",
       "      <td>avalanche</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>bitcoin-avalanche-bridged-btc-b</th>\n",
       "      <td>-1.000000</td>\n",
       "      <td>None</td>\n",
       "      <td>-1.000000</td>\n",
       "      <td>avalanche</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>osaka-protocol</th>\n",
       "      <td>-1.000000</td>\n",
       "      <td>None</td>\n",
       "      <td>-1.000000</td>\n",
       "      <td>avalanche</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "</div>"
      ],
      "text/plain": [
       "                                 avalanche optimal chain  best slippage  \\\n",
       "id                                                                        \n",
       "wrapped-avax                     -0.002127     avalanche      -0.002127   \n",
       "benqi-liquid-staked-avax         -0.002961     avalanche      -0.002961   \n",
       "joe                              -0.013979     avalanche      -0.013979   \n",
       "avalaunch                        -0.048350     avalanche      -0.048350   \n",
       "benqi                            -0.070172     avalanche      -0.070172   \n",
       "colony                           -0.160146          None      -0.160146   \n",
       "chainlink                        -0.186839          None      -0.186839   \n",
       "playa3ull-games-2                -0.214202          None      -0.214202   \n",
       "everrise                         -0.310061          None      -0.310061   \n",
       "gamer-arena                      -0.371865          None      -0.371865   \n",
       "domi                             -0.382851          None      -0.382851   \n",
       "xana                             -0.573050          None      -0.573050   \n",
       "trustswap                        -0.595088          None      -0.595088   \n",
       "orbs                             -0.637071          None      -0.637071   \n",
       "pendle                           -0.706725          None      -0.706725   \n",
       "step-app-fitfi                   -0.828661          None      -0.828661   \n",
       "spell-token                      -0.857332          None      -0.857332   \n",
       "aave                             -0.886753          None      -0.886753   \n",
       "dexalot                          -0.895591          None      -0.895591   \n",
       "defi-kingdoms                    -0.902106          None      -0.902106   \n",
       "sushi                            -0.962121          None      -0.962121   \n",
       "beta-finance                     -0.966442          None      -0.966442   \n",
       "balancer                         -0.970841          None      -0.970841   \n",
       "spookyswap                       -0.975571          None      -0.975571   \n",
       "alpha-finance                    -0.983390          None      -0.983390   \n",
       "insure                           -0.988160          None      -0.988160   \n",
       "frax-share                       -0.994623          None      -0.994623   \n",
       "woo-network                      -0.994837          None      -0.994837   \n",
       "ferrum-network                   -0.994897          None      -0.994897   \n",
       "uniswap                          -0.994944          None      -0.994944   \n",
       "1inch                            -0.997716          None      -0.997716   \n",
       "deapcoin                         -0.999007          None      -0.999007   \n",
       "dextf                            -0.999066          None      -0.999066   \n",
       "basic-attention-token            -0.999299          None      -0.999299   \n",
       "yearn-finance                    -0.999785          None      -0.999785   \n",
       "0x                               -0.999869          None      -0.999869   \n",
       "compound-governance-token        -0.999900          None      -0.999900   \n",
       "synapse-2                        -0.999903          None      -0.999903   \n",
       "uma                              -0.999920          None      -0.999920   \n",
       "maker                            -0.999954          None      -0.999954   \n",
       "ankr                             -0.999968          None      -0.999968   \n",
       "meld-2                           -0.999999          None      -0.999999   \n",
       "ampleforth                       -1.000000          None      -1.000000   \n",
       "xen-crypto                       -1.000000          None      -1.000000   \n",
       "the-graph                        -1.000000          None      -1.000000   \n",
       "euro-coin                        -1.000000          None      -1.000000   \n",
       "snowbank                         -1.000000          None      -1.000000   \n",
       "bitcoin-avalanche-bridged-btc-b  -1.000000          None      -1.000000   \n",
       "osaka-protocol                   -1.000000          None      -1.000000   \n",
       "\n",
       "                                best slippage chain  \n",
       "id                                                   \n",
       "wrapped-avax                              avalanche  \n",
       "benqi-liquid-staked-avax                  avalanche  \n",
       "joe                                       avalanche  \n",
       "avalaunch                                 avalanche  \n",
       "benqi                                     avalanche  \n",
       "colony                                    avalanche  \n",
       "chainlink                                 avalanche  \n",
       "playa3ull-games-2                         avalanche  \n",
       "everrise                                  avalanche  \n",
       "gamer-arena                               avalanche  \n",
       "domi                                      avalanche  \n",
       "xana                                      avalanche  \n",
       "trustswap                                 avalanche  \n",
       "orbs                                      avalanche  \n",
       "pendle                                    avalanche  \n",
       "step-app-fitfi                            avalanche  \n",
       "spell-token                               avalanche  \n",
       "aave                                      avalanche  \n",
       "dexalot                                   avalanche  \n",
       "defi-kingdoms                             avalanche  \n",
       "sushi                                     avalanche  \n",
       "beta-finance                              avalanche  \n",
       "balancer                                  avalanche  \n",
       "spookyswap                                avalanche  \n",
       "alpha-finance                             avalanche  \n",
       "insure                                    avalanche  \n",
       "frax-share                                avalanche  \n",
       "woo-network                               avalanche  \n",
       "ferrum-network                            avalanche  \n",
       "uniswap                                   avalanche  \n",
       "1inch                                     avalanche  \n",
       "deapcoin                                  avalanche  \n",
       "dextf                                     avalanche  \n",
       "basic-attention-token                     avalanche  \n",
       "yearn-finance                             avalanche  \n",
       "0x                                        avalanche  \n",
       "compound-governance-token                 avalanche  \n",
       "synapse-2                                 avalanche  \n",
       "uma                                       avalanche  \n",
       "maker                                     avalanche  \n",
       "ankr                                      avalanche  \n",
       "meld-2                                    avalanche  \n",
       "ampleforth                                avalanche  \n",
       "xen-crypto                                avalanche  \n",
       "the-graph                                 avalanche  \n",
       "euro-coin                                 avalanche  \n",
       "snowbank                                  avalanche  \n",
       "bitcoin-avalanche-bridged-btc-b           avalanche  \n",
       "osaka-protocol                            avalanche  "
      ]
     },
     "execution_count": 5,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "\n",
    "results,liquidity = methodology_class.main(\n",
    "    single_chain=\"avalanche\",\n",
    "    df_to_remove=[stablecoins,ctokens,atokens],\n",
    "    ids_to_replace=[[\"avalanche-2\"],[\"wrapped-avax\"]],\n",
    "    add_category_assets=[\"shrapnel-2\"],\n",
    "    remove_category_assets=['wrapped-bitcoin',\"gmx\",\"pangolin\"],\n",
    "    values_to_update=[{'id':'pangolin','category':'total_supply','value':230000000},\n",
    "                      {'id':'benqi-liquid-staked-avax','category':'market_cap','value':20000000000},\n",
    "                      {'id':'benqi-liquid-staked-avax','category':'symbol','value':\"sAVAX\"}\n",
    "                      ],\n",
    "    weight_split_data={\"asset_to_split\":\"wrapped-avax\",\"asset_to_receive\":\"benqi-liquid-staked-avax\",\"split_ratio\":0.6}\n",
    "    )\n",
    "liquidity"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "a74ebe0c",
   "metadata": {},
   "source": [
    "## Show Results"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 6,
   "id": "b3a4ae5c",
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/html": [
       "<div>\n",
       "<style scoped>\n",
       "    .dataframe tbody tr th:only-of-type {\n",
       "        vertical-align: middle;\n",
       "    }\n",
       "\n",
       "    .dataframe tbody tr th {\n",
       "        vertical-align: top;\n",
       "    }\n",
       "\n",
       "    .dataframe thead th {\n",
       "        text-align: right;\n",
       "    }\n",
       "</style>\n",
       "<table border=\"1\" class=\"dataframe\">\n",
       "  <thead>\n",
       "    <tr style=\"text-align: right;\">\n",
       "      <th></th>\n",
       "      <th>symbol</th>\n",
       "      <th>market_cap</th>\n",
       "      <th>weight</th>\n",
       "      <th>weight_converted</th>\n",
       "      <th>address</th>\n",
       "      <th>blockchain</th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>wrapped-avax</th>\n",
       "      <td>AVAX</td>\n",
       "      <td>2.043299e+10</td>\n",
       "      <td>0.200000</td>\n",
       "      <td>51</td>\n",
       "      <td>0xb31f66aa3c1e785363f0875a1b74e27b85fd66c7</td>\n",
       "      <td>avalanche</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>benqi-liquid-staked-avax</th>\n",
       "      <td>sAVAX</td>\n",
       "      <td>2.000000e+10</td>\n",
       "      <td>0.300000</td>\n",
       "      <td>77</td>\n",
       "      <td>0x2b2c81e08f1af8835a78bb2a90ae924ace0ea4be</td>\n",
       "      <td>avalanche</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>joe</th>\n",
       "      <td>JOE</td>\n",
       "      <td>3.010393e+08</td>\n",
       "      <td>0.314569</td>\n",
       "      <td>81</td>\n",
       "      <td>0x6e84a6216ea6dacc71ee8e6b0a5b7322eebc0fdd</td>\n",
       "      <td>avalanche</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>benqi</th>\n",
       "      <td>QI</td>\n",
       "      <td>1.219358e+08</td>\n",
       "      <td>0.127416</td>\n",
       "      <td>32</td>\n",
       "      <td>0x8729438eb15e2c8b576fcc6aecda6a148776c0f5</td>\n",
       "      <td>avalanche</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>avalaunch</th>\n",
       "      <td>XAVA</td>\n",
       "      <td>5.552019e+07</td>\n",
       "      <td>0.058015</td>\n",
       "      <td>14</td>\n",
       "      <td>0xd1c3f94de7e5b45fa4edbba472491a9f4b166fc4</td>\n",
       "      <td>avalanche</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "</div>"
      ],
      "text/plain": [
       "                         symbol    market_cap    weight  weight_converted  \\\n",
       "wrapped-avax               AVAX  2.043299e+10  0.200000                51   \n",
       "benqi-liquid-staked-avax  sAVAX  2.000000e+10  0.300000                77   \n",
       "joe                         JOE  3.010393e+08  0.314569                81   \n",
       "benqi                        QI  1.219358e+08  0.127416                32   \n",
       "avalaunch                  XAVA  5.552019e+07  0.058015                14   \n",
       "\n",
       "                                                             address  \\\n",
       "wrapped-avax              0xb31f66aa3c1e785363f0875a1b74e27b85fd66c7   \n",
       "benqi-liquid-staked-avax  0x2b2c81e08f1af8835a78bb2a90ae924ace0ea4be   \n",
       "joe                       0x6e84a6216ea6dacc71ee8e6b0a5b7322eebc0fdd   \n",
       "benqi                     0x8729438eb15e2c8b576fcc6aecda6a148776c0f5   \n",
       "avalaunch                 0xd1c3f94de7e5b45fa4edbba472491a9f4b166fc4   \n",
       "\n",
       "                         blockchain  \n",
       "wrapped-avax              avalanche  \n",
       "benqi-liquid-staked-avax  avalanche  \n",
       "joe                       avalanche  \n",
       "benqi                     avalanche  \n",
       "avalaunch                 avalanche  "
      ]
     },
     "execution_count": 6,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "results"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "84c4665c",
   "metadata": {},
   "source": [
    "## Contract Output"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 7,
   "id": "78d6dafd",
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "0x2b2c81e08f1af8835a78bb2a90ae924ace0ea4be,0x6e84a6216ea6dacc71ee8e6b0a5b7322eebc0fdd,0x8729438eb15e2c8b576fcc6aecda6a148776c0f5,0xb31f66aa3c1e785363f0875a1b74e27b85fd66c7,0xd1c3f94de7e5b45fa4edbba472491a9f4b166fc4\n",
      "77,81,32,51,14\n"
     ]
    }
   ],
   "source": [
    "methodology_class.output_for_contract()"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3.8.13 ('base')",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.11.9"
  },
  "vscode": {
   "interpreter": {
    "hash": "40d3a090f54c6569ab1632332b64b2c03c39dcf918b08424e98f38b5ae0af88f"
   }
  }
 },
 "nbformat": 4,
 "nbformat_minor": 5
}