d8x-etherfi

README

d8x-etherfi

Etherfi Integration

• Traders get allocated WEETH corresponding to margin account +/- unpaid funding
• LPs get allocated the entire pool WEETH minus the trader amount. This is more than the provide in liquidity because there are protocol owned funds
• Restaking of sharepooltoken is not supported

GET Endpoint /contracts

• GET endpoint with no arguments
• Returns the relevant contracts that are directly holding WEETH, including the WEETH balance
• optional argument: blockNumber

Response example:

{
  "holderContracts": [
    "0x2163cf2f1B7c331C0C757E068D00eFC9A707A1D7"
  ],
  "balance": [1216.55474202954],
  "status": "ok"
}

Balances are ordered in line with holderContracts and are provided as floating point numbers. The status can be different from ok, if the RPC request to get the balances failed:

{
  "holderContracts": [
    "0x2163cf2f1B7c331C0C757E068D00eFC9A707A1D7"
  ],
  "balance": [],
  "status": "balance unavailable"
}

POST Endpoint /balances

• Post endpoint with arguments blockNumber and a possibly empty list of addresses
• Returns the relevant contracts that are directly holding WEETH
• If addresses is empty, all token holders at the given block are returned

Payload example:

{
	"blockNumber": 195685403,
	"addresses": []
}

Response example: The effective_balance is provided as a floating point number.

{
    "Result": [
        {
            "address": "0x337a3778244159f37c016196a8e1038a811a34c9",
            "effective_balance": 3635.689148
        }
    ]
}

GET Endpoint /get-balances

• Optional argument: blockNumber=30021418
• Optional argument: http://127.0.0.1:8001/get-balances?addresses=0x2163cf2f1B7c331C0C757E068D00eFC9A707A1D7&addresses=0x0c0421445b9b4f721235676363b4be6d94d049d4

Same response as the corresponding post request /balances

Get Endpoint etherfi-apy

Queries the endpoint of etherfi https://www.etherfi.bid/api/etherfi/apr and calculates APY as adjustedAPR := lastAPR / 0.9 / (29.0 / 32.0) / 100.0. The value is cached for 12h.

Response:

{
  "etherfiApy": "3.40"
}

Dev

Contracts

Generate the ABI: abigen --abi internal/contracts/abi/ERC20.json --pkg contracts --type Erc20 --out erc20.go

Config

{
    "perpAddr":     "0x8f8BccE4c180B699F81499005281fA89440D1e95", <-- perpetual manager address
    "poolShareTknAddr": "0xc21950e41121C2c52DC8074713514ddBAD678258", <-- share token address for the relevant pool collateralized in WEETH
    "poolTknAddr" : "0xaf88d065e77c8cc2239327c5edb3a432268e5831", <-- address of the pool token (WEETH)
    "poolTknDecimals": 6, <-- number of decimals of the pool token to conver the ownership to float
    "rpcUrl": ["https://arbitrum.llamarpc.com", "https://arb1.arbitrum.io/rpc"] <-- RPC urls that will be used for queries
}