[TypeScript SDK] Remove deprecated methods (MystenLabs#6141)

Queryable-Labs · Nov 16, 2022 · a9602e5 · a9602e5
1 parent 626f668
commit a9602e5
Show file tree

Hide file tree

Showing 11 changed files with 15 additions and 409 deletions.
diff --git a/.changeset/blue-eyes-applaud.md b/.changeset/blue-eyes-applaud.md
@@ -0,0 +1,5 @@
+---
+"@mysten/sui.js": minor
+---
+
+Remove deprecated events API
diff --git a/sdk/typescript/src/providers/json-rpc-provider.ts b/sdk/typescript/src/providers/json-rpc-provider.ts
@@ -9,7 +9,6 @@ import {
   isGetTxnDigestsResponse,
   isPaginatedEvents,
   isPaginatedTransactionDigests,
-  isSuiEvents,
   isSuiExecuteTransactionResponse,
   isSuiMoveFunctionArgTypes,
   isSuiMoveNormalizedFunction,
@@ -20,23 +19,18 @@ import {
 } from '../types/index.guard';
 import {
   Coin,
-  DEFAULT_END_TIME,
-  DEFAULT_START_TIME,
-  EVENT_QUERY_MAX_LIMIT,
   ExecuteTransactionRequestType,
   CoinDenominationInfoResponse,
   GatewayTxSeqNumber,
   GetObjectDataResponse,
   getObjectReference,
   GetTxnDigestsResponse,
   ObjectId,
-  ObjectOwner,
   PaginatedTransactionDigests,
   SubscriptionId,
   SuiAddress,
   SuiEventEnvelope,
   SuiEventFilter,
-  SuiEvents,
   SuiExecuteTransactionResponse,
   SuiMoveFunctionArgTypes,
   SuiMoveNormalizedFunction,
@@ -600,144 +594,6 @@ export class JsonRpcProvider extends Provider {
     }
   }
 
-  async getEventsByTransaction(
-    digest: TransactionDigest,
-    count: number = EVENT_QUERY_MAX_LIMIT
-  ): Promise<SuiEvents> {
-    try {
-      return await this.client.requestWithType(
-        'sui_getEventsByTransaction',
-        [digest, count],
-        isSuiEvents,
-        this.options.skipDataValidation
-      );
-    } catch (err) {
-      throw new Error(
-        `Error getting events by transaction: ${digest}, with error: ${err}`
-      );
-    }
-  }
-
-  async getEventsByModule(
-    package_: string,
-    module: string,
-    count: number = EVENT_QUERY_MAX_LIMIT,
-    startTime: number = DEFAULT_START_TIME,
-    endTime: number = DEFAULT_END_TIME
-  ): Promise<SuiEvents> {
-    try {
-      return await this.client.requestWithType(
-        'sui_getEventsByModule',
-        [package_, module, count, startTime, endTime],
-        isSuiEvents,
-        this.options.skipDataValidation
-      );
-    } catch (err) {
-      throw new Error(
-        `Error getting events by transaction module: ${package_}::${module}, with error: ${err}`
-      );
-    }
-  }
-
-  async getEventsByMoveEventStructName(
-    moveEventStructName: string,
-    count: number = EVENT_QUERY_MAX_LIMIT,
-    startTime: number = DEFAULT_START_TIME,
-    endTime: number = DEFAULT_END_TIME
-  ): Promise<SuiEvents> {
-    try {
-      return await this.client.requestWithType(
-        'sui_getEventsByMoveEventStructName',
-        [moveEventStructName, count, startTime, endTime],
-        isSuiEvents,
-        this.options.skipDataValidation
-      );
-    } catch (err) {
-      throw new Error(
-        `Error getting events by move event struct name: ${moveEventStructName}, with error: ${err}`
-      );
-    }
-  }
-
-  async getEventsBySender(
-    sender: SuiAddress,
-    count: number = EVENT_QUERY_MAX_LIMIT,
-    startTime: number = DEFAULT_START_TIME,
-    endTime: number = DEFAULT_END_TIME
-  ): Promise<SuiEvents> {
-    try {
-      return await this.client.requestWithType(
-        'sui_getEventsBySender',
-        [sender, count, startTime, endTime],
-        isSuiEvents,
-        this.options.skipDataValidation
-      );
-    } catch (err) {
-      throw new Error(
-        `Error getting events by sender: ${sender}, with error: ${err}`
-      );
-    }
-  }
-
-  async getEventsByRecipient(
-    recipient: ObjectOwner,
-    count: number = EVENT_QUERY_MAX_LIMIT,
-    startTime: number = DEFAULT_START_TIME,
-    endTime: number = DEFAULT_END_TIME
-  ): Promise<SuiEvents> {
-    try {
-      return await this.client.requestWithType(
-        'sui_getEventsByRecipient',
-        [recipient, count, startTime, endTime],
-        isSuiEvents,
-        this.options.skipDataValidation
-      );
-    } catch (err) {
-      throw new Error(
-        `Error getting events by receipient: ${recipient}, with error: ${err}`
-      );
-    }
-  }
-
-  async getEventsByObject(
-    object: ObjectId,
-    count: number = EVENT_QUERY_MAX_LIMIT,
-    startTime: number = DEFAULT_START_TIME,
-    endTime: number = DEFAULT_END_TIME
-  ): Promise<SuiEvents> {
-    try {
-      return await this.client.requestWithType(
-        'sui_getEventsByObject',
-        [object, count, startTime, endTime],
-        isSuiEvents,
-        this.options.skipDataValidation
-      );
-    } catch (err) {
-      throw new Error(
-        `Error getting events by object: ${object}, with error: ${err}`
-      );
-    }
-  }
-
-  async getEventsByTimeRange(
-    count: number = EVENT_QUERY_MAX_LIMIT,
-    startTime: number = DEFAULT_START_TIME,
-    endTime: number = DEFAULT_END_TIME
-  ): Promise<SuiEvents> {
-    try {
-      return await this.client.requestWithType(
-        'sui_getEventsByTimeRange',
-        [count, startTime, endTime],
-        isSuiEvents,
-        this.options.skipDataValidation
-      );
-    } catch (err) {
-      throw new Error(
-        `Error getting events by time range: ${startTime} thru ${endTime}, with error: ${err}`
-      );
-    }
-  }
-
   async subscribeEvent(
     filter: SuiEventFilter,
     onMessage: (event: SuiEventEnvelope) => void

diff --git a/sdk/typescript/src/providers/provider.ts b/sdk/typescript/src/providers/provider.ts
@@ -25,8 +25,6 @@ import {
   SuiAddress,
   EventQuery,
   EventId,
-  ObjectOwner,
-  SuiEvents,
   PaginatedTransactionDigests,
   TransactionQuery,
   PaginatedEvents,
@@ -242,114 +240,6 @@ export abstract class Provider {
       order: Order,
   ): Promise<PaginatedEvents>;
 
-  /**
-   * Get events for one transaction
-   * @param digest transaction digest to search by
-   * @param count max result count
-   *
-   * @deprecated The method will be replaced by 'getEvents'
-   */
-  abstract getEventsByTransaction(
-    digest: TransactionDigest,
-    count: number
-  ): Promise<SuiEvents>;
-
-  /**
-   * Get events emitted from within the specified Move module
-   * @param packageId Move package object ID
-   * @param module Move module name
-   * @param count max result count
-   * @param startTime start of time range
-   * @param endTime end of time range, exclusive
-   *
-   * @deprecated The method will be replaced by 'getEvents'
-   */
-  abstract getEventsByModule(
-    packageId: ObjectId,
-    module: string,
-    count: number,
-    startTime: number,
-    endTime: number
-  ): Promise<SuiEvents>;
-
-  /**
-   * Get events with a matching Move type name
-   * @param moveEventStructName Move struct type name
-   * @param count max result count
-   * @param startTime start of time range to search
-   * @param endTime end of time range
-   *
-   * @deprecated The method will be replaced by 'getEvents'
-   */
-  abstract getEventsByMoveEventStructName(
-    moveEventStructName: string,
-    count: number,
-    startTime: number,
-    endTime: number
-  ): Promise<SuiEvents>;
-
-  /**
-   * Get events from transactions sent by a specific address
-   * @param sender Sui address of the sender of the transaction that generated the event
-   * @param count max result count
-   * @param startTime start of time range to search
-   * @param endTime end of time range
-   *
-   * @deprecated The method will be replaced by 'getEvents'
-   */
-  abstract getEventsBySender(
-    sender: SuiAddress,
-    count: number,
-    startTime: number,
-    endTime: number
-  ): Promise<SuiEvents>;
-
-  /**
-   * Get events with a matching recipient
-   * @param recipient object owner that received the transaction that generated the event
-   * @param count max result count
-   * @param startTime start of time range to search
-   * @param endTime end of time range
-   *
-   * @deprecated The method will be replaced by 'getEvents'
-   */
-  abstract getEventsByRecipient(
-    recipient: ObjectOwner,
-    count: number,
-    startTime: number,
-    endTime: number
-  ): Promise<SuiEvents>;
-
-  /**
-   * Get events involving the given object
-   * @param object object id created, mutated, or deleted in events
-   * @param count max result count
-   * @param startTime start of time range to search
-   * @param endTime end of time range
-   *
-   * @deprecated The method will be replaced by 'getEvents'
-   */
-  abstract getEventsByObject(
-    object: ObjectId,
-    count: number,
-    startTime: number,
-    endTime: number
-  ): Promise<SuiEvents>;
-
-  /**
-   * Get all events within the given time span
-   * @param count max result count
-   * @param startTime start of time range to search
-   * @param endTime end of time range
-   *
-   * @deprecated The method will be replaced by 'getEvents'
-   */
-  abstract getEventsByTimeRange(
-    count: number,
-    startTime: number,
-    endTime: number
-  ): Promise<SuiEvents>;
-
   /**
    * Subscribe to get notifications whenever an event matching the filter occurs
    * @param filter - filter describing the subset of events to follow

diff --git a/sdk/typescript/src/providers/void-provider.ts b/sdk/typescript/src/providers/void-provider.ts
@@ -22,10 +22,8 @@ import {
   SubscriptionId,
   ExecuteTransactionRequestType,
   SuiExecuteTransactionResponse,
-  ObjectOwner,
   SuiAddress,
   ObjectId,
-  SuiEvents,
   TransactionQuery,
   PaginatedTransactionDigests,
   EventQuery,
@@ -168,66 +166,7 @@ export class VoidProvider extends Provider {
     throw this.newError('syncAccountState');
   }
 
-  async getEventsByTransaction(
-    _digest: TransactionDigest,
-    _count: number
-  ): Promise<SuiEvents> {
-    throw this.newError('getEventsByTransaction');
-  }
-
-  async getEventsByModule(
-    _package: string,
-    _module: string,
-    _count: number,
-    _startTime: number,
-    _endTime: number
-  ): Promise<SuiEvents> {
-    throw this.newError('getEventsByTransactionModule');
-  }
-
-  async getEventsByMoveEventStructName(
-    _moveEventStructName: string,
-    _count: number,
-    _startTime: number,
-    _endTime: number
-  ): Promise<SuiEvents> {
-    throw this.newError('getEventsByMoveEventStructName');
-  }
-
-  async getEventsBySender(
-    _sender: SuiAddress,
-    _count: number,
-    _startTime: number,
-    _endTime: number
-  ): Promise<SuiEvents> {
-    throw this.newError('getEventsBySender');
-  }
-
-  async getEventsByRecipient(
-    _recipient: ObjectOwner,
-    _count: number,
-    _startTime: number,
-    _endTime: number
-  ): Promise<SuiEvents> {
-    throw this.newError('getEventsByRecipient');
-  }
 
-  async getEventsByObject(
-    _object: ObjectId,
-    _count: number,
-    _startTime: number,
-    _endTime: number
-  ): Promise<SuiEvents> {
-    throw this.newError('getEventsByObject');
-  }
-
-  async getEventsByTimeRange(
-    _count: number,
-    _startTime: number,
-    _endTime: number
-  ): Promise<SuiEvents> {
-    throw this.newError('getEventsByTimeRange');
-  }
 
   async subscribeEvent(
     _filter: SuiEventFilter,