docs: Inter Protocol Liquidation Bidding Test Tool #7295

dckc · 2023-03-31T16:39:57Z

Description

This documents a revised design implemented in #7256. Excerpt:

Placing a bid: inter bid ...

Let's place a 5 IST bid at a price of 9.50:
$ inter bid by-price --give 5 --price 9.50 --from test-acct
2023-03-31T07:07:33.319399551Z tx not in block 55762 retrying...
2023-03-31T07:07:33.319399551Z tx not in block 55762 retrying...
bid is broadcast:
{"timestamp":"2023-03-31T07:07:38Z","height":"55763","offerId":"bid-1680246460034","txhash":"FDB98EEC71E987FEEE4A..."}
{"id":"bid-1680246460034","price":"9.5 IST/IbcATOM","give":{"Currency":"5IST"},"result":"Your bid has been accepted"}
This command does several things:

formats the bid as a Zoe offer specification

signs and broadcasts a transaction containing the offer spec

waits for the transaction to be included in a block

waits for the offer to be placed with the auctioneer contract via Zoe

Tasks

Give feedback

address TODOs in the doc such as by-discount, want
Options

Security Considerations

Scaling Considerations

Documentation Considerations

rendered: README-bidding-cli.md

Testing Considerations

Ideally we'd have tests that tell us that this needs maintenance. The cited snapshot tests can help, perhaps.

mergify · 2023-03-31T16:40:30Z

⚠️ The sha of the head commit of this PR conflicts with #7256. Mergify cannot evaluate rules on this PR. ⚠️

packages/inter-protocol/test/auction/README-bidding-cli.md

dckc · 2023-04-01T03:54:03Z

@Mergifyio refresh

mergify · 2023-04-01T03:54:05Z

refresh

✅ Pull request refreshed

dckc · 2023-04-12T17:05:36Z

packages/inter-protocol/test/auction/README-bidding-cli.md

@@ -109,8 +112,15 @@ Using the `test` keyring is lower friction, but feel free to use the os keyring:
 agd keys add test-acct
 ```

+## Provisioning your account for use with Zoe smart contracts
+
+Mainnet


This is a testing tool. Use with mainnet is outside the scope.

Please coordinate before pushing to this branch.

I made https://github.com/Agoric/agoric-sdk/tree/bot-bid-cli-doc and put your work there.

Chris-Hibbert · 2023-04-12T17:34:28Z

packages/inter-protocol/test/auction/README-bidding-cli.md

+
+Mainnet
+
+You’ll need to provision an Agoric Smart Wallet account (offer handler) in order to interact with Zoe contracts. You’ll need acquire 10BLD in order to do this. See[ ‘How to Provisions a Smart Wallet instructions’](https://docs.inter.trade/user-how-to/wallet-usage/create-your-agoric-account-and-smart-wallet.). Once provisioned, you’ll need to hold an IST balance in order to be able to place a bid.


The deleted period is not very visible in the diff, but it's the most semantically significant change below. The link won't work without the fix.

Suggested change

You’ll need to provision an Agoric Smart Wallet account (offer handler) in order to interact with Zoe contracts. You’ll need acquire 10BLD in order to do this. See[ ‘How to Provisions a Smart Wallet instructions’](https://docs.inter.trade/user-how-to/wallet-usage/create-your-agoric-account-and-smart-wallet.). Once provisioned, you’ll need to hold an IST balance in order to be able to place a bid.

You’ll need to provision an Agoric Smart Wallet account (offer handler) in order to interact with Zoe contracts. You’ll need acquire 10BLD in order to do this. See [‘How to Provision a Smart Wallet instructions’](https://docs.inter.trade/user-how-to/wallet-usage/create-your-agoric-account-and-smart-wallet). Once provisioned, you’ll need to hold an IST balance in order to be able to place a bid.

Note that I reverted the Mainnet stuff.

fixup: SKIP_DOWNLOAD=false to install chore: --give amounts include brand names

@qclass

- add tests for: inter liquidation status, inter vbank list - take test expected output from README - use matching bid id, 3.105 ATOM - spaces in amounts - round to 4 digits - tweak brands: - ATOM board # - include BLD - want -> maxBuy - punt on payouts from bid cancel - use board serializer rather than ad-hoc @qclass stuff

- address TODOs per discussion with product - omit want

packages/inter-protocol/test/auction/README-bidding-cli.md

otoole-brendan · 2023-04-24T15:26:35Z

packages/inter-protocol/test/auction/README-bidding-cli.md

+
+```
+$ inter bid list --from test-acct
+{"id":"bid-1680246460034","price":"9.5 IST/ATOM","give":{"Currency":"5 IST"},"result":"Your bid has been accepted"}


@dckc I disagree - If the example in instructions are different to what I receive in my output, I as a user would be confused/bothered. We know 'maxBuy' appears so it's not accurate as stated.

packages/inter-protocol/test/auction/README-bidding-cli.md

otoole-brendan

@dckc Looks good to me. Just an FYI though - I only reviewed the .md file as I don't believe I am a suitable reviewer of the .js files so my review has ignored those.

dckc requested review from Chris-Hibbert and otoole-brendan March 31, 2023 16:39

dckc force-pushed the dc-bid-cli-doc branch from 6882ea3 to fb1335c Compare March 31, 2023 17:09

Chris-Hibbert reviewed Mar 31, 2023

View reviewed changes

packages/inter-protocol/test/auction/README-bidding-cli.md Outdated Show resolved Hide resolved

packages/inter-protocol/test/auction/README-bidding-cli.md Outdated Show resolved Hide resolved

dckc force-pushed the dc-bid-cli branch 2 times, most recently from c29b823 to 4983d7e Compare March 31, 2023 19:05

dckc force-pushed the dc-bid-cli-doc branch from fb1335c to a05e8ae Compare March 31, 2023 19:16

dckc force-pushed the dc-bid-cli branch from b9079ad to a05f324 Compare April 1, 2023 01:06

dckc force-pushed the dc-bid-cli-doc branch from 09e0197 to 62c4f11 Compare April 1, 2023 03:45

dckc requested a review from arirubinstein April 1, 2023 03:50

dckc force-pushed the dc-bid-cli branch from a05f324 to fa305ac Compare April 1, 2023 03:51

dckc requested review from ivanlei and rowgraus April 1, 2023 04:01

dckc force-pushed the dc-bid-cli branch from fa305ac to 4bdffe2 Compare April 3, 2023 23:12

dckc force-pushed the dc-bid-cli-doc branch from ba48b06 to 85ef5a5 Compare April 3, 2023 23:16

dckc mentioned this pull request Apr 3, 2023

feat: more usable bidding CLI: integrated sign/broadcast #7256

Merged

dckc force-pushed the dc-bid-cli-doc branch from 85ef5a5 to 158b832 Compare April 4, 2023 03:18

dckc force-pushed the dc-bid-cli branch 4 times, most recently from c0fb26b to 1200ad5 Compare April 5, 2023 16:07

Base automatically changed from dc-bid-cli to master April 5, 2023 16:47

dckc force-pushed the dc-bid-cli-doc branch from 158b832 to 273c7ba Compare April 6, 2023 00:54

dckc mentioned this pull request Apr 7, 2023

Cannot find package '@endo/init' from agd build #7356

Closed

dckc force-pushed the dc-bid-cli-doc branch from 273c7ba to c058871 Compare April 12, 2023 03:20

dckc commented Apr 12, 2023

View reviewed changes

Chris-Hibbert reviewed Apr 12, 2023

View reviewed changes

dckc force-pushed the dc-bid-cli-doc branch from 4d78e27 to 6f4c7d9 Compare April 19, 2023 03:51

dckc changed the base branch from master to 7266-auction-status-cli April 19, 2023 03:53

dckc mentioned this pull request Apr 19, 2023

feat!: inter auction status command #7454

Merged

Chris-Hibbert approved these changes Apr 19, 2023

View reviewed changes

dckc force-pushed the 7266-auction-status-cli branch 4 times, most recently from 5cbbfc5 to d7cd994 Compare April 20, 2023 17:19

Base automatically changed from 7266-auction-status-cli to master April 20, 2023 17:45

dckc force-pushed the dc-bid-cli-doc branch from 6f4c7d9 to 0b757e3 Compare April 20, 2023 20:14

dckc added 9 commits April 20, 2023 15:16

docs: Inter Protocol Liquidation Bidding Test Tool

f2f0fcd

fixup: SKIP_DOWNLOAD=false to install chore: --give amounts include brand names

chore: throw if vstorage response code !== 0

a4a12e5

fix: ec vote: handle failed vstorage read for latestQuestion

4edd5f1

docs: finish pruning section

f84fe05

chore: update for inter auction status

c9ca2c1

docs: polish bidding CLI README

cf0419e

- address TODOs per discussion with product - omit want

fixup! chore: update for inter auction status

76abed6

chore: regen inter cli snapshot

1b9f0d9

dckc force-pushed the dc-bid-cli-doc branch from 0b757e3 to 1b9f0d9 Compare April 20, 2023 20:16

dckc requested a review from otoole-brendan April 20, 2023 20:17

fixup! chore: update for inter auction status

3a6b2b5

otoole-brendan requested changes Apr 24, 2023

View reviewed changes

docs: don't omit maxBuy in example output

98b3e79

dckc requested a review from otoole-brendan April 24, 2023 15:50

otoole-brendan approved these changes Apr 24, 2023

View reviewed changes

dckc added the automerge:squash Automatically squash merge label Apr 24, 2023

Merge branch 'master' into dc-bid-cli-doc

6f7c1e2

mergify bot merged commit fcebad4 into master Apr 24, 2023

mergify bot deleted the dc-bid-cli-doc branch April 24, 2023 20:34

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Inter Protocol Liquidation Bidding Test Tool #7295

docs: Inter Protocol Liquidation Bidding Test Tool #7295

dckc commented Mar 31, 2023 •

edited

Loading

Tasks

mergify bot commented Mar 31, 2023

dckc commented Apr 1, 2023

mergify bot commented Apr 1, 2023

dckc Apr 12, 2023

Chris-Hibbert Apr 12, 2023

dckc Apr 17, 2023

otoole-brendan Apr 24, 2023

otoole-brendan left a comment


		Mainnet

		You’ll need to provision an Agoric Smart Wallet account (offer handler) in order to interact with Zoe contracts. You’ll need acquire 10BLD in order to do this. See[ ‘How to Provisions a Smart Wallet instructions’](https://docs.inter.trade/user-how-to/wallet-usage/create-your-agoric-account-and-smart-wallet.). Once provisioned, you’ll need to hold an IST balance in order to be able to place a bid.

docs: Inter Protocol Liquidation Bidding Test Tool #7295

docs: Inter Protocol Liquidation Bidding Test Tool #7295

Conversation

dckc commented Mar 31, 2023 • edited Loading

Description

Placing a bid: inter bid ...

Tasks

Security Considerations

Scaling Considerations

Documentation Considerations

Testing Considerations

mergify bot commented Mar 31, 2023

dckc commented Apr 1, 2023

mergify bot commented Apr 1, 2023

✅ Pull request refreshed

dckc Apr 12, 2023

Choose a reason for hiding this comment

Chris-Hibbert Apr 12, 2023

Choose a reason for hiding this comment

dckc Apr 17, 2023

Choose a reason for hiding this comment

otoole-brendan Apr 24, 2023

Choose a reason for hiding this comment

otoole-brendan left a comment

Choose a reason for hiding this comment

dckc commented Mar 31, 2023 •

edited

Loading

Placing a bid: `inter bid ...`