aftermath-ts-sdk 1.2.63 → 1.2.64-docs.1

package/dist/general/providers/aftermathApi.js

@@ -27,18 +27,40 @@ const multisigApi_1 = require("../../packages/multisig/api/multisigApi");
 const userDataApi_1 = require("../../packages/userData/api/userDataApi");
 const limitOrdersApi_1 = require("../../packages/limitOrders/api/limitOrdersApi");
 /**
- * This class represents the Aftermath API and provides helper methods for various functionalities.
- * @class
+ * The `AftermathApi` class is a low-level factory and reference point for
+ * interacting directly with underlying API modules (e.g., PoolsApi, StakingApi).
+ * It encapsulates a configured `SuiClient` and the known `addresses` for the
+ * Aftermath protocol, allowing flexible or advanced usage scenarios.
+ *
+ * @example
+ * ```typescript
+ * import { AftermathApi } from "aftermath-ts-sdk";
+ * import { SuiClient, SuiHTTPTransport } from "@mysten/sui/client";
+ *
+ * const addresses = { ... }; // from aftermath.getAddresses()
+ * const suiClient = new SuiClient({
+ *   transport: new SuiHTTPTransport({
+ *     url: "https://fullnode.mainnet.sui.io",
+ *   }),
+ * });
+ *
+ * const afApi = new AftermathApi(suiClient, addresses);
+ * // access protocol APIs
+ * const poolsApi = afApi.Pools();
+ * ```
  */
 class AftermathApi {
     // =========================================================================
     //  Constructor
     // =========================================================================
     /**
-     * Creates an instance of AftermathApi.
-     * @param provider - The SuiClient instance to use for interacting with the blockchain.
-     * @param addresses - The configuration addresses for the Aftermath protocol.
-     * @param providerV0 - The SuiClient instance to use for interacting with the blockchain.
+     * Constructs a new instance of the `AftermathApi`, binding the given Sui client
+     * to the known `addresses`. Optionally, a `providerV0` can be passed for
+     * legacy transaction building or older Sui libraries.
+     *
+     * @param provider - The `SuiClient` for on-chain queries and transactions.
+     * @param addresses - The config addresses (object IDs, package IDs, etc.) for the Aftermath protocol.
+     * @param providerV0 - An optional legacy `SuiClient` from `@mysten/sui.js/client`.
      */
     constructor(provider, addresses, providerV0) {
         this.provider = provider;
@@ -50,50 +72,135 @@ class AftermathApi {
         // =========================================================================
         //  General
         // =========================================================================
+        /**
+         * Creates a new `DynamicFieldsApiHelpers` instance for complex object field queries.
+         */
         this.DynamicFields = () => new dynamicFieldsApiHelpers_1.DynamicFieldsApiHelpers(this);
+        /**
+         * Creates a new `EventsApiHelpers` instance for querying Sui events.
+         */
         this.Events = () => new eventsApiHelpers_1.EventsApiHelpers(this);
+        /**
+         * Creates a new `InspectionsApiHelpers` instance for reading Summaries or inspection data.
+         */
         this.Inspections = () => new inspectionsApiHelpers_1.InspectionsApiHelpers(this);
+        /**
+         * Creates a new `ObjectsApiHelpers` instance for object retrieval/manipulation.
+         */
         this.Objects = () => new objectsApiHelpers_1.ObjectsApiHelpers(this);
+        /**
+         * Creates a new `TransactionsApiHelpers` instance for querying or parsing transaction data.
+         */
         this.Transactions = () => new transactionsApiHelpers_1.TransactionsApiHelpers(this);
         // =========================================================================
         //  Utils
         // =========================================================================
+        /**
+         * Creates a new `WalletApi` instance for direct wallet-based operations (fetching balances, etc.).
+         */
         this.Wallet = () => new walletApi_1.WalletApi(this);
+        /**
+         * Creates a new `NftsApi` instance for retrieving and interacting with NFT data.
+         */
         this.Nfts = () => new nftsApi_1.NftsApi(this);
         // =========================================================================
         //  General Packages
         // =========================================================================
+        /**
+         * Creates a new `CoinApi` instance for detailed coin operations.
+         */
         this.Coin = () => new coinApi_1.CoinApi(this);
+        /**
+         * Creates a new `SuiApi` instance for lower-level Sui chain interactions.
+         */
         this.Sui = () => new suiApi_1.SuiApi(this);
         // =========================================================================
         //  Aftermath Packages
         // =========================================================================
+        /**
+         * Creates a new `PoolsApi` instance for pool-related interactions (AMM pools, liquidity, etc.).
+         */
         this.Pools = () => new poolsApi_1.PoolsApi(this);
+        /**
+         * Creates a new `FaucetApi` instance for dispensing tokens on supported dev/test networks.
+         */
         this.Faucet = () => new faucetApi_1.FaucetApi(this);
+        /**
+         * Creates a new `SuiFrensApi` instance for special social or token gating utilities on Sui.
+         */
         this.SuiFrens = () => new suiFrensApi_1.SuiFrensApi(this);
+        /**
+         * Creates a new `StakingApi` instance for advanced or direct staking operations on Sui.
+         */
         this.Staking = () => new stakingApi_1.StakingApi(this);
+        /**
+         * Creates a new `NftAmmApi` instance for NFT AMM logic (buy, sell, liquidity).
+         */
         this.NftAmm = () => new nftAmmApi_1.NftAmmApi(this);
+        /**
+         * Creates a new `ReferralVaultApi` instance for referral-based logic in Aftermath.
+         */
         this.ReferralVault = () => new referralVaultApi_1.ReferralVaultApi(this);
+        /**
+         * Creates a new `PerpetualsApi` instance for futures or perpetual derivatives on Sui.
+         */
         this.Perpetuals = () => new perpetualsApi_1.PerpetualsApi(this);
+        /**
+         * Creates a new `OracleApi` instance for price or data feed oracles.
+         */
         this.Oracle = () => new oracleApi_1.OracleApi(this);
+        /**
+         * Creates a new `FarmsApi` instance for yield farming or liquidity mining interactions.
+         */
         this.Farms = () => new farmsApi_1.FarmsApi(this);
+        /**
+         * Creates a new `DcaApi` instance for dollar-cost averaging logic.
+         */
         this.Dca = () => new dcaApi_1.DcaApi(this);
+        /**
+         * Creates a new `MultisigApi` instance for multi-signature address creation and management.
+         */
         this.Multisig = () => new multisigApi_1.MultisigApi(this);
+        /**
+         * Creates a new `LimitOrdersApi` instance for placing limit orders on supported DEX protocols.
+         */
         this.LimitOrders = () => new limitOrdersApi_1.LimitOrdersApi(this);
+        /**
+         * Creates a new `UserDataApi` instance for managing user-specific data storage or sign-on logic.
+         */
         this.UserData = () => new userDataApi_1.UserDataApi(this);
         /**
-         * Creates a new instance of the RouterApi class.
-         * @returns A new instance of the RouterApi class.
+         * Creates a new `RouterApi` instance for best-price trade routing across multiple DEX liquidity sources.
          */
         this.Router = () => new routerApi_1.RouterApi(this);
-        this.LeveragedStaking = (ScallopProviders // ScallopProviders
-        ) => new leveragedStakingApi_1.LeveragedStakingApi(this, ScallopProviders);
+        /**
+         * Creates a new `LeveragedStakingApi` instance for leveraged staking operations,
+         * optionally using `ScallopProviders` if needed.
+         *
+         * @param ScallopProviders - An optional object containing references to Scallop's Sui modules or providers.
+         */
+        this.LeveragedStaking = (ScallopProviders) => new leveragedStakingApi_1.LeveragedStakingApi(this, ScallopProviders);
         // =========================================================================
         //  Helpers
         // =========================================================================
+        /**
+         * Attempts to decode a Move error message into a structured error code,
+         * package ID, module name, and descriptive error string.
+         *
+         * @param inputs - An object containing the raw `errorMessage`.
+         * @returns An object with `errorCode`, `packageId`, `module`, and `error` if translation is successful, or `undefined`.
+         *
+         * @example
+         * ```typescript
+         * const errorDecoded = afApi.translateMoveErrorMessage({ errorMessage: "MoveAbort at ..." });
+         * if (errorDecoded) {
+         *   console.log(errorDecoded.errorCode, errorDecoded.error);
+         * }
+         * ```
+         */
         this.translateMoveErrorMessage = (inputs) => {
             const { errorMessage } = inputs;
-            // TODO: make this work more cleanly
+            // Candidate packageApis that define `moveErrors` we can search against
             const packageApis = [
                 // @ts-ignore
                 this.Pools,
@@ -117,7 +224,9 @@ class AftermathApi {
                         continue;
                     return translation;
                 }
-                catch (e) { }
+                catch (e) {
+                    // If any package lacks `moveErrors`, we skip it
+                }
             }
             return undefined;
         };
@@ -127,22 +236,33 @@ exports.AftermathApi = AftermathApi;
 // =========================================================================
 //  Helpers
 // =========================================================================
+/**
+ * Static helper references for quick usage without instantiating the class.
+ */
 AftermathApi.helpers = {
     // =========================================================================
     //  General
     // =========================================================================
+    /** Helpers for accessing or iterating over dynamic fields in Sui objects. */
     dynamicFields: dynamicFieldsApiHelpers_1.DynamicFieldsApiHelpers,
+    /** Helpers for working with Sui events and pagination. */
     events: eventsApiHelpers_1.EventsApiHelpers,
+    /** Helpers for reading on-chain data in an "inspection" manner (designed for Summaries). */
     inspections: inspectionsApiHelpers_1.InspectionsApiHelpers,
+    /** Helpers for retrieving and parsing Sui objects by ID or type. */
     objects: objectsApiHelpers_1.ObjectsApiHelpers,
+    /** Helpers for reading transaction data (by digest, query, etc.). */
     transactions: transactionsApiHelpers_1.TransactionsApiHelpers,
     // =========================================================================
     //  Utils
     // =========================================================================
+    /** Helper for wallet-based operations, separate from the main `Wallet` classes. */
     wallet: walletApi_1.WalletApi,
     // =========================================================================
     //  General Packages
     // =========================================================================
+    /** Low-level direct coin operations, separate from the higher-level `Coin` class. */
     coin: coinApi_1.CoinApi,
+    /** Low-level Sui chain data ops, separate from the higher-level `Sui` class. */
     sui: suiApi_1.SuiApi,
 };

package/dist/general/types/castingTypes.d.ts

@@ -1,6 +1,5 @@
 import { AnyObjectType, BigIntAsString, ModuleName, ObjectId, SuiAddress, TransactionDigest } from "./generalTypes";
 export type BcsTypeName = string | [string, ...(BcsTypeName | string)[]];
-export type SuiAddressWithout0x = string;
 export interface EventOnChain<Fields> {
     id: {
         txDigest: TransactionDigest;
@@ -49,10 +48,4 @@ export interface SupplyOnChain {
         value: BigIntAsString;
     };
 }
-export interface TypeNameOnChain {
-    type: AnyObjectType;
-    fields: {
-        name: AnyObjectType;
-    };
-}
 //# sourceMappingURL=castingTypes.d.ts.map

package/dist/general/types/castingTypes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"castingTypes.d.ts","sourceRoot":"","sources":["../../../src/general/types/castingTypes.ts"],"names":[],"mappings":"AACA,OAAO,EACN,aAAa,EACb,cAAc,EACd,UAAU,EACV,QAAQ,EACR,UAAU,EACV,iBAAiB,EACjB,MAAM,gBAAgB,CAAC;AAMxB,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,WAAW,GAAG,MAAM,CAAC,EAAE,CAAC,CAAC;AAMzE,MAAM,MAAM,mBAAmB,GAAG,MAAM,CAAC;AAMzC,MAAM,WAAW,YAAY,CAAC,MAAM;IACnC,EAAE,EAAE;QACH,QAAQ,EAAE,iBAAiB,CAAC;QAC5B,QAAQ,EAAE,cAAc,CAAC;KACzB,CAAC;IACF,SAAS,EAAE,QAAQ,CAAC;IACpB,iBAAiB,EAAE,UAAU,CAAC;IAC9B,MAAM,EAAE,UAAU,CAAC;IACnB,IAAI,EAAE,aAAa,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;CAChC;AAED,MAAM,WAAW,mBAAmB,CAAC,MAAM;IAC1C,EAAE,EAAE;QACH,QAAQ,EAAE,iBAAiB,CAAC;QAC5B,QAAQ,EAAE,cAAc,CAAC;KACzB,CAAC;IACF,SAAS,EAAE,QAAQ,CAAC;IACpB,iBAAiB,EAAE,UAAU,CAAC;IAC9B,MAAM,EAAE,UAAU,CAAC;IACnB,IAAI,EAAE,aAAa,CAAC;IACpB,UAAU,EAAE;QACX,IAAI,EAAE,MAAM,CAAC;KACb,CAAC;IACF,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;CAChC;AAED,MAAM,MAAM,mBAAmB,CAAC,MAAM,IAAI;IACzC,IAAI,EAAE,aAAa,CAAC;IACpB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,SAAS,EAAE,iBAAiB,CAAC;CAC7B,GAAG,MAAM,CAAC;AAEX,MAAM,WAAW,YAAY;IAC5B,IAAI,EAAE,aAAa,CAAC;IACpB,MAAM,EAAE;QACP,EAAE,EAAE;YACH,EAAE,EAAE,QAAQ,CAAC;SACb,CAAC;QACF,IAAI,EAAE,cAAc,CAAC;KACrB,CAAC;CACF;AAED,MAAM,WAAW,aAAa;IAC7B,IAAI,EAAE,aAAa,CAAC;IACpB,MAAM,EAAE;QACP,KAAK,EAAE,cAAc,CAAC;KACtB,CAAC;CACF;AAED,MAAM,WAAW,eAAe;IAC/B,IAAI,EAAE,aAAa,CAAC;IACpB,MAAM,EAAE;QACP,IAAI,EAAE,aAAa,CAAC;KACpB,CAAC;CACF"}
+{"version":3,"file":"castingTypes.d.ts","sourceRoot":"","sources":["../../../src/general/types/castingTypes.ts"],"names":[],"mappings":"AACA,OAAO,EACN,aAAa,EACb,cAAc,EACd,UAAU,EACV,QAAQ,EACR,UAAU,EACV,iBAAiB,EACjB,MAAM,gBAAgB,CAAC;AAMxB,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,WAAW,GAAG,MAAM,CAAC,EAAE,CAAC,CAAC;AAYzE,MAAM,WAAW,YAAY,CAAC,MAAM;IACnC,EAAE,EAAE;QACH,QAAQ,EAAE,iBAAiB,CAAC;QAC5B,QAAQ,EAAE,cAAc,CAAC;KACzB,CAAC;IACF,SAAS,EAAE,QAAQ,CAAC;IACpB,iBAAiB,EAAE,UAAU,CAAC;IAC9B,MAAM,EAAE,UAAU,CAAC;IACnB,IAAI,EAAE,aAAa,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;CAChC;AAED,MAAM,WAAW,mBAAmB,CAAC,MAAM;IAC1C,EAAE,EAAE;QACH,QAAQ,EAAE,iBAAiB,CAAC;QAC5B,QAAQ,EAAE,cAAc,CAAC;KACzB,CAAC;IACF,SAAS,EAAE,QAAQ,CAAC;IACpB,iBAAiB,EAAE,UAAU,CAAC;IAC9B,MAAM,EAAE,UAAU,CAAC;IACnB,IAAI,EAAE,aAAa,CAAC;IACpB,UAAU,EAAE;QACX,IAAI,EAAE,MAAM,CAAC;KACb,CAAC;IACF,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;CAChC;AAED,MAAM,MAAM,mBAAmB,CAAC,MAAM,IAAI;IACzC,IAAI,EAAE,aAAa,CAAC;IACpB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,SAAS,EAAE,iBAAiB,CAAC;CAC7B,GAAG,MAAM,CAAC;AAEX,MAAM,WAAW,YAAY;IAC5B,IAAI,EAAE,aAAa,CAAC;IACpB,MAAM,EAAE;QACP,EAAE,EAAE;YACH,EAAE,EAAE,QAAQ,CAAC;SACb,CAAC;QACF,IAAI,EAAE,cAAc,CAAC;KACrB,CAAC;CACF;AAED,MAAM,WAAW,aAAa;IAC7B,IAAI,EAAE,aAAa,CAAC;IACpB,MAAM,EAAE;QACP,KAAK,EAAE,cAAc,CAAC;KACtB,CAAC;CACF"}

package/dist/general/types/castingTypes.js

@@ -1,2 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+// export interface TypeNameOnChain {
+// 	type: AnyObjectType;
+// 	fields: {
+// 		name: AnyObjectType;
+// 	};
+// }

package/dist/general/types/generalTypes.d.ts

@@ -1,120 +1,341 @@
 import { DynamicFieldInfo, EventId, SuiTransactionBlockResponse } from "@mysten/sui/client";
 import { SuiNetwork } from "./suiTypes";
+/**
+ * Represents a token or currency balance in the system, defined as a bigint.
+ */
 export type Balance = bigint;
+/**
+ * Represents a fixed-point integer using a bigint. May be used for calculations requiring
+ * precision (e.g., decimal-like math).
+ */
 export type IFixed = bigint;
+/**
+ * Represents a gas budget for transactions. Typically a raw `number`.
+ */
 export type GasBudget = number;
+/**
+ * Represents a timestamp in milliseconds or seconds. Typically a raw `number`.
+ */
 export type Timestamp = number;
+/**
+ * A single byte, typically expressed as a `number` from 0 to 255.
+ */
 export type Byte = number;
+/**
+ * Defines the allowable slippage in a trading scenario, expressed as an unscaled percentage (e.g., 0.01 = 1%).
+ */
 export type Slippage = number;
 /**
- * Unscaled percentage
- *
- * @remarks 0.54 = 54%
+ * Represents an unscaled percentage (e.g., 0.01 = 1%).
  */
 export type Percentage = number;
+/**
+ * Annual percentage rate (APR), expressed as a `number` (e.g., 0.01 = 1%).
+ */
 export type Apr = number;
+/**
+ * Annual percentage yield (APY), expressed as a `number` (e.g., 0.01 = 1%).
+ */
 export type Apy = number;
+/**
+ * Represents the version of an on-chain object, expressed as a `number`.
+ */
 export type ObjectVersion = number;
+/**
+ * Represents an error code from a Move smart contract, typically a `number`.
+ */
 export type MoveErrorCode = number;
+/**
+ * Represents a serialized transaction in a base64 or similar format.
+ */
 export type SerializedTransaction = string;
+/**
+ * Represents raw transaction bytes in a base64 or similar format.
+ */
 export type TxBytes = string;
+/**
+ * Represents a BigInt in string form, typically used for JSON serialization.
+ */
 export type BigIntAsString = string;
+/**
+ * Represents a numeric value in string form, typically used for JSON serialization.
+ */
 export type NumberAsString = string;
+/**
+ * Represents an IFixed value in string form, typically used for JSON serialization.
+ */
 export type IFixedAsString = string;
+/**
+ * A key type used in certain contexts, typically a string (e.g., "ed25519", "secp256k1").
+ */
 export type KeyType = string;
+/**
+ * Represents any string identifying an object type, such as "0x2::sui::SUI".
+ */
 export type AnyObjectType = string;
+/**
+ * Represents the name of a Move module, e.g. "Router" or "Coin".
+ */
 export type ModuleName = string;
+/**
+ * Represents the name of a Move function, e.g. "swap" or "mint".
+ */
 export type FunctionName = string;
+/**
+ * Represents the ID of a published Move package on the Sui network, e.g. "0x<package_id>".
+ */
 export type PackageId = string;
+/**
+ * Represents a color in a string format (e.g., "#FFFFFF" or "blue").
+ */
 export type Color = string;
+/**
+ * Represents a URL in string format (e.g., "https://example.com").
+ */
 export type Url = string;
+/**
+ * Represents a local resource URL (e.g., "file://path/to/resource").
+ */
 export type LocalUrl = string;
+/**
+ * Represents a file path (e.g., "/usr/local/bin").
+ */
 export type FilePath = string;
+/**
+ * Represents an on-chain object ID (e.g., "0x<32-byte_hex>").
+ */
 export type ObjectId = string;
+/**
+ * Represents a Sui wallet address (e.g., "0x<address>").
+ */
 export type SuiAddress = string;
+/**
+ * Represents a TransactionDigest from a Sui transaction, typically a hex-encoded string.
+ */
 export type TransactionDigest = string;
+/**
+ * Represents a single byte in string form, usually hex-encoded (e.g., "0xFF").
+ */
 export type StringByte = string;
+/**
+ * Represents an object's digest, typically a hex-encoded string.
+ */
 export type ObjectDigest = string;
+/**
+ * Represents an IFixed type as an array of bytes.
+ */
 export type IFixedAsBytes = Byte[];
+/**
+ * Represents an IFixed type in string form, each byte also in string form.
+ */
 export type IFixedAsStringBytes = string[];
+/**
+ * Represents an ID as an array of bytes in string form.
+ */
 export type IdAsStringBytes = string[];
 /**
- * Fee info for third party packages wanting to fee transactions
+ * Holds information about third-party fees in transactions, including the recipient
+ * and the fee percentage to be collected.
  */
 export interface ExternalFee {
     /**
-     * Address of recipient for collected fees
+     * Address of the recipient for collected fees.
      */
     recipient: SuiAddress;
     /**
-     * Percent of fees to be collected from coin
-     *
+     * Percentage of the fee to be collected.
      * @remarks 0.54 = 54%
      */
     feePercentage: Percentage;
 }
+/**
+ * A function signature for signing arbitrary messages. Typically used in
+ * cryptographic contexts.
+ */
 export type SignMessageCallback = (args: {
     message: Uint8Array;
 }) => Promise<{
     signature: string;
 }>;
+/**
+ * Generic shape for events with optional paging cursor data.
+ */
 export interface IndexerEventsWithCursor<EventType> {
+    /**
+     * An array of events of type `EventType`.
+     */
     events: EventType[];
+    /**
+     * The next cursor position. If undefined, no more events are available.
+     */
     nextCursor: number | undefined;
 }
+/**
+ * A generic shape for events with a Sui-based cursor structure.
+ */
 export interface EventsWithCursor<EventType> {
+    /**
+     * An array of events of type `EventType`.
+     */
     events: EventType[];
+    /**
+     * The next cursor position. If null, no more events are available.
+     */
     nextCursor: EventId | null;
 }
+/**
+ * Represents a Sui event, typically including type, timestamp, and transaction digest.
+ */
 export interface Event {
+    /**
+     * A string identifying the Move event type.
+     */
     type: AnyObjectType;
+    /**
+     * Timestamp of the event, if available.
+     */
     timestamp: Timestamp | undefined;
+    /**
+     * The transaction digest associated with the event.
+     */
     txnDigest: TransactionDigest;
 }
+/**
+ * Common inputs for event retrieval, including an optional cursor and limit.
+ */
 export interface EventsInputs {
+    /**
+     * Cursor for pagination, often an EventId or numeric index.
+     */
     cursor?: EventId;
+    /**
+     * Limit for pagination, specifying the maximum number of events.
+     */
     limit?: number;
 }
+/**
+ * Inputs for retrieving user events, extending from general event inputs
+ * and including the user's wallet address.
+ */
 export type UserEventsInputs = EventsInputs & {
     walletAddress: SuiAddress;
 };
+/**
+ * Represents a Sui object, including its ID and type.
+ */
 export interface Object {
+    /**
+     * The on-chain object ID.
+     */
     objectId: ObjectId;
+    /**
+     * The Move type of the object.
+     */
     objectType: AnyObjectType;
 }
+/**
+ * Holds the dynamic fields and an optional next cursor for pagination.
+ */
 export interface DynamicFieldsWithCursor {
+    /**
+     * An array of dynamic field information objects.
+     */
     dynamicFields: DynamicFieldInfo[];
+    /**
+     * The next cursor for pagination. If null, no more fields are available.
+     */
     nextCursor: ObjectId | null;
 }
+/**
+ * Holds the dynamic field objects and an optional next cursor for pagination.
+ */
 export interface DynamicFieldObjectsWithCursor<ObjectType> {
+    /**
+     * An array of objects derived from dynamic fields.
+     */
     dynamicFieldObjects: ObjectType[];
+    /**
+     * The next cursor for pagination. If null, no more fields are available.
+     */
     nextCursor: ObjectId | null;
 }
+/**
+ * Inputs for fetching dynamic fields, including optional cursor and limit for pagination.
+ */
 export interface DynamicFieldsInputs {
     cursor?: ObjectId;
     limit?: number;
 }
+/**
+ * A collection of transactions with a cursor for pagination.
+ */
 export interface TransactionsWithCursor {
+    /**
+     * An array of Sui transactions.
+     */
     transactions: SuiTransactionBlockResponse[];
+    /**
+     * The next cursor for pagination. If null, no more transactions are available.
+     */
     nextCursor: TransactionDigest | null;
 }
+/**
+ * Generic shape for API data requests that include pagination parameters.
+ */
 export interface ApiDataWithCursorBody<CursorType> {
+    /**
+     * Cursor for pagination.
+     */
     cursor?: CursorType;
+    /**
+     * Limit for pagination.
+     */
     limit?: number;
 }
+/**
+ * Specifies the shape for API calls involving events.
+ */
 export type ApiEventsBody = ApiDataWithCursorBody<EventId>;
+/**
+ * Specifies the shape for API calls involving dynamic fields.
+ */
 export type ApiDynamicFieldsBody = ApiDataWithCursorBody<ObjectId>;
+/**
+ * Specifies the shape for API calls involving transactions.
+ */
 export type ApiTransactionsBody = ApiDataWithCursorBody<TransactionDigest>;
+/**
+ * Body payload for indexer-based event queries, using a numeric cursor.
+ */
 export type ApiIndexerEventsBody = ApiDataWithCursorBody<number>;
+/**
+ * Body payload for indexer-based user events, extending from `ApiIndexerEventsBody`.
+ */
 export type ApiIndexerUserEventsBody = ApiIndexerEventsBody & {
+    /**
+     * The wallet address of the user.
+     */
     walletAddress: SuiAddress;
 };
+/**
+ * Represents query parameters for retrieving data with skip/limit pagination in an indexer.
+ */
 export interface IndexerDataWithCursorQueryParams {
     skip: number;
     limit: number;
 }
+/**
+ * Configuration for constructing a `Caller`. Includes network specification
+ * and optional access token for authentication.
+ */
 export interface CallerConfig {
+    /**
+     * The target Sui network (e.g., "MAINNET", "TESTNET").
+     */
     network?: SuiNetwork;
+    /**
+     * Access token used for authenticated requests, if required.
+     */
     accessToken?: string;
 }
 //# sourceMappingURL=generalTypes.d.ts.map

package/dist/general/types/generalTypes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"generalTypes.d.ts","sourceRoot":"","sources":["../../../src/general/types/generalTypes.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,gBAAgB,EAChB,OAAO,EACP,2BAA2B,EAC3B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAWxC,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC;AAC7B,MAAM,MAAM,MAAM,GAAG,MAAM,CAAC;AAM5B,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC;AAC/B,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC;AAC/B,MAAM,MAAM,IAAI,GAAG,MAAM,CAAC;AAC1B,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC;AAC9B;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC;AAChC,MAAM,MAAM,GAAG,GAAG,MAAM,CAAC;AACzB,MAAM,MAAM,GAAG,GAAG,MAAM,CAAC;AACzB,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC;AACnC,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC;AAMnC,MAAM,MAAM,qBAAqB,GAAG,MAAM,CAAC;AAC3C,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC;AAC7B,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC;AACpC,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC;AACpC,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC;AACpC,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC;AAC7B,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC;AACnC,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC;AAChC,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC;AAClC,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC;AAC/B,MAAM,MAAM,KAAK,GAAG,MAAM,CAAC;AAC3B,MAAM,MAAM,GAAG,GAAG,MAAM,CAAC;AACzB,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC;AAC9B,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC;AAC9B,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC;AAC9B,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC;AAChC,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC;AACvC,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC;AAChC,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC;AAMlC,MAAM,MAAM,aAAa,GAAG,IAAI,EAAE,CAAC;AAMnC,MAAM,MAAM,mBAAmB,GAAG,MAAM,EAAE,CAAC;AAC3C,MAAM,MAAM,eAAe,GAAG,MAAM,EAAE,CAAC;AAMvC;;GAEG;AACH,MAAM,WAAW,WAAW;IAC3B;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC;IACtB;;;;OAIG;IACH,aAAa,EAAE,UAAU,CAAC;CAC1B;AAED,MAAM,MAAM,mBAAmB,GAAG,CAAC,IAAI,EAAE;IAAE,OAAO,EAAE,UAAU,CAAA;CAAE,KAAK,OAAO,CAAC;IAC5E,SAAS,EAAE,MAAM,CAAC;CAClB,CAAC,CAAC;AAMH,MAAM,WAAW,uBAAuB,CAAC,SAAS;IACjD,MAAM,EAAE,SAAS,EAAE,CAAC;IACpB,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B;AAED,MAAM,WAAW,gBAAgB,CAAC,SAAS;IAC1C,MAAM,EAAE,SAAS,EAAE,CAAC;IACpB,UAAU,EAAE,OAAO,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,KAAK;IACrB,IAAI,EAAE,aAAa,CAAC;IACpB,SAAS,EAAE,SAAS,GAAG,SAAS,CAAC;IACjC,SAAS,EAAE,iBAAiB,CAAC;CAC7B;AAED,MAAM,WAAW,YAAY;IAC5B,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,MAAM,gBAAgB,GAAG,YAAY,GAAG;IAC7C,aAAa,EAAE,UAAU,CAAC;CAC1B,CAAC;AAMF,MAAM,WAAW,MAAM;IACtB,QAAQ,EAAE,QAAQ,CAAC;IACnB,UAAU,EAAE,aAAa,CAAC;CAC1B;AAMD,MAAM,WAAW,uBAAuB;IACvC,aAAa,EAAE,gBAAgB,EAAE,CAAC;IAClC,UAAU,EAAE,QAAQ,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,6BAA6B,CAAC,UAAU;IACxD,mBAAmB,EAAE,UAAU,EAAE,CAAC;IAClC,UAAU,EAAE,QAAQ,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,mBAAmB;IACnC,MAAM,CAAC,EAAE,QAAQ,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;CACf;AAMD,MAAM,WAAW,sBAAsB;IACtC,YAAY,EAAE,2BAA2B,EAAE,CAAC;IAC5C,UAAU,EAAE,iBAAiB,GAAG,IAAI,CAAC;CACrC;AAMD,MAAM,WAAW,qBAAqB,CAAC,UAAU;IAChD,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,MAAM,aAAa,GAAG,qBAAqB,CAAC,OAAO,CAAC,CAAC;AAC3D,MAAM,MAAM,oBAAoB,GAAG,qBAAqB,CAAC,QAAQ,CAAC,CAAC;AACnE,MAAM,MAAM,mBAAmB,GAAG,qBAAqB,CAAC,iBAAiB,CAAC,CAAC;AAM3E,MAAM,MAAM,oBAAoB,GAAG,qBAAqB,CAAC,MAAM,CAAC,CAAC;AAEjE,MAAM,MAAM,wBAAwB,GAAG,oBAAoB,GAAG;IAC7D,aAAa,EAAE,UAAU,CAAC;CAC1B,CAAC;AAEF,MAAM,WAAW,gCAAgC;IAChD,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACd;AAgBD,MAAM,WAAW,YAAY;IAC5B,OAAO,CAAC,EAAE,UAAU,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB"}
+{"version":3,"file":"generalTypes.d.ts","sourceRoot":"","sources":["../../../src/general/types/generalTypes.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,gBAAgB,EAChB,OAAO,EACP,2BAA2B,EAC3B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAExC;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC;AAE7B;;;GAGG;AACH,MAAM,MAAM,MAAM,GAAG,MAAM,CAAC;AAE5B;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC;AAE/B;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC;AAE/B;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG,MAAM,CAAC;AAE1B;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC;AAE9B;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC;AAEhC;;GAEG;AACH,MAAM,MAAM,GAAG,GAAG,MAAM,CAAC;AAEzB;;GAEG;AACH,MAAM,MAAM,GAAG,GAAG,MAAM,CAAC;AAEzB;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC;AAEnC;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC;AAEnC;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,MAAM,CAAC;AAE3C;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC;AAE7B;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC;AAEpC;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC;AAEpC;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC;AAEpC;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC;AAE7B;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC;AAEnC;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC;AAEhC;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC;AAElC;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC;AAE/B;;GAEG;AACH,MAAM,MAAM,KAAK,GAAG,MAAM,CAAC;AAE3B;;GAEG;AACH,MAAM,MAAM,GAAG,GAAG,MAAM,CAAC;AAEzB;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC;AAE9B;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC;AAE9B;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC;AAE9B;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC;AAEhC;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC;AAEvC;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC;AAEhC;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC;AAElC;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,IAAI,EAAE,CAAC;AAEnC;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,MAAM,EAAE,CAAC;AAE3C;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,EAAE,CAAC;AAEvC;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC3B;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC;IACtB;;;OAGG;IACH,aAAa,EAAE,UAAU,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,CAAC,IAAI,EAAE;IAAE,OAAO,EAAE,UAAU,CAAA;CAAE,KAAK,OAAO,CAAC;IAC5E,SAAS,EAAE,MAAM,CAAC;CAClB,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,WAAW,uBAAuB,CAAC,SAAS;IACjD;;OAEG;IACH,MAAM,EAAE,SAAS,EAAE,CAAC;IACpB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB,CAAC,SAAS;IAC1C;;OAEG;IACH,MAAM,EAAE,SAAS,EAAE,CAAC;IACpB;;OAEG;IACH,UAAU,EAAE,OAAO,GAAG,IAAI,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,KAAK;IACrB;;OAEG;IACH,IAAI,EAAE,aAAa,CAAC;IACpB;;OAEG;IACH,SAAS,EAAE,SAAS,GAAG,SAAS,CAAC;IACjC;;OAEG;IACH,SAAS,EAAE,iBAAiB,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC5B;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG,YAAY,GAAG;IAC7C,aAAa,EAAE,UAAU,CAAC;CAC1B,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,MAAM;IACtB;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC;IACnB;;OAEG;IACH,UAAU,EAAE,aAAa,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACvC;;OAEG;IACH,aAAa,EAAE,gBAAgB,EAAE,CAAC;IAClC;;OAEG;IACH,UAAU,EAAE,QAAQ,GAAG,IAAI,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B,CAAC,UAAU;IACxD;;OAEG;IACH,mBAAmB,EAAE,UAAU,EAAE,CAAC;IAClC;;OAEG;IACH,UAAU,EAAE,QAAQ,GAAG,IAAI,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IACnC,MAAM,CAAC,EAAE,QAAQ,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACtC;;OAEG;IACH,YAAY,EAAE,2BAA2B,EAAE,CAAC;IAC5C;;OAEG;IACH,UAAU,EAAE,iBAAiB,GAAG,IAAI,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB,CAAC,UAAU;IAChD;;OAEG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,qBAAqB,CAAC,OAAO,CAAC,CAAC;AAE3D;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,qBAAqB,CAAC,QAAQ,CAAC,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,qBAAqB,CAAC,iBAAiB,CAAC,CAAC;AAE3E;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,qBAAqB,CAAC,MAAM,CAAC,CAAC;AAEjE;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,oBAAoB,GAAG;IAC7D;;OAEG;IACH,aAAa,EAAE,UAAU,CAAC;CAC1B,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,gCAAgC;IAChD,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC5B;;OAEG;IACH,OAAO,CAAC,EAAE,UAAU,CAAC;IACrB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB"}

package/dist/general/types/suiTypes.d.ts

@@ -1,18 +1,2 @@
-import { Balance, ObjectId } from "./generalTypes";
 export type SuiNetwork = "DEVNET" | "TESTNET" | "LOCAL" | "MAINNET" | (string & {});
-export interface ObjectTable<K, V> {
-    objectId: ObjectId;
-    size: number;
-}
-export interface Table<K, V> {
-    objectId: ObjectId;
-    size: number;
-}
-export interface SuiBalance {
-    objectId: ObjectId;
-    value: Balance;
-}
-export interface EpochTimeLock {
-    epoch: EpochTimeStamp;
-}
 //# sourceMappingURL=suiTypes.d.ts.map

package/dist/general/types/suiTypes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"suiTypes.d.ts","sourceRoot":"","sources":["../../../src/general/types/suiTypes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAMnD,MAAM,MAAM,UAAU,GACnB,QAAQ,GACR,SAAS,GACT,OAAO,GACP,SAAS,GACT,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;AAMjB,MAAM,WAAW,WAAW,CAAC,CAAC,EAAE,CAAC;IAChC,QAAQ,EAAE,QAAQ,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;CACb;AACD,MAAM,WAAW,KAAK,CAAC,CAAC,EAAE,CAAC;IAC1B,QAAQ,EAAE,QAAQ,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,UAAU;IAC1B,QAAQ,EAAE,QAAQ,CAAC;IACnB,KAAK,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,aAAa;IAC7B,KAAK,EAAE,cAAc,CAAC;CACtB"}
+{"version":3,"file":"suiTypes.d.ts","sourceRoot":"","sources":["../../../src/general/types/suiTypes.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,UAAU,GACnB,QAAQ,GACR,SAAS,GACT,OAAO,GACP,SAAS,GACT,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC"}