aftermath-ts-sdk 0.0.161 → 0.0.163

package/dist/general/api/dynamicFieldsApiHelpers.d.ts

@@ -1,12 +1,22 @@
 import { ObjectId } from "@mysten/sui.js";
-import { AnyObjectType, DynamicFieldObjectsWithCursor, DynamicFieldsWithCursor } from "../../types";
+import { AnyObjectType, DynamicFieldObjectsWithCursor, DynamicFieldsInputs, DynamicFieldsWithCursor } from "../../types";
 import { AftermathApi } from "../providers/aftermathApi";
 export declare class DynamicFieldsApiHelpers {
     private readonly Provider;
     private static readonly constants;
     constructor(Provider: AftermathApi);
-    fetchCastDynamicFieldsOfTypeWithCursor: <ObjectType>(parentObjectId: ObjectId, objectsFromObjectIds: (objectIds: ObjectId[]) => Promise<ObjectType[]>, dynamicFieldType?: string | ((objectType: AnyObjectType) => boolean) | undefined, cursor?: ObjectId, limit?: number) => Promise<DynamicFieldObjectsWithCursor<ObjectType>>;
-    fetchAllDynamicFieldsOfType: (parentObjectId: ObjectId, dynamicFieldType?: string | ((objectType: AnyObjectType) => boolean) | undefined, limitStepSize?: number) => Promise<{
+    fetchCastDynamicFieldsOfTypeWithCursor: <ObjectType>(inputs: {
+        parentObjectId: ObjectId;
+        objectsFromObjectIds: (objectIds: ObjectId[]) => Promise<ObjectType[]>;
+        dynamicFieldType?: string | ((objectType: AnyObjectType) => boolean) | undefined;
+        cursor?: string | undefined;
+        limit?: number | undefined;
+    }) => Promise<DynamicFieldObjectsWithCursor<ObjectType>>;
+    fetchAllDynamicFieldsOfType: (inputs: {
+        parentObjectId: ObjectId;
+        dynamicFieldType?: string | ((objectType: AnyObjectType) => boolean) | undefined;
+        limitStepSize?: number | undefined;
+    }) => Promise<{
         type: "DynamicField" | "DynamicObject";
         objectType: string;
         objectId: string;
@@ -18,8 +28,21 @@ export declare class DynamicFieldsApiHelpers {
         };
         bcsName: string;
     }[]>;
-    fetchCastAllDynamicFieldsOfType: <ObjectType>(parentObjectId: ObjectId, objectsFromObjectIds: (objectIds: ObjectId[]) => Promise<ObjectType[]>, dynamicFieldType?: string | ((objectType: AnyObjectType) => boolean) | undefined, limitStepSize?: number) => Promise<ObjectType[]>;
-    fetchDynamicFieldsUntil: <ObjectType>(fetchFunc: (cursor?: ObjectId, limit?: number) => Promise<DynamicFieldObjectsWithCursor<ObjectType>>, isComplete: (dynamicFieldObjects: ObjectType[]) => boolean, cursor?: ObjectId, limitStepSize?: number) => Promise<DynamicFieldObjectsWithCursor<ObjectType>>;
-    fetchDynamicFieldsOfTypeWithCursor: (parentObjectId: ObjectId, dynamicFieldType?: string | ((objectType: AnyObjectType) => boolean) | undefined, cursor?: ObjectId, limit?: number) => Promise<DynamicFieldsWithCursor>;
+    fetchCastAllDynamicFieldsOfType: <ObjectType>(inputs: {
+        parentObjectId: ObjectId;
+        objectsFromObjectIds: (objectIds: ObjectId[]) => Promise<ObjectType[]>;
+        dynamicFieldType?: string | ((objectType: AnyObjectType) => boolean) | undefined;
+        limitStepSize?: number | undefined;
+    }) => Promise<ObjectType[]>;
+    fetchDynamicFieldsUntil: <ObjectType>(inputs: {
+        fetchFunc: (dynamicFieldsInputs: DynamicFieldsInputs) => Promise<DynamicFieldObjectsWithCursor<ObjectType>>;
+        isComplete: (dynamicFieldObjects: ObjectType[]) => boolean;
+        cursor?: string | undefined;
+        limitStepSize?: number | undefined;
+    }) => Promise<DynamicFieldObjectsWithCursor<ObjectType>>;
+    fetchDynamicFieldsOfTypeWithCursor: (inputs: {
+        parentObjectId: ObjectId;
+        dynamicFieldType?: string | ((objectType: AnyObjectType) => boolean) | undefined;
+    } & DynamicFieldsInputs) => Promise<DynamicFieldsWithCursor>;
 }
 //# sourceMappingURL=dynamicFieldsApiHelpers.d.ts.map

package/dist/general/api/dynamicFieldsApiHelpers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dynamicFieldsApiHelpers.d.ts","sourceRoot":"","sources":["../../../src/general/api/dynamicFieldsApiHelpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EACN,aAAa,EACb,6BAA6B,EAC7B,uBAAuB,EACvB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAGzD,qBAAa,uBAAuB;IAavB,OAAO,CAAC,QAAQ,CAAC,QAAQ;IARrC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAE/B;gBAM2B,QAAQ,EAAE,YAAY;IAY5C,sCAAsC,+BAC5B,QAAQ,oCACU,QAAQ,EAAE,sEAG3B,aAAa,KAAK,OAAO,wBACjC,QAAQ,UACT,MAAM,wDAqBb;IAEK,2BAA2B,mBACjB,QAAQ,4CAGP,aAAa,KAAK,OAAO,+BAC3B,MAAM;;;;;;;;;;;SAuBpB;IAEK,+BAA+B,+BACrB,QAAQ,oCACU,QAAQ,EAAE,sEAG3B,aAAa,KAAK,OAAO,+BAC3B,MAAM,2BAepB;IAEK,uBAAuB,oCAEnB,QAAQ,UACT,MAAM,4GAEoC,OAAO,WACjD,QAAQ,kBACF,MAAM,wDAiCpB;IAEK,kCAAkC,mBACxB,QAAQ,4CAGP,aAAa,KAAK,OAAO,wBACjC,QAAQ,UACT,MAAM,KACZ,QAAQ,uBAAuB,CAAC,CAsBjC;CACF"}
+{"version":3,"file":"dynamicFieldsApiHelpers.d.ts","sourceRoot":"","sources":["../../../src/general/api/dynamicFieldsApiHelpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EACN,aAAa,EACb,6BAA6B,EAC7B,mBAAmB,EACnB,uBAAuB,EACvB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAGzD,qBAAa,uBAAuB;IAavB,OAAO,CAAC,QAAQ,CAAC,QAAQ;IARrC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAE/B;gBAM2B,QAAQ,EAAE,YAAY;IAY5C,sCAAsC;wBAC5B,QAAQ;0CACU,QAAQ,EAAE;kDAG3B,aAAa,KAAK,OAAO;;;6DAkBzC;IAEK,2BAA2B;wBACjB,QAAQ;kDAGP,aAAa,KAAK,OAAO;;;;;;;;;;;;;SAwBzC;IAEK,+BAA+B;wBACrB,QAAQ;0CACU,QAAQ,EAAE;kDAG3B,aAAa,KAAK,OAAO;;gCAWzC;IAEK,uBAAuB;yCAEP,mBAAmB;2DAEU,OAAO;;;6DAsCzD;IAEK,kCAAkC;wBAEvB,QAAQ;kDAGP,aAAa,KAAK,OAAO;gCAEzC,QAAQ,uBAAuB,CAAC,CA0BjC;CACF"}

package/dist/general/api/dynamicFieldsApiHelpers.js

@@ -11,32 +11,32 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DynamicFieldsApiHelpers = void 0;
 class DynamicFieldsApiHelpers {
-    /////////////////////////////////////////////////////////////////////
-    //// Constructor
-    /////////////////////////////////////////////////////////////////////
+    // =========================================================================
+    //  Constructor
+    // =========================================================================
     constructor(Provider) {
         this.Provider = Provider;
-        /////////////////////////////////////////////////////////////////////
-        //// Public Methods
-        /////////////////////////////////////////////////////////////////////
-        /////////////////////////////////////////////////////////////////////
-        //// Fetching
-        /////////////////////////////////////////////////////////////////////
-        this.fetchCastDynamicFieldsOfTypeWithCursor = (parentObjectId, objectsFromObjectIds, dynamicFieldType, cursor, limit) => __awaiter(this, void 0, void 0, function* () {
-            const { dynamicFields, nextCursor } = yield this.fetchDynamicFieldsOfTypeWithCursor(parentObjectId, dynamicFieldType, cursor, limit);
+        // =========================================================================
+        //  Public Methods
+        // =========================================================================
+        // =========================================================================
+        //  Fetching
+        // =========================================================================
+        this.fetchCastDynamicFieldsOfTypeWithCursor = (inputs) => __awaiter(this, void 0, void 0, function* () {
+            const { dynamicFields, nextCursor } = yield this.fetchDynamicFieldsOfTypeWithCursor(inputs);
             const dynamicFieldObjectIds = dynamicFields.map((field) => field.objectId);
-            const dynamicFieldObjects = yield objectsFromObjectIds(dynamicFieldObjectIds);
+            const dynamicFieldObjects = yield inputs.objectsFromObjectIds(dynamicFieldObjectIds);
             return {
                 dynamicFieldObjects,
                 nextCursor,
             };
         });
-        this.fetchAllDynamicFieldsOfType = (parentObjectId, dynamicFieldType, limitStepSize = DynamicFieldsApiHelpers.constants
-            .defaultLimitStepSize) => __awaiter(this, void 0, void 0, function* () {
+        this.fetchAllDynamicFieldsOfType = (inputs) => __awaiter(this, void 0, void 0, function* () {
+            var _a;
             let allDynamicFields = [];
             let cursor = undefined;
             do {
-                const dynamicFieldsWithCursor = yield this.fetchDynamicFieldsOfTypeWithCursor(parentObjectId, dynamicFieldType, cursor, limitStepSize);
+                const dynamicFieldsWithCursor = yield this.fetchDynamicFieldsOfTypeWithCursor(Object.assign(Object.assign({}, inputs), { cursor, limit: (_a = inputs.limitStepSize) !== null && _a !== void 0 ? _a : DynamicFieldsApiHelpers.constants.defaultLimitStepSize }));
                 const dynamicFields = dynamicFieldsWithCursor.dynamicFields;
                 allDynamicFields = [...allDynamicFields, ...dynamicFields];
                 if (dynamicFields.length === 0 ||
@@ -45,19 +45,21 @@ class DynamicFieldsApiHelpers {
                 cursor = dynamicFieldsWithCursor.nextCursor;
             } while (true);
         });
-        this.fetchCastAllDynamicFieldsOfType = (parentObjectId, objectsFromObjectIds, dynamicFieldType, limitStepSize = DynamicFieldsApiHelpers.constants
-            .defaultLimitStepSize) => __awaiter(this, void 0, void 0, function* () {
-            const dynamicFields = yield this.fetchAllDynamicFieldsOfType(parentObjectId, dynamicFieldType, limitStepSize);
+        this.fetchCastAllDynamicFieldsOfType = (inputs) => __awaiter(this, void 0, void 0, function* () {
+            const dynamicFields = yield this.fetchAllDynamicFieldsOfType(inputs);
             const dynamicFieldObjectIds = dynamicFields.map((field) => field.objectId);
-            const dynamicFieldObjects = yield objectsFromObjectIds(dynamicFieldObjectIds);
+            const dynamicFieldObjects = yield inputs.objectsFromObjectIds(dynamicFieldObjectIds);
             return dynamicFieldObjects;
         });
-        this.fetchDynamicFieldsUntil = (fetchFunc, isComplete, cursor, limitStepSize = DynamicFieldsApiHelpers.constants
-            .defaultLimitStepSize) => __awaiter(this, void 0, void 0, function* () {
+        this.fetchDynamicFieldsUntil = (inputs) => __awaiter(this, void 0, void 0, function* () {
+            const { fetchFunc, isComplete, cursor, limitStepSize } = inputs;
             let allDynamicFields = [];
             let currentCursor = cursor !== null && cursor !== void 0 ? cursor : null;
             do {
-                const dynamicFieldsWithCursor = yield fetchFunc(currentCursor !== null && currentCursor !== void 0 ? currentCursor : undefined, limitStepSize);
+                const dynamicFieldsWithCursor = yield fetchFunc({
+                    cursor: currentCursor !== null && currentCursor !== void 0 ? currentCursor : undefined,
+                    limit: limitStepSize !== null && limitStepSize !== void 0 ? limitStepSize : DynamicFieldsApiHelpers.constants.defaultLimitStepSize,
+                });
                 const fetchedDynamicFields = dynamicFieldsWithCursor.dynamicFieldObjects;
                 const nextCursor = dynamicFieldsWithCursor.nextCursor;
                 allDynamicFields = [...allDynamicFields, ...fetchedDynamicFields];
@@ -76,12 +78,10 @@ class DynamicFieldsApiHelpers {
                 currentCursor = dynamicFieldsWithCursor.nextCursor;
             } while (true);
         });
-        this.fetchDynamicFieldsOfTypeWithCursor = (parentObjectId, dynamicFieldType, cursor, limit) => __awaiter(this, void 0, void 0, function* () {
-            const dynamicFieldsResponse = yield this.Provider.provider.getDynamicFields({
-                parentId: parentObjectId,
-                cursor,
-                limit,
-            });
+        this.fetchDynamicFieldsOfTypeWithCursor = (inputs) => __awaiter(this, void 0, void 0, function* () {
+            var _b;
+            const { parentObjectId, dynamicFieldType } = inputs;
+            const dynamicFieldsResponse = yield this.Provider.provider.getDynamicFields(Object.assign(Object.assign({}, inputs), { limit: (_b = inputs.limit) !== null && _b !== void 0 ? _b : DynamicFieldsApiHelpers.constants.defaultLimitStepSize, parentId: parentObjectId }));
             const dynamicFields = dynamicFieldType === undefined
                 ? dynamicFieldsResponse.data
                 : dynamicFieldsResponse.data.filter((dynamicField) => typeof dynamicFieldType === "string"
@@ -97,9 +97,9 @@ class DynamicFieldsApiHelpers {
     }
 }
 exports.DynamicFieldsApiHelpers = DynamicFieldsApiHelpers;
-/////////////////////////////////////////////////////////////////////
-//// Private Static Constants
-/////////////////////////////////////////////////////////////////////
+// =========================================================================
+//  Private Static Constants
+// =========================================================================
 DynamicFieldsApiHelpers.constants = {
     defaultLimitStepSize: 256,
 };

package/dist/general/api/eventsApiHelpers.d.ts

@@ -1,17 +1,32 @@
-import { Event, EventsWithCursor, AnyObjectType } from "../../types";
-import { EventId, SuiAddress, SuiEvent, SuiEventFilter, SuiTransactionBlockResponse } from "@mysten/sui.js";
+import { Event, EventsWithCursor, AnyObjectType, EventsInputs } from "../../types";
+import { SuiAddress, SuiEvent, SuiEventFilter, SuiTransactionBlockResponse, Unsubscribe } from "@mysten/sui.js";
 import { QUnitType, OpUnitType } from "dayjs";
 import { AftermathApi } from "../providers/aftermathApi";
 export declare class EventsApiHelpers {
     private readonly Provider;
     private static readonly constants;
     constructor(Provider: AftermathApi);
-    fetchSubscribeToUserEvents: (address: SuiAddress, onEvent: (event: SuiEvent) => void) => Promise<number>;
-    fetchUnsubscribeFromEvents: (subscriptionId: number) => Promise<boolean>;
-    fetchEventsOnChainWithCursor: <EventOnChainType>(query: SuiEventFilter, cursor?: EventId, limit?: number) => Promise<EventsWithCursor<EventOnChainType>>;
-    fetchCastEventsWithCursor: <EventOnChainType, EventType>(query: SuiEventFilter, eventFromEventOnChain: (eventOnChain: EventOnChainType) => EventType, cursor?: EventId, limit?: number) => Promise<EventsWithCursor<EventType>>;
-    fetchEventsWithinTime: <T extends Event>(fetchEventsFunc: (cursor?: EventId, limit?: number) => Promise<EventsWithCursor<T>>, timeUnit: QUnitType | OpUnitType, time: number, limitStepSize?: number) => Promise<T[]>;
-    fetchAllEvents: <T>(fetchEventsFunc: (cursor?: EventId, limit?: number) => Promise<EventsWithCursor<T>>, limitStepSize?: number) => Promise<T[]>;
+    fetchSubscribeToUserEvents: (inputs: {
+        address: SuiAddress;
+        onEvent: (event: SuiEvent) => void;
+    }) => Promise<Unsubscribe>;
+    fetchEventsOnChainWithCursor: <EventOnChainType>(inputs: {
+        query: SuiEventFilter;
+    } & EventsInputs) => Promise<EventsWithCursor<EventOnChainType>>;
+    fetchCastEventsWithCursor: <EventOnChainType, EventType>(inputs: {
+        query: SuiEventFilter;
+        eventFromEventOnChain: (eventOnChain: EventOnChainType) => EventType;
+    } & EventsInputs) => Promise<EventsWithCursor<EventType>>;
+    fetchEventsWithinTime: <T extends Event>(inputs: {
+        fetchEventsFunc: (eventsInputs: EventsInputs) => Promise<EventsWithCursor<T>>;
+        timeUnit: QUnitType | OpUnitType;
+        time: number;
+        limitStepSize?: number | undefined;
+    }) => Promise<T[]>;
+    fetchAllEvents: <T>(inputs: {
+        fetchEventsFunc: (eventsInputs: EventsInputs) => Promise<EventsWithCursor<T>>;
+        limitStepSize?: number | undefined;
+    }) => Promise<T[]>;
     static suiEventOfTypeOrUndefined: (event: SuiEvent, eventType: AnyObjectType | (() => AnyObjectType)) => SuiEvent | undefined;
     static castEventOfTypeOrUndefined: <EventTypeOnChain, EventType>(event: SuiEvent, eventType: AnyObjectType | (() => AnyObjectType), castFunction: (eventOnChain: EventTypeOnChain) => EventType) => EventType | undefined;
     static findCastEventInTransactionOrUndefined: <EventTypeOnChain, EventType>(transaction: SuiTransactionBlockResponse, eventType: AnyObjectType | (() => AnyObjectType), castFunction: (eventOnChain: EventTypeOnChain) => EventType) => EventType | undefined;

package/dist/general/api/eventsApiHelpers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"eventsApiHelpers.d.ts","sourceRoot":"","sources":["../../../src/general/api/eventsApiHelpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AACrE,OAAO,EACN,OAAO,EACP,UAAU,EACV,QAAQ,EACR,cAAc,EACd,2BAA2B,EAC3B,MAAM,gBAAgB,CAAC;AACxB,OAAc,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,OAAO,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAGzD,qBAAa,gBAAgB;IAahB,OAAO,CAAC,QAAQ,CAAC,QAAQ;IARrC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAE/B;gBAM2B,QAAQ,EAAE,YAAY;IAa5C,0BAA0B,YACvB,UAAU,mBACF,QAAQ,KAAK,IAAI,KAChC,QAAQ,MAAM,CAAC,CAShB;IAEK,0BAA0B,mBAChB,MAAM,KACpB,QAAQ,OAAO,CAAC,CAKjB;IAGK,4BAA4B,4BAC3B,cAAc,WACZ,OAAO,UACR,MAAM,iDAiBb;IAEK,yBAAyB,uCACxB,cAAc,iFAEZ,OAAO,UACR,MAAM,0CAmBb;IAGK,qBAAqB,+CAEjB,OAAO,UACR,MAAM,6CAEL,SAAS,GAAG,UAAU,QAC1B,MAAM,kBACG,MAAM,kBAiCpB;IAEK,cAAc,iCAEV,OAAO,UACR,MAAM,mDAEA,MAAM,kBAgBpB;IAUF,OAAc,yBAAyB,UAC/B,QAAQ,aACJ,aAAa,GAAG,CAAC,MAAM,aAAa,CAAC,KAC9C,QAAQ,GAAG,SAAS,CAGT;IAEd,OAAc,0BAA0B,uCAChC,QAAQ,aACJ,aAAa,GAAG,CAAC,MAAM,aAAa,CAAC,wFAa/C;IAEF,OAAc,qCAAqC,6CAIrC,2BAA2B,aAC7B,aAAa,GAAG,CAAC,MAAM,aAAa,CAAC,wFAY/C;IAEF,OAAc,sCAAsC,8CAIrC,2BAA2B,EAAE,aAChC,aAAa,GAAG,CAAC,MAAM,aAAa,CAAC,wFAgB/C;IAEF,OAAc,eAAe,mBACZ,MAAM,eACT,MAAM,aACR,MAAM,YACqC;CACvD"}
+{"version":3,"file":"eventsApiHelpers.d.ts","sourceRoot":"","sources":["../../../src/general/api/eventsApiHelpers.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,KAAK,EACL,gBAAgB,EAChB,aAAa,EACb,YAAY,EACZ,MAAM,aAAa,CAAC;AACrB,OAAO,EAEN,UAAU,EACV,QAAQ,EACR,cAAc,EACd,2BAA2B,EAC3B,WAAW,EACX,MAAM,gBAAgB,CAAC;AACxB,OAAc,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,OAAO,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAGzD,qBAAa,gBAAgB;IAahB,OAAO,CAAC,QAAQ,CAAC,QAAQ;IARrC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAE/B;gBAM2B,QAAQ,EAAE,YAAY;IAa5C,0BAA0B;iBACvB,UAAU;yBACF,QAAQ,KAAK,IAAI;UAC/B,QAAQ,WAAW,CAAC,CAUtB;IAGK,4BAA4B,6BAC1B;QACP,KAAK,EAAE,cAAc,CAAC;KACtB,GAAG,YAAY,iDAmBf;IAEK,yBAAyB;eAEvB,cAAc;;8DAyBrB;IAGK,qBAAqB;wCAEZ,YAAY;kBAEjB,SAAS,GAAG,UAAU;cAC1B,MAAM;;uBAwCX;IAEK,cAAc;wCAEL,YAAY;;uBAwB1B;IAUF,OAAc,yBAAyB,UAC/B,QAAQ,aACJ,aAAa,GAAG,CAAC,MAAM,aAAa,CAAC,KAC9C,QAAQ,GAAG,SAAS,CAGT;IAEd,OAAc,0BAA0B,uCAChC,QAAQ,aACJ,aAAa,GAAG,CAAC,MAAM,aAAa,CAAC,wFAa/C;IAEF,OAAc,qCAAqC,6CAIrC,2BAA2B,aAC7B,aAAa,GAAG,CAAC,MAAM,aAAa,CAAC,wFAY/C;IAEF,OAAc,sCAAsC,8CAIrC,2BAA2B,EAAE,aAChC,aAAa,GAAG,CAAC,MAAM,aAAa,CAAC,wFAgB/C;IAEF,OAAc,eAAe,mBACZ,MAAM,eACT,MAAM,aACR,MAAM,YACqC;CACvD"}

package/dist/general/api/eventsApiHelpers.js

@@ -15,35 +15,31 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.EventsApiHelpers = void 0;
 const dayjs_1 = __importDefault(require("dayjs"));
 class EventsApiHelpers {
-    /////////////////////////////////////////////////////////////////////
-    //// Constructor
-    /////////////////////////////////////////////////////////////////////
+    // =========================================================================
+    //  Constructor
+    // =========================================================================
     constructor(Provider) {
         this.Provider = Provider;
-        /////////////////////////////////////////////////////////////////////
-        //// Public Methods
-        /////////////////////////////////////////////////////////////////////
-        /////////////////////////////////////////////////////////////////////
-        //// Fetching
-        /////////////////////////////////////////////////////////////////////
+        // =========================================================================
+        //  Public Methods
+        // =========================================================================
+        // =========================================================================
+        //  Fetching
+        // =========================================================================
         // TODO: make this filter by looking ONLY at all relevant AF packages
-        this.fetchSubscribeToUserEvents = (address, onEvent) => __awaiter(this, void 0, void 0, function* () {
-            const userEventSubscriptionId = yield this.Provider.provider.subscribeEvent({
+        this.fetchSubscribeToUserEvents = (inputs) => __awaiter(this, void 0, void 0, function* () {
+            const { address, onEvent } = inputs;
+            const unsubscribe = yield this.Provider.provider.subscribeEvent({
                 filter: {
                     Sender: address,
                 },
                 onMessage: onEvent,
             });
-            return userEventSubscriptionId;
-        });
-        this.fetchUnsubscribeFromEvents = (subscriptionId) => __awaiter(this, void 0, void 0, function* () {
-            const success = yield this.Provider.provider.unsubscribeEvent({
-                id: subscriptionId,
-            });
-            return success;
+            return unsubscribe;
         });
         // TODO: handle extending event type correctly (for access to timestamp, etc)
-        this.fetchEventsOnChainWithCursor = (query, cursor, limit) => __awaiter(this, void 0, void 0, function* () {
+        this.fetchEventsOnChainWithCursor = (inputs) => __awaiter(this, void 0, void 0, function* () {
+            const { query, cursor, limit } = inputs;
             const fetchedEvents = yield this.Provider.provider.queryEvents({
                 query,
                 cursor: cursor
@@ -54,7 +50,8 @@ class EventsApiHelpers {
             const nextCursor = fetchedEvents.nextCursor;
             return { events, nextCursor };
         });
-        this.fetchCastEventsWithCursor = (query, eventFromEventOnChain, cursor, limit) => __awaiter(this, void 0, void 0, function* () {
+        this.fetchCastEventsWithCursor = (inputs) => __awaiter(this, void 0, void 0, function* () {
+            const { query, eventFromEventOnChain, cursor, limit } = inputs;
             const fetchedEvents = yield this.Provider.provider.queryEvents({
                 query,
                 cursor: cursor
@@ -67,11 +64,15 @@ class EventsApiHelpers {
             return { events, nextCursor };
         });
         // TODO: make this function use timestamp passing as one of event filter args
-        this.fetchEventsWithinTime = (fetchEventsFunc, timeUnit, time, limitStepSize = EventsApiHelpers.constants.defaultLimitStepSize) => __awaiter(this, void 0, void 0, function* () {
+        this.fetchEventsWithinTime = (inputs) => __awaiter(this, void 0, void 0, function* () {
+            const { fetchEventsFunc, timeUnit, time, limitStepSize } = inputs;
             let eventsWithinTime = [];
             let cursor = undefined;
             do {
-                const eventsWithCursor = yield fetchEventsFunc(cursor, limitStepSize);
+                const eventsWithCursor = yield fetchEventsFunc({
+                    cursor,
+                    limit: limitStepSize !== null && limitStepSize !== void 0 ? limitStepSize : EventsApiHelpers.constants.defaultLimitStepSize,
+                });
                 const events = eventsWithCursor.events;
                 const now = Date.now();
                 const endIndex = events.findIndex((event) => {
@@ -92,11 +93,15 @@ class EventsApiHelpers {
                 cursor = eventsWithCursor.nextCursor;
             } while (true);
         });
-        this.fetchAllEvents = (fetchEventsFunc, limitStepSize = EventsApiHelpers.constants.defaultLimitStepSize) => __awaiter(this, void 0, void 0, function* () {
+        this.fetchAllEvents = (inputs) => __awaiter(this, void 0, void 0, function* () {
+            const { fetchEventsFunc, limitStepSize } = inputs;
             let allEvents = [];
             let cursor = undefined;
             do {
-                const eventsWithCursor = yield fetchEventsFunc(cursor, limitStepSize);
+                const eventsWithCursor = yield fetchEventsFunc({
+                    cursor,
+                    limit: limitStepSize !== null && limitStepSize !== void 0 ? limitStepSize : EventsApiHelpers.constants.defaultLimitStepSize,
+                });
                 const events = eventsWithCursor.events;
                 allEvents = [...allEvents, ...events];
                 if (events.length === 0 || eventsWithCursor.nextCursor === null)
@@ -108,18 +113,18 @@ class EventsApiHelpers {
     }
 }
 exports.EventsApiHelpers = EventsApiHelpers;
-/////////////////////////////////////////////////////////////////////
-//// Private Static Constants
-/////////////////////////////////////////////////////////////////////
+// =========================================================================
+//  Private Static Constants
+// =========================================================================
 EventsApiHelpers.constants = {
     defaultLimitStepSize: 256,
 };
-/////////////////////////////////////////////////////////////////////
-//// Static Methods
-/////////////////////////////////////////////////////////////////////
-/////////////////////////////////////////////////////////////////////
-//// Helpers
-/////////////////////////////////////////////////////////////////////
+// =========================================================================
+//  Static Methods
+// =========================================================================
+// =========================================================================
+//  Helpers
+// =========================================================================
 EventsApiHelpers.suiEventOfTypeOrUndefined = (event, eventType) => event.type === (typeof eventType === "string" ? eventType : eventType())
     ? event
     : undefined;

package/dist/general/api/inspectionsApiHelpers.js

@@ -12,17 +12,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.InspectionsApiHelpers = void 0;
 const rpcApiHelpers_1 = require("./rpcApiHelpers");
 class InspectionsApiHelpers {
-    /////////////////////////////////////////////////////////////////////
-    //// Constructor
-    /////////////////////////////////////////////////////////////////////
+    // =========================================================================
+    //  Constructor
+    // =========================================================================
     constructor(Provider) {
         this.Provider = Provider;
-        /////////////////////////////////////////////////////////////////////
-        //// Public Methods
-        /////////////////////////////////////////////////////////////////////
-        /////////////////////////////////////////////////////////////////////
-        //// Fetching
-        /////////////////////////////////////////////////////////////////////
+        // =========================================================================
+        //  Public Methods
+        // =========================================================================
+        // =========================================================================
+        //  Fetching
+        // =========================================================================
         this.fetchFirstBytesFromTxOutput = (tx) => __awaiter(this, void 0, void 0, function* () {
             return (yield this.fetchAllBytesFromTxOutput({ tx }))[0];
         });