client support for Fast USDC #10735

turadg · 2024-12-18T19:33:31Z

Description

Everything in #10677 including some offer makers. There are more opportunities but this lays the groundwork for those to be added as valuable.

Security Considerations

none

Scaling Considerations

none

Documentation Considerations

none

Testing Considerations

nothing special

Upgrade Considerations

not yet released

cloudflare-workers-and-pages · 2024-12-18T19:37:42Z

Deploying agoric-sdk with Cloudflare Pages

Latest commit:	`948d7b7`
Status:	✅ Deploy successful!
Preview URL:	https://1c837511.agoric-sdk.pages.dev
Branch Preview URL:	https://10677-fu-client-support.agoric-sdk.pages.dev

View logs

dckc

oops... I think I misinterpreted a request-for-review notification

So these comments might be a bit premature...

dckc · 2025-01-24T23:17:01Z

packages/fast-usdc/src/types.ts

@@ -55,6 +55,11 @@ export interface TransactionRecord extends CopyRecord {
  status: TxStatus;
 }

+export interface ContractRecord extends CopyRecord {


the name... does it refer to "the record you'll get from vstorage if you query the contract's node"?

docstring, please?

dckc · 2025-01-24T23:23:14Z

packages/client-utils/src/types.d.ts

+            : T extends 'agoricNames.instance'
+              ? Array<[string, Instance]>
+              : T extends 'agoricNames.brand'
+                ? Array<[string, Brand]>


A lot of the relevant code expects not just a Brand but a Brand<'nat'> or Brand<'set'>.

agoric-sdk/multichain-testing/test/fast-usdc/fast-usdc.test.ts

Line 168 in b2cb709

const { USDC, FastLP } = await agoricNamesQ(vstorageClient).brands('nat');

agoric-sdk/multichain-testing/test/fast-usdc/fu-actors.ts

Line 39 in b2cb709

const { Invitation } = await agoricNamesQ(vsc).brands('set');

I suppose one can add as Brand<'nat'>, but it almost defeats the point. It's also helpful to reassemble the entries into a record. Do you want to add helpers for this sort of thing?

agreed this is low value because you'll often want the kind of brand. It's still true tho so I think it's worth having here.

dckc · 2025-01-24T23:25:54Z

packages/client-utils/src/types.d.ts

+                : T extends 'fastUsdc'
+                  ? ContractRecord
+                  : T extends 'fastUsdc.poolMetrics'
+                    ? PoolMetrics


It still feels strange for client-utils to depend on fast-usdc. Should it depend on dapp-offer-up and dapp-agoric-basics likewise?

It seems like fast-usdc should extend the type from client-utils.

It is weird but ok for now. We'll have to solve it for #10811

dckc · 2025-01-24T23:26:41Z

packages/fast-usdc/src/cli/lp-commands.js

      /** @type {import('../types.js').PoolMetrics} */
-      // @ts-expect-error it treats this as "unknown"


do you want to get rid of the type annotation while you're at it?

oh yeah thanks

dckc · 2025-01-24T23:28:19Z

packages/fast-usdc/src/exos/advancer.js

+        settlementAddress: ChainAddressShape,
        intermediateRecipient: M.opt(ChainAddressShape),
-        settlementAddress: M.opt(ChainAddressShape),


good catch!

What prompted it, I wonder?

I can't remember but I'm guessing some type feedback

turadg · 2025-01-25T00:12:21Z

these comments might be a bit premature...

Thanks they're helpful. I was just waiting for CI to get green before requesting.

In the interim I gave Aider with R1+Sonnet a spin. 88f0921 has its solution to adding a ClientSupport module. LGTM! Minor cleanup in f4f6a52.

samsiegart

From description:

Everything in #10677 except the offer makers. I think that'll come through Noble integration.

I think you added the offer makers in packages/fast-usdc/src/clientSupport.js right? Also, by Noble integration do you mean Noble Express UI? Because that won't be submitting any offers AFAIK. Only LPs and OCW will.

I'm assuming we're going to change the CLI and multichain-testing to use these offer functions in a later PR?

The actual code changes in this PR LGTM, so approving.

samsiegart · 2025-01-25T04:39:43Z

packages/fast-usdc/src/clientSupport.js

Do we want to also add functions for accepting the operator invitation and submitting evidence?

samsiegart · 2025-01-25T04:42:16Z

packages/fast-usdc/test/clientSupport.test.js

Test for WithdrawFees?

samsiegart · 2025-01-25T04:50:17Z

packages/builders/scripts/fast-usdc/start-fast-usdc.build.js

@@ -15,7 +15,7 @@ import { parseArgs } from 'node:util';
 /**
 * @import {CoreEvalBuilder, DeployScriptFunction} from '@agoric/deploy-script-support/src/externalTypes.js'
 * @import {ParseArgsConfig} from 'node:util'
- * @import {FastUSDCConfig, FeedPolicy} from '@agoric/fast-usdc/src/types.js'
+ * @import {FastUSDCConfig, FeedPolicy} from '@agoric/fast-usdc';


Nit: there's a semicolon here but not for the lines above. I wonder if eslint/prettier should have a rule for this

I don't think ESlint has a linter for it. There's a Prettier plugin for JSDoc but it's quite buggy

dckc

Let's factor the offer makers out of existing code.

And as a result, let's leave BoardRemote behind and go from Number to ERTP ratio early.

dckc · 2025-01-25T05:05:17Z

packages/fast-usdc/src/clientSupport.js

+ * @param {number} opts.amount
+ * @returns {import('@agoric/smart-wallet/src/offers.js').OfferSpec}
+ */
+const makeDepositOffer = ({ brand }, instance, { offerId, amount }) => {


want is required, and the keyword is USDC, not Deposit.

I'd like us to re-use the existing fast usdc deposit type as in:

agoric-sdk/packages/fast-usdc/src/cli/lp-commands.js

Lines 104 to 112 in f0ccde6

/** @type {USDCProposalShapes['deposit']} */

const proposal = {

give: {

USDC: usdcAmount,

},

want: {

PoolShare: fastLPAmount,

},

};

We could calculate the want for them if they pass in metrics or shareWorth as in...

agoric-sdk/packages/fast-usdc/src/cli/lp-commands.js

Lines 101 to 102 in f0ccde6

const metrics = await swk.readPublished('fastUsdc.poolMetrics');

const fastLPAmount = floorDivideBy(usdcAmount, metrics.shareWorth);

We might want a slippage parameter.

dckc · 2025-01-25T05:07:58Z

packages/fast-usdc/src/clientSupport.js

+
+/**
+ * @param {Pick<
+ *   import('@agoric/vats/tools/board-utils.js').AgoricNamesRemotes,


Let's please stop using BoardRemote and hence AgoricNamesRemotes. Just use the ordinary types like Brand.

ref

identity-preserving marshallers for vstorage testing, clients etc. #10491

I agree eventually but can you accept that as being out of scope? The inter-protocol clientSupport uses AgoricNamesRemotes and I think if we're going to change it we should do both. #10491 looks like a good issue to schedule that.

if we're going to change it we should do both.

I prefer the "platform is fixed" idea where fast-usdc is independent of inter-protocol. But I can live with this.

dckc · 2025-01-25T05:10:57Z

packages/fast-usdc/src/clientSupport.js

+
+// Reusable amount scaling similar to inter-protocol's approach
+const COSMOS_UNIT = 1_000_000n;
+const scaleDecimals = num => BigInt(num * Number(COSMOS_UNIT));


Using Number has weird edge cases. For example, if the product inside BigInt isn't an integer, it throws.

Let's stick to ERTP Amount and Ratio as in:

agoric-sdk/packages/fast-usdc/src/cli/lp-commands.js

Lines 42 to 46 in f0ccde6

const parseUSDCAmount = (amountString, usdc) => {

const USDC_DECIMALS = 6;

const unit = AmountMath.make(usdc, 10n ** BigInt(USDC_DECIMALS));

return multiplyBy(unit, parseRatio(amountString, usdc));

};

parseRatio will take a Number or a string (anything that passes assertParsableNumber), so we could relax amountString likewise.

For commander-style arg parsing, we could export this one:

agoric-sdk/packages/fast-usdc/src/cli/lp-commands.js

Lines 28 to 36 in f0ccde6

const parseDecimal = arg => {

try {

assertParsableNumber(arg);

const n = Number(arg);

return n;

} catch {

throw new InvalidArgumentError('Not a number');

}

};

One of the thing clientSupport helpers do is provide the brand. I think what you're asking for is a bigger change. Again I'm not fully opposed but I think it should be separated from this PR and cover the inter-protocol helper too.

I compromised by making it take a bigint but not the brand.

packages/fast-usdc/src/clientSupport.js

dckc · 2025-01-25T05:16:25Z

packages/fast-usdc/src/clientSupport.js

+});
+
+/** @satisfies {Record<string, import('@agoric/smart-wallet/src/types.js').OfferMaker>} */
+export const Offers = {


Is there any particular reason to export this Offers structure rather than the functions makeDepositOffer and such?

I don't have it handy but there was a PR for refactoring our tests to use these and it let you merge multiple of these into an Offers object with all the makers you needed.

Also this provides a way to enforce that they all satisfy OfferMaker.

dckc · 2025-01-25T05:41:50Z

packages/fast-usdc/src/clientSupport.js

+ * @param {string} opts.offerId
+ * @returns {import('@agoric/smart-wallet/src/offers.js').OfferSpec}
+ */
+const makeWithdrawFeesOffer = (instance, { offerId }) => ({


This one is much less valuable; only a core-eval can withdraw fees.

But if we want to provide a helper, let's factor it out of...

agoric-sdk/packages/fast-usdc/src/distribute-fees.core.js

Line 32 in f0ccde6

export const distributeFees = async (permittedPowers, config) => {

Note support for both absolute amounts and proportions.

dckc

ok, this is forward progress.

dckc · 2025-01-27T23:55:56Z

packages/fast-usdc/src/clientSupport.js

+
+/**
+ * @param {Pick<
+ *   import('@agoric/vats/tools/board-utils.js').AgoricNamesRemotes,


if we're going to change it we should do both.

I prefer the "platform is fixed" idea where fast-usdc is independent of inter-protocol. But I can live with this.

dckc · 2025-01-27T23:59:43Z

packages/fast-usdc/src/clientSupport.js

+  fastUsdc: {
+    Deposit: makeDepositOffer,
+    Withdraw: makeWithdrawOffer,
+    BecomeOperator: makeOperatorOffer,


I'd like to see a WithdrawFees offer maker factored our of distribute-fees.core.js. But I suppose it's reasonable to treat core eval stuff differently.

#10735 (comment)

Fixes this warning from typdoc, ``` ./packages/SwingSet/src/controller/controller.js:480:21 - [warning] The relative path ../docs/run-policy.md is not a file and will not be copied to the output directory 480 * [`runPolicy`](../docs/run-policy.md) to rate-limit cleanups. ```

…ests

mergify · 2025-01-28T23:15:38Z

This pull request has been removed from the queue for the following reason: checks failed.

The merge conditions cannot be satisfied due to failing checks:

❌ integration-test-result
☑️ linear-history

You should look at the reason for the failure and decide if the pull request needs to be fixed or if you want to requeue it.

If you want to requeue this pull request, you need to post a comment with the text: @mergifyio requeue

turadg force-pushed the 10677-fu-client-support branch from c76dc1b to e49ad00 Compare December 18, 2024 23:42

turadg force-pushed the 10677-fu-client-support branch from e49ad00 to ea8de31 Compare January 14, 2025 01:16

turadg force-pushed the 10677-fu-client-support branch from ea8de31 to 7374d68 Compare January 24, 2025 23:14

turadg requested review from dckc and samsiegart January 24, 2025 23:15

dckc reviewed Jan 24, 2025

View reviewed changes

turadg marked this pull request as ready for review January 25, 2025 00:12

turadg requested a review from a team as a code owner January 25, 2025 00:12

samsiegart approved these changes Jan 25, 2025

View reviewed changes

dckc requested changes Jan 25, 2025

View reviewed changes

turadg force-pushed the 10677-fu-client-support branch from f4f6a52 to 6e5d568 Compare January 27, 2025 23:34

turadg requested a review from dckc January 27, 2025 23:35

dckc approved these changes Jan 28, 2025

View reviewed changes

turadg added the automerge:rebase Automatically rebase updates, then merge label Jan 28, 2025

turadg force-pushed the 10677-fu-client-support branch from 05e5caf to fa56775 Compare January 28, 2025 00:03

turadg added 9 commits January 28, 2025 14:20

chore(types): FU ContractRecord

9585105

chore(types): expand PublishedTypeMap

7700425

chore(types): fast-usdc package export types

fc940a3

chore: settlementAddress no longer optional

ef689b4

feat: add client support module for fast-usdc with offer makers and t…

943402f

…ests

refactor: use Offers.fastUsdc.Deposit

2936c0d

refactor: use Offers.fastUsdc.Withdraw

6c2ebf8

refactor: use Offers.fastUsdc

948d7b7

turadg force-pushed the 10677-fu-client-support branch from fa56775 to 948d7b7 Compare January 28, 2025 22:22

mergify bot merged commit 35cb8ca into master Jan 29, 2025
83 checks passed

mergify bot deleted the 10677-fu-client-support branch January 29, 2025 00:23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

client support for Fast USDC #10735

client support for Fast USDC #10735

turadg commented Dec 18, 2024 •

edited

Loading

cloudflare-workers-and-pages bot commented Dec 18, 2024 •

edited

Loading

dckc left a comment

dckc Jan 24, 2025

dckc Jan 24, 2025

turadg Jan 25, 2025

dckc Jan 24, 2025

turadg Jan 25, 2025

dckc Jan 24, 2025

turadg Jan 25, 2025

dckc Jan 24, 2025

turadg Jan 25, 2025

turadg commented Jan 25, 2025 •

edited

Loading

samsiegart left a comment

samsiegart Jan 25, 2025

samsiegart Jan 25, 2025

samsiegart Jan 25, 2025

turadg Jan 27, 2025

dckc left a comment

dckc Jan 25, 2025

dckc Jan 25, 2025

turadg Jan 27, 2025 •

edited

Loading

dckc Jan 27, 2025

dckc Jan 25, 2025

turadg Jan 27, 2025

turadg Jan 27, 2025

dckc Jan 25, 2025

turadg Jan 27, 2025 •

edited

Loading

dckc Jan 25, 2025

dckc left a comment

dckc Jan 27, 2025

dckc Jan 27, 2025

mergify bot commented Jan 28, 2025

		/** @type {import('../types.js').PoolMetrics} */
		// @ts-expect-error it treats this as "unknown"

	/** @type {USDCProposalShapes['deposit']} */
	const proposal = {
	give: {
	USDC: usdcAmount,
	},
	want: {
	PoolShare: fastLPAmount,
	},
	};

	const metrics = await swk.readPublished('fastUsdc.poolMetrics');
	const fastLPAmount = floorDivideBy(usdcAmount, metrics.shareWorth);

	const parseUSDCAmount = (amountString, usdc) => {
	const USDC_DECIMALS = 6;
	const unit = AmountMath.make(usdc, 10n ** BigInt(USDC_DECIMALS));
	return multiplyBy(unit, parseRatio(amountString, usdc));
	};

	const parseDecimal = arg => {
	try {
	assertParsableNumber(arg);
	const n = Number(arg);
	return n;
	} catch {
	throw new InvalidArgumentError('Not a number');
	}
	};

client support for Fast USDC #10735

client support for Fast USDC #10735

Conversation

turadg commented Dec 18, 2024 • edited Loading

Description

Security Considerations

Scaling Considerations

Documentation Considerations

Testing Considerations

Upgrade Considerations

cloudflare-workers-and-pages bot commented Dec 18, 2024 • edited Loading

Deploying agoric-sdk with Cloudflare Pages

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

turadg commented Jan 25, 2025 • edited Loading

samsiegart 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 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

turadg Jan 27, 2025 • 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 Jan 27, 2025 • edited Loading

Choose a reason for hiding this 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

mergify bot commented Jan 28, 2025

turadg commented Dec 18, 2024 •

edited

Loading

cloudflare-workers-and-pages bot commented Dec 18, 2024 •

edited

Loading

turadg commented Jan 25, 2025 •

edited

Loading

turadg Jan 27, 2025 •

edited

Loading

turadg Jan 27, 2025 •

edited

Loading