Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(codegen): generated js client (the wrapper) #772

Merged
merged 15 commits into from
Mar 1, 2021

Conversation

ilgooz
Copy link
Member

@ilgooz ilgooz commented Feb 20, 2021

depends on #771.
depends on #795.

it wraps generated protobufjs types and rest client, uses cosmjs and exports high level txClient() and queryClient() funcs for:

  • creating messages, signing and broadcasting them,
  • querying.

js client created individually for each module. within Vuex, it can be used like in below:

import { DirectSecp256k1HdWallet } from "@cosmjs/proto-signing";
import { txClient, queryClient } from "./store/tendermint/mars/mars/module";

async function main() {
    const wallet = await DirectSecp256k1HdWallet.fromMnemonic("alfa romeo...");

    const t = await txClient(wallet); // txClient(wallet, { addr: "http://localhost:26657" });
    const q = await queryClient(); // queryClient({ addr: "http://localhost:1317" });

    console.log(await t.signAndBroadcast([ t.msgCreateUser({ name: "mars", creator: wallet.address }) ]));
    console.log(await q.queryUserAll());
}

main()

it wraps generated protobufjs types and rest client, uses cosmjs and exports high level `txClient()` and `queryClient()` funcs for:

* creating messages, signing and broadcasting them,
* querying.

js client created individually for each module. within Vuex, it can be used like in below:

```js
import { DirectSecp256k1HdWallet } from "@cosmjs/proto-signing";
import { txClient, queryClient } from "./store/tendermint/mars/mars/module";

async function main() {
    const wallet = await DirectSecp256k1HdWallet.fromMnemonic("alfa romeo...");

    const t = await txClient(wallet);
    const q = await queryClient();

    console.log(await t.signAndBroadcast([ t.msgCreateUser({ name: "mars", creator: wallet.address }) ]));
    console.log(await q.queryUserAll());
}

main()

```
@ilgooz ilgooz marked this pull request as ready for review February 22, 2021 18:23
@ilgooz ilgooz requested review from fadeev and lumtis as code owners February 22, 2021 18:23
@ilgooz ilgooz requested a review from clockworkgr February 22, 2021 18:25
@ilgooz ilgooz mentioned this pull request Feb 26, 2021
@ilgooz ilgooz marked this pull request as draft February 27, 2021 10:06
previously, we were using `protobufjs` to generate app types.
now, we have switched to `ts-proto` but also kept js support by placing `.js` and `.d.ts` files next to the generated `.ts` files.

* refactored `nodetime` packaging.
* added more detailed info to `pkg/cosmosanalysis/module.Discover()` output.
* added more detailed info to `pkg/protoanalysis.DiscoverPackages()` output.
* added plugin binary configurability option to `pkg/protoc` pkg.
* improved `pkg/cosmosgen`'s public API.
* added `pkg/nodetime/tsc`, `pkg/nodetime/ts-proto` and removed `pkg/nodetime/protobufjs`.
* several code generation improvements made.
@ilgooz ilgooz marked this pull request as ready for review March 1, 2021 09:21
Copy link
Contributor

@fadeev fadeev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome! 🤩

@ilgooz ilgooz merged commit ecf578b into feat/codegen-fx Mar 1, 2021
@ilgooz ilgooz deleted the feat/js-wrapper branch March 1, 2021 10:41
ilgooz added a commit that referenced this pull request Mar 16, 2021
* empty commit

* feat: sdk msg discovery from app source (#734)

* feat: sdk msg discovery from app source

* `pkg/cosmosanalysis/msg.Discover()` discovers types that implements sdk.Msg.
* added `pkg/protoanalysis` for proto file analysis.

* fix linter

* docs

* docs

Co-authored-by: Lucas Bertrand <[email protected]>

Co-authored-by: Lucas Bertrand <[email protected]>

* feat: add pkg/protobufjs (#744)

* feat: add pkg/protobufjs

protobufjs is made available for use as a Go pkg with the high level Generate() API.

protobufjs binaries statically added to Starport's source code and they are instantly available.

only the relavent protobufjs binary included to the final binary of Starport dependending on the OS. for Linux, it adds 17MB to the total binary size of Starport.

* ci: enable lfs

* fix lint

* cleanup & docs

* cleanup & an attempt to add ts defs for generated js

* gitpod: install git-lfs

* ci(pi): disable them temp because high LFS usage

* rm pi files

* gitpod: fix lfs

* gitpod: fix lfs

* gitpod: fix lfs

* gitpod: fix lfs

* docs: manual installation

* gitpod: fix lfs

* fix gitpod (#754)

* fix(gitpod): drop lfs (#755)

* fix(gitpod): drop lfs

compress protobufjs binary manually instead of relying on go-bindata's.

generated files now under 100MB.

* tidy

* cleanup

* feat(pkg/cosmosanalysis): add more detailed msg info (#752)

* feat(pkg/cosmosanalysis): add more detailed msg info

most importantly, msg urls added to the analysis output.

* docs

Co-authored-by: Lucas Bertrand <[email protected]>

Co-authored-by: Lucas Bertrand <[email protected]>

* feat(nodetime): add sta pkg and refactor (#757)

* feat(nodetime): add sta pkg and refactor

a new pkg/ called nodetime added to host and use a single NodeJS runtime
that has multiple CLIs bundled inside.

* `swagger-typescript-api` CLI added alongside `protobufjs` CLI.

* switched Starport's Go compiler to 1.16 beta to benefit from new the `embed` feature. it'll be switched to stable 1.16 release once it's available (likely this Feb).

* fix integration tests

* fix gitpod

* feat: upgrade to stable Go 1.16 (#765)

* fix: integration tests (#766)

* feat: enable js proto generation (#751)

* refactor(protoc): wrap protoc cmd as a pkg

* enable js code generation for build & server

out dir can be configured via `build.proto.js.out`.

* generate js per module

* change cosmosprotoc name to cosmosproto

* docs

* fix linter

* chore(integration): disable parallel run to not bottleneck the CI

* feat(codegen): generate rest client for js (#771)

* feat(codegen): generate rest client for js

* fix Go codegen

* feat(codegen/ts-proto): generate app types with ts-proto (#795)

* feat(codegen/ts-proto): generate app types with ts-proto

previously, we were using `protobufjs` to generate app types.
now, we have switched to `ts-proto` but also kept js support by placing `.js` and `.d.ts` files next to the generated `.ts` files.

* refactored `nodetime` packaging.
* added more detailed info to `pkg/cosmosanalysis/module.Discover()` output.
* added more detailed info to `pkg/protoanalysis.DiscoverPackages()` output.
* added plugin binary configurability option to `pkg/protoc` pkg.
* improved `pkg/cosmosgen`'s public API.
* added `pkg/nodetime/tsc`, `pkg/nodetime/ts-proto` and removed `pkg/nodetime/protobufjs`.

* fix lint

* fix err check

* feat(codegen): generated js client (the wrapper) (#772)

* feat(codegen): generate rest client for js

* fix Go codegen

* feat(codegen): generated js client (the wrapper)

it wraps generated protobufjs types and rest client, uses cosmjs and exports high level `txClient()` and `queryClient()` funcs for:

* creating messages, signing and broadcasting them,
* querying.

js client created individually for each module. within Vuex, it can be used like in below:

```js
import { DirectSecp256k1HdWallet } from "@cosmjs/proto-signing";
import { txClient, queryClient } from "./store/tendermint/mars/mars/module";

async function main() {
    const wallet = await DirectSecp256k1HdWallet.fromMnemonic("alfa romeo...");

    const t = await txClient(wallet);
    const q = await queryClient();

    console.log(await t.signAndBroadcast([ t.msgCreateUser({ name: "mars", creator: wallet.address }) ]));
    console.log(await q.queryUserAll());
}

main()

```

* fix(sta): sdk module name

* docs

* feat(codegen/ts-proto): generate app types with ts-proto

previously, we were using `protobufjs` to generate app types.
now, we have switched to `ts-proto` but also kept js support by placing `.js` and `.d.ts` files next to the generated `.ts` files.

* refactored `nodetime` packaging.
* added more detailed info to `pkg/cosmosanalysis/module.Discover()` output.
* added more detailed info to `pkg/protoanalysis.DiscoverPackages()` output.
* added plugin binary configurability option to `pkg/protoc` pkg.
* improved `pkg/cosmosgen`'s public API.
* added `pkg/nodetime/tsc`, `pkg/nodetime/ts-proto` and removed `pkg/nodetime/protobufjs`.

* fix lint

* fix err check

* migrate wrapper to ts(-proto) and new version of cosmjs

* several code generation improvements made.

* add customizable fee

* fix default amount

* feat(codegen): add code generation for 3rd party modules (#797)

* feat(codegen): generate rest client for js

* fix Go codegen

* feat(codegen): generated js client (the wrapper)

it wraps generated protobufjs types and rest client, uses cosmjs and exports high level `txClient()` and `queryClient()` funcs for:

* creating messages, signing and broadcasting them,
* querying.

js client created individually for each module. within Vuex, it can be used like in below:

```js
import { DirectSecp256k1HdWallet } from "@cosmjs/proto-signing";
import { txClient, queryClient } from "./store/tendermint/mars/mars/module";

async function main() {
    const wallet = await DirectSecp256k1HdWallet.fromMnemonic("alfa romeo...");

    const t = await txClient(wallet);
    const q = await queryClient();

    console.log(await t.signAndBroadcast([ t.msgCreateUser({ name: "mars", creator: wallet.address }) ]));
    console.log(await q.queryUserAll());
}

main()

```

* fix(sta): sdk module name

* docs

* feat(codegen/ts-proto): generate app types with ts-proto

previously, we were using `protobufjs` to generate app types.
now, we have switched to `ts-proto` but also kept js support by placing `.js` and `.d.ts` files next to the generated `.ts` files.

* refactored `nodetime` packaging.
* added more detailed info to `pkg/cosmosanalysis/module.Discover()` output.
* added more detailed info to `pkg/protoanalysis.DiscoverPackages()` output.
* added plugin binary configurability option to `pkg/protoc` pkg.
* improved `pkg/cosmosgen`'s public API.
* added `pkg/nodetime/tsc`, `pkg/nodetime/ts-proto` and removed `pkg/nodetime/protobufjs`.

* fix lint

* fix err check

* migrate wrapper to ts(-proto) and new version of cosmjs

* several code generation improvements made.

* feat(codegen): add code generation for dependency modules

optionally enable js related code code generation for the 3rd party modules -including the sdk- that used by an app.

* several improvements mode on code generation logic.

* fix lint & err checking

* fix go codegen

* scaffolding(stargate): add generated 3rd party js clients

* enable code gen for 3rd party modules on demand

* docs

* fix: add chain to path (#802)

Co-authored-by: Alex Megalokonomos <[email protected]>

* chore: sync stargate scaffolding for new js gen path (#803)

* feat: Updated vue template for codegen (#807)

* feat: Updated vue template

* package.json fixes

* chrore(ui): update versions , add plain eslint config (#812)

* feat: (codegen/vuex): add Vuex code generation & refactor (#824)

* codegen(vuex): add Vuex code generation & refactor

code generation related packages.

* fix err handling & linter errors

* fix err handling

* fix msg discovery

* cosmosanalysis: add metadata about grpc gateway

* docs: fix typo

* fix linter err

* feat: provide more tpl data to loader & add user-side warnings (#857)

* feat: provide more tpl data to loader & add user-side warnings

about not modifying generated dirs/files.

* cosmetic

* fix: Template updates (#825)

* fix: Template updates

* feat: sendMsg*  actions, Msg* message creation

* feat: Add true Error()s

* fix: Change `chain` to `generated`

* fix: tsc ignore imported dependency

* Updated generated JS/TS for SDK modules

* feat: Add get all pages option to queries

* fiix: Pass all option to subscription

* feat: Add query returns from store

* WIP v0.15 Layout

* Regenerated JS/TS

* fix: stale state, return from getters

* Regenerated TS/JS

* JS Template changes

* Regenerated JS/TS

* Additional template changes

* fix: Template changes

* Regenerated TS/JS

* templates: sync pre generated js

Co-authored-by: Lucas Bertrand <[email protected]>
Co-authored-by: Alex Megalokonomos <[email protected]>
Jchicode pushed a commit to Jchicode/cli that referenced this pull request Aug 9, 2023
* empty commit

* feat: sdk msg discovery from app source (ignite#734)

* feat: sdk msg discovery from app source

* `pkg/cosmosanalysis/msg.Discover()` discovers types that implements sdk.Msg.
* added `pkg/protoanalysis` for proto file analysis.

* fix linter

* docs

* docs

Co-authored-by: Lucas Bertrand <[email protected]>

Co-authored-by: Lucas Bertrand <[email protected]>

* feat: add pkg/protobufjs (ignite#744)

* feat: add pkg/protobufjs

protobufjs is made available for use as a Go pkg with the high level Generate() API.

protobufjs binaries statically added to Starport's source code and they are instantly available.

only the relavent protobufjs binary included to the final binary of Starport dependending on the OS. for Linux, it adds 17MB to the total binary size of Starport.

* ci: enable lfs

* fix lint

* cleanup & docs

* cleanup & an attempt to add ts defs for generated js

* gitpod: install git-lfs

* ci(pi): disable them temp because high LFS usage

* rm pi files

* gitpod: fix lfs

* gitpod: fix lfs

* gitpod: fix lfs

* gitpod: fix lfs

* docs: manual installation

* gitpod: fix lfs

* fix gitpod (ignite#754)

* fix(gitpod): drop lfs (ignite#755)

* fix(gitpod): drop lfs

compress protobufjs binary manually instead of relying on go-bindata's.

generated files now under 100MB.

* tidy

* cleanup

* feat(pkg/cosmosanalysis): add more detailed msg info (ignite#752)

* feat(pkg/cosmosanalysis): add more detailed msg info

most importantly, msg urls added to the analysis output.

* docs

Co-authored-by: Lucas Bertrand <[email protected]>

Co-authored-by: Lucas Bertrand <[email protected]>

* feat(nodetime): add sta pkg and refactor (ignite#757)

* feat(nodetime): add sta pkg and refactor

a new pkg/ called nodetime added to host and use a single NodeJS runtime
that has multiple CLIs bundled inside.

* `swagger-typescript-api` CLI added alongside `protobufjs` CLI.

* switched Starport's Go compiler to 1.16 beta to benefit from new the `embed` feature. it'll be switched to stable 1.16 release once it's available (likely this Feb).

* fix integration tests

* fix gitpod

* feat: upgrade to stable Go 1.16 (ignite#765)

* fix: integration tests (ignite#766)

* feat: enable js proto generation (ignite#751)

* refactor(protoc): wrap protoc cmd as a pkg

* enable js code generation for build & server

out dir can be configured via `build.proto.js.out`.

* generate js per module

* change cosmosprotoc name to cosmosproto

* docs

* fix linter

* chore(integration): disable parallel run to not bottleneck the CI

* feat(codegen): generate rest client for js (ignite#771)

* feat(codegen): generate rest client for js

* fix Go codegen

* feat(codegen/ts-proto): generate app types with ts-proto (ignite#795)

* feat(codegen/ts-proto): generate app types with ts-proto

previously, we were using `protobufjs` to generate app types.
now, we have switched to `ts-proto` but also kept js support by placing `.js` and `.d.ts` files next to the generated `.ts` files.

* refactored `nodetime` packaging.
* added more detailed info to `pkg/cosmosanalysis/module.Discover()` output.
* added more detailed info to `pkg/protoanalysis.DiscoverPackages()` output.
* added plugin binary configurability option to `pkg/protoc` pkg.
* improved `pkg/cosmosgen`'s public API.
* added `pkg/nodetime/tsc`, `pkg/nodetime/ts-proto` and removed `pkg/nodetime/protobufjs`.

* fix lint

* fix err check

* feat(codegen): generated js client (the wrapper) (ignite#772)

* feat(codegen): generate rest client for js

* fix Go codegen

* feat(codegen): generated js client (the wrapper)

it wraps generated protobufjs types and rest client, uses cosmjs and exports high level `txClient()` and `queryClient()` funcs for:

* creating messages, signing and broadcasting them,
* querying.

js client created individually for each module. within Vuex, it can be used like in below:

```js
import { DirectSecp256k1HdWallet } from "@cosmjs/proto-signing";
import { txClient, queryClient } from "./store/tendermint/mars/mars/module";

async function main() {
    const wallet = await DirectSecp256k1HdWallet.fromMnemonic("alfa romeo...");

    const t = await txClient(wallet);
    const q = await queryClient();

    console.log(await t.signAndBroadcast([ t.msgCreateUser({ name: "mars", creator: wallet.address }) ]));
    console.log(await q.queryUserAll());
}

main()

```

* fix(sta): sdk module name

* docs

* feat(codegen/ts-proto): generate app types with ts-proto

previously, we were using `protobufjs` to generate app types.
now, we have switched to `ts-proto` but also kept js support by placing `.js` and `.d.ts` files next to the generated `.ts` files.

* refactored `nodetime` packaging.
* added more detailed info to `pkg/cosmosanalysis/module.Discover()` output.
* added more detailed info to `pkg/protoanalysis.DiscoverPackages()` output.
* added plugin binary configurability option to `pkg/protoc` pkg.
* improved `pkg/cosmosgen`'s public API.
* added `pkg/nodetime/tsc`, `pkg/nodetime/ts-proto` and removed `pkg/nodetime/protobufjs`.

* fix lint

* fix err check

* migrate wrapper to ts(-proto) and new version of cosmjs

* several code generation improvements made.

* add customizable fee

* fix default amount

* feat(codegen): add code generation for 3rd party modules (ignite#797)

* feat(codegen): generate rest client for js

* fix Go codegen

* feat(codegen): generated js client (the wrapper)

it wraps generated protobufjs types and rest client, uses cosmjs and exports high level `txClient()` and `queryClient()` funcs for:

* creating messages, signing and broadcasting them,
* querying.

js client created individually for each module. within Vuex, it can be used like in below:

```js
import { DirectSecp256k1HdWallet } from "@cosmjs/proto-signing";
import { txClient, queryClient } from "./store/tendermint/mars/mars/module";

async function main() {
    const wallet = await DirectSecp256k1HdWallet.fromMnemonic("alfa romeo...");

    const t = await txClient(wallet);
    const q = await queryClient();

    console.log(await t.signAndBroadcast([ t.msgCreateUser({ name: "mars", creator: wallet.address }) ]));
    console.log(await q.queryUserAll());
}

main()

```

* fix(sta): sdk module name

* docs

* feat(codegen/ts-proto): generate app types with ts-proto

previously, we were using `protobufjs` to generate app types.
now, we have switched to `ts-proto` but also kept js support by placing `.js` and `.d.ts` files next to the generated `.ts` files.

* refactored `nodetime` packaging.
* added more detailed info to `pkg/cosmosanalysis/module.Discover()` output.
* added more detailed info to `pkg/protoanalysis.DiscoverPackages()` output.
* added plugin binary configurability option to `pkg/protoc` pkg.
* improved `pkg/cosmosgen`'s public API.
* added `pkg/nodetime/tsc`, `pkg/nodetime/ts-proto` and removed `pkg/nodetime/protobufjs`.

* fix lint

* fix err check

* migrate wrapper to ts(-proto) and new version of cosmjs

* several code generation improvements made.

* feat(codegen): add code generation for dependency modules

optionally enable js related code code generation for the 3rd party modules -including the sdk- that used by an app.

* several improvements mode on code generation logic.

* fix lint & err checking

* fix go codegen

* scaffolding(stargate): add generated 3rd party js clients

* enable code gen for 3rd party modules on demand

* docs

* fix: add chain to path (ignite#802)

Co-authored-by: Alex Megalokonomos <[email protected]>

* chore: sync stargate scaffolding for new js gen path (ignite#803)

* feat: Updated vue template for codegen (ignite#807)

* feat: Updated vue template

* package.json fixes

* chrore(ui): update versions , add plain eslint config (ignite#812)

* feat: (codegen/vuex): add Vuex code generation & refactor (ignite#824)

* codegen(vuex): add Vuex code generation & refactor

code generation related packages.

* fix err handling & linter errors

* fix err handling

* fix msg discovery

* cosmosanalysis: add metadata about grpc gateway

* docs: fix typo

* fix linter err

* feat: provide more tpl data to loader & add user-side warnings (ignite#857)

* feat: provide more tpl data to loader & add user-side warnings

about not modifying generated dirs/files.

* cosmetic

* fix: Template updates (ignite#825)

* fix: Template updates

* feat: sendMsg*  actions, Msg* message creation

* feat: Add true Error()s

* fix: Change `chain` to `generated`

* fix: tsc ignore imported dependency

* Updated generated JS/TS for SDK modules

* feat: Add get all pages option to queries

* fiix: Pass all option to subscription

* feat: Add query returns from store

* WIP v0.15 Layout

* Regenerated JS/TS

* fix: stale state, return from getters

* Regenerated TS/JS

* JS Template changes

* Regenerated JS/TS

* Additional template changes

* fix: Template changes

* Regenerated TS/JS

* templates: sync pre generated js

Co-authored-by: Lucas Bertrand <[email protected]>
Co-authored-by: Alex Megalokonomos <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants