chore(acceptance): add tests for PSM to `z:acceptance` #10273

anilhelvaci · 2024-10-14T22:04:54Z

Description

Current version of z:acceptance tests do not cover PSM at all. The goal of this PR is to make sure we cover test cases in Agoric/BytePitchPartnerEng#23 prepared by @otoole-brendan

Security Considerations

None.

Scaling Considerations

None.

Documentation Considerations

None.

Testing Considerations

The tests assume that anchorPerMinted ratio is 1. I think this is a safe assumption because;

Unit tests and boot tests for the PSM has the same assumption
The value is read from terms. Therefore, it can only change by "replacing" the USDC_axl instance which is something we shouldn't worry about anytime soon.

Upgrade Considerations

None.

cloudflare-workers-and-pages · 2024-10-15T13:13:08Z

Deploying agoric-sdk with Cloudflare Pages

Latest commit:	`712f970`
Status:	✅ Deploy successful!
Preview URL:	https://f84ad6c8.agoric-sdk.pages.dev
Branch Preview URL:	https://anil-psm-tests.agoric-sdk.pages.dev

View logs

turadg

I did a code quality pass. I don't have PSM swapped in enough rn to evaluate whether this fully closes the issue.

a3p-integration/proposals/z:acceptance/test-lib/psm-lib.js

turadg · 2024-10-17T15:58:20Z

a3p-integration/proposals/z:acceptance/test-lib/psm-lib.js

+
+  // @ts-expect-error initialization
+  const balance = await getBalances([userAddress], expectedAnchorFunds.denom);
+  t.is(balance >= BigInt(expectedAnchorFunds.value), true);


this also doesn't have a diagnostic message. I think a simple assert would be more appropriate here, so you don't have to thread the t (especially since the any erases the type)

Suggested change

t.is(balance >= BigInt(expectedAnchorFunds.value), true);

assert(balance >= BigInt(expectedAnchorFunds.value));

resolved in 712f970

turadg · 2024-10-17T15:59:06Z

a3p-integration/proposals/z:acceptance/test-lib/psm-lib.js

+const giveAnchor = (base, fee) => {
+  return Math.ceil(base / (1 - fee));
+};


consider more concise for these math expressions:

Suggested change

const giveAnchor = (base, fee) => {

return Math.ceil(base / (1 - fee));

};

const giveAnchor = (base, fee) => Math.ceil(base / (1 - fee));

resolved in 712f970

turadg · 2024-10-17T16:00:08Z

a3p-integration/proposals/z:acceptance/test-lib/psm-lib.js

+ * @param {any} t
+ * @param {any} metricsBefore
+ * @param {any} balancesBefore


please use real types

resolved in 712f970

a3p-integration/proposals/z:acceptance/tsconfig.json

turadg · 2024-10-17T16:03:02Z

a3p-integration/proposals/z:acceptance/package.json

@@ -9,6 +9,7 @@
  "type": "module",
  "license": "Apache-2.0",
  "dependencies": {
+    "@agoric/ertp": "0.16.3-u17.1",


this doesn't match the @agoric/internal version so there are duplicates.

Please make them both"dev" so they're testing the latest master push. The version won't change unless the yarn.lock changes, which can't happen without a PR, and that would have to pass CI to merge.

made both of them dev and re-enforced yarn.lock by doing;

cd proposals/z:acceptance rm yarn.lock touch yarn.lock yarn install

addressed in 712f970

turadg · 2024-10-17T16:04:46Z

a3p-integration/proposals/z:acceptance/psm.test.js

+} from '@agoric/synthetic-chain';
+import { getBalances } from './test-lib/utils.js';
+
+// Export these from synthetic-chain?


perhaps eventually. But having them in ENV gives us flexibility for other runtimes using them

Why not we do them both? We do the same for ATOM_DENOM =>
https://github.com/Agoric/agoric-3-proposals/blob/93bb953db209433499db08ae563942d1bf7eeb46/packages/synthetic-chain/src/lib/constants.js#L11

sure. Just if they're in ENV that's the source of truth and any module can be made to export them

turadg · 2024-10-17T16:05:18Z

a3p-integration/proposals/z:acceptance/psm.test.js

+    { committeeAddrs: [GOV1ADDR, GOV2ADDR, GOV3ADDR], position: 0 },
+  );
+
+  // Replace when https://github.com/Agoric/agoric-sdk/pull/10171 is in


please land that first cc @Chris-Hibbert

@Chris-Hibbert approved it yesterday => #10171

So, as I understand, we should update this one with whatever is landed in #10171 then merge into master?

Merge #10171 to master then rebase this onto master that has it.

Refs: Agoric/BytePitchPartnerEng#23 fix(acceptance-psm): address change requests

anilhelvaci · 2024-10-19T10:12:26Z

Addressed all change requests outside of #10273 (comment). Should I ask for a re-review once the last one is done as well? @turadg

turadg

Code LGMT. I haven't reviewed for whether this covers all the PSM testing requirements.

dckc

I meant to separate the critical comments from the suggestions, but it's taking too long.

Consider these all suggestions. I'll do another pass to look for anything critical.

dckc · 2024-10-15T15:36:02Z

a3p-integration/proposals/z:acceptance/psm.test.js

+import { getBalances } from './test-lib/utils.js';
+
+// Export these from synthetic-chain?
+export const USDC_DENOM = process.env.USDC_DENOM;


Why export? Importing from a .test.js file would mean running the tests. And I think even that fails with some sort of "ava test only work with the ava runner command" diagnostic.

dckc · 2024-10-15T15:36:48Z

a3p-integration/proposals/z:acceptance/psm.test.js

+  newUser: {
+    name: 'new-psm-trader',
+    fund: {
+      denom: USDC_DENOM ? USDC_DENOM : 'fake',


Do we use / test the fake case? I suspect we rely on USDC_DENOM being NonNullish. Better to do that above.

dckc · 2024-10-15T15:37:19Z

a3p-integration/proposals/z:acceptance/psm.test.js

+import { getBalances } from './test-lib/utils.js';
+
+// Export these from synthetic-chain?
+export const USDC_DENOM = process.env.USDC_DENOM;


re fake below...

Suggested change

export const USDC_DENOM = process.env.USDC_DENOM;

export const USDC_DENOM = NonNullish(process.env.USDC_DENOM);

dckc · 2024-10-15T15:37:34Z

a3p-integration/proposals/z:acceptance/psm.test.js

+  otherUser: {
+    name: 'gov1',
+    fund: {
+      denom: USDC_DENOM ? USDC_DENOM : 'fake',


dckc · 2024-10-15T15:39:57Z

a3p-integration/proposals/z:acceptance/test-lib/psm-lib.js

+ * @param {string} wanted
+ * @param {string} [from]
+ */
+export const bankSend = (addr, wanted, from = VALIDATORADDR) => {


suggestion; feel free to ignore

bankSend is using ambient authority to access the keychain and filesystem. Please have the caller use makeAgd and have bankSend accept an Agd argument.

dckc · 2024-10-15T15:40:32Z

a3p-integration/proposals/z:acceptance/test-lib/psm-lib.js

+import { boardSlottingMarshaller, makeFromBoard } from './rpc.js';
+import {
+  addUser,
+  agd,


suggestion; feel free to ignore

That form of agd uses ambient authority. Please avoid it. (bonus points for a PR to deprecate it)

dckc · 2024-10-15T15:45:25Z

a3p-integration/proposals/z:acceptance/test-lib/psm-lib.js

+    offerArgs: {
+      instance: instances[instanceName],
+      params,
+      deadline: BigInt(deadline * 60 + Math.round(Date.now() / 1000)),


suggestion; feel free to ignore

Date.now() is ambient authority. Please pass it in explicitly.

dckc · 2024-10-15T15:46:35Z

a3p-integration/proposals/z:acceptance/test-lib/psm-lib.js

+  instanceName,
+  newParams,
+  deadline,
+  offerId = Date.now().toString(),


Suggested change

offerId = Date.now().toString(),

nowVal = Date.now(),

offerId = nowVal.toString(),

dckc · 2024-10-15T15:46:54Z

a3p-integration/proposals/z:acceptance/test-lib/psm-lib.js

+    offerArgs: {
+      instance: instances[instanceName],
+      params,
+      deadline: BigInt(deadline * 60 + Math.round(Date.now() / 1000)),


Suggested change

deadline: BigInt(deadline * 60 + Math.round(Date.now() / 1000)),

deadline: BigInt(deadline * 60 + Math.round(nowVal / 1000)),

dckc · 2024-10-15T15:52:05Z

a3p-integration/proposals/z:acceptance/test-lib/psm-lib.js

+  deadline,
+  offerId = Date.now().toString(),
+}) => {
+  const charterAcceptOfferId = await agops.ec(


suggestion; feel free to ignore

agops uses ambient authority. synthetic-chain doesn't have a handy alternative, but in dapp-orchestration-basics, one technique I recently used is for the caller to do:

const execFileP = promisify(childProcess.execFile); const npx = (file: string, args: string[]) => execFileP('npx', ['--no-install', file, ...args]);

https://github.com/Agoric/dapp-orchestration-basics/blob/main/e2e-testing/scripts/deploy-cli.ts

and then here we would do

Suggested change

const charterAcceptOfferId = await agops.ec(

const charterAcceptOfferId = await npx('agops' , ['ec,

dckc

The tests cover the 6 requested items (New user can complete a swap, ...).

This approval presumes you'll address any lint failures, as usual. No need to re-request review once you've done that.

I found it a little challenging to navigate the split between psm.test.js and psm-lib.js in some places. I made some suggestions about factoring. Those are suggestions; feel free to act on them, respond to them, or ignore them, at your discretion.

dckc · 2024-10-23T19:27:42Z

a3p-integration/proposals/z:acceptance/psm.test.js

+export const USDC_DENOM = process.env.USDC_DENOM
+  ? process.env.USDC_DENOM
+  : 'no-denom';


Is the 'no-denom' path exercised / tested? How about just throwing?

Suggested change

export const USDC_DENOM = process.env.USDC_DENOM

? process.env.USDC_DENOM

: 'no-denom';

export const USDC_DENOM = NonNullish(process.env.USDC_DENOM);

dckc · 2024-10-23T19:28:35Z

a3p-integration/proposals/z:acceptance/psm.test.js

+export const USDC_DENOM = process.env.USDC_DENOM
+  ? process.env.USDC_DENOM
+  : 'no-denom';
+export const PSM_PAIR = process.env.PSM_PAIR?.replace('.', '-');


.replace() will fail if PSM_PAIR is undefined, right?

Suggested change

export const PSM_PAIR = process.env.PSM_PAIR?.replace('.', '-');

export const PSM_PAIR = NonNullish(process.env.PSM_PAIR).replace('.', '-');

dckc · 2024-10-23T19:29:15Z

a3p-integration/proposals/z:acceptance/psm.test.js

+    giveMintedFeeVal: 10n, // in %
+    wantMintedFeeVal: 10n, // in %
+    mintLimit: 500n * 1_000_000n, // in IST
+    deadline: 1, // in minutes


is this really a deadline, i.e. an absolute time? or is it a duration?

dckc · 2024-10-23T19:38:31Z

a3p-integration/proposals/z:acceptance/psm.test.js

+  await initializeNewUser(name, fund);
+  // Replace when https://github.com/Agoric/agoric-sdk/pull/10171 is in
+  await waitForBlock(3);
+
+  await checkUserInitializedSuccessfully(name, fund);


How about folding checkUserInitializedSuccessfully into initializeNewUser?

dckc · 2024-10-23T20:12:44Z

a3p-integration/proposals/z:acceptance/test-lib/psm-lib.js

+
+  const balancesAdjusted = [];
+
+  balances.forEach(({ denom, amount }) => {


as the linter says...

Prefer for...of instead of Array.forEach

dckc · 2024-10-23T20:47:44Z

a3p-integration/proposals/z:acceptance/psm.test.js

+  await agopsPsm(psmTrader, [
+    'swap',
+    '--pair',
+    process.env.PSM_PAIR,


why not use the PSM_PAIR from above? (line 42)

dckc · 2024-10-23T20:52:15Z

a3p-integration/proposals/z:acceptance/psm.test.js

+    '--feePct',
+    wantMintedFeeVal,
+  ]);
+  await waitForBlock(5);


I'd prefer that the agopsPsm function takes care of any relevant synchronization.

Is that straightforward?

Also: is agopsPsm ever called with anything other than swap? If not, how about narrowing it to psmSwap(...)?

dckc · 2024-10-23T20:58:27Z

a3p-integration/proposals/z:acceptance/psm.test.js

+  // Replace when https://github.com/Agoric/agoric-sdk/pull/10171 is in
+  await waitForBlock(3);


#10171 is in. now is the time to replace this, yes?

dckc · 2024-10-23T21:11:13Z

a3p-integration/proposals/z:acceptance/psm.test.js

+  await waitForBlock(5);
+
+  // Now check if failed with correct error message
+  await checkSwapExceedMintLimit(t, otherAddr, metricsBefore);


Pushing the t.is(...) etc. down into checkSwapExceedMintLimit makes this code somewhat hard to follow.

What do you think of:

Suggested change

await checkSwapExceedMintLimit(t, otherAddr, metricsBefore);

const walletUpdate = await getWalletUpdate(otherAddr, 'offerStatus');

t.is(walletUpdate.status.error, 'Error: Request would exceed mint limit');

t.like(await getPsmMetrics(anchor), { mintedPoolBalance: metricsBefore.mintedPoolBalance });

where getWalletUpdate throws if offerResult.updated != the 2nd arg.

Library functions that read data are straightforward. For non-read operations, making a swap is a clearly scoped thing to put in a helper function. But functions that mix reading data and doing assertions with t are hard to follow.

dckc · 2024-10-23T21:14:03Z

a3p-integration/proposals/z:acceptance/test-lib/psm-lib.js

+ *
+ * @param {number} base
+ * @param {number} fee
+ * @returns


I suspect this makes yarn lint fail, so it needs to be cleaned up before the PR is green.

anilhelvaci requested a review from a team as a code owner October 14, 2024 22:04

anilhelvaci requested review from AgoricTriage, turadg and dckc October 14, 2024 22:04

anilhelvaci force-pushed the anil/psm-tests branch from b167d7d to 0c1ae50 Compare October 15, 2024 13:13

This comment was marked as resolved.

Sign in to view

turadg reviewed Oct 17, 2024

View reviewed changes

anilhelvaci force-pushed the anil/psm-tests branch from 0c1ae50 to 324d3ee Compare October 19, 2024 10:01

chore(acceptance): add tests for PSM to z:acceptance

712f970

Refs: Agoric/BytePitchPartnerEng#23 fix(acceptance-psm): address change requests

anilhelvaci force-pushed the anil/psm-tests branch from 324d3ee to 712f970 Compare October 19, 2024 10:02

turadg approved these changes Oct 20, 2024

View reviewed changes

dckc reviewed Oct 23, 2024

View reviewed changes

dckc approved these changes Oct 23, 2024

View reviewed changes

	t.is(balance >= BigInt(expectedAnchorFunds.value), true);
	assert(balance >= BigInt(expectedAnchorFunds.value));

	export const USDC_DENOM = process.env.USDC_DENOM;
	export const USDC_DENOM = NonNullish(process.env.USDC_DENOM);

	offerId = Date.now().toString(),
	nowVal = Date.now(),
	offerId = nowVal.toString(),

	deadline: BigInt(deadline * 60 + Math.round(Date.now() / 1000)),
	deadline: BigInt(deadline * 60 + Math.round(nowVal / 1000)),

	const charterAcceptOfferId = await agops.ec(
	const charterAcceptOfferId = await npx('agops' , ['ec,

	export const PSM_PAIR = process.env.PSM_PAIR?.replace('.', '-');
	export const PSM_PAIR = NonNullish(process.env.PSM_PAIR).replace('.', '-');


		const balancesAdjusted = [];

		balances.forEach(({ denom, amount }) => {

		// Replace when https://github.com/Agoric/agoric-sdk/pull/10171 is in
		await waitForBlock(3);

-  await checkSwapExceedMintLimit(t, otherAddr, metricsBefore);
+  const walletUpdate = await getWalletUpdate(otherAddr, 'offerStatus');
+  t.is(walletUpdate.status.error, 'Error: Request would exceed mint limit');
+  t.like(await getPsmMetrics(anchor), { mintedPoolBalance: metricsBefore.mintedPoolBalance });

chore(acceptance): add tests for PSM to z:acceptance #10273

Are you sure you want to change the base?

chore(acceptance): add tests for PSM to z:acceptance #10273

Conversation

anilhelvaci commented Oct 14, 2024

Description

Security Considerations

Scaling Considerations

Documentation Considerations

Testing Considerations

Upgrade Considerations

cloudflare-workers-and-pages bot commented Oct 15, 2024 • edited Loading

Deploying agoric-sdk with Cloudflare Pages

This comment was marked as resolved.

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

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

anilhelvaci commented Oct 19, 2024

turadg left a comment

Choose a reason for hiding this comment

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

dckc Oct 15, 2024 • edited Loading

Choose a reason for hiding this comment

dckc Oct 15, 2024 • edited Loading

Choose a reason for hiding this comment

dckc Oct 15, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dckc Oct 15, 2024 • edited Loading

Choose a reason for hiding this comment

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chore(acceptance): add tests for PSM to `z:acceptance` #10273

chore(acceptance): add tests for PSM to `z:acceptance` #10273

cloudflare-workers-and-pages bot commented Oct 15, 2024 •

edited

Loading

dckc Oct 15, 2024 •

edited

Loading

dckc Oct 15, 2024 •

edited

Loading

dckc Oct 15, 2024 •

edited

Loading

dckc Oct 15, 2024 •

edited

Loading