farm.army - Backend

Track your farming and pool performance on the Binance Chain

Platforms

Platform	Auto Fetch	Done	Notes
acryptos	❌	✔️
apeswap	❌	✔️
autofarm	✔️	✔️
bakery	✅	✅	farm config inconsistent for non so called "supportedPools"
bdollar	❌	✅	staking missing
bearn	❌	✅	staking missing
beefy	✔️	✅	boost vaults missing
goose	✅	✅	pools
hyperjump	❌	✔️
jetfuel	❌	✅	staking missing
kebab	❌	✅	pools
pancake	✅	✔️
pancakebunny	❌	✔️
saltswap	❌	✔️
slime	❌	✔️
valuedefi	✔️	✅	staking missing

• Auto Fetch

  • ✔️ New vaults are directly added when new are added New vaults are directly added when new are added
  • ✅ Vaults can be internal generate eg via external Github repo
  • ❌ Vaults need to be extraced from the page; mainly dump a javascript variable via chrome

• Done All supported "vault types" (pools, farms, staking, ...) are implemented

Tech Stack

• node.js
• sqlite

Business Values

• blockchain data MUST be called aggregated eg with "multicall" or "rpc wrapper" there should not be any direct single contract reading calls
• blockchain endpoints are slow, so runs should be in parallel with splitting http call to different URLs

Technical Debt

• Price discovery of a single token; multiple implementations
• Reduce platform duplicate codes
• Normalize platform "configuration format" of farms
• Reduce manually task to generate farm.json for some platforms; basically set the breakpoint in foreign platform javascript files (chrome) and dump the JSON configs (mostly all have the same pattern)
• Make generation farm.json via submodules and typescript call redundant
• Avoid global state; use dependency injection
• Use a persistent cache to reduce warmup time
• ...

Call Stack

Platforms

Platforms need to provide following implementations

• getFarms All farm, vaults, pools should be cached for all calls; should no be cached for background calls this are the data "refreshers"
• getAddressFarms(address) Get possible farms for an address, should be cached longer and should call needed contract values (also its normally the same as the following endpoint)
• getYields(address) Get all address farms with balances, rewards, ... cache can be lower, request should to take too long, else user need to wait long for the overview page
• getDetails(address, farm) Detail information for an address farm; request can to more stuff

Install

npm install
sqlite3 db.db < db.sql

Optional: to generate new farms / vault of some provide we need the public repo from them.

git submodule update --init --recursive

Optional: create a config file with custom configuration

config.json => config.json.local

Start

node src/index.js

Endpoints

  /farms

  /balances/:address

  /all/yield/:address

Farm / Pool Contract

Every farm contract should be converted / provided in a common format. Still feature early definition

  {
    "id": "pancake_farm_foobar", // required and should be somehow unique and should not change (so no index) 
    "name": "Syrup-BNB", // required
    "token": "syrup-bnb", // optional (fallback on "name" if not given, eg for icon)
    "platform": "pancake", // required
    "earns": ["bake"], // optional
    "link": "https:\/\/pancakeswap.finance\/farms", // required
    "has_details": true, // optional provide a detail link in frontend
    "notes": ['note_1', 'note_1'] // optional note of the farm; will be join in frontend
    "extra": {
      "lpAddress": "0x0e09fabb73bd3ade0a17ecc321fd13a19e81ce82", // to given hint about liquity split calculation
      "transactionToken": "0x0e09fabb73bd3ade0a17ecc321fd13a19e81ce82", // "in" and "out" transaction token
      "transactionAddress": "0x73feaa1eE314F8c655E354234017bE2193C9E24E" // "from" and "to" transaction
      "pricePerFullShare": 1.0408062780129632, // auto vault yield pools normally just wrap the "lpAddress" with a token which price is increasing; so just the multiplier
      "pricePerFullShareToken": "0xA9936272065e6DDAc9D2453C9a2712B581e9aE1B" // if given the value of "pricePerFullShare" is writting into database for historical data 
    },
    "tvl": {
      "amount": 212497359.08927876, // optional and not used
      "usd": 2832998380.971941 // optional
    },
    "yield": { // yearly values in percent eg 12.12%. apy or apr can be given (TODO: normalize to one)
      "apy": 553.9292024968477,
      "apr": 12.9292024968477,
    }
  },