@aptos-labs/ts-sdk 6.3.1 → 7.0.1

package/dist/internal/staking.js

@@ -0,0 +1,71 @@
+// Copyright © Aptos Foundation
+// SPDX-License-Identifier: Apache-2.0
+import { AccountAddress } from "../core/index.js";
+import { GetDelegatedStakingActivities, GetNumberOfDelegators } from "../types/generated/queries.js";
+import { queryIndexer } from "./general.js";
+/**
+ * Retrieves the number of active delegators for a specified pool address.
+ *
+ * @param args - The arguments for the function.
+ * @param args.aptosConfig - The configuration object for Aptos.
+ * @param args.poolAddress - The address of the pool for which to retrieve the number of delegators.
+ * @returns The number of active delegators for the specified pool address.
+ * @group Implementation
+ */
+export async function getNumberOfDelegators(args) {
+    const { aptosConfig, poolAddress } = args;
+    const address = AccountAddress.from(poolAddress).toStringLong();
+    const query = {
+        query: GetNumberOfDelegators,
+        variables: { where_condition: { pool_address: { _eq: address } } },
+    };
+    const data = await queryIndexer({ aptosConfig, query });
+    // commonjs (aka cjs) doesn't handle Nullish Coalescing for some reason
+    // might be because of how ts infer the graphql generated scheme type
+    return data.num_active_delegator_per_pool[0] ? data.num_active_delegator_per_pool[0].num_active_delegator : 0;
+}
+/**
+ * Retrieves the number of active delegators for all pools.
+ *
+ * @param args - The arguments for the function.
+ * @param args.aptosConfig - The configuration for the Aptos client.
+ * @param [args.options] - Optional parameters for ordering the results.
+ * @param args.options.orderBy - Specifies the order in which to return the results.
+ * @returns The number of active delegators per pool.
+ * @group Implementation
+ */
+export async function getNumberOfDelegatorsForAllPools(args) {
+    const { aptosConfig, options } = args;
+    const query = {
+        query: GetNumberOfDelegators,
+        variables: { order_by: options?.orderBy },
+    };
+    const data = await queryIndexer({
+        aptosConfig,
+        query,
+    });
+    return data.num_active_delegator_per_pool;
+}
+/**
+ * Retrieves the delegated staking activities for a specified delegator and pool.
+ *
+ * @param args - The parameters for the query.
+ * @param args.aptosConfig - The configuration object for Aptos.
+ * @param args.delegatorAddress - The address of the delegator whose activities are being queried.
+ * @param args.poolAddress - The address of the pool associated with the delegated staking activities.
+ * @returns The delegated staking activities for the specified delegator and pool.
+ * @group Implementation
+ */
+export async function getDelegatedStakingActivities(args) {
+    const { aptosConfig, delegatorAddress, poolAddress } = args;
+    const query = {
+        query: GetDelegatedStakingActivities,
+        variables: {
+            delegatorAddress: AccountAddress.from(delegatorAddress).toStringLong(),
+            poolAddress: AccountAddress.from(poolAddress).toStringLong(),
+        },
+    };
+    const data = await queryIndexer({ aptosConfig, query });
+    return data.delegated_staking_activities;
+}
+//# sourceMappingURL=staking.js.map

package/dist/internal/staking.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"staking.js","sourceRoot":"","sources":["../../src/internal/staking.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAC/B,sCAAsC;AAWtC,OAAO,EAAE,cAAc,EAAuB,MAAM,kBAAkB,CAAC;AAGvE,OAAO,EAAE,6BAA6B,EAAE,qBAAqB,EAAE,MAAM,+BAA+B,CAAC;AACrG,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAE5C;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB,CAAC,IAG3C;IACC,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC;IAC1C,MAAM,OAAO,GAAG,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,YAAY,EAAE,CAAC;IAChE,MAAM,KAAK,GAAG;QACZ,KAAK,EAAE,qBAAqB;QAC5B,SAAS,EAAE,EAAE,eAAe,EAAE,EAAE,YAAY,EAAE,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE,EAAE;KACnE,CAAC;IACF,MAAM,IAAI,GAAG,MAAM,YAAY,CAA6B,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC,CAAC;IAEpF,uEAAuE;IACvE,qEAAqE;IACrE,OAAO,IAAI,CAAC,6BAA6B,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC,CAAC,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,CAAC;AAChH,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,gCAAgC,CAAC,IAGtD;IACC,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IACtC,MAAM,KAAK,GAAG;QACZ,KAAK,EAAE,qBAAqB;QAC5B,SAAS,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE;KAC1C,CAAC;IACF,MAAM,IAAI,GAAG,MAAM,YAAY,CAA6B;QAC1D,WAAW;QACX,KAAK;KACN,CAAC,CAAC;IACH,OAAO,IAAI,CAAC,6BAA6B,CAAC;AAC5C,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,6BAA6B,CAAC,IAInD;IACC,MAAM,EAAE,WAAW,EAAE,gBAAgB,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC;IAC5D,MAAM,KAAK,GAAG;QACZ,KAAK,EAAE,6BAA6B;QACpC,SAAS,EAAE;YACT,gBAAgB,EAAE,cAAc,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,YAAY,EAAE;YACtE,WAAW,EAAE,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,YAAY,EAAE;SAC7D;KACF,CAAC;IACF,MAAM,IAAI,GAAG,MAAM,YAAY,CAAqC,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC,CAAC;IAC5F,OAAO,IAAI,CAAC,4BAA4B,CAAC;AAC3C,CAAC"}

package/dist/internal/table.d.ts

@@ -0,0 +1,60 @@
+import { AptosConfig } from "../api/aptosConfig.js";
+import { TableItemRequest, LedgerVersionArg, PaginationArgs, WhereArg, OrderByArg, GetTableItemsDataResponse, GetTableItemsMetadataResponse } from "../types/index.js";
+import { TableItemsBoolExp, TableMetadatasBoolExp } from "../types/generated/types.js";
+/**
+ * Retrieves a specific item from a table in the Aptos blockchain.
+ *
+ * @param args - The arguments for retrieving the table item.
+ * @param args.aptosConfig - The configuration for connecting to the Aptos blockchain.
+ * @param args.handle - The identifier for the table from which to retrieve the item.
+ * @param args.data - The request data for the table item.
+ * @param args.options - Optional parameters for the request, including ledger version.
+ * @group Implementation
+ */
+export declare function getTableItem<T>(args: {
+    aptosConfig: AptosConfig;
+    handle: string;
+    data: TableItemRequest;
+    options?: LedgerVersionArg;
+}): Promise<T>;
+/**
+ * Retrieves table items data based on specified conditions and pagination options.
+ *
+ * @param args - The arguments for retrieving table items data.
+ * @param args.aptosConfig - The configuration object for Aptos.
+ * @param args.options - Optional parameters for pagination and filtering.
+ * @param args.options.offset - The number of items to skip before starting to collect the result set.
+ * @param args.options.limit - The maximum number of items to return.
+ * @param args.options.where - Conditions to filter the table items.
+ * @param args.options.orderBy - The criteria to sort the results.
+ * @group Implementation
+ */
+export declare function getTableItemsData(args: {
+    aptosConfig: AptosConfig;
+    options?: PaginationArgs & WhereArg<TableItemsBoolExp> & OrderByArg<GetTableItemsDataResponse[0]>;
+}): Promise<{
+    decoded_key: any;
+    decoded_value?: any | null;
+    key: string;
+    table_handle: string;
+    transaction_version: any;
+    write_set_change_index: any;
+}[]>;
+/**
+ * Retrieves metadata for table items based on specified options.
+ *
+ * @param args - The arguments for retrieving table items metadata.
+ * @param args.aptosConfig - The configuration object for Aptos.
+ * @param args.options - Optional parameters for pagination and filtering.
+ * @param args.options.offset - The number of items to skip before starting to collect the result set.
+ * @param args.options.limit - The maximum number of items to return.
+ * @param args.options.where - Conditions to filter the results.
+ * @param args.options.orderBy - The order in which to return the results.
+ * @returns A promise that resolves to an array of table metadata.
+ * @group Implementation
+ */
+export declare function getTableItemsMetadata(args: {
+    aptosConfig: AptosConfig;
+    options?: PaginationArgs & WhereArg<TableMetadatasBoolExp> & OrderByArg<GetTableItemsMetadataResponse[0]>;
+}): Promise<GetTableItemsMetadataResponse>;
+//# sourceMappingURL=table.d.ts.map

package/dist/internal/table.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"table.d.ts","sourceRoot":"","sources":["../../src/internal/table.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAEpD,OAAO,EACL,gBAAgB,EAChB,gBAAgB,EAChB,cAAc,EACd,QAAQ,EACR,UAAU,EACV,yBAAyB,EACzB,6BAA6B,EAC9B,MAAM,mBAAmB,CAAC;AAG3B,OAAO,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AAGvF;;;;;;;;;GASG;AACH,wBAAsB,YAAY,CAAC,CAAC,EAAE,IAAI,EAAE;IAC1C,WAAW,EAAE,WAAW,CAAC;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,gBAAgB,CAAC;IACvB,OAAO,CAAC,EAAE,gBAAgB,CAAC;CAC5B,GAAG,OAAO,CAAC,CAAC,CAAC,CAUb;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,iBAAiB,CAAC,IAAI,EAAE;IAC5C,WAAW,EAAE,WAAW,CAAC;IACzB,OAAO,CAAC,EAAE,cAAc,GAAG,QAAQ,CAAC,iBAAiB,CAAC,GAAG,UAAU,CAAC,yBAAyB,CAAC,CAAC,CAAC,CAAC,CAAC;CACnG;;;;;;;KAoBA;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,qBAAqB,CAAC,IAAI,EAAE;IAChD,WAAW,EAAE,WAAW,CAAC;IACzB,OAAO,CAAC,EAAE,cAAc,GAAG,QAAQ,CAAC,qBAAqB,CAAC,GAAG,UAAU,CAAC,6BAA6B,CAAC,CAAC,CAAC,CAAC,CAAC;CAC3G,GAAG,OAAO,CAAC,6BAA6B,CAAC,CAoBzC"}

package/dist/internal/table.js

@@ -0,0 +1,86 @@
+import { postAptosFullNode } from "../client/index.js";
+import { GetTableItemsData, GetTableItemsMetadata } from "../types/generated/queries.js";
+import { queryIndexer } from "./general.js";
+/**
+ * Retrieves a specific item from a table in the Aptos blockchain.
+ *
+ * @param args - The arguments for retrieving the table item.
+ * @param args.aptosConfig - The configuration for connecting to the Aptos blockchain.
+ * @param args.handle - The identifier for the table from which to retrieve the item.
+ * @param args.data - The request data for the table item.
+ * @param args.options - Optional parameters for the request, including ledger version.
+ * @group Implementation
+ */
+export async function getTableItem(args) {
+    const { aptosConfig, handle, data, options } = args;
+    const response = await postAptosFullNode({
+        aptosConfig,
+        originMethod: "getTableItem",
+        path: `tables/${handle}/item`,
+        params: { ledger_version: options?.ledgerVersion },
+        body: data,
+    });
+    return response.data;
+}
+/**
+ * Retrieves table items data based on specified conditions and pagination options.
+ *
+ * @param args - The arguments for retrieving table items data.
+ * @param args.aptosConfig - The configuration object for Aptos.
+ * @param args.options - Optional parameters for pagination and filtering.
+ * @param args.options.offset - The number of items to skip before starting to collect the result set.
+ * @param args.options.limit - The maximum number of items to return.
+ * @param args.options.where - Conditions to filter the table items.
+ * @param args.options.orderBy - The criteria to sort the results.
+ * @group Implementation
+ */
+export async function getTableItemsData(args) {
+    const { aptosConfig, options } = args;
+    const graphqlQuery = {
+        query: GetTableItemsData,
+        variables: {
+            where_condition: options?.where,
+            offset: options?.offset,
+            limit: options?.limit,
+            order_by: options?.orderBy,
+        },
+    };
+    const data = await queryIndexer({
+        aptosConfig,
+        query: graphqlQuery,
+        originMethod: "getTableItemsData",
+    });
+    return data.table_items;
+}
+/**
+ * Retrieves metadata for table items based on specified options.
+ *
+ * @param args - The arguments for retrieving table items metadata.
+ * @param args.aptosConfig - The configuration object for Aptos.
+ * @param args.options - Optional parameters for pagination and filtering.
+ * @param args.options.offset - The number of items to skip before starting to collect the result set.
+ * @param args.options.limit - The maximum number of items to return.
+ * @param args.options.where - Conditions to filter the results.
+ * @param args.options.orderBy - The order in which to return the results.
+ * @returns A promise that resolves to an array of table metadata.
+ * @group Implementation
+ */
+export async function getTableItemsMetadata(args) {
+    const { aptosConfig, options } = args;
+    const graphqlQuery = {
+        query: GetTableItemsMetadata,
+        variables: {
+            where_condition: options?.where,
+            offset: options?.offset,
+            limit: options?.limit,
+            order_by: options?.orderBy,
+        },
+    };
+    const data = await queryIndexer({
+        aptosConfig,
+        query: graphqlQuery,
+        originMethod: "getTableItemsMetadata",
+    });
+    return data.table_metadatas;
+}
+//# sourceMappingURL=table.js.map

package/dist/internal/table.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"table.js","sourceRoot":"","sources":["../../src/internal/table.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAWvD,OAAO,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,MAAM,+BAA+B,CAAC;AAEzF,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAE5C;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAI,IAKrC;IACC,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IACpD,MAAM,QAAQ,GAAG,MAAM,iBAAiB,CAAwB;QAC9D,WAAW;QACX,YAAY,EAAE,cAAc;QAC5B,IAAI,EAAE,UAAU,MAAM,OAAO;QAC7B,MAAM,EAAE,EAAE,cAAc,EAAE,OAAO,EAAE,aAAa,EAAE;QAClD,IAAI,EAAE,IAAI;KACX,CAAC,CAAC;IACH,OAAO,QAAQ,CAAC,IAAS,CAAC;AAC5B,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAC,IAGvC;IACC,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IAEtC,MAAM,YAAY,GAAG;QACnB,KAAK,EAAE,iBAAiB;QACxB,SAAS,EAAE;YACT,eAAe,EAAE,OAAO,EAAE,KAAK;YAC/B,MAAM,EAAE,OAAO,EAAE,MAAM;YACvB,KAAK,EAAE,OAAO,EAAE,KAAK;YACrB,QAAQ,EAAE,OAAO,EAAE,OAAO;SAC3B;KACF,CAAC;IAEF,MAAM,IAAI,GAAG,MAAM,YAAY,CAAyB;QACtD,WAAW;QACX,KAAK,EAAE,YAAY;QACnB,YAAY,EAAE,mBAAmB;KAClC,CAAC,CAAC;IAEH,OAAO,IAAI,CAAC,WAAW,CAAC;AAC1B,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB,CAAC,IAG3C;IACC,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IAEtC,MAAM,YAAY,GAAG;QACnB,KAAK,EAAE,qBAAqB;QAC5B,SAAS,EAAE;YACT,eAAe,EAAE,OAAO,EAAE,KAAK;YAC/B,MAAM,EAAE,OAAO,EAAE,MAAM;YACvB,KAAK,EAAE,OAAO,EAAE,KAAK;YACrB,QAAQ,EAAE,OAAO,EAAE,OAAO;SAC3B;KACF,CAAC;IAEF,MAAM,IAAI,GAAG,MAAM,YAAY,CAA6B;QAC1D,WAAW;QACX,KAAK,EAAE,YAAY;QACnB,YAAY,EAAE,uBAAuB;KACtC,CAAC,CAAC;IAEH,OAAO,IAAI,CAAC,eAAe,CAAC;AAC9B,CAAC"}

package/dist/internal/transaction.d.ts

@@ -0,0 +1,192 @@
+/**
+ * This file contains the underlying implementations for exposed API surface in
+ * the {@link api/transaction}. By moving the methods out into a separate file,
+ * other namespaces and processes can access these methods without depending on the entire
+ * transaction namespace and without having a dependency cycle error.
+ * @group Implementation
+ */
+import { AptosConfig } from "../api/aptosConfig.js";
+import { type AnyNumber, type GasEstimation, type HexInput, type PaginationArgs, type TransactionResponse, WaitForTransactionOptions, CommittedTransactionResponse, Block } from "../types/index.js";
+import { ProcessorType } from "../utils/const.js";
+/**
+ * Retrieve a list of transactions based on the specified options.
+ *
+ * @param {Object} args - The parameters for retrieving transactions.
+ * @param {Object} args.aptosConfig - The configuration object for Aptos.
+ * @param {Object} args.options - The options for pagination.
+ * @param {number} args.options.offset - The number of transactions to skip before starting to collect the result set.
+ * @param {number} args.options.limit - The maximum number of transactions to return.
+ * @group Implementation
+ */
+export declare function getTransactions(args: {
+    aptosConfig: AptosConfig;
+    options?: PaginationArgs;
+}): Promise<TransactionResponse[]>;
+/**
+ * Retrieves the estimated gas price for transactions on the Aptos network.
+ * This function helps users understand the current gas price, which is essential for transaction planning and cost estimation.
+ *
+ * @param args - The configuration parameters for the Aptos network.
+ * @param args.aptosConfig - The configuration object containing network details.
+ * @group Implementation
+ */
+export declare function getGasPriceEstimation(args: {
+    aptosConfig: AptosConfig;
+}): Promise<GasEstimation>;
+/**
+ * Retrieves the transaction details associated with a specific ledger version.
+ *
+ * @param args - The arguments for the transaction retrieval.
+ * @param args.aptosConfig - The configuration settings for the Aptos client.
+ * @param args.ledgerVersion - The ledger version for which to retrieve the transaction.
+ * @returns The transaction details for the specified ledger version.
+ * @group Implementation
+ */
+export declare function getTransactionByVersion(args: {
+    aptosConfig: AptosConfig;
+    ledgerVersion: AnyNumber;
+}): Promise<TransactionResponse>;
+/**
+ * Retrieves transaction details using the specified transaction hash.
+ *
+ * @param args - The arguments for retrieving the transaction.
+ * @param args.aptosConfig - The configuration settings for the Aptos client.
+ * @param args.transactionHash - The hash of the transaction to retrieve.
+ * @returns A promise that resolves to the transaction details.
+ * @group Implementation
+ */
+export declare function getTransactionByHash(args: {
+    aptosConfig: AptosConfig;
+    transactionHash: HexInput;
+}): Promise<TransactionResponse>;
+/**
+ * Checks if a transaction is currently pending based on its hash.
+ * This function helps determine the status of a transaction in the Aptos network.
+ *
+ * @param args - The arguments for checking the transaction status.
+ * @param args.aptosConfig - The configuration settings for connecting to the Aptos network.
+ * @param args.transactionHash - The hash of the transaction to check.
+ * @returns A boolean indicating whether the transaction is pending.
+ * @throws An error if the transaction cannot be retrieved due to reasons other than a 404 status.
+ * @group Implementation
+ */
+export declare function isTransactionPending(args: {
+    aptosConfig: AptosConfig;
+    transactionHash: HexInput;
+}): Promise<boolean>;
+/**
+ * Waits for a transaction to be confirmed by its hash.
+ * This function allows you to monitor the status of a transaction until it is finalized.
+ *
+ * @param args - The arguments for the function.
+ * @param args.aptosConfig - The configuration settings for the Aptos client.
+ * @param args.transactionHash - The hash of the transaction to wait for.
+ * @group Implementation
+ */
+export declare function longWaitForTransaction(args: {
+    aptosConfig: AptosConfig;
+    transactionHash: HexInput;
+}): Promise<TransactionResponse>;
+/**
+ * Waits for a transaction to be confirmed on the blockchain and handles potential errors during the process.
+ * This function allows you to monitor the status of a transaction until it is either confirmed or fails.
+ *
+ * @param args - The arguments for waiting for a transaction.
+ * @param args.aptosConfig - The configuration settings for Aptos.
+ * @param args.transactionHash - The hash of the transaction to wait for.
+ * @param args.options - Optional settings for waiting, including timeout and success check.
+ * @param args.options.timeoutSecs - The maximum time to wait for the transaction in seconds. Defaults to a predefined value.
+ * @param args.options.checkSuccess - A flag indicating whether to check the success status of the transaction. Defaults to true.
+ * @returns A promise that resolves to the transaction response once the transaction is confirmed.
+ * @throws WaitForTransactionError if the transaction times out or remains pending.
+ * @throws FailedTransactionError if the transaction fails.
+ * @group Implementation
+ */
+export declare function waitForTransaction(args: {
+    aptosConfig: AptosConfig;
+    transactionHash: HexInput;
+    options?: WaitForTransactionOptions;
+}): Promise<CommittedTransactionResponse>;
+/**
+ * Waits for the indexer to sync up to the specified ledger version. The timeout is 3 seconds.
+ *
+ * @param args - The arguments for the function.
+ * @param args.aptosConfig - The configuration object for Aptos.
+ * @param args.minimumLedgerVersion - The minimum ledger version that the indexer should sync to.
+ * @param args.processorType - (Optional) The type of processor to check the last success version from.
+ * @group Implementation
+ */
+export declare function waitForIndexer(args: {
+    aptosConfig: AptosConfig;
+    minimumLedgerVersion: AnyNumber;
+    processorType?: ProcessorType;
+}): Promise<void>;
+/**
+ * Represents an error that occurs when waiting for a transaction to complete.
+ * This error is thrown by the `waitForTransaction` function when a transaction
+ * times out or when the transaction response is undefined.
+ *
+ * @param message - A descriptive message for the error.
+ * @param lastSubmittedTransaction - The last submitted transaction response, if available.
+ * @group Implementation
+ */
+export declare class WaitForTransactionError extends Error {
+    readonly lastSubmittedTransaction: TransactionResponse | undefined;
+    /**
+     * Constructs an instance of the class with a specified message and transaction response.
+     *
+     * @param message - The message associated with the transaction.
+     * @param lastSubmittedTransaction - The transaction response object containing details about the transaction.
+     * @group Implementation
+     */
+    constructor(message: string, lastSubmittedTransaction: TransactionResponse | undefined);
+}
+/**
+ * Represents an error that occurs when a transaction fails.
+ * This error is thrown by the `waitForTransaction` function when the `checkSuccess` parameter is set to true.
+ *
+ * @param message - A description of the error.
+ * @param transaction - The transaction response associated with the failure.
+ * @group Implementation
+ */
+export declare class FailedTransactionError extends Error {
+    readonly transaction: TransactionResponse;
+    constructor(message: string, transaction: TransactionResponse);
+}
+/**
+ * Retrieves a block from the Aptos blockchain by its ledger version.
+ * This function allows you to obtain detailed information about a specific block, including its transactions if requested.
+ *
+ * @param args - The arguments for retrieving the block.
+ * @param args.aptosConfig - The configuration object for connecting to the Aptos node.
+ * @param args.ledgerVersion - The ledger version of the block to retrieve.
+ * @param args.options - Optional parameters for the request.
+ * @param args.options.withTransactions - Indicates whether to include transactions in the block data.
+ * @group Implementation
+ */
+export declare function getBlockByVersion(args: {
+    aptosConfig: AptosConfig;
+    ledgerVersion: AnyNumber;
+    options?: {
+        withTransactions?: boolean;
+    };
+}): Promise<Block>;
+/**
+ * Retrieves a block from the Aptos blockchain by its height.
+ *
+ * @param args - The parameters for retrieving the block.
+ * @param args.aptosConfig - The configuration object for connecting to the Aptos network.
+ * @param args.blockHeight - The height of the block to retrieve.
+ * @param args.options - Optional parameters for the request.
+ * @param args.options.withTransactions - Indicates whether to include transactions in the block data.
+ * @returns A promise that resolves to the block data, potentially including its transactions.
+ * @group Implementation
+ */
+export declare function getBlockByHeight(args: {
+    aptosConfig: AptosConfig;
+    blockHeight: AnyNumber;
+    options?: {
+        withTransactions?: boolean;
+    };
+}): Promise<Block>;
+//# sourceMappingURL=transaction.d.ts.map

package/dist/internal/transaction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction.d.ts","sourceRoot":"","sources":["../../src/internal/transaction.ts"],"names":[],"mappings":"AAGA;;;;;;GAMG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAGpD,OAAO,EAEL,KAAK,SAAS,EACd,KAAK,aAAa,EAClB,KAAK,QAAQ,EACb,KAAK,cAAc,EACnB,KAAK,mBAAmB,EACxB,yBAAyB,EACzB,4BAA4B,EAC5B,KAAK,EACN,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAA2B,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAK3E;;;;;;;;;GASG;AACH,wBAAsB,eAAe,CAAC,IAAI,EAAE;IAC1C,WAAW,EAAE,WAAW,CAAC;IACzB,OAAO,CAAC,EAAE,cAAc,CAAC;CAC1B,GAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC,CAQjC;AAED;;;;;;;GAOG;AACH,wBAAsB,qBAAqB,CAAC,IAAI,EAAE;IAAE,WAAW,EAAE,WAAW,CAAA;CAAE,0BAe7E;AAED;;;;;;;;GAQG;AACH,wBAAsB,uBAAuB,CAAC,IAAI,EAAE;IAClD,WAAW,EAAE,WAAW,CAAC;IACzB,aAAa,EAAE,SAAS,CAAC;CAC1B,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAQ/B;AAED;;;;;;;;GAQG;AACH,wBAAsB,oBAAoB,CAAC,IAAI,EAAE;IAC/C,WAAW,EAAE,WAAW,CAAC;IACzB,eAAe,EAAE,QAAQ,CAAC;CAC3B,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAQ/B;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,oBAAoB,CAAC,IAAI,EAAE;IAC/C,WAAW,EAAE,WAAW,CAAC;IACzB,eAAe,EAAE,QAAQ,CAAC;CAC3B,GAAG,OAAO,CAAC,OAAO,CAAC,CAWnB;AAED;;;;;;;;GAQG;AACH,wBAAsB,sBAAsB,CAAC,IAAI,EAAE;IACjD,WAAW,EAAE,WAAW,CAAC;IACzB,eAAe,EAAE,QAAQ,CAAC;CAC3B,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAQ/B;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,kBAAkB,CAAC,IAAI,EAAE;IAC7C,WAAW,EAAE,WAAW,CAAC;IACzB,eAAe,EAAE,QAAQ,CAAC;IAC1B,OAAO,CAAC,EAAE,yBAAyB,CAAC;CACrC,GAAG,OAAO,CAAC,4BAA4B,CAAC,CAuGxC;AAED;;;;;;;;GAQG;AACH,wBAAsB,cAAc,CAAC,IAAI,EAAE;IACzC,WAAW,EAAE,WAAW,CAAC;IACzB,oBAAoB,EAAE,SAAS,CAAC;IAChC,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B,GAAG,OAAO,CAAC,IAAI,CAAC,CA+BhB;AAED;;;;;;;;GAQG;AACH,qBAAa,uBAAwB,SAAQ,KAAK;IAChD,SAAgB,wBAAwB,EAAE,mBAAmB,GAAG,SAAS,CAAC;IAE1E;;;;;;OAMG;gBACS,OAAO,EAAE,MAAM,EAAE,wBAAwB,EAAE,mBAAmB,GAAG,SAAS;CAIvF;AAED;;;;;;;GAOG;AACH,qBAAa,sBAAuB,SAAQ,KAAK;IAC/C,SAAgB,WAAW,EAAE,mBAAmB,CAAC;gBAErC,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,mBAAmB;CAI9D;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,iBAAiB,CAAC,IAAI,EAAE;IAC5C,WAAW,EAAE,WAAW,CAAC;IACzB,aAAa,EAAE,SAAS,CAAC;IACzB,OAAO,CAAC,EAAE;QAAE,gBAAgB,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC;CAC1C,GAAG,OAAO,CAAC,KAAK,CAAC,CAUjB;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,gBAAgB,CAAC,IAAI,EAAE;IAC3C,WAAW,EAAE,WAAW,CAAC;IACzB,WAAW,EAAE,SAAS,CAAC;IACvB,OAAO,CAAC,EAAE;QAAE,gBAAgB,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC;CAC1C,GAAG,OAAO,CAAC,KAAK,CAAC,CASjB"}