feat: inter-tool bid list #7939

dckc · 2023-06-16T15:13:44Z

closes: #7905

stacked on:

Description

Tasks for Functional Requirements, followed by engineering goals:

Tasks

Give feedback

measurable code coverage for tests (FR1)
automated installation test (FR1)
test for show partially filled bids (FR3) - docker test? leave out of scope, assuming it's addressed by auction publish all bids to vstorage #7906 / feat(auction): auction publish all bids off-chain #7618?
snapshot test for help text (FR5)
figure out what --from-bidder and --from-everyone are about (FR5)
support, test --asset (FR5)
test AGORIC_NET (FR6)
show disclaimer (FR7)
test formatting amounts (FR9)
handle >1 (cosmos RPC) page of results (FR10-11)
support size limits (FR12)
change from inter-tool auction list-bids to inter-tool bid list (FR13)
something about --from-everyone –asset (FR14)???
format timestamps a la YYYY-MM-DDTHH:MM:SS - remove fraction of second. remove timezone ??? (FR15)
include want in output (???) (FR15)
sort bids by price, seqno (FR16)
support oracle price option (FR17)
support price option where brand can be IST, USD, or implicit (FR17)
format bids nicely
refactor: unmarshalled brands etc. should not know their boardIDs; that mapping should be kept elsewhere
fetch bid data in a batch
prune agd related code? signing, key lookup are not used when showing bids
Options

Security Considerations

unlike agops, this CLI code is suspicious of data from vstorage: static type declarations are enforced by dynamic checks such as pattern matches

Scaling Considerations

Documentation Considerations

Testing Considerations

dckc · 2023-06-16T21:55:50Z

list bids from auction works in 1 case

Using

feat(auction): auction publish all bids off-chain #7618

not nicely formatted yet, but fetched from vstorage, unmarshalled:

packages/inter-cli$ node src/inter-tool.js auction list-bids
...
@@@bid {
  balance: {
    brand: Object [Alleged: BoardRemoteIST brand] { getBoardId: {} },
    value: 1000n
  },
  exitAfterBuy: false,
  price: {
    denominator: { brand: [Object [Alleged: BoardRemoteATOM brand]], value: 1n },
    numerator: { brand: [Object [Alleged: BoardRemoteIST brand]], value: 9n }
  },
  sequence: 1n,
  timestamp: {
    absValue: 1686951226n,
    timerBrand: Object [Alleged: BoardRemotetimerBrand] { getBoardId: {} }
  },
  wanted: {
    brand: Object [Alleged: BoardRemoteATOM brand] { getBoardId: {} },
    value: 1000000000000n
  }
}

prep: start chain, place bid

agoric-sdk/packages/inter-protocol$ ./scripts/start-local-chain.sh
...

$ agops inter bid by-price --price=9 --give 0.001IST --from gov1
2023-06-16T21:33:46.894667486Z tx not in block 145 retrying...
bid is broadcast:
{"timestamp":"2023-06-16T21:33:51Z","height":"146","offerId":"bid-1686951234745","txhash":"042B4D6BDBC1F23EBED1D02C9CF6394A4643B96FFD6A4C87834DAE14CA412EBB"}
2023-06-16T21:33:51.906915122Z offer not in wallet at block 146 retrying...
2023-06-16T21:33:51.906915122Z offer not in wallet at block 146 retrying...
{"id":"bid-1686951234745","price":"9 IST/ATOM","give":{"Bid":"0.001 IST"},"maxBuy":"1000000 ATOM","result":"Your bid has been accepted"}

$ agops inter bid list --from gov1
{"id":"bid-1686951234745","price":"9 IST/ATOM","give":{"Bid":"0.001 IST"},"maxBuy":"1000000 ATOM","result":"Your bid has been accepted"}

Raw book0.bids from auction contract

$ agd query vstorage data published.auction.book0.bids
value: '{"blockHeight":"147","values":["{\"body\":\"#{\\\"pricedBids\\\":[{\\\"balance\\\":{\\\"brand\\\":\\\"$0.Alleged:
  IST brand\\\",\\\"value\\\":\\\"+1000\\\"},\\\"exitAfterBuy\\\":false,\\\"price\\\":{\\\"denominator\\\":{\\\"brand\\\":\\\"$1.Alleged:
  ATOM brand\\\",\\\"value\\\":\\\"+1\\\"},\\\"numerator\\\":{\\\"brand\\\":\\\"$0\\\",\\\"value\\\":\\\"+9\\\"}},\\\"sequence\\\":\\\"+1\\\",\\\"timestamp\\\":{\\\"absValue\\\":\\\"+1686951226\\\",\\\"timerBrand\\\":\\\"$2.Alleged:
  timerBrand\\\"},\\\"wanted\\\":{\\\"brand\\\":\\\"$1\\\",\\\"value\\\":\\\"+1000000000000\\\"}}],\\\"scaledBids\\\":[]}\",\"slots\":[\"board0257\",\"board02152\",\"board0425\"]}"]}'

actual output from 1638dd384 , which merges #7618 with b6ac9a3

full output with debug logging

$ yarn --silent node src/inter-tool.js auction list-bids
XXX is sync IO essential?
XXX: rpcAddrs after [0] are ignored
{ rpcAddr: 'http://0.0.0.0:26657' }
XXX why is vstorage QueryClientImpl any???
TODO: test empty stream cell
{
  "pricedBids": [
    {
      "balance": {
        "brand": {},
        "value": "1000"
      },
      "exitAfterBuy": false,
      "price": {
        "denominator": {
          "brand": {},
          "value": "1"
        },
        "numerator": {
          "brand": {},
          "value": "9"
        }
      },
      "sequence": "1",
      "timestamp": {
        "absValue": "1686951226",
        "timerBrand": {}
      },
      "wanted": {
        "brand": {},
        "value": "1000000000000"
      }
    }
  ],
  "scaledBids": []
}
@@@bid {
  balance: {
    brand: Object [Alleged: BoardRemoteIST brand] { getBoardId: {} },
    value: 1000n
  },
  exitAfterBuy: false,
  price: {
    denominator: { brand: [Object [Alleged: BoardRemoteATOM brand]], value: 1n },
    numerator: { brand: [Object [Alleged: BoardRemoteIST brand]], value: 9n }
  },
  sequence: 1n,
  timestamp: {
    absValue: 1686951226n,
    timerBrand: Object [Alleged: BoardRemotetimerBrand] { getBoardId: {} }
  },
  wanted: {
    brand: Object [Alleged: BoardRemoteATOM brand] { getBoardId: {} },
    value: 1000000000000n
  }
}

turadg · 2023-07-11T00:42:32Z

I see this is in Draft. Are there parts of it that are ready to consider landing?

dckc · 2023-07-11T16:44:22Z

I see this is in Draft.

Yeah... IOU a TODO list...

Are there parts of it that are ready to consider landing?

I factored out #7935

- batch vstorage queries

dckc · 2023-07-12T05:22:41Z

fetches each bid at its own vstorage key

I caught up with the current state of...

feat(auction): auction publish all bids off-chain #7618

so we now get:

$ yarn --silent node src/inter-tool.js auction list-bids
fetching 3 bids: [ 'bid1001', 'bid1002', 'bid1003' ] 
{"timestamp":"2023-07-11T17:49:18.000Z","sequence":1001,"price":"5.0000 IST/ATOM","balance":"0.00123 IST","wanted":"1000000 ATOM"}
{"timestamp":"2023-07-11T23:50:04.000Z","sequence":1002,"price":"5.0000 IST/ATOM","balance":"0.00456 IST","wanted":"1000000 ATOM"}
{"timestamp":"2023-07-12T03:59:28.000Z","sequence":1003,"bidScaling":"90.0000%","balance":"0.00321 IST","wanted":"1000000 ATOM"}

the current code also emits some debug/todo info:

XXX is sync IO essential?
XXX: rpcAddrs after [0] are ignored
TODO: pick among >1 rpcAddrs { rpcAddr: 'http://0.0.0.0:26657' }
TODO: pagination

test status

I refined the RPC fixture to avoid base64 gorp in most cases.

  ✔ [expected fail] format › format price > 1e20
  ✔ format › makeAssetFormatters handles all nat amounts, ratios (with seed=1107299986)
  ✔ auction › inter auction list-bids
  ✔ vstorage › extractStreamCellValue() handles empty response
  ✔ vstorage › extractStreamCellValue() handles all valid non-empty responses
  ✔ boardClient › boardProxy.provide() preserves identity
  ✔ boardClient › boardCtx ingest() preserves identity for passable keys
  ─

  6 tests passed
  1 known failure

currently: -----------------|---------|----------|---------|---------| File | % Stmts | % Branch | % Funcs | % Lines | -----------------|---------|----------|---------|---------| All files | 95.4 | 75.94 | 77.14 | 95.4 |

to match spec

dckc · 2023-07-12T19:53:14Z

updated usage / tests to better match product spec

test-auction.js.md is a snapshot of help / usage text.

Tests such as "see all bids for a collateral type" have t.log() output to match the product spec.

$ yarn test
yarn run v1.22.19
$ ava

  ✔ auction › see all bids for a collateral type
    ℹ inter-tool bid list
fetching 3 bids: [ 'bid1001', 'bid1002', 'bid1003' ] 
TODO: pagination
    ℹ {"timestamp":"2023-07-11T17:49:18Z","sequence":1001,"price":"9.5000 IST/ATOM","balance":"500 IST","wanted":"1000000 ATOM"}
    ℹ {"timestamp":"2023-07-11T23:50:04Z","sequence":1002,"price":"8.5000 IST/ATOM","balance":"300 IST","wanted":"1000000 ATOM"}
    ℹ {"timestamp":"2023-07-12T03:59:28Z","sequence":1003,"bidScaling":"90.0000%","balance":"200 IST","wanted":"1000000 ATOM"}
  ✔ auction › FR5: Usage: inter-tool --help
  ✔ auction › FR5: Usage: inter-tool bid --help
  ✔ auction › FR5: Usage: inter-tool bid list --help
  - [todo] auction › FR5: --asset
  - [todo] auction › should timestamps really not show timezone?
  - [todo] auction › FR3: show partially filled bids
  - [todo] auction › FR5: --from-bidder, --from-everyone
  - [todo] auction › want should be maxBuy
  - [todo] auction › balance should be give
  - [todo] auction › give should be formatted as keyword record with Bid keyword
  - [todo] auction › price should be a number with implicit brands (?)
  ✔ format › makeAssetFormatters handles all nat amounts, ratios (with seed=-906316278)
  - [todo] format › prices truncate at 4 decimal places
  ✔ [expected fail] format › format price > 1e20
  ✔ networkConfig › support AGORIC_NET
  ✔ vstorage › extractStreamCellValue() handles empty response
  ✔ vstorage › extractStreamCellValue() handles all valid non-empty responses
  ✔ boardClient › boardProxy.provide() preserves identity
  ✔ boardClient › boardCtx ingest() preserves identity for passable keys
  ─

  10 tests passed
  1 known failure
  9 tests todo
Done in 1.23s.

I took the liberty of re-ordering the test output for clarity.

Test Coverage

-------------------|---------|----------|---------|---------|----------------------------
File               | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s          
-------------------|---------|----------|---------|---------|----------------------------
All files          |   95.03 |    75.29 |   76.92 |   95.03 |                            
 commands          |     100 |    85.71 |     100 |     100 |                            
  auction.js       |     100 |    85.71 |     100 |     100 | 76,129                     
 lib               |   93.61 |    73.23 |   74.28 |   93.61 |                            
  boardClient.js   |   93.65 |    76.19 |      50 |   93.65 | ...-50,128-129,183-187,192 
  format.js        |    98.4 |    80.76 |     100 |    98.4 | 31-32                      
  networkConfig.js |   91.07 |    71.42 |      75 |   91.07 | 33-34,43-44,54             
  vstorage.js      |   89.56 |    58.82 |     100 |   89.56 | 39-40,86-87,94-98,104-106  
-------------------|---------|----------|---------|---------|----------------------------

src/lib/agd-lib.js is not used/tested at all.
src/lib/tui.js is not tested either.

2023-07-12 14:39 cb8d491

lifted from in-progress PR: feat: inter-tool bid list #7939 https://github.com/Agoric/agoric-sdk/blob/6045ee17ce409400e48deb8e470f39b0a192b91e/packages/inter-cli/test/test-auction.js#L107-L132

dckc force-pushed the dc-inter-cli-pola branch 3 times, most recently from 122049b to cef90cd Compare June 18, 2023 04:13

dckc mentioned this pull request Jun 19, 2023

feat(cosmic-proto): stubs for vstorage/query.proto #7950

Merged

dckc force-pushed the dc-inter-cli-pola branch 2 times, most recently from ea886be to afe38c5 Compare June 20, 2023 23:42

Chris-Hibbert added 4 commits June 26, 2023 09:33

feat(auction): auction publish all bids off-chain

e218017

feat(auction): add timestamp to bid records

0cbe9ab

refactor: each bid written to a separate node

ed21579

chore: clean up persistence

223451a

dckc mentioned this pull request Jul 11, 2023

use TS satisfies #8032

Merged

dckc added 2 commits July 11, 2023 12:32

Merge branch '7159-auctionBids' into dc-cosmjs-interpose-net

6e50dee

chore(inter-protcol): auctionBook type fixes

f0b48ea

dckc force-pushed the dc-inter-cli-pola branch from 67a1953 to 71b5d19 Compare July 12, 2023 00:00

dckc added 8 commits July 11, 2023 23:12

build: inter-cli package / devtools

3e87dc3

feat(inter-cli): vstorage.proto client, extractStreamCellValue()

302607f

- batch vstorage queries

chore(inter-cli): makeTUI - Textual User Interface

61f69d8

feat(inter-cli): board client preserving identity from vstorage

324c085

chore(inter-cli): networkConfig handling with explicit access

b360219

feat(inter-cli): vbank asset formatters: amount, price, percent

61e9bf8

chore(inter-cli): lookup(name) -> address in agd keyring

371182c

feat(inter-cli): inter auction list-bids command

79c008f

dckc force-pushed the dc-inter-cli-pola branch from 71b5d19 to 79c008f Compare July 12, 2023 05:13

dckc changed the title ~~WIP: taking inter cli beyond test tool~~ feat: inter-tool auction list-bids Jul 12, 2023

dckc added 2 commits July 12, 2023 13:56

build(inter-cli): test:c8 (code coverage)

30d899f

currently: -----------------|---------|----------|---------|---------| File | % Stmts | % Branch | % Funcs | % Lines | -----------------|---------|----------|---------|---------| All files | 95.4 | 75.94 | 77.14 | 95.4 |

SQUASHME: prune inter-tool auction governance command

1bcf8d6

dckc changed the title ~~feat: inter-tool auction list-bids~~ feat: inter-tool bid list Jul 12, 2023

dckc added 2 commits July 12, 2023 14:08

SQUASHME: update usage: inter-tool bid list

fe02449

to match spec

fixup! chore(inter-cli): networkConfig handling with explicit access

5b7f3d7

dckc force-pushed the dc-inter-cli-pola branch from 21ab29b to 5b7f3d7 Compare July 12, 2023 19:09

dckc added 6 commits July 12, 2023 14:21

SQUASHME: update RPC fixture to match product scenario

2193124

SQUASHME: update 'bid list' test per product scenario

8e58ffe

SQUASHME: format: omit fraction on whole seconds in timestamps

791a22e

SQUASHME: no fractional seconds in bid list timestamps

19d45f0

fixup! SQUASHME: update 'bid list' test per product scenario

6e5760d

chore: inter-tool help text snapshot tests

cb8d491

dckc added 9 commits July 12, 2023 18:26

fixup! build: inter-cli package / devtools

d3e25b8

fixup! build: inter-cli package / devtools

626d584

SQUASHME: inter-tool: never mind place-bid command

85cd54b

fixup! feat(inter-cli): board client preserving identity from vstorage

ac3a316

SQUASHME: prune incomplete bid command

b43eb92

SQUASHME: inter-tool: prune left-over signing code

0938631

SQUASHME: inter-tool: tidy / docs

eb55d15

feat(inter-tool): disclaimer (WIP NEEDSTEST)

c6f6ca8

SQUASHME: inter-tool: pick among rpcAddrs

6045ee1

dckc mentioned this pull request Aug 15, 2023

feat: support offer signing with keplr Agoric/ui-kit#28

Merged

dckc mentioned this pull request Nov 7, 2024

vstorage published types mapping #10422

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: inter-tool bid list #7939

feat: inter-tool bid list #7939

dckc commented Jun 16, 2023 •

edited

Loading

Tasks

dckc commented Jun 16, 2023

turadg commented Jul 11, 2023

dckc commented Jul 11, 2023

dckc commented Jul 12, 2023

dckc commented Jul 12, 2023

feat: inter-tool bid list #7939

Are you sure you want to change the base?

feat: inter-tool bid list #7939

Conversation

dckc commented Jun 16, 2023 • edited Loading

Description

Tasks

Security Considerations

Scaling Considerations

Documentation Considerations

Testing Considerations

dckc commented Jun 16, 2023

list bids from auction works in 1 case

turadg commented Jul 11, 2023

dckc commented Jul 11, 2023

dckc commented Jul 12, 2023

fetches each bid at its own vstorage key

test status

dckc commented Jul 12, 2023

updated usage / tests to better match product spec

Test Coverage

dckc commented Jun 16, 2023 •

edited

Loading