feat(orchestrate): membrane friendly wrapper for agoricNames #9551

0xpatrickdev · 2024-06-21T04:57:02Z

Description

Perform remote calls to agoricNames in membrane-friendly way. This is an interim approach until #9541, #9322, or #9519.

packages/orchestration/src/utils/start-helper.js

cloudflare-workers-and-pages · 2024-06-21T04:59:19Z

Deploying agoric-sdk with Cloudflare Pages

Latest commit:	`622ed61`
Status:	✅ Deploy successful!
Preview URL:	https://84177708.agoric-sdk.pages.dev
Branch Preview URL:	https://pc-membrane-friendly-agoricn.agoric-sdk.pages.dev

View logs

0xpatrickdev · 2024-06-21T04:59:42Z

packages/orchestration/src/exos/agoric-names-tools.js

+ * @param {Zone} zone
+ * @param {{ agoricNames: Remote<NameHub>; vowTools: VowTools }} powers
+ */
+export const makeAgNamesTools = (


Reviewers might suggest a better name

I think we should avoid Ag abbreviation in code. "Tools" isn't quite right because this is augmenting AgoricNames. We sometimes use Kit for that but more often that's for a multi-faceted object and this isn't.

AgoricNames would be confused with the remote/vat and AgoricNameHub could also be.

ResumableAgoricNames conveys that it's wrapping the remove in vows, but that seems like an anti-pattern. We don't want to have to define a fetcher for each remote.

My suggestion is that instead we name it conspicuously not for production. E.g. AgoricNamesHack

I've renamed it to ResumableAgoricNamesHack. Given it supports additional functionality - a vbank lookup by brand with local caching - we might consider renaming in the future. When we build getBrandInfo and asAmount this may be a good place to put them (or, we can move findBrandInVBank there) cc @dckc.

dckc

This is an interim approach until ...

What motivates an interim approach now? Why not either leave it as is or solve it completely?

dckc · 2024-06-21T14:31:11Z

packages/orchestration/src/exos/agoric-names-tools.js

+ const vbankAssetNameHubP = E(agoricNames).lookup('vbankAsset');
+ return watch(
+ E(vbankAssetNameHubP).values(),
+ Far('BrandsWatcher', {


Far? Is that how watch is supposed to be used? I don't see Far used in watch.test.js. I see exos there.

I don't see any docs either way on the watch function nor the Watcher type.

Refactored to a durable exo in 3cf3fd0

turadg · 2024-06-21T14:29:14Z

packages/orchestration/src/exos/agoric-names-tools.js

+ * @param {Zone} zone
+ * @param {{ agoricNames: Remote<NameHub>; vowTools: VowTools }} powers
+ */
+export const makeAgNamesTools = (


I think we should avoid Ag abbreviation in code. "Tools" isn't quite right because this is augmenting AgoricNames. We sometimes use Kit for that but more often that's for a multi-faceted object and this isn't.

AgoricNames would be confused with the remote/vat and AgoricNameHub could also be.

ResumableAgoricNames conveys that it's wrapping the remove in vows, but that seems like an anti-pattern. We don't want to have to define a fetcher for each remote.

My suggestion is that instead we name it conspicuously not for production. E.g. AgoricNamesHack

turadg · 2024-06-21T14:29:25Z

packages/orchestration/src/exos/agoric-names-tools.js

+ * interim approach until https://github.com/Agoric/agoric-sdk/issues/9541,
+ * https://github.com/Agoric/agoric-sdk/pull/9322, or
+ * https://github.com/Agoric/agoric-sdk/pull/9519


thanks for referencing all these

turadg · 2024-06-21T14:33:32Z

packages/orchestration/src/exos/agoric-names-tools.js

+ * @returns {Vow<AssetInfo>}
+ */
+ findBrandInVBank(brand) {
+ // XXX consider caching and refetching 1x if brand is not found,


why refetch? why only once?

Likely more clear with this refactor: 3cf3fd0

turadg · 2024-06-21T14:36:07Z

packages/orchestration/src/examples/sendAnywhere.contract.js

@@ -77,7 +67,7 @@ export const start = async (zcf, privateArgs, baggage) => {
 const { chainName, destAddr } = offerArgs;
 const { give } = seat.getProposal();
 const [[kw, amt]] = entries(give);
- const { denom } = await findBrandInVBank(amt.brand);
+ const { denom } = await V.when(agNamesTools.findBrandInVBank(amt.brand));


this should come from context, not the closure. Also then it doesn't need V.when()

Moved to context. It seems like V.when() is still needed until orchestrate uses asyncFlow (like on dt/af-spike)

packages/orchestration/src/utils/start-helper.js

dckc

close enough for now

dckc · 2024-06-21T21:24:14Z

packages/orchestration/src/exos/agoric-names-tools.js

+ const makeResumableAgoricNamesHackKit = zone.exoClassKit(
+ 'ResumableAgoricNamesHack',


This will fail if makeResumableAgoricNamesHack is called more than once in the same zone.

Add that to the docstring? or just leave it implicit in the *Hack name?

dckc · 2024-06-21T21:27:55Z

packages/orchestration/src/exos/agoric-names-tools.js

+ if (vbankAssetsByBrand.has(brand)) {
+ return watch(vbankAssetsByBrand.get(brand));


Can we skip the watch() here and just return the payload directly? Wrapping it in a Vow adds a round-trip between vats.
Does Vow<T> include T like ERef<T> does?

Add a TODO about cache invalidation?

Added cache invalidation in aa53b01.

And yes, Vow<T> is a thing.

Can we skip the watch() here and just return the payload directly? Wrapping it in a Vow adds a round-trip between vats.

My understanding from this comment is that we always have to return a vow. Seeing in the ticket description methods that don't return immediately return Vows, which seems like it might conflict with this .

dckc · 2024-06-21T21:30:02Z

packages/orchestration/src/utils/start-helper.js

 zone,
 makeRecorderKit,
 zcf,
- remotePowers.timerService,
+ timerService,
 vowTools,
 chainHub,


Aside: do we really have a function with that many positional args? If it gets >3, they should be named.

* Perform remote calls to agoricNames in membrane-friendly way. This is an * interim approach until #9541, * #9322, or * #9519

0xpatrickdev · 2024-06-25T16:45:11Z

This was refactored to use the newly added asVow helper, if you could please take another look @dckc

This was refactored to use the newly added asVow helper

dckc · 2024-06-25T16:50:21Z

Did you consider adding this to chainHub?

In #9491, my draft has a chainHub.saveVBankAssets(); it doesn't have chainHub.findBrand(brand), but it has chainHub.getAssetInfo(denom) that makes it pretty obvious how to do that.

dckc

I'd rather we add this to chainHub than make a whole file of tests that we'll probably discard. But I guess I'm ok with it for now.

0xpatrickdev commented Jun 21, 2024

View reviewed changes

packages/orchestration/src/utils/start-helper.js Outdated Show resolved Hide resolved

0xpatrickdev commented Jun 21, 2024

View reviewed changes

0xpatrickdev requested review from turadg and dckc June 21, 2024 05:26

dckc reviewed Jun 21, 2024

View reviewed changes

turadg requested changes Jun 21, 2024

View reviewed changes

0xpatrickdev requested review from turadg and dckc June 21, 2024 21:15

turadg previously approved these changes Jun 21, 2024

View reviewed changes

dckc previously approved these changes Jun 21, 2024

View reviewed changes

0xpatrickdev force-pushed the pc/membrane-friendly-agoricnames-lookup branch 3 times, most recently from b0de115 to 98f44fb Compare June 25, 2024 02:15

0xpatrickdev added 2 commits June 25, 2024 12:40

feat(orchestrate): membrane friendly wrapper for agoricNames

16fc446

* Perform remote calls to agoricNames in membrane-friendly way. This is an * interim approach until #9541, * #9322, or * #9519

feat(findBrandInVBank): add optional parameter to invalidate cache

622ed61

0xpatrickdev force-pushed the pc/membrane-friendly-agoricnames-lookup branch from 98f44fb to 622ed61 Compare June 25, 2024 16:40

0xpatrickdev requested a review from dckc June 25, 2024 16:43

dckc approved these changes Jun 25, 2024

View reviewed changes

0xpatrickdev added the automerge:rebase Automatically rebase updates, then merge label Jun 25, 2024

mergify bot merged commit 80db38c into master Jun 25, 2024
85 checks passed

mergify bot deleted the pc/membrane-friendly-agoricnames-lookup branch June 25, 2024 17:26

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(orchestrate): membrane friendly wrapper for agoricNames #9551

feat(orchestrate): membrane friendly wrapper for agoricNames #9551

0xpatrickdev commented Jun 21, 2024

cloudflare-workers-and-pages bot commented Jun 21, 2024 •

edited

Loading

0xpatrickdev Jun 21, 2024

turadg Jun 21, 2024

0xpatrickdev Jun 21, 2024

dckc left a comment

dckc Jun 21, 2024

0xpatrickdev Jun 21, 2024

turadg Jun 21, 2024

turadg Jun 21, 2024

turadg Jun 21, 2024

0xpatrickdev Jun 21, 2024

turadg Jun 21, 2024

0xpatrickdev Jun 21, 2024

dckc left a comment

dckc Jun 21, 2024

dckc Jun 21, 2024

dckc Jun 21, 2024

0xpatrickdev Jun 21, 2024 •

edited

Loading

0xpatrickdev Jun 21, 2024

dckc Jun 21, 2024

0xpatrickdev commented Jun 25, 2024

dckc commented Jun 25, 2024

dckc left a comment

		const makeResumableAgoricNamesHackKit = zone.exoClassKit(
		'ResumableAgoricNamesHack',

		if (vbankAssetsByBrand.has(brand)) {
		return watch(vbankAssetsByBrand.get(brand));

feat(orchestrate): membrane friendly wrapper for agoricNames #9551

feat(orchestrate): membrane friendly wrapper for agoricNames #9551

Conversation

0xpatrickdev commented Jun 21, 2024

Description

cloudflare-workers-and-pages bot commented Jun 21, 2024 • edited Loading

Deploying agoric-sdk with Cloudflare Pages

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

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 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

0xpatrickdev Jun 21, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

0xpatrickdev commented Jun 25, 2024

dckc commented Jun 25, 2024

dckc left a comment

Choose a reason for hiding this comment

cloudflare-workers-and-pages bot commented Jun 21, 2024 •

edited

Loading

0xpatrickdev Jun 21, 2024 •

edited

Loading