Merge pull request #612 from InjectiveLabs/fix/grpc-options-parameter

fix: allow passing grpc options into client classes

Author: ThomasRalee

packages/exceptions/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@injectivelabs/exceptions",
-  "version": "1.17.2",
+  "version": "1.17.3-alpha.0",
   "description": "List of exceptions that can be reused throughout Injective's projects.",
   "license": "Apache-2.0",
   "author": {

packages/networks/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@injectivelabs/networks",
-  "version": "1.17.2",
+  "version": "1.17.3-alpha.0",
   "description": "Endpoints, networks, etc. Can be reused throughout Injective's projects.",
   "license": "Apache-2.0",
   "author": {

packages/sdk-ts/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@injectivelabs/sdk-ts",
-  "version": "1.17.2",
+  "version": "1.17.3-alpha.0",
   "description": "SDK in TypeScript for building Injective applications in a browser, node, and react native environment.",
   "license": "Apache-2.0",
   "author": {

packages/sdk-ts/src/client/abacus/grpc/AbacusGrpcApi.ts

@@ -6,11 +6,9 @@ import { AbacusGrpcTransformer } from './transformers/index.js'
 
 export class AbacusGrpcApi extends BaseGrpcConsumer {
   protected module: string = IndexerErrorModule.Abacus
-  private client: PointsSvcClient
 
-  constructor(endpoint: string) {
-    super(endpoint)
-    this.client = new PointsSvcClient(this.transport)
+  private get client() {
+    return this.initClient(PointsSvcClient)
   }
 
   async fetchAccountLatestPoints(address: string) {

packages/sdk-ts/src/client/base/BaseGrpcConsumer.ts

@@ -7,43 +7,80 @@ import {
 } from '@injectivelabs/exceptions'
 import { GrpcWebRpcTransport } from './GrpcWebRpcTransport.js'
 import type { UnaryCall, RpcOptions } from '@protobuf-ts/runtime-rpc'
+import type { GrpcWebTransportAdditionalOptions } from '../../types'
 
 /**
  * BaseGrpcConsumer provides base functionality for all gRPC consumers.
  * It uses the GrpcWebRpcTransport with GrpcWebFetchTransport from @protobuf-ts/grpcweb-transport.
  */
 export default class BaseGrpcConsumer {
-  protected transport: GrpcWebRpcTransport
+  private _client: unknown
+  protected endpoint: string
   protected module: string = ''
+  protected transport: GrpcWebRpcTransport
   protected metadata?: Record<string, string>
-  protected endpoint: string
+  protected options?: GrpcWebTransportAdditionalOptions
 
-  constructor(endpoint: string) {
+  constructor(endpoint: string, options?: GrpcWebTransportAdditionalOptions) {
+    this.options = options
     this.endpoint = endpoint
-    this.transport = new GrpcWebRpcTransport(endpoint, {
-      headers: {},
-    })
+    this.transport = new GrpcWebRpcTransport(endpoint, options)
   }
 
+  /**
+   * @deprecated Pass options into the constructor instead
+   */
   public setMetadata(map: Record<string, string>) {
     this.metadata = map
-    // Recreate transport with new metadata
+    // Recreate transport with new metadata, preserving existing options
     this.transport = new GrpcWebRpcTransport(this.endpoint, {
-      headers: this.metadata,
+      ...this.options,
+      meta: this.metadata,
     })
+
+    // Invalidate cached client so initClient creates a new client with updated transport
+    this._client = undefined
+
     return this
   }
 
+  /**
+   * @deprecated Manage options within the constructor instead
+   */
   public clearMetadata() {
     this.metadata = undefined
+    // Recreate transport without metadata, preserving existing options
+    this.transport = new GrpcWebRpcTransport(this.endpoint, this.options)
+    // Invalidate cached client so initClient creates a new client with updated transport
+    this._client = undefined
   }
 
   public getTransport(): GrpcWebRpcTransport {
     return this.transport
   }
 
+  /**
+   * Lazily initializes and returns the gRPC client.
+   * Call this from a getter in subclasses to avoid constructor boilerplate.
+   *
+   * @example
+   * private get client() {
+   *   return this.initClient(MyGrpcClient)
+   * }
+   */
+  protected initClient<TClient>(
+    ClientClass: new (transport: GrpcWebRpcTransport) => TClient,
+  ): TClient {
+    if (!this._client) {
+      this._client = new ClientClass(this.transport)
+    }
+
+    return this._client as TClient
+  }
+
   /**
    * Builds RpcOptions with metadata
+   * @deprecated Options should be managed externally and passed into the constructor instead
    */
   protected getRpcOptions(): RpcOptions {
     const options: RpcOptions = {

packages/sdk-ts/src/client/base/GrpcWebRpcTransport.ts

@@ -8,6 +8,7 @@ import type {
   ClientStreamingCall,
   DuplexStreamingCall,
 } from '@protobuf-ts/runtime-rpc'
+import type { GrpcWebTransportAdditionalOptions } from '../../types'
 
 /**
  * GrpcWebRpcTransport provides a simple wrapper around GrpcWebFetchTransport
@@ -18,15 +19,7 @@ import type {
 export class GrpcWebRpcTransport implements RpcTransport {
   private transport: RpcTransport
 
-  constructor(
-    baseUrl: string,
-    options?: {
-      fetch?: typeof fetch
-      headers?: Record<string, string>
-      timeout?: number
-      credentials?: RequestCredentials
-    },
-  ) {
+  constructor(baseUrl: string, options?: GrpcWebTransportAdditionalOptions) {
     this.transport = getGrpcWebTransport(baseUrl, options)
   }
 

packages/sdk-ts/src/client/chain/grpc/ChainGrpcAuctionApi.ts

@@ -3,19 +3,14 @@ import { QueryClient as InjectiveAuctionV1Beta1QueryClient } from '@injectivelab
 import { ChainModule } from '../types/index.js'
 import BaseGrpcConsumer from '../../base/BaseGrpcConsumer.js'
 import { ChainGrpcAuctionTransformer } from '../transformers/index.js'
-
 /**
  * @category Chain Grpc API
  */
 export class ChainGrpcAuctionApi extends BaseGrpcConsumer {
   protected module: string = ChainModule.Auction
 
-  private client: InjectiveAuctionV1Beta1QueryClient
-
-  constructor(endpoint: string) {
-    super(endpoint)
-
-    this.client = new InjectiveAuctionV1Beta1QueryClient(this.transport)
+  private get client() {
+    return this.initClient(InjectiveAuctionV1Beta1QueryClient)
   }
 
   async fetchModuleParams() {

packages/sdk-ts/src/client/chain/grpc/ChainGrpcAuthApi.ts

@@ -5,17 +5,14 @@ import BaseGrpcConsumer from '../../base/BaseGrpcConsumer.js'
 import { ChainGrpcAuthTransformer } from '../transformers/ChainGrpcAuthTransformer.js'
 import { ChainGrpcCommonTransformer } from '../transformers/ChainGrpcCommonTransformer.js'
 import type { PaginationOption } from '../../../types/pagination.js'
-
 /**
  * @category Chain Grpc API
  */
 export class ChainGrpcAuthApi extends BaseGrpcConsumer {
   protected module: string = ChainModule.Auth
-  private client: CosmosAuthV1BetaQueryClient
 
-  constructor(endpoint: string) {
-    super(endpoint)
-    this.client = new CosmosAuthV1BetaQueryClient(this.transport)
+  private get client() {
+    return this.initClient(CosmosAuthV1BetaQueryClient)
   }
 
   async fetchModuleParams() {

packages/sdk-ts/src/client/chain/grpc/ChainGrpcAuthZApi.ts

@@ -5,17 +5,14 @@ import BaseGrpcConsumer from '../../base/BaseGrpcConsumer.js'
 import { ChainGrpcAuthZTransformer } from '../transformers/ChainGrpcAuthZTransformer.js'
 import { ChainGrpcCommonTransformer } from '../transformers/ChainGrpcCommonTransformer.js'
 import type { PaginationOption } from '../../../types/pagination.js'
-
 /**
  * @category Chain Grpc API
  */
 export class ChainGrpcAuthZApi extends BaseGrpcConsumer {
   protected module: string = ChainModule.Authz
-  private client: CosmosAuthzV1BetaQueryClient
 
-  constructor(endpoint: string) {
-    super(endpoint)
-    this.client = new CosmosAuthzV1BetaQueryClient(this.transport)
+  private get client() {
+    return this.initClient(CosmosAuthzV1BetaQueryClient)
   }
 
   async fetchGrants({

packages/sdk-ts/src/client/chain/grpc/ChainGrpcBankApi.ts

@@ -6,19 +6,16 @@ import { ChainGrpcBankTransformer } from '../transformers/index.js'
 import { fetchAllWithPagination } from '../../../utils/pagination.js'
 import { ChainGrpcCommonTransformer } from '../transformers/ChainGrpcCommonTransformer.js'
 import type { PaginationOption } from '../../../types/pagination.js'
-
 const MAX_LIMIT_FOR_SUPPLY = 10000
 
 /**
  * @category Chain Grpc API
  */
 export class ChainGrpcBankApi extends BaseGrpcConsumer {
   protected module: string = ChainModule.Bank
-  private client: CosmosBankV1BetaQueryClient
 
-  constructor(endpoint: string) {
-    super(endpoint)
-    this.client = new CosmosBankV1BetaQueryClient(this.transport)
+  private get client() {
+    return this.initClient(CosmosBankV1BetaQueryClient)
   }
 
   async fetchModuleParams() {