Create internal manual bidding tool for GA testing

[pyropy]

Context

Per the GA scope defined in XFN-221, we need a simple internal manual bidding tool:

• Allows a dev/researcher to place a manual bid
• For testing / analysis only
• Document how to run it
• A dev (e.g. Luca) should be able to run it and place at least one real bid

Acceptance Criteria

• Create a simple CLI or script for placing manual bids
• Document usage instructions
• Verify a developer can successfully place at least one real bid

References

• GA Scope: https://linear.app/filoz/issue/XFN-221/filecoin-pay-ga-scope
• Parent issue: Fee auction monitoring tools #251

[Chaitu-Tatipamula]

can i take this up? @pyropy

[pyropy]

This issue should be moved to https://github.com/FilOzone/filecoin-pay-auction-bot

@Chaitu-Tatipamula I would've assign this issue to you but it's time critical. We got to have this merged, working and documented before 14th February (ideally couple of days before that). Would you be able to do that by that time given the amount of WIP you currently have?

[Chaitu-Tatipamula]

This issue should be moved to https://github.com/FilOzone/filecoin-pay-auction-bot

@Chaitu-Tatipamula I would've assign this issue to you but it's time critical. We got to have this merged, working and documented before 14th February (ideally couple of days before that). Would you be able to do that by that time given the amount of WIP you currently have?

yes i can get this done in this time frame, i'm going to add a high level implementation plan tonight so that we stay aligned wdyt?

[pyropy]

@Chaitu-Tatipamula sounds good. Once we agree on the high level implementation plan I'll assign this issue over to you.

[pyropy]

Some additional context: Ideally the tooling is not used for testing only but will also used for demoing/sharing with interested bidders eventually. The tool should be simple to use and understand.

In my opinion it should have two commands:

• list that will list all active auctions for tokens together with details like amount, price and start time
• bid that would allow bidders to bid on part or on full amount of tokens in the token auction
  • Required arguments would be
    • --token that should receive token address we wish to bid for
    • --private-key that should receive private key of the bidder
  • By default tool should bid on full amount unless provided --amount argument
  • By default tool should send value equal to the price for given amount, unless provided explicit --value argument (maybe the name value is not ideal here as it can confuse bidders
• When bid is placed tool should wait for receipt and print transaction details alongside with bid details

[Chaitu-Tatipamula]

Some additional context: Ideally the tooling is not used for testing only but will also used for demoing/sharing with interested bidders eventually. The tool should be simple to use and understand.

In my opinion it should have two commands:

• list that will list all active auctions for tokens together with details like amount, price and start time

• bid that would allow bidders to bid on part or on full amount of tokens in the token auction

  • Required arguments would be

    • --token that should receive token address we wish to bid for
    • --private-key that should receive private key of the bidder

  • By default tool should bid on full amount unless provided --amount argument

  • By default tool should send value equal to the price for given amount, unless provided explicit --value argument (maybe the name value is not ideal here as it can confuse bidders

• When bid is placed tool should wait for receipt and print transaction details alongside with bid details

ah i was thinking of the same, looks like i was on right track i'll drop a plan shortly i am just experimenting by deploying things myself creating rails, set lockup/payment rate, settle etc, this also only applies to ERC20 tokens right as the Native FIL fees are burned directly and for ERC20s they're auctioned to recover value as FIL which will then be burned i believe

[pyropy]

ah i was thinking of the same, looks like i was on right track i'll drop a plan shortly i am just experimenting by deploying things myself creating rails, set lockup/payment rate, settle etc, this also only applies to ERC20 tokens right as the Native FIL fees are burned directly and for ERC20s they're auctioned to recover value as FIL which will then be burned i believe

Perhaps this tool could be a tool build in Node.js so we could use Synapse SDK. That way we could have contract address without user having to know it.

We're trying to make this as simple as possible as it will be used by people not in tech, so it should be really user friendly.

[Chaitu-Tatipamula]

ah i was thinking of the same, looks like i was on right track i'll drop a plan shortly i am just experimenting by deploying things myself creating rails, set lockup/payment rate, settle etc, this also only applies to ERC20 tokens right as the Native FIL fees are burned directly and for ERC20s they're auctioned to recover value as FIL which will then be burned i believe

Perhaps this tool could be a tool build in Node.js so we could use Synapse SDK. That way we could have contract address without user having to know it.

We're trying to make this as simple as possible as it will be used by people not in tech, so it should be really user friendly.

Oh yeah thanks for the feedback. I was experimenting along the same lines you are right that using synapse SDK is good way as it already has everything we need like auctionInfo(), auctionFunds() and auctionPriceAt() and getChain() through which we can auto resolve contract addresses

about the 2 commands

list/info - shows all active auctions
options:
--token - token address to list auctions for
--network - mainnet or calibration

having --token option will let users check for any other ERC20 if we have not maintained it in KNOWN_TOKENS list as there is no direct way to enumerate all tokens with active auctions from the contract

for e.g.

% npx auction-bidder list --network calibration

Active Auctions on Filecoin Calibration
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Payments Contract: 0x09a0fDc2723fAd1A7b8e3e00eE5DF73841df55a0

Token: USDFC (0xb3042734b608a1B16e9e86B374A3f3e389B4cDf0)
  Available: 0.067201 USDFC
  Price: 0.038881 FIL
  Started: 6d ago

bid - Places bid with the options below
--token - token address to bid on
--private-key - bidder's key
--amount - amount to request (default: all available)
--value or --pay - FIL to pay (default: calculated price + 5% buffer)
--network - mainnet or calibration

when a bid is placed, it waits for the receipt and prints the transaction details alongside the result.

I am planning to put this in tools/auction-bidder

i already have a working prototype for bid and for list i mentioned above in list/info section

% npx auction-bidder bid \
 --token 0xb3042734b608a1B16e9e86B374A3f3e389B4cDf0 \
 --private-key 0x... \
 --network calibration

Placing Bid on Filecoin Calibration
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Token: 0xb3042734b608a1B16e9e86B374A3f3e389B4cDf0
Available: 0.067201
Requesting: 0.067201
Price: 0.040685 FIL

Bidder: 0xD117738595dfAFe4c2f96bcF63Ed381788E08d39

Submitting transaction...

✓ Transaction submitted: 0x5acbc4beb5dd3e79701f4a801e6b83c542b0027e72a6401f8b5ec3f6c7da6854
  View: https://calibration.filfox.info/en/tx/0x5acbc4beb5dd3e79701f4a801e6b83c542b0027e72a6401f8b5ec3f6c7da6854

Waiting for confirmation...

✓ Bid successful!
  Purchased: 0.067201 tokens
  Paid: 0.040685 FIL (burned)

letme know if this looks better i can clean it up for a PR