Fee auction monitoring tools

[irenegia]

We need to have tools to monitor the auction is working as expected

• Run a keeper (a bot to participate in the auction )
  • A keeper will give us monitoring on the pricing and auction activity around
  • @wjmelements write down the task
• Settled Fees accumulated vs fee auctioned per token
• A webpage - buy usdfc ?
• Add any related runbooks or documentation from https://www.notion.so/filecoindev/FOC-Operational-Excellence-2b7dc41950c1802aa432fff8ecb801cc

[rjan90]

A webpage - buy usdfc ?

In stead of a webpage for GA, this could be a Grafana dashboard internal for GA.

[timfong888]

How can I get coloring on the impact of the fee auction having issues? I'd like to take it out of GA, but I don't have a good way to understand scope.

[rvagg]

@timfong888 we could probably put "issues" under the heading of the auction not resulting in total burnt FIL being within some % of some market valued expectation of the ERC20 value and FIL value at the time of auction events. The whole point is to get close to burning the FIL equivalent of the ERC20 collected, but we'd have to come up with some acceptable range within which we are happy (along with sources that provide a plausible valuation of the ERC20 and FIL at that point in time).

If the auction isn't resulting in burning FIL for services mediated by Filecoin Pay, then we have no direct value accrual to the network due to running this mediation functionality, it's all indirect (e.g. hooking up clients and servers, value provided to both of those parties, network is just a disinterested party in that transaction). So it's kind of core, but to solve for the basic version of this we probably just need a grafana dashboard or some simple web page that can show auction events and we can extrapolate from that.

[timfong888]

Got it - how do we size the work? I don't have a sense of the operational complexity of the auction and the risks that part of the process isn't working.

[rvagg]

This is related btw, William wrote this up: https://www.notion.so/filecoindev/Payments-Auction-UI-2b5dc41950c180bd8b20ff58777bfc8d

(Warning: Spitballing going on here ...)

The main barrier to a fast-path of monitoring is the lack of events on burnForFees (see comments in that doc), so we're left fishing around for burn events or proxies to that. But we do have Goldsky to lean on here and they can do indexing for us. I think they support call handlers which are what we could use to index function calls.

We have RailSettled and RailOneTimePaymentProcessed events to work with. eth_getLogs can get these.

We could put together and small collector service to run somewhere in our infra to:

1. query subgraph for historical/aggregate data
2. query an RPC for real-time data (current price, current pool)
3. query a price API for FIL and other ERC20 prices (CoinGecko? could peg stablecoin(s) to $1 for simplicity)
4. push to prometheus

We could get:

• Auction Price (per token) (RPC)
• Fee Pool Balance (per token) (RPC)
• Fees Collected (cumulative) (Subgraph)
• Fees Claimed (cumulative) (Subgraph)
• FIL Burned (cumulative) (Subgraph)
• Recent Claims (Subgraph)
• Efficiency Ratio ((FIL burned * FIL price) / (ERC20 fees claimed * ERC20 price))

And build some charts and alerting around that. Look for efficiency below some threshold like 80%, look for stale auctions (price near zero, no claims, is anyone watching?).

Seems like an interesting 2-4 day project for someone who has a clue about how some of these things work. AI would be quite good at guiding this if pointed at the various related resources.

[wjmelements]

Yes should have logged an event but we can workaround.

I think block explorer APIs are the way to go. Look for transactions to the burn address from the payments contract, or filter all messages to the payments contract by method signature. Those messages will have the taken token amount and the FIL burn.

https://filecoin.blockscout.com/api-docs

filfox also has an internal transactions API

curl -X 'GET' \
  'https://filfox.info/api/v1/address/f410feoy6aghqro4yenelcwug52jg527x6tnkxl36cyi/messages' \
  -H 'accept: */*'
curl -X 'GET' \
  'https://filfox.info/api/v1/address/f410fobkxce3syvfhgdi7m6x5grz3q2w54cqmadgunoy/transfers' \
  -H 'accept: */*'