opynfinance / gamma-liquidator Goto Github PK

Add how to setup local development environment in Readme

Currently the user who will run the liquidation bot need to set Controller and Calculator addresses. Other addresses may be needed in the future. I think it is better to just use AddressBook address as argument and then fetch all addresses from there.

Docs link in Readme is invalid

I think the current calculateGasPriceFromGasNow() implementation make it hard to read the function or to change it for a new developer.

export async function calculateGasPriceFromGasNow() {
  return BigNumber.from((await (await fetch(gasNowUrl)).json()).data.rapid)
    .mul(Math.round(Number(process.env.GAS_PRICE_MULTIPLIER) * 100000000))
    .div(100000000);
}

IMO make sense to separate and assign values to some variables.

E.g

const rapidGasNow = (await fetch(gasNowUrl)).json()).data.rapid;
const multipliedGasNow = rapidGasNow.mul(...);
...

Improve readme instructions on how to setup the local development environment

Currently the bot by default get rapid gas price fro gasnow.org API and multiply it by a multiplier number that the liquidator can customize (default set to 1.0).
The initial idea of the multiplier is to use it when fetching gas price directly from the network (used as fallback if gasnow.org API fail).
This is a bit confusing as a liquidator can set the multiplier to 2.5 assuming this will only multiply gas price fetching from the network, and use the default rapid gasnow.org price, but what will happen is the bot will overprice the rapid gasnow.org.