convert fast-usdc contract to .ts #10480

turadg · 2024-11-14T01:51:50Z

Description

Convert some of the fast-usdc package to .ts. It also adds generics to mapStore() and makeDurablePublishKit().

I'd like to migrate to .ts incrementally because this package is in active development and if I were to migrate the whole thing now there would be lots of merge conflicts.

Security Considerations

As usual, readers must keep in mind that the types are advisory and be sure that adequate runtime validation is also in place.

Scaling Considerations

none

Documentation Considerations

Once this is working, we should convert the demo dapps to it to make them more accessible.

Testing Considerations

CI should cover it.

Upgrade Considerations

Should have no runtime impacts.

dckc · 2024-11-14T02:52:19Z

packages/fast-usdc/src/exos/transaction-feed.ts

-  /** @type {PublishKit<CctpTxEvidence>} */
-  const { publisher, subscriber } = makeDurablePublishKit();
+  const { publisher, subscriber } =
+    makeDurablePublishKit() as PublishKit<CctpTxEvidence>;



Is this a substantive change in static type checking?

Does casting with as require assignment compatibility? I think @type does.

Should it use makeDurablePublishKit<CctpTxEvidence>() instead?

Once that type is generic, yes

dckc · 2024-11-14T02:56:08Z

packages/fast-usdc/test/exos/advancer.test.ts

@@ -8,7 +8,7 @@ import type { Zone } from '@agoric/zone';
 import type { VowTools } from '@agoric/vow';
 import { prepareAdvancer } from '../../src/exos/advancer.js';
 import { prepareStatusManager } from '../../src/exos/status-manager.js';
-import { prepareTransactionFeedKit } from '../../src/exos/transaction-feed.js';
+import { prepareTransactionFeedKit } from '../../src/exos/transaction-feed.ts';


It looks like the build step does just a bit more than erase types.

I guess bundleSource groks, though

dckc · 2024-11-14T02:59:00Z

packages/fast-usdc/src/fast-usdc.contract.ts

@@ -102,10 +101,9 @@ export const contract = async (zcf, privateArgs, zone, tools) => {
     *
     * Provide an API call in the form of an invitation maker, so that the
     * capability is available in the smart-wallet bridge.
-     *
-     * @param {CctpTxEvidence} evidence
+     * @param evidence


Is this @param still necessary?
Perhaps only until we tell eslint otherwise?

Right. Our eslint config is that if there's a jsdoc comment on a function it must have params. I'd like to leave changing out that as out of scope of this PR.

It’s not awful to have a place to document the meaning of the param for tsdoc. We just don’t have to note the type.

cloudflare-workers-and-pages · 2024-11-24T01:51:37Z

Deploying agoric-sdk with Cloudflare Pages

Latest commit:	`2899c22`
Status:	✅ Deploy successful!
Preview URL:	https://d09c15c3.agoric-sdk.pages.dev
Branch Preview URL:	https://ta-fu-ts.agoric-sdk.pages.dev

View logs

github-actions · 2024-11-24T04:44:24Z

Base branch is changed to master. Please re-run the integration tests by adding 'force:integration' label.

0xpatrickdev · 2024-11-25T17:22:07Z

packages/fast-usdc/src/exos/transaction-feed.ts

+}
+
+export const prepareTransactionFeedKit = (zone: Zone, zcf: ZCF) => {
+  const kinds = zone.mapStore<string, unknown>('Kinds');


Why is this unknown?

I just didn't know what to type it and this worked

0xpatrickdev · 2024-11-25T17:24:35Z

packages/fast-usdc/src/exos/transaction-feed.ts

-        makeOperatorInvitation(operatorId) {
+        makeOperatorInvitation(
+          operatorId: string,
+        ): Promise<Invitation<OperatorKit>> {


Why type the return? It seems the same value is inferred

Just moved from what was there. I'll leave since it doesn't hurt to be explicit

turadg · 2024-11-25T18:00:52Z

I'll hold off until in-flight FU PRs are landed so this doesn't create merge conflicts for them

dckc · 2024-11-27T18:07:58Z

packages/fast-usdc/src/fast-usdc.contract.ts

 import { depositToSeat } from '@agoric/zoe/src/contractSupport/zoeHelpers.js';
 import { E } from '@endo/far';
 import { M, objectMap } from '@endo/patterns';
+import type { Zone } from '@agoric/zone';


I was concerned that conversion to .ts would mean that type imports have to be changed from devDependencies to dependencies, but I don't see a change to package.json for @agoric/zone, so evidently not. Interesting.

dckc reviewed Nov 14, 2024

View reviewed changes

This was referenced Nov 14, 2024

Fast USDC CLI: Transfer #10437

Merged

allow .ts for package exports #10495

Draft

turadg force-pushed the ta/fu-ts branch from 49247e2 to 6cfac29 Compare November 24, 2024 01:51

turadg changed the base branch from master to typescript-5.7 November 24, 2024 01:51

turadg force-pushed the ta/fu-ts branch from 6cfac29 to aa93503 Compare November 24, 2024 01:55

turadg changed the base branch from typescript-5.7 to master November 24, 2024 04:43

turadg force-pushed the ta/fu-ts branch from aa93503 to e982250 Compare November 24, 2024 05:10

turadg mentioned this pull request Nov 24, 2024

TypeScript 5.7 and fix coverage CI #10561

Merged

turadg changed the title ~~convert fast-usdc package to .ts~~ convert fast-usdc contract to .ts Nov 24, 2024

turadg force-pushed the ta/fu-ts branch from e982250 to c1ce445 Compare November 24, 2024 19:45

turadg added 6 commits November 24, 2024 17:22

build: support for .ts in JS bundles

653ec1f

feat(types): generic makeDurablePublishKit

f5aa600

feat(types): generic zone.mapStore

f531c7f

refactor: fast-usdc.contract to .ts

384916e

refactor: Convert transaction-feed.js to TypeScript

d46b152

refactor: convert operator-kit to .ts

2899c22

turadg force-pushed the ta/fu-ts branch from c1ce445 to 2899c22 Compare November 25, 2024 01:22

turadg marked this pull request as ready for review November 25, 2024 01:22

turadg requested a review from a team as a code owner November 25, 2024 01:22

turadg requested a review from AgoricTriage November 25, 2024 01:22

0xpatrickdev approved these changes Nov 25, 2024

View reviewed changes

dckc reviewed Nov 27, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

convert fast-usdc contract to .ts #10480

convert fast-usdc contract to .ts #10480

turadg commented Nov 14, 2024 •

edited

Loading

dckc Nov 14, 2024

dckc Nov 14, 2024 •

edited

Loading

turadg Nov 15, 2024

turadg Nov 24, 2024

dckc Nov 14, 2024

dckc Nov 14, 2024

turadg Nov 14, 2024

kriskowal Nov 15, 2024

cloudflare-workers-and-pages bot commented Nov 24, 2024 •

edited

Loading

github-actions bot commented Nov 24, 2024

0xpatrickdev Nov 25, 2024

turadg Nov 25, 2024

0xpatrickdev Nov 25, 2024

turadg Nov 25, 2024

turadg commented Nov 25, 2024

dckc Nov 27, 2024

convert fast-usdc contract to .ts #10480

Are you sure you want to change the base?

convert fast-usdc contract to .ts #10480

Conversation

turadg commented Nov 14, 2024 • edited Loading

Description

Security Considerations

Scaling Considerations

Documentation Considerations

Testing Considerations

Upgrade Considerations

Choose a reason for hiding this comment

dckc Nov 14, 2024 • 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

cloudflare-workers-and-pages bot commented Nov 24, 2024 • edited Loading

Deploying agoric-sdk with Cloudflare Pages

github-actions bot commented Nov 24, 2024

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 Nov 25, 2024

Choose a reason for hiding this comment

turadg commented Nov 14, 2024 •

edited

Loading

dckc Nov 14, 2024 •

edited

Loading

cloudflare-workers-and-pages bot commented Nov 24, 2024 •

edited

Loading