@0xobelisk/sui-client 1.1.5 → 1.1.7

package/dist/libs/http/http.d.ts

@@ -1,4 +1,5 @@
 import { WebSocketInstance } from './ws-adapter';
+import { SubscribableType } from '../../types';
 export type FetchOptions = RequestInit & {
     next?: {
         revalidate?: boolean | number;
@@ -17,5 +18,5 @@ export declare class Http {
         query: string;
         variables?: any;
     }): Promise<T>;
-    subscribe(names: string[], handleData: (data: any) => void): Promise<WebSocketInstance>;
+    subscribe(types: SubscribableType[], handleData: (data: any) => void): Promise<WebSocketInstance>;
 }

package/dist/libs/suiIndexerClient/index.d.ts

@@ -1,8 +1,13 @@
 import { Http } from '../http';
+import { SubscribableType } from '../../types';
 export interface OrderDirection {
     ASC: 'ASC';
     DESC: 'DESC';
 }
+export declare enum SubscriptionKind {
+    Event = "event",
+    Schema = "schema"
+}
 export interface PageInfo {
     hasNextPage: boolean;
     endCursor?: string;
@@ -11,6 +16,7 @@ export interface IndexerTransaction {
     id: number;
     checkpoint: number;
     digest: string;
+    sender: string;
     created_at: string;
 }
 export interface IndexerSchema {
@@ -30,6 +36,7 @@ export interface IndexerEvent {
     checkpoint: string;
     digest: string;
     name: string;
+    sender: string;
     value: any;
     created_at: string;
 }
@@ -58,6 +65,8 @@ export declare class SuiIndexerClient {
     getTransactions(params?: {
         first?: number;
         after?: string;
+        sender?: string;
+        digest?: string;
         checkpoint?: number;
         orderBy?: string[];
     }): Promise<ConnectionResponse<IndexerTransaction>>;
@@ -77,6 +86,8 @@ export declare class SuiIndexerClient {
         first?: number;
         after?: string;
         name?: string;
+        sender?: string;
+        digest?: string;
         checkpoint?: string;
         orderBy?: string[];
     }): Promise<ConnectionResponse<IndexerEvent>>;
@@ -101,5 +112,5 @@ export declare class SuiIndexerClient {
         last_update_digest?: string;
         value?: any;
     }): Promise<StorageItemResponse<IndexerSchema> | undefined>;
-    subscribe(names: string[], handleData: (data: any) => void): Promise<WebSocket>;
+    subscribe(types: SubscribableType[], handleData: (data: any) => void): Promise<WebSocket>;
 }

package/dist/types/index.d.ts

@@ -6,6 +6,7 @@ import type { SuiMoveNormalizedModules, DevInspectResults, SuiTransactionBlockRe
 import { SuiTx } from '../libs/suiTxBuilder';
 import { SuiMoveMoudleFuncType } from '../libs/suiContractFactory/types';
 import { FetchOptions } from '../libs/http';
+import { SubscriptionKind } from '../libs/suiIndexerClient';
 export declare const ObjectContentFields: import("superstruct").Struct<Record<string, any>, null>;
 export type ObjectContentFields = Infer<typeof ObjectContentFields>;
 export type DubheObjectData = {
@@ -206,4 +207,12 @@ export type ObjectContent = {
     dataType: string;
 };
 export type SuiDubheReturnType<T extends boolean> = T extends true ? SuiTransactionBlockResponse : SuiTx;
+export type SubscribableType = {
+    kind: SubscriptionKind.Event;
+    name?: string;
+    sender?: string;
+} | {
+    kind: SubscriptionKind.Schema;
+    name?: string;
+};
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@0xobelisk/sui-client",
-  "version": "1.1.5",
+  "version": "1.1.7",
   "description": "Tookit for interacting with move eps framework",
   "keywords": [
     "sui",
@@ -70,19 +70,19 @@
     "@typescript-eslint/eslint-plugin": "^6.8.0",
     "@typescript-eslint/parser": "^6.8.0",
     "dotenv": "^16.3.1",
-    "eslint": "^8.52.0",
-    "eslint-config-prettier": "^8.8.0",
     "eslint-plugin-prettier": "^5.0.1",
     "graphql-ws": "^6.0.2",
     "jest": "^29.7.0",
     "lint-staged": "^15.0.2",
-    "prettier": "^2.8.8",
     "ts-node": "^10.9.1",
     "tsconfig-paths": "^4.2.0",
     "tsup": "^7.1.0",
     "typedoc": "^0.25.2",
     "typescript": "^5.2.2",
-    "@types/ws": "^8.5.14"
+    "@types/ws": "^8.5.14",
+    "eslint": "^8.56.0",
+    "eslint-config-prettier": "^9.1.0",
+    "prettier": "3.3.3"
   },
   "lint-staged": {
     "**/*.ts": [
@@ -154,8 +154,9 @@
     "lint:fix": "eslint . --ignore-pattern dist --ext .ts --fix",
     "commit": "commit",
     "doc": "typedoc --out docs src/index.ts",
-    "chalk": "^5.0.1",
-    "prettier": "^2.8.4",
-    "prettier-plugin-rust": "^0.1.9"
+    "format": "prettier --write .",
+    "format:check": "prettier --check .",
+    "type-check": "tsc --noEmit",
+    "validate": "pnpm format:check && pnpm type-check"
   }
 }

package/src/dubhe.ts

@@ -28,6 +28,7 @@ import {
   SuiTxArg,
   SuiObjectArg,
   SuiVecTxArg,
+  SubscribableType,
 } from './types';
 import {
   convertHttpToWebSocket,
@@ -1120,15 +1121,24 @@ export class Dubhe {
   async getTransactions({
     first,
     after,
+    sender,
+    digest,
+    checkpoint,
     orderBy,
   }: {
     first?: number;
     after?: string;
+    sender?: string;
+    digest?: string;
+    checkpoint?: number;
     orderBy?: string[];
   }): Promise<ConnectionResponse<IndexerTransaction>> {
     return await this.suiIndexerClient.getTransactions({
       first,
       after,
+      sender,
+      digest,
+      checkpoint,
       orderBy,
     });
   }
@@ -1137,12 +1147,16 @@ export class Dubhe {
     first,
     after,
     name,
+    sender,
+    digest,
     checkpoint,
     orderBy,
   }: {
     first?: number;
     after?: string;
     name?: string;
+    sender?: string;
+    digest?: string;
     checkpoint?: string;
     orderBy?: string[];
   }): Promise<ConnectionResponse<IndexerEvent>> {
@@ -1150,6 +1164,8 @@ export class Dubhe {
       first,
       after,
       name,
+      sender,
+      digest,
       checkpoint,
       orderBy,
     });
@@ -1259,10 +1275,10 @@ export class Dubhe {
   }
 
   async subscribe(
-    names: string[],
+    types: SubscribableType[],
     handleData: (data: any) => void
   ): Promise<WebSocket> {
-    return this.suiIndexerClient.subscribe(names, handleData);
+    return this.suiIndexerClient.subscribe(types, handleData);
   }
 
   #processKeyParameter(tx: Transaction, keyType: string, value: any) {

package/src/index.ts

@@ -11,5 +11,6 @@ export { SuiAccountManager } from './libs/suiAccountManager';
 export { SuiTx } from './libs/suiTxBuilder';
 export { MultiSigClient } from './libs/multiSig';
 export { SuiContractFactory } from './libs/suiContractFactory';
+export { SubscriptionKind } from './libs/suiIndexerClient';
 export { loadMetadata } from './metadata';
 export type * from './types';

package/src/libs/http/errors.ts

@@ -1,5 +1,9 @@
 export class BaseError extends Error {
-  constructor(message: string, public code: number, public type: string) {
+  constructor(
+    message: string,
+    public code: number,
+    public type: string
+  ) {
     super(message);
     this.name = this.constructor.name;
   }

package/src/libs/http/http.ts

@@ -1,5 +1,6 @@
 import { BaseError, HttpError, GraphQLError, ParseError } from './errors';
 import { createWebSocketClient, WebSocketInstance } from './ws-adapter';
+import { SubscribableType } from '../../types';
 
 export type FetchOptions = RequestInit & {
   next?: {
@@ -122,17 +123,14 @@ export class Http {
   }
 
   async subscribe(
-    names: string[],
+    types: SubscribableType[],
     handleData: (data: any) => void
   ): Promise<WebSocketInstance> {
     const ws = createWebSocketClient(this.wsEndpoint);
 
     ws.onopen = () => {
       console.log('Connected to the WebSocket server');
-      const subscribeMessage = JSON.stringify({
-        type: 'subscribe',
-        names: names,
-      });
+      const subscribeMessage = JSON.stringify(types);
       ws.send(subscribeMessage);
     };
 

package/src/libs/suiIndexerClient/index.ts

@@ -1,11 +1,17 @@
 import { Http } from '../http';
 import { parseValue } from './utils';
+import { SubscribableType } from '../../types';
 
 export interface OrderDirection {
   ASC: 'ASC';
   DESC: 'DESC';
 }
 
+export enum SubscriptionKind {
+  Event = 'event',
+  Schema = 'schema',
+}
+
 // export interface OrderBy {
 //   field: string;
 //   direction: OrderDirection['ASC'] | OrderDirection['DESC'];
@@ -20,6 +26,7 @@ export interface IndexerTransaction {
   id: number;
   checkpoint: number;
   digest: string;
+  sender: string;
   created_at: string;
 }
 
@@ -41,6 +48,7 @@ export interface IndexerEvent {
   checkpoint: string;
   digest: string;
   name: string;
+  sender: string;
   value: any;
   created_at: string;
 }
@@ -80,18 +88,21 @@ export class SuiIndexerClient {
   async getTransactions(params?: {
     first?: number;
     after?: string;
+    sender?: string;
+    digest?: string;
     checkpoint?: number;
     orderBy?: string[];
-  }) {
+  }): Promise<ConnectionResponse<IndexerTransaction>> {
     const query = `
-      query GetTransactions($first: Int, $after: String, $checkpoint: Int, $orderBy: [TransactionOrderField!]) {
-        transactions(first: $first, after: $after, checkpoint: $checkpoint, orderBy: $orderBy) {
+      query GetTransactions($first: Int, $after: String, $sender: String, $digest: String, $checkpoint: Int, $orderBy: [TransactionOrderField!]) {
+        transactions(first: $first, after: $after, sender: $sender, digest: $digest, checkpoint: $checkpoint, orderBy: $orderBy) {
           edges {
             cursor
             node {
               id
               checkpoint
               digest
+              sender
               created_at
             }
           }
@@ -181,12 +192,14 @@ export class SuiIndexerClient {
     first?: number;
     after?: string;
     name?: string;
+    sender?: string;
+    digest?: string;
     checkpoint?: string;
     orderBy?: string[];
   }): Promise<ConnectionResponse<IndexerEvent>> {
     const query = `
-      query GetEvents($first: Int, $after: String, $name: String, $checkpoint: String, $orderBy: [EventOrderField!]) {
-        events(first: $first, after: $after, name: $name, checkpoint: $checkpoint, orderBy: $orderBy) {
+      query GetEvents($first: Int, $after: String, $name: String, $sender: String, $digest: String, $checkpoint: String, $orderBy: [EventOrderField!]) {
+        events(first: $first, after: $after, name: $name, sender: $sender, digest: $digest, checkpoint: $checkpoint, orderBy: $orderBy) {
           edges {
             cursor
             node {
@@ -194,6 +207,7 @@ export class SuiIndexerClient {
               checkpoint
               digest
               name
+              sender
               value
               created_at
             }
@@ -297,9 +311,9 @@ export class SuiIndexerClient {
   }
 
   async subscribe(
-    names: string[],
+    types: SubscribableType[],
     handleData: (data: any) => void
   ): Promise<WebSocket> {
-    return this.http.subscribe(names, handleData);
+    return this.http.subscribe(types, handleData);
   }
 }

package/src/metadata/index.ts

@@ -13,9 +13,8 @@ export async function loadMetadata(
   fullnodeUrls = fullnodeUrls || [getFullnodeUrl(networkType)];
   const suiInteractor = new SuiInteractor(fullnodeUrls);
   if (packageId !== undefined) {
-    const jsonData = await suiInteractor.getNormalizedMoveModulesByPackage(
-      packageId
-    );
+    const jsonData =
+      await suiInteractor.getNormalizedMoveModulesByPackage(packageId);
 
     return jsonData as SuiMoveNormalizedModules;
   } else {

package/src/types/index.ts

@@ -24,6 +24,7 @@ import { SuiTx } from '../libs/suiTxBuilder';
 
 import { SuiMoveMoudleFuncType } from '../libs/suiContractFactory/types';
 import { FetchOptions } from '../libs/http';
+import { SubscriptionKind } from '../libs/suiIndexerClient';
 
 export const ObjectContentFields = record(string(), any());
 export type ObjectContentFields = Infer<typeof ObjectContentFields>;
@@ -306,3 +307,7 @@ export type ObjectContent = {
 export type SuiDubheReturnType<T extends boolean> = T extends true
   ? SuiTransactionBlockResponse
   : SuiTx;
+
+export type SubscribableType =
+  | { kind: SubscriptionKind.Event; name?: string; sender?: string }
+  | { kind: SubscriptionKind.Schema; name?: string };