feat: start PSM contracts with metrics, governance from previous published state #7480

dckc · 2023-04-22T17:58:28Z

closes: #6645

Description

Given metrics and governance state published from previous VM (chainStorageEntries from #7156), start matching PSM contracts.
Refine startPSM and makeAnchorAsset to consult chainStorageEntries.

Security Considerations

mints anchor (USDC, ...) for anchorPoolBalance
adds E(creatorFacet).makeRestoreMetricsInvitation() method that allows the caller to assign { mintedPoolBalance, totalAnchorProvided, totalMintedProvided, feePoolBalance } to arbitrary (pattern-matched) values, minting IST for feePoolBalance.

Scaling Considerations

none

Documentation Considerations

None, I think; that is: I think this is consistent with what BLD stakers would expect without further documentation.

Testing Considerations

Light unit testing seems sufficient, given that startPSM will only be called in very constrained circumstances.

dckc · 2023-04-24T13:18:39Z

refine chain bootstrap to use restorePSM rather than startPSM

I just realized: it's probably more straightforward to mix the restorePSM functionality into startPSM instead.

fixes: #6645 - compute total fees - style: keep to jessie-check in startPSM - use vatPowers.chainStorageEntries in restorePSM

dckc · 2023-04-25T19:42:55Z

back to draft... I think I can avoid minting IST in bootstrap

mint the fees within the PSM contract

turadg

lookin good!

turadg · 2023-04-26T15:55:51Z

packages/inter-protocol/src/proposals/startPSM.js


 export { inviteCommitteeMembers, startEconCharter, inviteToEconCharter };

 /**
- * @param {EconomyBootstrapPowers & WellKnownSpaces} powers
+ * Decode vstorage value to CapData
+ * XXX already written somewhere?


seems like it must be. agoric/casting does some of this, but I don't see a piece matching this interface.

If it's really new, I think there's a better home for it than startPSM. maybe in agoric/internal?

Longer term I think @endo/marshal should have something like assertCapData, which is the bulk of this function.

I split decodeToCapData into assertCapData and parsedValuesFromStreamCellText and put them in board-utils.js with makeHistoryReviver.

turadg · 2023-04-26T15:58:58Z

packages/inter-protocol/src/proposals/startPSM.js

+ *
+ * @param {unknown} value
+ */
+const decodeToCapData = value => {


This is deserializing not decoding and the function name should specify what it operates on (the vstorage value.)

consider deserializeVstorageValue. That it produces CapData is loosely implied by that being what went into vstorage. would help to have that as the @returns as well and simply return data at the end.

You may want to generalize isStreamCell.

/** * @param {string} cellText * @returns {any[]} */ const parsedValuesFromStreamCellText = cellText => { assert.typeof(cellText, 'string'); const cell = /** @type {{blockHeight: string, values: string[]}} */ ( JSON.parse(cellText) ); assert(isObject(cell)); const { values } = cell; assert(Array.isArray(values)); const parsedValues = values.map(value => JSON.parse(value)); return harden(parsedValues); };

And then separately assert that length of the returned array is 1 and that its sole element is a capdata object, either manually (e.g., const maybeCapData = obj => matches(obj, M.splitRecord(harden({body: M.string(), slots: M.array()})));) or slower but future-proofed like const isCapData = obj => { defaultMarshaller.fromCapData(obj); return true; };.

This is deserializing not decoding

I'm curious where the boundary is.

TMK,
Serialization is converting objects to a stream of data.
Encoding is converting one stream of data to another stream of data.

We've been informally reserving encode/decode for processes in which input and output are both data structures, even though serialize/deserialize (in which the output or input, respectively, is a sequence of primitive values such as bytes or characters) are technically a subset of those more general transformations.

As noted above, I split decodeToCapData into assertCapData and parsedValuesFromStreamCellText and put them in board-utils.js with makeHistoryReviver.

turadg · 2023-04-26T16:08:06Z

packages/inter-protocol/src/proposals/startPSM.js

+ * @param {Array<[string, string]>} entries
+ * @param {(slot: string, iface?: string) => any} [slotToVal]
+ */
+export const makeHistoryReviver = (entries, slotToVal = undefined) => {


consider putting this in vat/tools/board-utils.js

turadg · 2023-04-26T16:11:47Z

packages/inter-protocol/src/proposals/startPSM.js

+  // In this reviver, object references are revived as boardIDs
+  // from the pre-bulldozer board.
+  const toSlotReviver = makeHistoryReviver(chainStorageEntries);
+  if (!toSlotReviver.has(`published.psm.${Stable.symbol}.${keyword}.metrics`)) {


this vstorage path is repeated several times, and in the last time it has IST hard-coded. please pull out consts for the path strings to name them

turadg · 2023-04-26T16:16:30Z

packages/inter-protocol/src/proposals/startPSM.js

+ * @param {Array<[key: string, value: string]>} chainStorageEntries
+ * @param {string} keyword
+ * @param {{ minted: Brand<'nat'>, anchor: Brand<'nat'> }} brands
+ * @returns {{ metrics?: MetricsNotification, governance?: Record<string, *> }}


source of confusion that the return value doesn't match the contents of what was published. please move the .current lookup to the caller and type this:

Suggested change

* @returns {{ metrics?: MetricsNotification, governance?: Record<string, *> }}

* @returns {{ metrics?: MetricsNotification, governance?: GovernanceSubscriptionState }}

turadg · 2023-04-26T16:43:12Z

packages/inter-protocol/src/psm/psm.js

+      give: { Anchor },
+    } = seat.getProposal();
+    stableMint.mintGains({ Minted: target.feePoolBalance }, feePool);
+    atomicRearrange(zcf, harden([[seat, anchorPool, { Anchor }, { Anchor }]]));


I think something like this is clearer:

Suggested change

atomicRearrange(zcf, harden([[seat, anchorPool, { Anchor }, { Anchor }]]));

atomicTransfer(zcf, seat, anchorPool, { Anchor });

turadg · 2023-04-26T16:44:28Z

packages/inter-protocol/test/psm/test-psm.js

+ *
+ * Taken from mainnet; for example, the 1st value comes from...
+ *
+ * `agd --node https://main.rpc.agoric.net:443 query vstorage data published.agoricNames.brand -o json | jq .value`


turadg · 2023-04-26T16:44:53Z

packages/inter-protocol/test/psm/test-psm.js

+ *
+ * @type {Array<[key: string, value: string]>}
+ */
+const chainStorageEntries = [


please pull this and anchorAssets out into a fixtures module

turadg · 2023-04-26T16:47:25Z

packages/inter-protocol/test/psm/test-psm.js

+test('restore PSM: decode metrics, governance with old board IDs', async t => {
+  const toSlotReviver = makeHistoryReviver(chainStorageEntries);


this is is testing makeHistoryReviver, not anything about PSM per se. (it's testing the shape of what was published to vstorage, but only assuming the fixture is correct.)

if you move makeHistoryReviver remember to move this test with it.

turadg · 2023-04-26T16:48:52Z

packages/inter-protocol/test/psm/test-psm.js

+
+    for (const [name, installation] of Object.entries({
+      ...installs,
+      psm: installs.psmInstall,


please just name the key psm so this isn't a special case

gibson042 · 2023-04-26T18:14:59Z

packages/inter-protocol/src/proposals/startPSM.js

+    ...makeSet(
+      entries
+        .map(([k, _]) => k)
+        .filter(k => k.length > prefix.length && k.startsWith(prefix))


Suggested change

.filter(k => k.length > prefix.length && k.startsWith(prefix))

.filter(k => k.startsWith(prefix))

gibson042 · 2023-04-26T18:19:35Z

packages/inter-protocol/src/proposals/startPSM.js

+    const capData = decodeToCapData(raw);
+    return harden(board.fromCapData(capData));
+  };
+  const children = prefix => [


Is this missing validation that prefix ends with "." to avoid e.g. children("foo") not filtering out a path like "foolish.donkey"?

dckc · 2023-04-26T22:58:47Z

The history has gotten a little choppy; I suppose I'll use automerge:squash.

dckc · 2023-04-26T23:00:50Z

I think I responded to everything. PTAL, @turadg . @gibson042 too, if you like.

turadg

The history has gotten a little choppy; I suppose I'll use automerge:squash.

fwiw automerge:rebase recently learned to squash fixups. assuming they all squash cleanly.

turadg · 2023-04-26T22:56:56Z

packages/vats/tools/board-utils.js

+  assert(data);
+  assert.typeof(data.body, 'string');
+  assert(Array.isArray(data.slots));
+  // XXX check that the .slots array elements are actually strings


would suffice to check just the first one. though there might not be any.

alternately you could be honest about what this function is asserting ;-)

* @returns {asserts data is import('@endo/marshal').CapData}

CapData without any <> parsed as any somehow. I tried being honest with CapData<unknown> but that clashed with a type elsewhere.

would suffice to check just the first one.

between friends, I suppose

turadg · 2023-04-26T22:57:44Z

packages/vats/tools/board-utils.js

+harden(deserializeVstorageValue);
+
+/**
+ * Provide access to object graphs serialized in vstorage.


turadg · 2023-04-26T23:00:41Z

packages/inter-protocol/src/proposals/startPSM.js

+    );
+    await E(seat).getPayouts();
+  };
+  await (oldState.metrics && restoreMetrics(oldState.metrics));


oic. normally I'd expect,

if (oldState.metrics) { await restoreMetrics(oldState.metrics)); }

but I suppose that trips on the jessie awaits rule

dckc · 2023-04-26T23:47:21Z

fwiw automerge:rebase recently learned to squash fixups. assuming they all squash cleanly.

yeah; that's really handy. But I didn't keep good fixup discipline here.

refs #7480

dckc requested review from turadg and dtribble April 22, 2023 17:58

dckc force-pushed the 6645-restore-psm-state branch 4 times, most recently from 68269dc to cf2f84e Compare April 25, 2023 17:40

dckc added 2 commits April 25, 2023 12:47

feat(psm): creatorFacet.makeRestoreMetricsInvitation

56c9c39

feat: restore PSM state from former VM vstorage contents

d65b3bd

fixes: #6645 - compute total fees - style: keep to jessie-check in startPSM - use vatPowers.chainStorageEntries in restorePSM

dckc force-pushed the 6645-restore-psm-state branch from cf2f84e to d65b3bd Compare April 25, 2023 17:47

dckc marked this pull request as ready for review April 25, 2023 17:48

dckc marked this pull request as draft April 25, 2023 19:42

chore: never mind mintPSMFees

f5b4a30

mint the fees within the PSM contract

dckc marked this pull request as ready for review April 25, 2023 19:59

turadg reviewed Apr 26, 2023

View reviewed changes

gibson042 reviewed Apr 26, 2023

View reviewed changes

dckc added 13 commits April 26, 2023 16:35

refactor: move makeHistoryReviver etc. to board-utils.js

743689c

chore: findOldPSMState matches published governance shape

e1774ff

fixup! refactor: move makeHistoryReviver etc. to board-utils.js

54bc2dd

refactor: factor out common published.psm.IST prefix

ea0c454

refactor: length check before startsWith is superfluous

462e2c0

fixup! refactor: move makeHistoryReviver etc. to board-utils.js

91aa63f

refactor: move ChainStorageVatParams with other swingset types

577bd25

test: move makeHistoryReviver test; move data to fixture module

2c03a0f

refactor: use atomicTransfer

5a1ad92

refactor: clean up shapes

d3fc98d

refactor: default chainStorageEntries to [] earlier

b65aa1f

fixup: prune stray comment

b207ea5

chore: prune redundant CONTRACT_ELECTORATE

6159b77

dckc added 3 commits April 26, 2023 17:41

docs: explain override of governedParams

9615b01

refactor: use .name property of startPSM

9b1c8b6

test: clean up installs.psm

4887e2a

dckc requested review from turadg and gibson042 April 26, 2023 22:58

turadg approved these changes Apr 26, 2023

View reviewed changes

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

Merge branch 'master' into 6645-restore-psm-state

d7b6e31

mergify bot merged commit 1a65832 into master Apr 27, 2023

mergify bot deleted the 6645-restore-psm-state branch April 27, 2023 01:12

dckc added a commit that referenced this pull request May 1, 2023

chore: add PSM exportStorageSubtrees to bootstrap swingset config

90b686d

refs #7480

mhofman pushed a commit that referenced this pull request May 3, 2023

chore: add PSM exportStorageSubtrees to bootstrap swingset config

1fd3bc9

refs #7480

gibson042 pushed a commit that referenced this pull request May 4, 2023

chore: add PSM exportStorageSubtrees to bootstrap swingset config

2332dba

refs #7480

gibson042 pushed a commit that referenced this pull request May 9, 2023

chore: add PSM exportStorageSubtrees to bootstrap swingset config

0af343e

refs #7480

gibson042 pushed a commit that referenced this pull request May 10, 2023

chore: add PSM exportStorageSubtrees to bootstrap swingset config

2b5656c

refs #7480

gibson042 pushed a commit that referenced this pull request May 10, 2023

chore: add PSM exportStorageSubtrees to bootstrap swingset config

8afe083

refs #7480

gibson042 pushed a commit that referenced this pull request May 10, 2023

chore: add PSM exportStorageSubtrees to bootstrap swingset config

1e6f1b6

refs #7480

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: start PSM contracts with metrics, governance from previous published state #7480

feat: start PSM contracts with metrics, governance from previous published state #7480

dckc commented Apr 22, 2023 •

edited

Loading

dckc commented Apr 24, 2023

dckc commented Apr 25, 2023

turadg left a comment

turadg Apr 26, 2023

dckc Apr 26, 2023

turadg Apr 26, 2023

gibson042 Apr 26, 2023

dckc Apr 26, 2023

turadg Apr 26, 2023

gibson042 Apr 26, 2023 •

edited

Loading

dckc Apr 26, 2023

turadg Apr 26, 2023

turadg Apr 26, 2023

turadg Apr 26, 2023

turadg Apr 26, 2023

turadg Apr 26, 2023

turadg Apr 26, 2023

turadg Apr 26, 2023

turadg Apr 26, 2023

gibson042 Apr 26, 2023

gibson042 Apr 26, 2023

dckc commented Apr 26, 2023

dckc commented Apr 26, 2023

turadg left a comment

turadg Apr 26, 2023

dckc Apr 26, 2023

dckc Apr 26, 2023

turadg Apr 26, 2023

turadg Apr 26, 2023

dckc commented Apr 26, 2023

	* @returns {{ metrics?: MetricsNotification, governance?: Record<string, *> }}
	* @returns {{ metrics?: MetricsNotification, governance?: GovernanceSubscriptionState }}

	atomicRearrange(zcf, harden([[seat, anchorPool, { Anchor }, { Anchor }]]));
	atomicTransfer(zcf, seat, anchorPool, { Anchor });

		test('restore PSM: decode metrics, governance with old board IDs', async t => {
		const toSlotReviver = makeHistoryReviver(chainStorageEntries);

	.filter(k => k.length > prefix.length && k.startsWith(prefix))
	.filter(k => k.startsWith(prefix))

feat: start PSM contracts with metrics, governance from previous published state #7480

feat: start PSM contracts with metrics, governance from previous published state #7480

Conversation

dckc commented Apr 22, 2023 • edited Loading

Description

Security Considerations

Scaling Considerations

Documentation Considerations

Testing Considerations

dckc commented Apr 24, 2023

dckc commented Apr 25, 2023

turadg 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

gibson042 Apr 26, 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

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 commented Apr 26, 2023

dckc commented Apr 26, 2023

turadg 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

dckc commented Apr 26, 2023

dckc commented Apr 22, 2023 •

edited

Loading

gibson042 Apr 26, 2023 •

edited

Loading