2-Staking-Pools.ipynb

{
 "cells": [
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "# IGNORE THIS :3\n",
    "import os\n",
    "from geode import Geode, globals\n",
    "G = Geode(exec_api = os.environ['EXECUTION_API'], cons_key = os.environ['CONSENSUS_KEY'])\n",
    "Portal = G.Portal\n",
    "pid = Portal.functions.allIdsByType(globals.ID_TYPE.POOL, 1).call()\n",
    "# IGNORE THIS :3"
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Staking Pools\n",
    "\n",
    "Read data from a staking pool's isolated storage easily!"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "# # note that some parameters like fee is denominated with 10**10\n",
    "from geode.globals.constants import DENOMINATOR, ETH\n",
    "\n",
    "myPool = Portal.pool(pid)"
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Pool Ownership and Creation Date\n",
    "> `TYPE`, `NAME`, `CONTROLLER` keys are always capitalized for any ID, other keys are always camelCase."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "print(\"TYPE:\",myPool.TYPE) \n",
    "print(\"NAME:\",myPool.NAME)\n",
    "print(\"CONTROLLER:\",myPool.CONTROLLER) # current owner\n",
    "print(\"maintainer:\",myPool.maintainer)\n",
    "print(\"yieldReceiver:\",myPool.yieldReceiver) # address(0) means yield is distributed to the token holders\n",
    "print(\"initiated:\",myPool.initiated) # timestamp"
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Pool Configuration"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "print(\"private:\",myPool.private) # bool\n",
    "print(\"whitelist:\",myPool.whitelist) # returns address(0) if pool does not have one\n",
    "print(\"withdrawalCredential:\",myPool.withdrawalCredential) # useful for NOs\n",
    "print(\"withdrawalContract:\",myPool.withdrawalContract)\n",
    "print(\"liquidityPool:\",myPool.liquidityPool) # returns address(0) if pool does not have one"
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Pool Fee"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "# returns active fee, takes 3 days the change to be effective\n",
    "print(f\"fee:{myPool.fee}, which is {myPool.fee/DENOMINATOR*100}%\")\n",
    "# no need to give it to a param, lib does not call within 60 sec (REFRESH RATE)\n",
    "print(f\"priorFee:{myPool.priorFee}, which is {myPool.priorFee/DENOMINATOR*100}%\") \n",
    "# latest fee effective change date as timestamp\n",
    "print(\"feeSwitch:\",myPool.feeSwitch)"
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Staking Related Data"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "# amount that is waiting to be delegated (useful when proposing a validator)\n",
    "print(\"surplus:\",myPool.surplus) \n",
    "# amount that is waiting to be sent to delegated validators\n",
    "print(\"secured:\",myPool.secured) "
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Token Data\n",
    "\n",
    "> Token* mentioned here is just one ERC1155 'ID', acting like it is ERC20!\n",
    "\n",
    "> `middleware` is a unique approach that combine ERC1155 and ERC20."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "print(\"middlewaresLen:\", myPool.middlewaresLen)\n",
    "print(\"middleware 0\", myPool.middlewares(0))\n",
    "# this function creates a loop, won't recommend using it\n",
    "print(\"middlewaresList:\", myPool.middlewaresList) "
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Internal Wallet\n",
    "\n",
    "Every ID has its own internal wallet within Portal. \n",
    "\n",
    "It accrues fees, makes things safer and easier for Node Operators etc."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "print(f\"wallet has {myPool.wallet} wei, which is {myPool.wallet/ETH} ETH\")"
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### fallback Operator\n",
    "`fallback Operator` is probably not widely used or documented for now, but I will explain it:\n",
    "\n",
    "> Let's say A staking pool has 100 cumulative validator allowances accross all Operators.\n",
    ">\n",
    "> But pool has a lot of volume going through. So, pool owner says:\n",
    ">\n",
    "> \"ok, when 80% (`fallbackThreshold`) of my allowances are filled, I want IceBearInstitutional (`fallbackOperator`) to have unlimited allowance.\" "
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "print(\"fallbackOperator\", myPool.fallbackOperator)\n",
    "print(\"fallbackThreshold\", myPool.fallbackThreshold)"
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "> For relational data, which is actually a part of the Pool's Isolated Storage, see the Operator-Marketplace.ipynb"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "venv",
   "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.9.6"
  },
  "orig_nbformat": 4,
  "vscode": {
   "interpreter": {
    "hash": "b1b6c5072c5a50f6d2400b07d553322444e3342f0da0ae61087b066e28ec204a"
   }
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}