Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Inter Protocol Liquidation Bidding Test Tool #7295

Merged
merged 12 commits into from
Apr 24, 2023
Merged

docs: Inter Protocol Liquidation Bidding Test Tool #7295

merged 12 commits into from
Apr 24, 2023

Conversation

dckc
Copy link
Member

@dckc dckc commented Mar 31, 2023 •
edited
Loading

refs: #6930, #6889
stacked on #7454

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:

  1. formats the bid as a Zoe offer specification
  2. signs and broadcasts a transaction containing the offer spec
  3. waits for the transaction to be included in a block
  4. waits for the offer to be placed with the auctioneer contract via Zoe

Tasks
Preview Give feedback

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
Copy link
Contributor

mergify bot commented Mar 31, 2023

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

@dckc dckc force-pushed the dc-bid-cli branch 2 times, most recently from c29b823 to 4983d7e Compare March 31, 2023 19:05
@dckc dckc force-pushed the dc-bid-cli-doc branch from 09e0197 to 62c4f11 Compare April 1, 2023 03:45
@dckc dckc requested a review from arirubinstein April 1, 2023 03:50
@dckc
Copy link
Member Author

dckc commented Apr 1, 2023

@Mergifyio refresh

@mergify
Copy link
Contributor

mergify bot commented Apr 1, 2023

refresh

✅ Pull request refreshed

@dckc dckc requested review from ivanlei and rowgraus April 1, 2023 04:01
@dckc dckc force-pushed the dc-bid-cli-doc branch from ba48b06 to 85ef5a5 Compare April 3, 2023 23:16
@dckc dckc mentioned this pull request Apr 3, 2023
Merged
@dckc dckc force-pushed the dc-bid-cli-doc branch from 85ef5a5 to 158b832 Compare April 4, 2023 03:18
@dckc 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 dckc force-pushed the dc-bid-cli-doc branch from 158b832 to 273c7ba Compare April 6, 2023 00:54
@dckc dckc mentioned this pull request Apr 7, 2023
Closed
dckc
dckc commented Apr 12, 2023
View reviewed changes
packages/inter-protocol/test/auction/README-bidding-cli.md Outdated
@@ -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
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Chris-Hibbert reviewed Apr 12, 2023
View reviewed changes
packages/inter-protocol/test/auction/README-bidding-cli.md Outdated

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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that I reverted the Mainnet stuff.

@dckc dckc changed the base branch from master to 7266-auction-status-cli April 19, 2023 03:53
@dckc dckc mentioned this pull request Apr 19, 2023
Merged
@dckc 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 added 9 commits April 20, 2023 15:16
@dckc
docs: Inter Protocol Liquidation Bidding Test Tool
f2f0fcd 
fixup: SKIP_DOWNLOAD=false to install

chore: --give amounts include brand names
@dckc
test: sync bidding CLI tests with doc
97c2fba 
 - 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
@dckc
chore: throw if vstorage response code !== 0
a4a12e5
@dckc
fix: ec vote: handle failed vstorage read for latestQuestion
4edd5f1
@dckc
docs: finish pruning section
f84fe05
@dckc
chore: update for inter auction status
c9ca2c1
@dckc
docs: polish bidding CLI README
cf0419e 
 - address TODOs per discussion with product
 - omit want
@dckc
fixup! chore: update for inter auction status
76abed6
@dckc
chore: regen inter cli snapshot
1b9f0d9
@dckc dckc requested a review from otoole-brendan April 20, 2023 20:17
otoole-brendan
otoole-brendan requested changes Apr 24, 2023
View reviewed changes
packages/inter-protocol/test/auction/README-bidding-cli.md Show resolved Hide resolved
packages/inter-protocol/test/auction/README-bidding-cli.md Outdated

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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 Outdated Show resolved Hide resolved
@dckc dckc requested a review from otoole-brendan April 24, 2023 15:50
otoole-brendan
otoole-brendan approved these changes Apr 24, 2023
View reviewed changes
Copy link
Contributor

@otoole-brendan otoole-brendan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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 dckc added the automerge:squash Automatically squash merge label Apr 24, 2023
@mergify mergify bot merged commit fcebad4 into master Apr 24, 2023
@mergify mergify bot deleted the dc-bid-cli-doc branch April 24, 2023 20:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@otoole-brendan otoole-brendan otoole-brendan approved these changes

@Chris-Hibbert Chris-Hibbert Chris-Hibbert approved these changes

Assignees
No one assigned
Labels
automerge:squash Automatically squash merge
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@dckc @Chris-Hibbert @otoole-brendan