@aptos-labs/ts-sdk 3.1.2 → 4.0.0

package/dist/esm/chunk-OYUW6ZN2.mjs

@@ -1,2 +0,0 @@
-import{a}from"./chunk-NJN3EAOM.mjs";var e=class extends a{};export{e as a};
-//# sourceMappingURL=chunk-OYUW6ZN2.mjs.map

package/dist/esm/internal/event.d.mts

@@ -1,82 +0,0 @@
-import { A as AptosConfig, d7 as MoveStructId, bO as PaginationArgs, bR as OrderByArg, m as AccountAddressInput, bM as AnyNumber, bS as WhereArg } from '../account--Q9z_xMN.mjs';
-import { GetEventsResponse } from '../types/indexer.mjs';
-import { EventsBoolExp } from '../types/generated/types.mjs';
-import '../utils/apiEndpoints.mjs';
-import '../utils/const.mjs';
-import '../core/common.mjs';
-import '../types/generated/operations.mjs';
-
-/**
- * This file contains the underlying implementations for exposed API surface in
- * the {@link api/event}. By moving the methods out into a separate file,
- * other namespaces and processes can access these methods without depending on the entire
- * event namespace and without having a dependency cycle error.
- * @group Implementation
- */
-
-/**
- * Retrieves events associated with a specific module event type.
- * This function allows you to filter events based on the event type and pagination options.
- *
- * @param args - The arguments for retrieving module events.
- * @param args.aptosConfig - The configuration object for Aptos.
- * @param args.eventType - The MoveStructId representing the type of event to retrieve.
- * @param [args.options] - Optional pagination and ordering parameters for the event retrieval.
- * @group Implementation
- */
-declare function getModuleEventsByEventType(args: {
-    aptosConfig: AptosConfig;
-    eventType: MoveStructId;
-    options?: PaginationArgs & OrderByArg<GetEventsResponse[0]>;
-}): Promise<GetEventsResponse>;
-/**
- * Retrieve events associated with a specific account and creation number.
- *
- * @param args - The parameters for retrieving account events.
- * @param args.aptosConfig - The configuration settings for the Aptos client.
- * @param args.accountAddress - The address of the account for which events are being retrieved.
- * @param args.creationNumber - The creation number to filter events.
- * @param args.options - Optional pagination and ordering parameters for the event retrieval.
- * @group Implementation
- */
-declare function getAccountEventsByCreationNumber(args: {
-    aptosConfig: AptosConfig;
-    accountAddress: AccountAddressInput;
-    creationNumber: AnyNumber;
-    options?: PaginationArgs & OrderByArg<GetEventsResponse[0]>;
-}): Promise<GetEventsResponse>;
-/**
- * Retrieves events associated with a specific account and event type.
- *
- * @param args - The parameters for retrieving account events.
- * @param args.aptosConfig - The configuration for connecting to the Aptos blockchain.
- * @param args.accountAddress - The address of the account for which to retrieve events.
- * @param args.eventType - The type of event to filter by.
- * @param args.options - Optional pagination and ordering parameters for the event retrieval.
- * @group Implementation
- */
-declare function getAccountEventsByEventType(args: {
-    aptosConfig: AptosConfig;
-    accountAddress: AccountAddressInput;
-    eventType: MoveStructId;
-    options?: PaginationArgs & OrderByArg<GetEventsResponse[0]>;
-}): Promise<GetEventsResponse>;
-/**
- * Retrieves a list of events based on specified filtering and pagination options.
- *
- * @param args - The arguments for retrieving events.
- * @param args.aptosConfig - The configuration for connecting to the Aptos network.
- * @param [args.options] - Optional parameters for pagination and filtering.
- * @param [args.options.offset] - The number of records to skip before starting to collect the result set.
- * @param [args.options.limit] - The maximum number of records to return.
- * @param [args.options.orderBy] - Defines the order in which to return the events.
- * @param [args.options.where] - Conditions to filter the events.
- * @param [args.options.where.indexed_type] - Filters events by the indexed type.
- * @group Implementation
- */
-declare function getEvents(args: {
-    aptosConfig: AptosConfig;
-    options?: PaginationArgs & OrderByArg<GetEventsResponse[0]> & WhereArg<EventsBoolExp>;
-}): Promise<GetEventsResponse>;
-
-export { getAccountEventsByCreationNumber, getAccountEventsByEventType, getEvents, getModuleEventsByEventType };

package/dist/esm/internal/event.mjs

@@ -1,2 +0,0 @@
-import{hd as a,id as b,jd as c,kd as d}from"../chunk-I4NMWLUZ.mjs";import"../chunk-G3MHXDYA.mjs";import"../chunk-RFQFTIOA.mjs";import"../chunk-XIQFX5FV.mjs";import"../chunk-UYVPNUH3.mjs";import"../chunk-A5L76YP7.mjs";import"../chunk-OYH2T6V5.mjs";import"../chunk-PRUQZNAP.mjs";import"../chunk-EPMBZCYJ.mjs";import"../chunk-5HXLZHDW.mjs";import"../chunk-GOXRBEIJ.mjs";import"../chunk-OYUW6ZN2.mjs";import"../chunk-NECL5FCQ.mjs";import"../chunk-4QMXOWHP.mjs";import"../chunk-FBCXUC7J.mjs";import"../chunk-FWGLACJS.mjs";import"../chunk-QGFWOGAV.mjs";import"../chunk-DPW6ELCQ.mjs";import"../chunk-C3Q23D22.mjs";import"../chunk-ROT6S6BM.mjs";import"../chunk-BYINW7I2.mjs";import"../chunk-Z6KQX6VX.mjs";import"../chunk-QREVMGQZ.mjs";import"../chunk-V3MBJJTL.mjs";import"../chunk-KJH4KKG6.mjs";import"../chunk-6PKBXYG3.mjs";import"../chunk-AQQEQB35.mjs";import"../chunk-QQEK2GJC.mjs";import"../chunk-GRB6YSIT.mjs";import"../chunk-DW6WLD2B.mjs";import"../chunk-YOZBVVKL.mjs";import"../chunk-THUSLDD6.mjs";import"../chunk-UL777LTI.mjs";import"../chunk-Y7ZQTLH4.mjs";import"../chunk-7ECCT6PK.mjs";import"../chunk-NII5Q32W.mjs";import"../chunk-PQS3II2E.mjs";import"../chunk-E6IUB35J.mjs";import"../chunk-HGLO5LDS.mjs";import"../chunk-HPQMAP7O.mjs";import"../chunk-6Y6ZO7TS.mjs";import"../chunk-FZY4PMEE.mjs";import"../chunk-6MWXV62C.mjs";import"../chunk-C6JRJNK3.mjs";import"../chunk-IXYGZ57N.mjs";import"../chunk-WLUXOUZH.mjs";import"../chunk-UCBUUH5M.mjs";import"../chunk-4RXKALLC.mjs";import"../chunk-JCFTAG5Z.mjs";import"../chunk-YFFDF22R.mjs";import"../chunk-BUUV6B4P.mjs";import"../chunk-GYVSI3TS.mjs";import"../chunk-FD6FGKYY.mjs";import"../chunk-IJE2LVZG.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-NJN3EAOM.mjs";import"../chunk-56CNRT2K.mjs";import"../chunk-STY74NUA.mjs";import"../chunk-IF4UU2MT.mjs";import"../chunk-4R4AI5RT.mjs";import"../chunk-KDMSOCZY.mjs";export{b as getAccountEventsByCreationNumber,c as getAccountEventsByEventType,d as getEvents,a as getModuleEventsByEventType};
-//# sourceMappingURL=event.mjs.map

package/dist/esm/internal/event.mjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/src/api/event.ts

@@ -1,230 +0,0 @@
-// Copyright © Aptos Foundation
-// SPDX-License-Identifier: Apache-2.0
-
-import {
-  getAccountEventsByCreationNumber,
-  getAccountEventsByEventType,
-  getModuleEventsByEventType,
-  getEvents,
-} from "../internal/event";
-import { AnyNumber, GetEventsResponse, MoveStructId, OrderByArg, PaginationArgs, WhereArg } from "../types";
-import { EventsBoolExp } from "../types/generated/types";
-import { AccountAddressInput } from "../core";
-import { ProcessorType } from "../utils/const";
-import { AptosConfig } from "./aptosConfig";
-import { waitForIndexerOnVersion } from "./utils";
-
-/**
- * A class to query all `Event` Aptos related queries.
- * @group Event
- */
-export class Event {
-  /**
-   * Initializes a new instance of the Aptos client with the provided configuration.
-   *
-   * @param config - The configuration settings for the Aptos client.
-   * @param config.network - The network to connect to (e.g., Testnet, Mainnet).
-   * @param config.nodeUrl - The URL of the Aptos node to connect to.
-   * @param config.faucetUrl - The URL of the faucet to use for funding accounts.
-   *
-   * @example
-   * ```typescript
-   * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
-   *
-   * async function runExample() {
-   *     // Create a new Aptos client with Testnet configuration
-   *     const config = new AptosConfig({ network: Network.TESTNET }); // Specify your own network if needed
-   *     const aptos = new Aptos(config);
-   *
-   *     console.log("Aptos client initialized:", aptos);
-   * }
-   * runExample().catch(console.error);
-   * ```
-   * @group Event
-   */
-  constructor(readonly config: AptosConfig) {}
-
-  /**
-   * Retrieve module events based on a specified event type.
-   * This function allows you to query for events that are associated with a particular module event type in the Aptos blockchain.
-   *
-   * @param args - The arguments for retrieving module events.
-   * @param args.eventType - The event type to filter the results.
-   * @param args.minimumLedgerVersion - Optional ledger version to sync up to before querying.
-   * @param args.options - Optional pagination and ordering parameters for the event results.
-   *
-   * @returns Promise<GetEventsResponse> - A promise that resolves to the retrieved events.
-   *
-   * @example
-   * ```typescript
-   * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
-   *
-   * const config = new AptosConfig({ network: Network.TESTNET });
-   * const aptos = new Aptos(config);
-   *
-   * async function runExample() {
-   *   // Retrieve module events for a specific event type
-   *   const events = await aptos.getModuleEventsByEventType({
-   *     eventType: "0x1::transaction_fee::FeeStatement", // specify the event type
-   *     minimumLedgerVersion: 1, // optional: specify minimum ledger version if needed
-   *   });
-   *
-   *   console.log(events); // log the retrieved events
-   * }
-   * runExample().catch(console.error);
-   * ```
-   * @group Event
-   */
-  async getModuleEventsByEventType(args: {
-    eventType: MoveStructId;
-    minimumLedgerVersion?: AnyNumber;
-    options?: PaginationArgs & OrderByArg<GetEventsResponse[0]>;
-  }): Promise<GetEventsResponse> {
-    await waitForIndexerOnVersion({
-      config: this.config,
-      minimumLedgerVersion: args.minimumLedgerVersion,
-      processorType: ProcessorType.EVENTS_PROCESSOR,
-    });
-    return getModuleEventsByEventType({ aptosConfig: this.config, ...args });
-  }
-
-  /**
-   * Retrieve events associated with a specific account address and creation number.
-   *
-   * @param args - The parameters for retrieving account events.
-   * @param args.accountAddress - The account address to query events for.
-   * @param args.creationNumber - The event creation number to filter the events.
-   * @param args.minimumLedgerVersion - Optional minimum ledger version to sync up to before querying.
-   *
-   * @returns Promise<GetEventsResponse>
-   *
-   * @example
-   * ```typescript
-   * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
-   *
-   * const config = new AptosConfig({ network: Network.TESTNET });
-   * const aptos = new Aptos(config);
-   *
-   * async function runExample() {
-   *   // Get events for the account at creation number 0
-   *   const events = await aptos.getAccountEventsByCreationNumber({
-   *     accountAddress: "0x1", // replace with a real account address
-   *     creationNumber: 0,
-   *   });
-   *
-   *   console.log(events);
-   * }
-   * runExample().catch(console.error);
-   * ```
-   * @group Event
-   */
-  async getAccountEventsByCreationNumber(args: {
-    accountAddress: AccountAddressInput;
-    creationNumber: AnyNumber;
-    minimumLedgerVersion?: AnyNumber;
-  }): Promise<GetEventsResponse> {
-    await waitForIndexerOnVersion({
-      config: this.config,
-      minimumLedgerVersion: args.minimumLedgerVersion,
-      processorType: ProcessorType.EVENTS_PROCESSOR,
-    });
-    return getAccountEventsByCreationNumber({ aptosConfig: this.config, ...args });
-  }
-
-  /**
-   * Retrieve events associated with a specific account address and event type.
-   *
-   * @param args.accountAddress - The account address to query events for.
-   * @param args.eventType - The type of event to filter by.
-   * @param args.minimumLedgerVersion - Optional ledger version to sync up to before querying.
-   * @param args.options - Optional pagination and ordering parameters for the event query.
-   *
-   * @returns Promise<GetEventsResponse>
-   *
-   * @example
-   * ```typescript
-   * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
-   *
-   * const config = new AptosConfig({ network: Network.TESTNET });
-   * const aptos = new Aptos(config);
-   *
-   * async function runExample() {
-   *   // Get events for a specific account and event type
-   *   const events = await aptos.getAccountEventsByEventType({
-   *     accountAddress: "0x1", // replace with a real account address
-   *     eventType: "0x1::transaction_fee::FeeStatement", // replace with a real event type
-   *     minimumLedgerVersion: 1, // optional, specify if needed
-   *   });
-   *
-   *   console.log(events);
-   * }
-   * runExample().catch(console.error);
-   * ```
-   * @group Event
-   */
-  async getAccountEventsByEventType(args: {
-    accountAddress: AccountAddressInput;
-    eventType: MoveStructId;
-    minimumLedgerVersion?: AnyNumber;
-    options?: PaginationArgs & OrderByArg<GetEventsResponse[0]>;
-  }): Promise<GetEventsResponse> {
-    await waitForIndexerOnVersion({
-      config: this.config,
-      minimumLedgerVersion: args.minimumLedgerVersion,
-      processorType: ProcessorType.EVENTS_PROCESSOR,
-    });
-    return getAccountEventsByEventType({ aptosConfig: this.config, ...args });
-  }
-
-  /**
-   * Retrieve all events from the Aptos blockchain.
-   * An optional `where` clause can be provided to filter the results based on specific criteria.
-   *
-   * @param args Optional parameters for the query.
-   * @param args.minimumLedgerVersion Optional ledger version to sync up to before querying.
-   * @param args.options Optional pagination and filtering options.
-   * @param args.options.where Optional condition to filter events.
-   * @param args.options.offset Optional pagination offset.
-   * @param args.options.limit Optional maximum number of events to return.
-   * @param args.options.orderBy Optional ordering of the results.
-   *
-   * @returns GetEventsQuery response type containing the events.
-   *
-   * @example
-   * ```typescript
-   * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
-   *
-   * const config = new AptosConfig({ network: Network.TESTNET });
-   * const aptos = new Aptos(config);
-   *
-   * async function runExample() {
-   *   // Retrieve all events
-   *   const events = await aptos.getEvents();
-   *
-   *   // Retrieve events with filtering by account address
-   *   const whereCondition = {
-   *     account_address: { _eq: "0x123" }, // replace with a real account address
-   *   };
-   *   const filteredEvents = await aptos.getEvents({
-   *     options: { where: whereCondition },
-   *   });
-   *
-   *   console.log(events);
-   *   console.log(filteredEvents);
-   * }
-   * runExample().catch(console.error);
-   * ```
-   * @group Event
-   */
-  async getEvents(args?: {
-    minimumLedgerVersion?: AnyNumber;
-    options?: PaginationArgs & OrderByArg<GetEventsResponse[0]> & WhereArg<EventsBoolExp>;
-  }): Promise<GetEventsResponse> {
-    await waitForIndexerOnVersion({
-      config: this.config,
-      minimumLedgerVersion: args?.minimumLedgerVersion,
-      processorType: ProcessorType.EVENTS_PROCESSOR,
-    });
-    return getEvents({ aptosConfig: this.config, ...args });
-  }
-}

package/src/internal/event.ts

@@ -1,166 +0,0 @@
-// Copyright © Aptos Foundation
-// SPDX-License-Identifier: Apache-2.0
-
-/**
- * This file contains the underlying implementations for exposed API surface in
- * the {@link api/event}. By moving the methods out into a separate file,
- * other namespaces and processes can access these methods without depending on the entire
- * event namespace and without having a dependency cycle error.
- * @group Implementation
- */
-
-import { AptosConfig } from "../api/aptosConfig";
-import { AccountAddress, AccountAddressInput } from "../core";
-import { AnyNumber, GetEventsResponse, PaginationArgs, MoveStructId, OrderByArg, WhereArg } from "../types";
-import { GetEventsQuery } from "../types/generated/operations";
-import { GetEvents } from "../types/generated/queries";
-import { EventsBoolExp, InputMaybe } from "../types/generated/types";
-import { queryIndexer } from "./general";
-
-const MAX_EVENT_TYPE_LENGTH = 300;
-const checkEventTypeLength = (eventType?: InputMaybe<string>) => {
-  if (eventType && eventType.length > MAX_EVENT_TYPE_LENGTH) {
-    throw new Error(`Event type length exceeds the maximum length of ${MAX_EVENT_TYPE_LENGTH}`);
-  }
-};
-
-/**
- * Retrieves events associated with a specific module event type.
- * This function allows you to filter events based on the event type and pagination options.
- *
- * @param args - The arguments for retrieving module events.
- * @param args.aptosConfig - The configuration object for Aptos.
- * @param args.eventType - The MoveStructId representing the type of event to retrieve.
- * @param [args.options] - Optional pagination and ordering parameters for the event retrieval.
- * @group Implementation
- */
-export async function getModuleEventsByEventType(args: {
-  aptosConfig: AptosConfig;
-  eventType: MoveStructId;
-  options?: PaginationArgs & OrderByArg<GetEventsResponse[0]>;
-}): Promise<GetEventsResponse> {
-  const { aptosConfig, eventType, options } = args;
-
-  const whereCondition: EventsBoolExp = {
-    _or: [
-      // EventHandle events
-      { account_address: { _eq: eventType.split("::")[0] } },
-      // Module events
-      {
-        account_address: { _eq: "0x0000000000000000000000000000000000000000000000000000000000000000" },
-        sequence_number: { _eq: 0 },
-        creation_number: { _eq: 0 },
-      },
-    ],
-    indexed_type: { _eq: eventType },
-  };
-
-  return getEvents({ aptosConfig, options: { ...options, where: whereCondition } });
-}
-
-/**
- * Retrieve events associated with a specific account and creation number.
- *
- * @param args - The parameters for retrieving account events.
- * @param args.aptosConfig - The configuration settings for the Aptos client.
- * @param args.accountAddress - The address of the account for which events are being retrieved.
- * @param args.creationNumber - The creation number to filter events.
- * @param args.options - Optional pagination and ordering parameters for the event retrieval.
- * @group Implementation
- */
-export async function getAccountEventsByCreationNumber(args: {
-  aptosConfig: AptosConfig;
-  accountAddress: AccountAddressInput;
-  creationNumber: AnyNumber;
-  options?: PaginationArgs & OrderByArg<GetEventsResponse[0]>;
-}): Promise<GetEventsResponse> {
-  const { accountAddress, aptosConfig, creationNumber, options } = args;
-  const address = AccountAddress.from(accountAddress);
-
-  const whereCondition: EventsBoolExp = {
-    account_address: { _eq: address.toStringLong() },
-    creation_number: { _eq: creationNumber },
-  };
-
-  return getEvents({ aptosConfig, options: { ...options, where: whereCondition } });
-}
-
-/**
- * Retrieves events associated with a specific account and event type.
- *
- * @param args - The parameters for retrieving account events.
- * @param args.aptosConfig - The configuration for connecting to the Aptos blockchain.
- * @param args.accountAddress - The address of the account for which to retrieve events.
- * @param args.eventType - The type of event to filter by.
- * @param args.options - Optional pagination and ordering parameters for the event retrieval.
- * @group Implementation
- */
-export async function getAccountEventsByEventType(args: {
-  aptosConfig: AptosConfig;
-  accountAddress: AccountAddressInput;
-  eventType: MoveStructId;
-  options?: PaginationArgs & OrderByArg<GetEventsResponse[0]>;
-}): Promise<GetEventsResponse> {
-  const { accountAddress, aptosConfig, eventType, options } = args;
-  const address = AccountAddress.from(accountAddress).toStringLong();
-
-  const whereCondition: EventsBoolExp = {
-    account_address: { _eq: address },
-    indexed_type: { _eq: eventType },
-  };
-
-  return getEvents({ aptosConfig, options: { ...options, where: whereCondition } });
-}
-
-/**
- * Retrieves a list of events based on specified filtering and pagination options.
- *
- * @param args - The arguments for retrieving events.
- * @param args.aptosConfig - The configuration for connecting to the Aptos network.
- * @param [args.options] - Optional parameters for pagination and filtering.
- * @param [args.options.offset] - The number of records to skip before starting to collect the result set.
- * @param [args.options.limit] - The maximum number of records to return.
- * @param [args.options.orderBy] - Defines the order in which to return the events.
- * @param [args.options.where] - Conditions to filter the events.
- * @param [args.options.where.indexed_type] - Filters events by the indexed type.
- * @group Implementation
- */
-export async function getEvents(args: {
-  aptosConfig: AptosConfig;
-  options?: PaginationArgs & OrderByArg<GetEventsResponse[0]> & WhereArg<EventsBoolExp>;
-}): Promise<GetEventsResponse> {
-  const { aptosConfig, options } = args;
-
-  /**
-   * Checks the length of event types based on the provided filtering options.
-   *
-   * @param options - The options for querying event types.
-   * @param options.where - The conditions to filter the event types.
-   * @param options.where.indexed_type - The indexed type to filter by.
-   * @param options.where.indexed_type._eq - The specific value to match for the indexed type.
-   * @param options.offset - The number of items to skip before starting to collect the result set.
-   * @param options.limit - The maximum number of items to return.
-   * @param options.orderBy - The criteria to sort the results.
-   * @group Implementation
-   */
-  // eslint-disable-next-line no-underscore-dangle
-  checkEventTypeLength(options?.where?.indexed_type?._eq);
-
-  const graphqlQuery = {
-    query: GetEvents,
-    variables: {
-      where_condition: options?.where,
-      offset: options?.offset,
-      limit: options?.limit,
-      order_by: options?.orderBy,
-    },
-  };
-
-  const data = await queryIndexer<GetEventsQuery>({
-    aptosConfig,
-    query: graphqlQuery,
-    originMethod: "getEvents",
-  });
-
-  return data.events;
-}