build cosmic-proto with Telescope #8931

turadg · 2024-02-15T23:44:18Z

closes: #8917

Description

Will change @agoric/cosmic-proto to build with Telescope, giving us better helper code.

I tried to keep the commits clean. The package started generated asnew-cosmic-proto and I replace the existing one after nailing some thing down.

Security Considerations

Scaling Considerations

Documentation Considerations

Testing Considerations

green PR in dapp-inter:

use Telescope-based cosmic-proto dapp-inter#240

green PR in wallet-app

TODO

green PR in ui-kit :

use Telescope-based cosmic-proto ui-kit#82

green PR in cosmos-proposal-builder

update @agoric/cosmic-proto DCFoundation/cosmos-proposal-builder#41

agoric-3-proposals had some references, but they were dead code,

cull dead code agoric-3-proposals#107

Upgrade Considerations

dckc · 2024-02-16T00:19:11Z

test plan looks as good as anything I can think of.
that same list is what you mean by requirements, yes?

IIUC, it should address...

how to use @agoric/cosmic-proto in a confined endo caplet? endojs/endo#1875

Here's hoping for a moment to try it.

I'm also interested to see how it goes with test-interpose-net-access.js in casting.

dckc · 2024-02-16T00:21:06Z

140KLOC. oh my.
Separating the generated code from the stuff we're maintaining by hand will be important for review.

turadg · 2024-02-16T00:53:25Z

that same list is what you mean by requirements, yes?

I suppose so.

Separating the generated code from the stuff we're maintaining by hand will be important for review.

Exactly the code in src/codegen is generated.

packages/cosmic-proto/test/test-agoric.ts

package.json

michaelfig

This is a good start! I would like to see some effort towards reducing the amount of noise introduced by Telescope, such as support for CommonJS and the semantically void codegen/ and dist/ directory names. But by all means, full steam ahead!

packages/agoric-cli/src/commands/wallet.js

michaelfig · 2024-02-27T16:53:48Z

packages/boot/tools/supports.ts

@@ -26,6 +26,7 @@ import {
 import type { ExecutionContext as AvaT } from 'ava';

 import { makeRunUtils } from '@agoric/swingset-vat/tools/run-utils.js';
+import { CoreEvalSDKType } from '@agoric/cosmic-proto/dist/codegen/agoric/swingset/swingset';


Suggested change

import { CoreEvalSDKType } from '@agoric/cosmic-proto/dist/codegen/agoric/swingset/swingset';

import type { CoreEvalSDKType } from '@agoric/cosmic-proto/agoric/swingset/swingset';

I've added type and exports for swingset/swingset.js.

Importing it here would be nice. Unfortunately it will only work with NodeNext moduleResolution and enabling that breaks our use of ambient types (3364 errors).

Punting to #9005

EDIT: I see your other comment about moving dist/codegen/* to the package level. I'll discuss that there.

packages/cosmic-proto/.gitignore

packages/cosmic-proto/README.md

packages/cosmic-proto/package.json

michaelfig · 2024-02-27T17:38:48Z

packages/cosmic-proto/scripts/codegen.cjs

+const rimraf = require('rimraf').rimrafSync;
+
+const protoDirs = [join(__dirname, '/../proto')];
+const outPath = join(__dirname, '../src/codegen');


I'd prefer this, since "codegen" is just noise.

Suggested change

const outPath = join(__dirname, '../src/codegen');

const outPath = join(__dirname, '../src');

Isn't it helpful to distinguish which source files were generated by machine vs by human? @dckc asked for this explicitly in review

michaelfig · 2024-02-27T17:42:13Z

packages/cosmic-proto/src/index.ts

Looks like this is the only hand-written source file in the src directory.

Right. And you can tell that because it's not in the codegen directory

michaelfig · 2024-02-27T17:46:43Z

packages/cosmic-proto/scripts/codegen.cjs

+    },
+    rpcClients: {
+      enabled: true,
+      camelCase: true,


Is this the setting that required changes in agoric-cli for the returned swingset params?

I suppose so. Are you opposed to it? To me the camelCase is what one would expect in a JS API.

@samsiegart you've written the most client code. What's your opinion?

I'd guess camelCase, but not sure where this shows up

@michaelfig made a good point about sticking to defaults. I took this option out to adopt the defaults. Turns out true is the Telescope default

@michaelfig made a good point about sticking to defaults. I took this option out to adopt the defaults. Turns out true is the Telescope default.

@samsiegart it shows up in 7c01cb0

Oh yea, camelCase please 👍

I found the option that determines power_flag_fees vs powerFlagFees: parser.keepCase.

Setting it to keepCase: true matches the older snake_case. Removing it uses the camelCase, so that is the default of Telescope. Given our desire to match the defaults I've left it alone. I considered removing it but I think it's helpful for discovery.

packages/agoric-cli/src/commands/wallet.js

packages/cosmic-proto/README.md

something recently started reporting TS errors in there. just ignore

to get confio/cosmjs-types#78

https://github.com/confio/ts-relayer/blob/main/CHANGELOG.md

michaelfig

No need to adopt any of these suggestions right now... I'm fine with putting them in a future PR.

michaelfig · 2024-02-28T18:05:03Z

packages/cosmic-proto/README.md

+
+### Codegen
+
+Contract schemas live in `./contracts`, and protos in `./proto`. Look inside of `scripts/codegen.cjs` and configure the settings for bundling your SDK and contracts into `@agoric/cosmic-proto`:


We don't use "Contract schemas" or "bundling contracts into @agoric/cosmic-proto":

Suggested change

Contract schemas live in `./contracts`, and protos in `./proto`. Look inside of `scripts/codegen.cjs` and configure the settings for bundling your SDK and contracts into `@agoric/cosmic-proto`:

Protos live in `./proto`. Look inside of `scripts/codegen.cjs` and configure the settings for bundling your SDK into `@agoric/cosmic-proto`:

michaelfig · 2024-02-29T21:35:45Z

packages/cosmic-proto/README.md

+- [Usage](#usage)
+    - [RPC Clients](#rpc-clients)
+    - [Composing Messages](#composing-messages)
+        - Cosmos, CosmWasm, and IBC


For future reference, please search the readme for all instances of (case-insensitive) "cosmwasm" and remove them as they may confuse somebody writing an Agoric smart contract.

michaelfig · 2024-02-29T21:43:23Z

patches/@cosmology+telescope+1.4.12.patch

+    const importStmts = bundler.bundle.importPaths;
+    for (const stmt of importStmts) {
+        if (stmt.source.value.startsWith('.') && !stmt.source.value.endsWith('.js')) {
+            stmt.source.value += '.js';
+        }
+    }
+


Nicely done!

michaelfig · 2024-02-29T21:46:47Z

patches/axios+1.6.7.patch

+-  const reducedDescriptors = {};
+  let reducedDescriptors = {};
+
+   forEach(descriptors, (descriptor, name) => {
+     let ret;
+     if ((ret = reducer(descriptor, name, obj)) !== false) {
+-      reducedDescriptors[name] = ret || descriptor;
+      reducedDescriptors = {...reducedDescriptors, 
+        [name]: ret || descriptor
+      };


FFR, we should probably use Object.defineProperty(reducedDescriptors, name, { value: ret || descriptor }) since otherwise this loop is quadratic.

That's what I did first but when PRing upstream it caused a test failure.

to get protobufjs/protobuf.js#1742

turadg requested review from dckc and michaelfig February 15, 2024 23:44

turadg force-pushed the 8917-telescope branch 7 times, most recently from 863515d to af55111 Compare February 21, 2024 01:33

dckc reviewed Feb 21, 2024

View reviewed changes

packages/cosmic-proto/test/test-agoric.ts Outdated Show resolved Hide resolved

dckc reviewed Feb 21, 2024

View reviewed changes

package.json Outdated Show resolved Hide resolved

turadg force-pushed the 8917-telescope branch 3 times, most recently from a19dee0 to f67bda7 Compare February 26, 2024 20:14

michaelfig reviewed Feb 27, 2024

View reviewed changes

turadg force-pushed the 8917-telescope branch 2 times, most recently from e954f2c to 3b88b7b Compare February 28, 2024 01:21

turadg marked this pull request as ready for review February 28, 2024 14:46

turadg requested a review from michaelfig February 28, 2024 14:46

0xpatrickdev reviewed Feb 28, 2024

View reviewed changes

packages/cosmic-proto/README.md Outdated Show resolved Hide resolved

0xpatrickdev reviewed Feb 28, 2024

View reviewed changes

packages/cosmic-proto/README.md Outdated Show resolved Hide resolved

turadg marked this pull request as draft February 28, 2024 18:18

turadg force-pushed the 8917-telescope branch 2 times, most recently from 855f30b to f71b722 Compare February 28, 2024 22:11

turadg marked this pull request as ready for review February 28, 2024 22:11

turadg requested a review from 0xpatrickdev February 28, 2024 22:11

0xpatrickdev reviewed Feb 28, 2024

View reviewed changes

packages/cosmic-proto/README.md Show resolved Hide resolved

turadg added 13 commits February 29, 2024 21:23

chore: match existing cosmic-proto (until replacing)

7aa4049

build: ts-nocheck for 'util' package

317defa

something recently started reporting TS errors in there. just ignore

test: Ava with TypeScript

4cfc9eb

build: ESM compat

d2467e7

build: source protos without symlink

733d5c7

chore: revise bad generation cosmology-tech/telescope#525

2323213

chore: tweak Telescope config (no change in output)

4250edf

chore: replace cosmic-proto with Telescope version

babf2e1

chore: drop CJS

f122002

chore(deps): bump @cosmjs/*

446262b

to get confio/cosmjs-types#78

chore(deps): bump @confio/relayer

ca28da0

https://github.com/confio/ts-relayer/blob/main/CHANGELOG.md

build: separate tsconfig so lint doesn't build

3a55025

chore: yarn codegen

6c3b571

turadg force-pushed the 8917-telescope branch from 853de5d to 2304c44 Compare February 29, 2024 21:23

michaelfig approved these changes Feb 29, 2024

View reviewed changes

turadg added 10 commits February 29, 2024 22:49

build: ignore output

1e8d923

build: export swingset/swingset.js

55ae8c8

feat: SES compatibility

b7bbc85

test: exports

d967a9c

test: integration with Emerynet

7c75d76

chore(deps): override protobufjs version

f65ca3e

to get protobufjs/protobuf.js#1742

fix(sim-params): power_flag casing

66955c1

feat: use HTTP to fetch SwingSet Params

6598319

refactor: use new cosmic-proto

5f19df9

docs: document only what works in tests

db6cdef

turadg force-pushed the 8917-telescope branch from a64795e to db6cdef Compare February 29, 2024 22:49

mergify bot merged commit 072c457 into master Feb 29, 2024
66 checks passed

mergify bot deleted the 8917-telescope branch February 29, 2024 23:24

0xpatrickdev mentioned this pull request Mar 1, 2024

feat: use oneof compressed_bundle, bundle for MsgInstallBundle proto #9017

Closed

mhofman mentioned this pull request Oct 2, 2024

feat(cosmic-swingset): Use vat cleanup budget values to allow slow cleanup #10165

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

build cosmic-proto with Telescope #8931

build cosmic-proto with Telescope #8931

turadg commented Feb 15, 2024 •

edited

Loading

dckc commented Feb 16, 2024

dckc commented Feb 16, 2024

turadg commented Feb 16, 2024

michaelfig left a comment

michaelfig Feb 27, 2024 •

edited

Loading

turadg Feb 27, 2024 •

edited

Loading

michaelfig Feb 27, 2024

turadg Feb 27, 2024

michaelfig Feb 27, 2024

turadg Feb 27, 2024

michaelfig Feb 27, 2024

turadg Feb 27, 2024

turadg Feb 28, 2024

samsiegart Feb 28, 2024

turadg Feb 28, 2024

turadg Feb 28, 2024

samsiegart Feb 28, 2024

turadg Feb 29, 2024 •

edited

Loading

michaelfig left a comment

michaelfig Feb 28, 2024

michaelfig Feb 29, 2024

michaelfig Feb 29, 2024

michaelfig Feb 29, 2024

turadg Feb 29, 2024

	import { CoreEvalSDKType } from '@agoric/cosmic-proto/dist/codegen/agoric/swingset/swingset';
	import type { CoreEvalSDKType } from '@agoric/cosmic-proto/agoric/swingset/swingset';

	const outPath = join(__dirname, '../src/codegen');
	const outPath = join(__dirname, '../src');


		### Codegen

		Contract schemas live in `./contracts`, and protos in `./proto`. Look inside of `scripts/codegen.cjs` and configure the settings for bundling your SDK and contracts into `@agoric/cosmic-proto`:

	Contract schemas live in `./contracts`, and protos in `./proto`. Look inside of `scripts/codegen.cjs` and configure the settings for bundling your SDK and contracts into `@agoric/cosmic-proto`:
	Protos live in `./proto`. Look inside of `scripts/codegen.cjs` and configure the settings for bundling your SDK into `@agoric/cosmic-proto`:

build cosmic-proto with Telescope #8931

build cosmic-proto with Telescope #8931

Conversation

turadg commented Feb 15, 2024 • edited Loading

Description

Security Considerations

Scaling Considerations

Documentation Considerations

Testing Considerations

Upgrade Considerations

dckc commented Feb 16, 2024

dckc commented Feb 16, 2024

turadg commented Feb 16, 2024

michaelfig left a comment

Choose a reason for hiding this comment

michaelfig Feb 27, 2024 • edited Loading

Choose a reason for hiding this comment

turadg Feb 27, 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

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 Feb 29, 2024 • edited Loading

Choose a reason for hiding this comment

michaelfig 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

turadg commented Feb 15, 2024 •

edited

Loading

michaelfig Feb 27, 2024 •

edited

Loading

turadg Feb 27, 2024 •

edited

Loading

turadg Feb 29, 2024 •

edited

Loading