Skip to content

Update default option v2 #763

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.

Sign up for GitHub

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

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Update default option v2 #763

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
075ff33
Default option update
NorOldBurden May 5, 2025
07a6dde
Added readme
NorOldBurden May 5, 2025
789971a
removed extra files
NorOldBurden May 5, 2025
3aa0bb7
Resolved conflict
Aug 8, 2025
352b511
Fixed some transpile options
Aug 11, 2025
ebfa83c
Upgraded interchainjs version
Aug 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
43 changes: 29 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -532,12 +532,12 @@ telescope({
| option | description | defaults |
| ----------------------------------------- | -------------------------------------------------------------- | ---------- |
| `interfaces.enabled` | Enable converters between Any type and specific implemented interfaces | `true` |
| `interfaces.useGlobalDecoderRegistry` | Enable GlobalDecoderRegistry and related functions. Highly recommended when dealing with fields with 'accepted_interface' option. See 'packages/telescope/__tests__/impl-interfaces.test.ts' for usage. | `false` |
| `interfaces.useGlobalDecoderRegistry` | Enable GlobalDecoderRegistry and related functions. Highly recommended when dealing with fields with 'accepted_interface' option. See 'packages/telescope/__tests__/impl-interfaces.test.ts' for usage. | `true` |
| `interfaces.registerAllDecodersToGlobal` | Automatically register all decoders to the global registry | `true` |
| `interfaces.useUseInterfacesParams` | Add `useInterfaces` argument to `decode` and `toAmino` functions | `false` |
| `interfaces.useByDefault` | Use interface decoders by default (default for `useInterfaces` argument to `decode` and `toAmino` functions) | `true` |
| `interfaces.useByDefaultRpc` | Use interface decoders by default in RPC clients | `true` |
| `interfaces.useUnionTypes` | Generate Any type as union types (TextProposal \| RegisterIncentiveProposal) instead of intersection types (TextProposal & RegisterIncentiveProposal) | `false` |
| `interfaces.useUnionTypes` | Generate Any type as union types (TextProposal \| RegisterIncentiveProposal) instead of intersection types (TextProposal & RegisterIncentiveProposal) | `true` |

### Prototypes Options

Expand All @@ -563,7 +563,7 @@ telescope({
| `prototypes.addTypeUrlToObjects` | Add typeUrl field to generated Decoders | `true` |
| `prototypes.strictNullCheckForPrototypeMethods` | Enable strict null checks for prototype methods | `false` |
| `prototypes.paginationDefaultFromPartial` | Set default values for pagination in fromPartial methods | `false` |
| `prototypes.enableRegistryLoader` | Generate Registry loader in *.registry.ts files | `true` |
| `prototypes.enableRegistryLoader` | Generate Registry loader in *.registry.ts files | `false` |
| `prototypes.enableMessageComposer` | Generate MessageComposer in *.registry.ts files | `true` |
| `prototypes.patch` | Object mapping filenames to an array of `Operation` to be applied as patches to proto files during generation. See [JSON Patch Protos](#json-patch-protos) | `undefined` |

Expand All @@ -573,12 +573,16 @@ telescope({
| ---------------------------------- | ----------------------------------------------------------------- | ------- |
| `prototypes.methods.encode` | Enable `encode` method on proto objects | `true` |
| `prototypes.methods.decode` | Enable `decode` method on proto objects | `true` |
| `prototypes.methods.fromJSON` | Enable `fromJSON` method on proto objects | `true` |
| `prototypes.methods.toJSON` | Enable `toJSON` method on proto objects | `true` |
| `prototypes.methods.fromJSON` | Enable `fromJSON` method on proto objects | `false` |
| `prototypes.methods.toJSON` | Enable `toJSON` method on proto objects | `false` |
| `prototypes.methods.fromPartial` | Enable `fromPartial` method on proto objects | `true` |
| `prototypes.methods.fromSDK` | Enable `fromSDK` method on proto objects | `false` |
| `prototypes.methods.toSDK` | Enable `toSDK` method on proto objects | `false` |

| `prototypes.methods.fromSDKJSON` | boolean to enable `fromSDKJSON` method on proto objects | `false` |
| `prototypes.methods.toAmino` | boolean to enable `toAmino` method on proto objects | `true` |
| `prototypes.methods.fromAmino` | boolean to enable `fromAmino` method on proto objects | `true` |
| `prototypes.methods.toProto` | boolean to enable `toProto` method on proto objects | `true` |
| `prototypes.methods.fromProto` | boolean to enable `fromProto` method on proto objects | `true` |
### Enums Options

| option | description | defaults |
Expand All @@ -590,7 +594,7 @@ telescope({

| option | description | defaults |
| ------------------------------ | -------------------------------------------------------------- | ---------- |
| `lcdClients.enabled` | Generate LCD clients that can query proto `Query` messages | `true` |
| `lcdClients.enabled` | Generate LCD clients that can query proto `Query` messages | `false` |
| `lcdClients.bundle` | Generate factory bundle aggregate of all LCD Clients | `true` |
| `lcdClients.scoped` | Generate factory of scoped LCD Clients | `undefined`|
| `lcdClients.scopedIsExclusive` | Allow both scoped bundles and all RPC Clients | `true` |
Expand All @@ -612,7 +616,7 @@ See [LCD Clients](#lcd-clients) for more info.
| option | description | defaults |
| ------------------------------ | ---------------------------------------------------------------------- | ----------------------------- |
| `rpcClients.type` | Generate this type of RPC client (`tendermint`, `gRPC-web`, `gRPC`)| `tendermint` |
| `rpcClients.enabled` | Generate RPC clients that can interact with proto messages | `true` |
| `rpcClients.enabled` | Generate RPC clients that can interact with proto messages | `false` |
| `rpcClients.bundle` | Generate factory bundle aggregate of all RPC Clients | `true` |
| `rpcClients.inline` | Inline all RPC client methods into a single file | `false` |
| `rpcClients.extensions` | Enable extensions for RPC clients | `true` |
Expand All @@ -637,8 +641,8 @@ See [RPC Clients](#rpc-clients) for more info.

| Option | Description | Defaults |
| --------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------- |
| `helperFunctions.enabled` | Enable the generation of helper function files `.func.ts` | `false` |
| `helperFunctions.useGlobalDecoderRegistry` | Use global decoder registry in helper functions | `false` |
| `helperFunctions.enabled` | Enable the generation of helper function files `.func.ts` | `true` |
| `helperFunctions.useGlobalDecoderRegistry` | Use global decoder registry in helper functions | `true` |
| `helperFunctions.hooks` | Generates hooks selected alongside helper functions | `{ react: false, vue: false }` |
| `helperFunctions.include.serviceTypes`| Specifies which types of services to include (`Query`, `Msg`). `undefined` includes all types. | `undefined` |
| `helperFunctions.include.patterns` | Array of glob patterns patterns (e.g., `"**"`, `"cosmos.bank.v1beta1.bala*"`, etc.) to match specific proto services. | `undefined` |
Expand All @@ -656,8 +660,9 @@ See [Helper Functions Configuration](#helper-functions-configuration) for more i

| option | description | defaults |
| -------------------------------------------- | -------------------------------------------------------------- | ---------|
| `stargateClients.includeCosmosDefaultTypes` | Include the CosmJS defaults with stargate clients | `true` (except cosmos package) |
| `stargateClients.addGetTxRpc` | Add getSigningTxRpc to clients in namespaces | `false` |
| `stargateClients.enabled` | if true, will include the cosmjs defaults with stargate clients | `false` |
| `stargateClients.includeCosmosDefaultTypes` | if true, will include the cosmjs defaults with stargate clients | `true` (except cosmos package) |
| `stargateClients.addGetTxRpc` | if true, will add getSigningTxRpc to clients in namespaces | `false` |

### State Management

Expand Down Expand Up @@ -706,10 +711,10 @@ See [Helper Functions Configuration](#helper-functions-configuration) for more i
| `prototypes.typingsFormat.customTypes.useEnhancedDecimal` | Use patched decimal instead of decimal from @cosmjs/math | `false` |
| `prototypes.typingsFormat.customTypes.base64Lib` | Use endo/base64 methods | `undefined` |
| `prototypes.typingsFormat.num64` | 'long' or 'bigint', the way of generating int64 proto types. Set to 'bigint' to use more stable built-in type | `bigint` |
| `prototypes.typingsFormat.useTelescopeGeneratedType` | Discard GeneratedType from CosmJS, use TelescopeGeneratedType instead inside *.registry.ts files | `false` |
| `prototypes.typingsFormat.useTelescopeGeneratedType` | Discard GeneratedType from CosmJS, use TelescopeGeneratedType instead inside *.registry.ts files | `true` |
| `prototypes.typingsFormat.useDeepPartial` | Use `DeepPartial` type instead of `Partial` TS type | `false` |
| `prototypes.typingsFormat.useExact` | Use the `Exact` TS type | `false` |
| `prototypes.typingsFormat.toJsonUnknown` | Use `any` for `toJSON` methods instead of `JsonSafe` | `true` |
| `prototypes.typingsFormat.toJsonUnknown` | Use `any` for `toJSON` methods instead of `JsonSafe` | `false` |
| `prototypes.typingsFormat.timestamp` | Use either `date` or `timestamp` for `Timestamp` proto type | "date" |
| `prototypes.typingsFormat.duration` | Use either `duration` or `string` for `Duration` proto type | "duration"|
| `prototypes.typingsFormat.updatedDuration` | temporary field to avoid breaking changes | `false` |
Expand All @@ -721,6 +726,9 @@ See [Helper Functions Configuration](#helper-functions-configuration) for more i

| option | description | defaults |
| ----------------------------------------- | -------------------------------------------------------------- | --------- |
| `prototypes.parser.keepCase` | passes `keepCase` to protobuf `parse()` to keep original casing | `false` |
| `prototypes.parser.alternateCommentMode` | passes `alternateCommentMode` to protobuf `parse()` method | `true` |
| `prototypes.parser.preferTrailingComment` | passes `preferTrailingComment` to protobuf `parse()` method | `false` |
| `prototypes.parser.keepCase` | Pass `keepCase` to protobuf `parse()` to keep original casing | `true` |
| `prototypes.parser.alternateCommentMode` | Pass `alternateCommentMode` to protobuf `parse()` method | `true` |
| `prototypes.parser.preferTrailingComment` | Pass `preferTrailingComment` to protobuf `parse()` method | `false` |
Expand Down Expand Up @@ -766,6 +774,13 @@ See [MCP Integration](https://docs.hyperweb.io/telescope/developing/mcp-integrat

| option | description | defaults |
| ------------------------------ | ----------------------------------------------------------------- | ---------- |
| `env` | 'default' or 'v-next', set to 'v-next' to enable yet to release features | `v-next` |
| `useInterchainJs` | use interchain.js features | `true` |
| `removeUnusedImports` | removes unused imports | `true` |
| `classesUseArrowFunctions` | classes use arrow functions instead of `bind()`ing in constructors | `false` |
| `useSDKTypes` | use SDK types | `true` |
| `includeExternalHelpers` | exports a few helpers functions in `extern.ts` | `false` |
| `restoreImportExtension` | restore extensions of imported paths. e.g: '.js'. null means no ext | `null` |
| `env` | 'default' or 'v-next', set to 'v-next' to enable yet-to-be-released features | `default` |
| `removeUnusedImports` | Remove unused imports | `true` |
| `classesUseArrowFunctions` | Classes use arrow functions instead of `bind()`ing in constructors | `false` |
Expand Down
55 changes: 35 additions & 20 deletions __fixtures__/misc/enforce-null-check-true/extern.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,30 +4,45 @@
* and run the transpile command or npm scripts command that is used to regenerate this bundle.
*/

import { QueryClient, createProtobufRpcClient, ProtobufRpcClient } from '@cosmjs/stargate'
import { Tendermint34Client, HttpEndpoint } from "@cosmjs/tendermint-rpc";

const _rpcClients: Record<string, ProtobufRpcClient> = {};
import { HttpEndpoint } from "@interchainjs/types";
import { Rpc } from "./helpers";
import { ClientOptions, createCosmosQueryClient } from "@interchainjs/cosmos";

const _rpcClients: Record<string, Rpc> = {};

export const getRpcEndpointKey = (rpcEndpoint: string | HttpEndpoint) => {
if (typeof rpcEndpoint === 'string') {
return rpcEndpoint;
} else if (!!rpcEndpoint) {
//@ts-ignore
return rpcEndpoint.url;
}
if (typeof rpcEndpoint === 'string') {
return rpcEndpoint;
} else if (!!rpcEndpoint) {
//@ts-ignore
return rpcEndpoint.url;
}
}

export const getRpcClient = async (rpcEndpoint: string | HttpEndpoint) => {
const key = getRpcEndpointKey(rpcEndpoint);
if (!key) return;
if (_rpcClients.hasOwnProperty(key)) {
return _rpcClients[key];
}
const tmClient = await Tendermint34Client.connect(rpcEndpoint);
//@ts-ignore
const client = new QueryClient(tmClient);
const rpc = createProtobufRpcClient(client);
_rpcClients[key] = rpc;
return rpc;
const key = getRpcEndpointKey(rpcEndpoint);
if (!key) return;
if (_rpcClients.hasOwnProperty(key)) {
return _rpcClients[key];
}
const rpc = await createRpcClient(rpcEndpoint);
_rpcClients[key] = rpc;
return rpc;
}

export const createRpcClient = async (rpcEndpoint: string | HttpEndpoint,
options?: ClientOptions
) => {
if (typeof rpcEndpoint === 'string') {
return createCosmosQueryClient(rpcEndpoint, options);
} else {
const endpointStr = rpcEndpoint.url;
const clientOptions = {
...options,
headers: rpcEndpoint.headers
};

return createCosmosQueryClient(endpointStr, clientOptions);
}
}
4 changes: 2 additions & 2 deletions __fixtures__/misc/enforce-null-check-true/gogoproto/bundle.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import * as _100 from "./gogo";
import * as _108 from "./gogo";
export const gogoproto = {
..._100
..._108
};
20 changes: 10 additions & 10 deletions __fixtures__/misc/enforce-null-check-true/google/bundle.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
import * as _101 from "./api/expr/v1alpha1/eval";
import * as _102 from "./protobuf/any";
import * as _103 from "./protobuf/descriptor";
import * as _104 from "./protobuf/duration";
import * as _105 from "./protobuf/timestamp";
import * as _109 from "./api/expr/v1alpha1/eval";
import * as _110 from "./protobuf/any";
import * as _111 from "./protobuf/descriptor";
import * as _112 from "./protobuf/duration";
import * as _113 from "./protobuf/timestamp";
export namespace google {
export namespace api {
export namespace expr {
export const v1alpha1 = {
..._101
..._109
};
}
}
export const protobuf = {
..._102,
..._103,
..._104,
..._105
..._110,
..._111,
..._112,
..._113
};
}
Loading
Loading