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

Chris-Hibbert · 2023-05-04T21:23:52Z

closes: #7906

Description

The auctionBooks will publish all active bids to off-chain storage.

Security Considerations

None.

Scaling Considerations

The means that information that could be accessed on-chain or off will now be more accessible statically.

Documentation Considerations

N/A

Testing Considerations

tested in unit tests.

Chris-Hibbert · 2023-05-04T21:24:26Z

Draft until the release is in the books.

Chris-Hibbert · 2023-07-05T22:31:04Z

@turadg, there's a test failure here in test-liquidation-1.js that I don't understand. It appears to be finding information about 'STARS-bid3', and complaining that it doesn't match the data it expected for 'STARS-bid2'. Can you help me understand what the test is trying to do so I can see about addressing this?

dckc

initial feedback...

dckc · 2023-07-11T20:19:53Z

packages/inter-protocol/src/auction/auctioneer.js

+        const [scheduleNode, bidsNode] = await Promise.all([
+          bookNodeP,
+          E(bookNodeP).makeChildNode('schedule'),
+          E(bookNodeP).makeChildNode('bids'),


something goofy is happening with bidsNode. see the snapshot...

fixed. rearranged the tree so bids are where they should have been.

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

packages/inter-protocol/src/auction/offerBook.js

+        for (const r of records.values()) {
+          this.self.publishOffer(r);
+        }


Before we land this, let's make sure we don't do O(n) work like this.

Also, I don't think this handles the case when bids go away.

Until we have an explicit delete method in vstorage (#7405) I think setValue('') has essentially the same effect.

done in deleteNodeIfPresent

dckc · 2023-07-12T15:13:11Z

packages/inter-protocol/src/auction/offerBook.js

+        return E(getBidDataRecorder(key)).write(
+          harden({
+            bidScaling: record.bidScaling,
+            wanted: record.wanted,


the product spec calls this maxBuy. Should we

change it here (my preference)

translate the field name on the client

ask product if wanted is a good name?

cc @turadg

maxBuy sounds like the total (original) cap. What's printed here is internally known in some places as stillWant, reflecting that it's a descending indicator of the amount this bid still needs to be complete.
I will publish both originalWant and stillWant, so the CLI can choose to display either or both.

dckc · 2023-07-12T15:13:42Z

packages/inter-protocol/src/auction/offerBook.js

+            wanted: record.wanted,
+            exitAfterBuy: record.exitAfterBuy,
+            timestamp: record.timestamp,
+            balance: record.seat.getCurrentAllocation().Bid,


the product spec calls this give. Should we

change it here

translate the field name on the client

ask product if balance is a good name (my preference)

cc @turadg

I'll leave this as is, since I agree. We can make the change here later if that's called for, or in the CLI.

Chris-Hibbert · 2023-07-13T17:27:06Z

Corrected vstorage paths to match:

published.auction.schedule for global schedule info.
published.auction.governance
published.auction.books.bookN for stats about that collateral
published.auction.books.bookN.bids.bidN for data about that bid.

Chris-Hibbert · 2023-07-19T20:43:48Z

Lint test is failing, but not reporting a particular problem. It passes locally. I think this is ready for review.

dckc

I don't see any critical problems.

I'd like to look closer... for example to make sure the types work for the CLI. But auction CLI work is sort of on my back burner now, so maybe it's time to land this. Thoughts, @turadg ?

dckc · 2023-07-19T20:54:49Z

packages/inter-protocol/src/auction/auctionBook.js

+/**
+ * @typedef {object} BidDataNotification
+ *
+ * @property {Array<ScaledBidData>} scaledBids
+ * @property {Array<PricedBidData>} pricedBids
+ */
+export const BidDataNotificationShape = {
+  scaledBids: M.arrayOf(M.any()),
+  pricedBids: M.arrayOf(M.any()),
+};
+harden(BidDataNotificationShape);


I suspect this is dead code.

If you mean BidDataNotificationShape, it's used on lines 229 and 235.

I'm still missing something. used in what way? Do we actually publish anything at bidsNode? I don't see any code that publishes data in this shape.

While working on the CLI, I found that this shape actually matched what's published; I'd like to import it from the contract code (ideally in a client helper module a la params.js that doesn't pull in the whole contract).

agoric-sdk/packages/inter-cli/src/commands/auction.js

Lines 17 to 42 in 6045ee1

const bidData = harden({

timestamp: TimeStampShape,

sequence: M.nat(),

balance: NatAmountShape,

wanted: NatAmountShape,

exitAfterBuy: M.boolean(),

});

const shapeLeaves = harden({

ScaledBidData: {

bidScaling: RatioShape,

...bidData,

},

PricedBidData: {

price: RatioShape,

...bidData,

},

});

const shape = harden({

...shapeLeaves,

BidDataNotification: M.arrayOf(

M.or(shapeLeaves.ScaledBidData, shapeLeaves.PricedBidData),

),

});

I may not understand how to use this right, but getPublicTopics() returns this node, which is the parent of all the actual bid nodes.

I did move BidDataNotificationShape to offerBook.js, and used it to declare the type of those sub-nodes that represent the individual bids.

edit to add: This is mostly wrong. revising....

Fixed. Separated BidsDataNotificationShape from BidDataNotificationShape.

dckc · 2023-07-21T14:13:17Z

packages/inter-protocol/src/auction/offerBook.js

+              bidDataKits.delete(key);
+            }
+            void deleteNodeIfPresent(key);


it seems a bit fragile to have to do both of these delete operations here. It would be nice to wrap the bidDataKits collection in something that automatically updates the storageNodes as appropriate. But maybe the values in the collection aren't enough info to update the storage nodes. hm.

I would have liked to just call delete(key), but that is currently only called when it's known that the record and node were actually created. Aah! I suppose I can put the conditional in that fn at no risk and little cost.

dckc · 2023-07-21T14:15:54Z

packages/inter-protocol/test/auction/test-auctionBook.js

@@ -14,8 +14,8 @@ import { makeOffer } from '@agoric/zoe/test/unitTests/makeOffer.js';
 import { setup } from '@agoric/zoe/test/unitTests/setupBasicMints.js';


I'd like to see tests of adding and deleting (exiting) bids that show that vstorage is updated correctly.

Already added. Check out test/auction/snapshots/test-auctionContract.js.md. The test multiple bidders at one auction step shows that bid1001 has an empty node, while bid1002 and bid1003 show their data.

turadg · 2023-07-21T16:32:54Z

Given #8079 I'm concerned with landing this without #7955 (which depends on #7954 and thus #8079)

That means this would be hanging around a while. But it really can't be used until all those blockers are cleared. Let's discuss.

Includes deleting the content for a bid when it is removed.

dckc

putting this in the background for a bit...

turadg · 2024-09-20T21:24:52Z

Closing to clean up project views

Chris-Hibbert · 2024-09-20T21:29:26Z

I'm surprised. This still seems valuable. We've noticed its absence. Don't we want this to be in a list for PM to be able to prioritize?

dckc · 2024-09-20T21:34:43Z

The issue is still open:

auction publish all bids to vstorage #7906

This is a PR.

turadg · 2024-09-20T21:45:40Z

yeah, the issue is still available to prioritize. And it has a link to this PR so when it is the PR can be reopened.

Chris-Hibbert added Vaults VaultFactor (née Treasury) auction labels May 4, 2023

Chris-Hibbert added this to the Vaults Validation milestone May 4, 2023

Chris-Hibbert self-assigned this May 4, 2023

Chris-Hibbert marked this pull request as draft May 4, 2023 21:24

Chris-Hibbert mentioned this pull request May 10, 2023

Bug: Liquidation auction fails to run #7677

Closed

turadg removed this from the Vaults Validation milestone May 17, 2023

Chris-Hibbert marked this pull request as ready for review May 22, 2023 20:56

Chris-Hibbert marked this pull request as draft June 9, 2023 00:32

Chris-Hibbert force-pushed the 7159-auctionBids branch from f29eab8 to 32360d6 Compare June 14, 2023 00:24

dckc mentioned this pull request Jun 16, 2023

feat: inter-tool bid list #7939

Draft

Chris-Hibbert force-pushed the 7159-auctionBids branch from 32360d6 to ed21579 Compare June 27, 2023 17:10

Chris-Hibbert force-pushed the 7159-auctionBids branch 3 times, most recently from 5420a64 to 223451a Compare July 5, 2023 20:55

dckc reviewed Jul 11, 2023

View reviewed changes

dckc reviewed Jul 12, 2023

View reviewed changes

turadg mentioned this pull request Jul 12, 2023

auction publish all bids to vstorage #7906

Open

Chris-Hibbert force-pushed the 7159-auctionBids branch 3 times, most recently from cbc8e62 to c47eec7 Compare July 13, 2023 17:21

dckc mentioned this pull request Jul 19, 2023

feat(internal): Add StorageNode delete method #8063

Open

Chris-Hibbert force-pushed the 7159-auctionBids branch from 1a4d221 to 0bac932 Compare July 19, 2023 20:07

Chris-Hibbert marked this pull request as ready for review July 19, 2023 20:42

Chris-Hibbert requested a review from dckc July 19, 2023 20:42

dckc reviewed Jul 21, 2023

View reviewed changes

Chris-Hibbert added 3 commits July 21, 2023 10:30

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

d7d4abd

feat(auction): add timestamp to bid records

69e7a76

refactor: each bid written to a separate node

1042a85

Chris-Hibbert force-pushed the 7159-auctionBids branch from 9a35b14 to 0c50c06 Compare July 21, 2023 17:39

Chris-Hibbert and others added 7 commits July 21, 2023 10:57

chore: clean up persistence

fc862de

fixup new nodes

5154a1d

chore(auction): shapes for recorders

1fbfa73

refactor: publishOffer delete exited seats before writing

acedf7d

docs: update README for auction vstorage shape

4fa440c

feature: replace wanted with originalWant + remainingWant

a66e788

feat: publish data on individual bids when there are changes

8281888

Includes deleting the content for a bid when it is removed.

Chris-Hibbert force-pushed the 7159-auctionBids branch from 0c50c06 to 79a4753 Compare July 21, 2023 17:57

Chris-Hibbert requested a review from dckc July 21, 2023 18:19

Chris-Hibbert added 2 commits July 21, 2023 11:36

chore: whitespace changesd

a29a826

refactor: DRY on cleanup when bids are deleted

45fe766

Chris-Hibbert force-pushed the 7159-auctionBids branch from 33d8e17 to 45fe766 Compare July 21, 2023 18:36

refactor: add type to bid record kit; move type declarations

9c2ed56

Chris-Hibbert force-pushed the 7159-auctionBids branch from ec9fcec to 9c2ed56 Compare July 24, 2023 18:36

dckc reviewed Aug 10, 2023

View reviewed changes

Jorge-Lopes mentioned this pull request Dec 28, 2023

Expose All Bids in Vstorage Jorge-Lopes/liquidation-visibility#1

Open

3 tasks

turadg unassigned Chris-Hibbert Sep 20, 2024

turadg closed this Sep 20, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

Chris-Hibbert commented May 4, 2023 •

edited by turadg

Loading

Chris-Hibbert commented May 4, 2023

Chris-Hibbert commented Jul 5, 2023

dckc left a comment

dckc Jul 11, 2023

Chris-Hibbert Jul 18, 2023

dckc Jul 12, 2023

Chris-Hibbert Jul 18, 2023

dckc Jul 19, 2023

Chris-Hibbert Jul 21, 2023

dckc Jul 12, 2023

Chris-Hibbert Jul 18, 2023

dckc Jul 12, 2023 •

edited

Loading

Chris-Hibbert Jul 18, 2023

Chris-Hibbert commented Jul 13, 2023

Chris-Hibbert commented Jul 19, 2023

dckc left a comment

dckc Jul 19, 2023

Chris-Hibbert Jul 21, 2023

dckc Jul 21, 2023

Chris-Hibbert Jul 24, 2023 •

edited

Loading

Chris-Hibbert Jul 24, 2023

dckc Jul 21, 2023

Chris-Hibbert Jul 21, 2023

dckc Jul 21, 2023

Chris-Hibbert Jul 21, 2023

turadg commented Jul 21, 2023

dckc left a comment

turadg commented Sep 20, 2024

Chris-Hibbert commented Sep 20, 2024

dckc commented Sep 20, 2024

turadg commented Sep 20, 2024

	const bidData = harden({
	timestamp: TimeStampShape,
	sequence: M.nat(),
	balance: NatAmountShape,
	wanted: NatAmountShape,
	exitAfterBuy: M.boolean(),
	});

	const shapeLeaves = harden({
	ScaledBidData: {
	bidScaling: RatioShape,
	...bidData,
	},

	PricedBidData: {
	price: RatioShape,
	...bidData,
	},
	});

	const shape = harden({
	...shapeLeaves,
	BidDataNotification: M.arrayOf(
	M.or(shapeLeaves.ScaledBidData, shapeLeaves.PricedBidData),
	),
	});

		@@ -14,8 +14,8 @@ import { makeOffer } from '@agoric/zoe/test/unitTests/makeOffer.js';
		import { setup } from '@agoric/zoe/test/unitTests/setupBasicMints.js';

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

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

Conversation

Chris-Hibbert commented May 4, 2023 • edited by turadg Loading

Description

Security Considerations

Scaling Considerations

Documentation Considerations

Testing Considerations

Chris-Hibbert commented May 4, 2023

Chris-Hibbert commented Jul 5, 2023

dckc left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dckc Jul 12, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Chris-Hibbert commented Jul 13, 2023

Chris-Hibbert commented Jul 19, 2023

dckc left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Chris-Hibbert Jul 24, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

turadg commented Jul 21, 2023

dckc left a comment

Choose a reason for hiding this comment

turadg commented Sep 20, 2024

Chris-Hibbert commented Sep 20, 2024

dckc commented Sep 20, 2024

turadg commented Sep 20, 2024

Chris-Hibbert commented May 4, 2023 •

edited by turadg

Loading

dckc Jul 12, 2023 •

edited

Loading

Chris-Hibbert Jul 24, 2023 •

edited

Loading