first release

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jackallabs/banshee",
-  "version": "0.0.0-rc.6",
+  "version": "0.1.0",
   "description": "Modern problems require modern solutions",
   "keywords": [],
   "exports": {

src/classes/ibcQueryClient.ts

@@ -4,7 +4,8 @@ import { connectComet } from '@cosmjs/tendermint-rpc'
 import { processExtensions } from '@/utils/extensions'
 import { WebsocketCore } from '@/classes'
 import {
-  IExtendedStargateClientOptions, IIbcDeafenBundle,
+  IExtendedStargateClientOptions,
+  IIbcDeafenBundle,
   IIbcDisengageBundle,
   IIbcEngageBundle,
   IIbcQueryClient,
@@ -15,7 +16,10 @@ import type { TPossibleTxEvents, TQueryLibrary } from '@/types'
 /**
  * @class {IIbcQueryClient} IbcQueryClient
  */
-export class IbcQueryClient<TQ extends TQueryLibrary> extends StargateClient implements IIbcQueryClient<TQ> {
+export class IbcQueryClient<TQ extends TQueryLibrary>
+  extends StargateClient
+  implements IIbcQueryClient<TQ>
+{
   public readonly queries: TQ
   protected readonly wsCore: IWebsocketCore
 

src/classes/ibcSigningClient.ts

@@ -1,10 +1,10 @@
-import {SigningStargateClient} from '@cosmjs/stargate'
-import {CometClient, connectComet} from '@cosmjs/tendermint-rpc'
-import {createDefaultRegistry} from '@/utils/registry'
-import {processExtensions} from '@/utils/extensions'
-import {WebsocketCore} from '@/classes'
-import type {OfflineSigner} from '@cosmjs/launchpad'
-import type {ISignAndBroadcastOptions} from '@/interfaces/ISignAndBroadcastOptions'
+import { SigningStargateClient } from '@cosmjs/stargate'
+import { CometClient, connectComet } from '@cosmjs/tendermint-rpc'
+import { createDefaultRegistry } from '@/utils/registry'
+import { processExtensions } from '@/utils/extensions'
+import { WebsocketCore } from '@/classes'
+import type { OfflineSigner } from '@cosmjs/launchpad'
+import type { ISignAndBroadcastOptions } from '@/interfaces/ISignAndBroadcastOptions'
 import type {
   DDeliverTxResponse,
   DEncodeObject,
@@ -14,87 +14,92 @@ import type {
   TTxLibrary
 } from '@/types'
 import {
-    IExtendedSigningStargateClientOptions, IIbcDeafenBundle,
-    IIbcDisengageBundle,
-    IIbcEngageBundle,
-    IIbcSigningClient,
-    IWebsocketCore
+  IExtendedSigningStargateClientOptions,
+  IIbcDeafenBundle,
+  IIbcDisengageBundle,
+  IIbcEngageBundle,
+  IIbcSigningClient,
+  IWebsocketCore
 } from '@/interfaces'
 
 /**
  * @class {IIbcSigningClient} IbcSigningClient
  */
 export class IbcSigningClient<TQ extends TQueryLibrary, TT extends TTxLibrary>
-    extends SigningStargateClient
-    implements IIbcSigningClient<TQ, TT> {
-    public readonly queries: TQ
-    public readonly txLibrary: TT
-    protected readonly address: string
-    protected readonly wsCore: IWebsocketCore
+  extends SigningStargateClient
+  implements IIbcSigningClient<TQ, TT>
+{
+  public readonly queries: TQ
+  public readonly txLibrary: TT
+  protected readonly address: string
+  protected readonly wsCore: IWebsocketCore
 
-    protected constructor(
-        tmClient: CometClient,
-        signer: OfflineSigner,
-        address: string,
-        options: IExtendedSigningStargateClientOptions,
-    ) {
-        super(tmClient, signer, options)
-        const {queryExtensions = [], txLibrary = {}} = options
-        this.address = address
-        this.queries = processExtensions(tmClient, queryExtensions) as TQ
-        this.txLibrary = txLibrary as TT
-        this.wsCore = new WebsocketCore()
-    }
+  protected constructor(
+    tmClient: CometClient,
+    signer: OfflineSigner,
+    address: string,
+    options: IExtendedSigningStargateClientOptions,
+  ) {
+    super(tmClient, signer, options)
+    const { queryExtensions = [], txLibrary = {} } = options
+    this.address = address
+    this.queries = processExtensions(tmClient, queryExtensions) as TQ
+    this.txLibrary = txLibrary as TT
+    this.wsCore = new WebsocketCore()
+  }
 
-    /**
-     * @function connectWithSigner
-     * @memberof IbcSigningClient
-     * @async
-     * @static
-     */
-    public static async connectWithSigner<TQ extends TQueryLibrary, TT extends TTxLibrary> (
-      endpoint: string | DHttpEndpoint,
-      signer: OfflineSigner,
-      options: IExtendedSigningStargateClientOptions = {},
-    ): Promise<IIbcSigningClient<TQ, TT>> {
-        try {
-            const client = await connectComet(endpoint)
-            const {address} = (await signer.getAccounts())[0]
-            const {customModules = []} = options
-            return new IbcSigningClient<TQ, TT>(client, signer, address, {
-                registry: createDefaultRegistry(customModules),
-                ...options,
-            })
-        } catch (err) {
-            throw err
-        }
+  /**
+   * @function connectWithSigner
+   * @memberof IbcSigningClient
+   * @async
+   * @static
+   */
+  public static async connectWithSigner<
+    TQ extends TQueryLibrary,
+    TT extends TTxLibrary,
+  >(
+    endpoint: string | DHttpEndpoint,
+    signer: OfflineSigner,
+    options: IExtendedSigningStargateClientOptions = {},
+  ): Promise<IIbcSigningClient<TQ, TT>> {
+    try {
+      const client = await connectComet(endpoint)
+      const { address } = (await signer.getAccounts())[0]
+      const { customModules = [] } = options
+      return new IbcSigningClient<TQ, TT>(client, signer, address, {
+        registry: createDefaultRegistry(customModules),
+        ...options,
+      })
+    } catch (err) {
+      throw err
     }
+  }
 
-    async monitor<T extends TPossibleTxEvents>(
-        connections: IIbcEngageBundle<T> | IIbcEngageBundle<T>[],
-    ): Promise<void> {
-        await this.wsCore.monitor(connections)
-    }
+  async monitor<T extends TPossibleTxEvents>(
+    connections: IIbcEngageBundle<T> | IIbcEngageBundle<T>[],
+  ): Promise<void> {
+    await this.wsCore.monitor(connections)
+  }
 
-    disengage(connections: IIbcDisengageBundle | IIbcDisengageBundle[]): void {
-        this.wsCore.disengage(connections)
-    }
+  disengage(connections: IIbcDisengageBundle | IIbcDisengageBundle[]): void {
+    this.wsCore.disengage(connections)
+  }
 
-    deafen(connection: IIbcDeafenBundle): void {
-        this.wsCore.deafen(connection)
-    }
+  deafen(connection: IIbcDeafenBundle): void {
+    this.wsCore.deafen(connection)
+  }
 
-    async selfSignAndBroadcast(
-        msgs: DEncodeObject[],
-        options: ISignAndBroadcastOptions = {},
-    ): Promise<DDeliverTxResponse> {
-        const {fee, memo, timeoutHeight} = {
-            fee: {
-                amount: [],
-                gas: (msgs.length * 100000).toString(),
-            },
-            ...options,
-        }
-        return this.signAndBroadcast(this.address, msgs, fee, memo, timeoutHeight)
+  async selfSignAndBroadcast(
+    msgs: DEncodeObject[],
+    options: ISignAndBroadcastOptions = {},
+  ): Promise<DDeliverTxResponse> {
+    const { fee, memo, timeoutHeight } = {
+      fee: {
+        amount: [],
+        gas: (msgs.length * 100000).toString(),
+      },
+      ...options,
     }
+    return this.signAndBroadcast(this.address, msgs, fee, memo, timeoutHeight)
+  }
 }

src/classes/websocketCore.ts

@@ -2,7 +2,12 @@ import type { CometClient } from '@cosmjs/tendermint-rpc'
 import { connectComet } from '@cosmjs/tendermint-rpc'
 import type { Stream } from 'xstream'
 import type { TPossibleTxEvents } from '@/types'
-import { IIbcDeafenBundle, IIbcDisengageBundle, IIbcEngageBundle, IWebsocketCore } from '@/interfaces'
+import {
+  IIbcDeafenBundle,
+  IIbcDisengageBundle,
+  IIbcEngageBundle,
+  IWebsocketCore,
+} from '@/interfaces'
 
 export class WebsocketCore implements IWebsocketCore {
   protected readonly wsConnections: Record<string, CometClient>
@@ -35,25 +40,34 @@ export class WebsocketCore implements IWebsocketCore {
         delete this.activeStreams[`${conn.chainId}|${conn.query || 'all'}`]
       }
     } else {
-      delete this.activeStreams[`${connections.chainId}|${connections.query || 'all'}`]
+      delete this.activeStreams[
+        `${connections.chainId}|${connections.query || 'all'}`
+      ]
     }
   }
 
   deafen(connection: IIbcDeafenBundle): void {
-    this.activeStreams[`${connection.chainId}|${connection.query || 'all'}`].removeListener(connection.listener)
+    this.activeStreams[
+      `${connection.chainId}|${connection.query || 'all'}`
+    ].removeListener(connection.listener)
   }
 
-  protected async setupMonitoring<T extends TPossibleTxEvents>(conn: IIbcEngageBundle<T>) {
+  protected async setupMonitoring<T extends TPossibleTxEvents>(
+    conn: IIbcEngageBundle<T>,
+  ) {
     if (!this.wsConnections[conn.chainId]) {
       this.wsConnections[conn.chainId] = await connectComet(conn.endpoint)
     }
     const client = this.wsConnections[conn.chainId]
     const streamId = `${conn.chainId}|${conn.query || 'all'}`
     if (!this.activeStreams[streamId]) {
       if (conn.query) {
-        this.activeStreams[streamId] = client.subscribeTx(conn.query) as Stream<TPossibleTxEvents>
+        this.activeStreams[streamId] = client.subscribeTx(
+          conn.query,
+        ) as Stream<TPossibleTxEvents>
       } else {
-        this.activeStreams[streamId] = client.subscribeTx() as Stream<TPossibleTxEvents>
+        this.activeStreams[streamId] =
+          client.subscribeTx() as Stream<TPossibleTxEvents>
       }
     }
     this.activeStreams[streamId].addListener(conn.listener)

src/global.d.ts

@@ -172,7 +172,7 @@ type Modify<T, R extends PartialAny<T>> = Omit<T, keyof R> & R
 
 type ModifyDeep<A, B extends DeepPartialAny<A>> = {
   // https://stackoverflow.com/a/74216680/985454
-  [K in keyof A | keyof B]: /**/ K extends keyof A // For all keys in A and B: ... // ───┐
+  [K in keyof A | keyof B /**/]: K extends keyof A // For all keys in A and B: ... // ───┐
     ? /**/ K extends keyof B // ───n ─ y ? key K exists in both A and B ...
       ? /*  */ A[K] extends AnyObject //    │  ─┴──┐
         ? /*  */ B[K] extends AnyObject //    │  ─── n ─ y ? both A and B are objects ...
@@ -187,7 +187,7 @@ type ModifyDeep<A, B extends DeepPartialAny<A>> = {
 
 type ModifyDeep1<A, B extends DeepPartialAny<A>> = {
   // https://stackoverflow.com/a/74216680/985454
-  [K in keyof A | keyof B]: /**/ K extends keyof A // For all keys in A and B: ... // ───┐
+  [K in keyof A | keyof B /**/]: K extends keyof A // For all keys in A and B: ... // ───┐
     ? /* */ K extends keyof B // ── n ─ y ? key K exists in both A and B ...
       ? /*   */ A[K] extends AnyObject //    │  ─┴──┐
         ? /*     */ B[K] extends AnyObject //    │  ─── n ─ y ? both A and B are objects ...

src/interfaces/classes/IIbcQueryClient.ts

@@ -1,11 +1,13 @@
-import type {IWebsocketCore} from '@/interfaces'
-import type {StargateClient} from '@cosmjs/stargate'
-import type {TQueryLibrary} from "@/types";
+import type { IWebsocketCore } from '@/interfaces'
+import type { StargateClient } from '@cosmjs/stargate'
+import type { TQueryLibrary } from '@/types'
 
 /**
  * @interface IIbcQueryClient
  * @extends StargateClient - [More here](https://cosmos.github.io/cosmjs/latest/stargate/classes/StargateClient.html)
  */
-export interface IIbcQueryClient<TQ extends TQueryLibrary> extends StargateClient, IWebsocketCore {
-    readonly queries: TQ
+export interface IIbcQueryClient<TQ extends TQueryLibrary>
+  extends StargateClient,
+    IWebsocketCore {
+  readonly queries: TQ
 }

src/interfaces/classes/IIbcSigningClient.ts

@@ -1,6 +1,6 @@
-import type {SigningStargateClient} from '@cosmjs/stargate'
+import type { SigningStargateClient } from '@cosmjs/stargate'
 import type { DDeliverTxResponse, DEncodeObject, TQueryLibrary, TTxLibrary } from '@/types'
-import type {ISignAndBroadcastOptions, IWebsocketCore} from '@/interfaces'
+import type { ISignAndBroadcastOptions, IWebsocketCore } from '@/interfaces'
 
 /**
  * @interface IIbcSigningClient
@@ -9,20 +9,22 @@ import type {ISignAndBroadcastOptions, IWebsocketCore} from '@/interfaces'
  * @property {TTxLibrary} txLibrary
  * @property {selfSignAndBroadcast} selfSignAndBroadcast
  */
-export interface IIbcSigningClient<TQ extends TQueryLibrary, TT extends TTxLibrary>
-  extends SigningStargateClient,
+export interface IIbcSigningClient<
+  TQ extends TQueryLibrary,
+  TT extends TTxLibrary,
+> extends SigningStargateClient,
     IWebsocketCore {
-    readonly queries: TQ
-    readonly txLibrary: TT
+  readonly queries: TQ
+  readonly txLibrary: TT
 
-    /**
-     * @function selfSignAndBroadcast
-     * @param {DEncodeObject[]} msgs
-     * @param {ISignAndBroadcastOptions} [options]
-     * @returns Promise<DDeliverTxResponse>
-     */
-    selfSignAndBroadcast(
-        msgs: DEncodeObject[],
-        options?: ISignAndBroadcastOptions,
-    ): Promise<DDeliverTxResponse>
+  /**
+   * @function selfSignAndBroadcast
+   * @param {DEncodeObject[]} msgs
+   * @param {ISignAndBroadcastOptions} [options]
+   * @returns Promise<DDeliverTxResponse>
+   */
+  selfSignAndBroadcast(
+    msgs: DEncodeObject[],
+    options?: ISignAndBroadcastOptions,
+  ): Promise<DDeliverTxResponse>
 }