aftermath-ts-sdk 1.1.7 → 1.1.8

package/dist/general/providers/aftermath.d.ts

@@ -38,19 +38,49 @@ export declare class Aftermath extends Caller {
      * @returns New `Aftermath` instance
      */
     constructor(network?: SuiNetwork | Url);
+    /**
+     * Retrieves the addresses from the Aftermath API.
+     * @returns A promise that resolves to a ConfigAddresses object.
+     */
     getAddresses(): Promise<ConfigAddresses>;
+    /**
+     * Returns an instance of the Pools class.
+     * @returns {Pools} An instance of the Pools class.
+     */
     Pools: () => Pools;
+    /**
+     * Creates a new instance of the Staking class.
+     * @returns A new instance of the Staking class.
+     */
     Staking: () => Staking;
     SuiFrens: () => SuiFrens;
     Faucet: () => Faucet;
+    /**
+     * Creates a new instance of the Router class with the current network.
+     * @returns A new instance of the Router class.
+     */
     Router: () => Router;
     NftAmm: () => NftAmm;
     ReferralVault: () => ReferralVault;
     Perpetuals: () => Perpetuals;
+    /**
+     * Creates a new instance of the Farms class.
+     * @returns A new instance of the Farms class.
+     */
     Farms: () => Farms;
     Sui: () => Sui;
     Prices: () => Prices;
+    /**
+     * Creates a new instance of the Wallet class.
+     * @param address - The address of the wallet.
+     * @returns A new instance of the Wallet class.
+     */
     Wallet: (address: SuiAddress) => Wallet;
+    /**
+     * Creates a new instance of the Coin class.
+     * @param coinType The type of coin to create.
+     * @returns A new instance of the Coin class.
+     */
     Coin: (coinType?: CoinType) => Coin;
     HistoricalData: () => HistoricalData;
     DynamicGas: () => DynamicGas;

package/dist/general/providers/aftermath.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"aftermath.d.ts","sourceRoot":"","sources":["../../../src/general/providers/aftermath.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,4BAA4B,CAAC;AACnD,OAAO,EACN,QAAQ,EACR,eAAe,EACf,UAAU,EACV,UAAU,EACV,GAAG,EACH,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AAC5D,OAAO,EAAE,IAAI,EAAE,MAAM,0BAA0B,CAAC;AAChD,OAAO,EAAE,MAAM,EAAE,MAAM,8BAA8B,CAAC;AACtD,OAAO,EAAE,OAAO,EAAE,MAAM,gCAAgC,CAAC;AACzD,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAC3C,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AACzC,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AACpE,OAAO,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAC;AAClE,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACvD,OAAO,EAAE,KAAK,EAAE,MAAM,4BAA4B,CAAC;AACnD,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AAEtD;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,SAAU,SAAQ,MAAM;IAKpC;;;;;OAKG;gBACS,OAAO,CAAC,EAAE,UAAU,GAAG,GAAG;IAQzB,YAAY;IAYlB,KAAK,cAAiC;IACtC,OAAO,gBAAmC;IAC1C,QAAQ,iBAAoC;IAC5C,MAAM,eAAkC;IACxC,MAAM,eAAkC;IACxC,MAAM,eAAkC;IACxC,aAAa,sBAAyC;IACtD,UAAU,mBAAsC;IAChD,KAAK,cAAiC;IAMtC,GAAG,YAA+B;IAClC,MAAM,eAAkC;IACxC,MAAM,YAAa,UAAU,YAAuC;IACpE,IAAI,cAAe,QAAQ,UAAsC;IACjE,cAAc,uBAA0C;IACxD,UAAU,mBAAsC;IAMvD,OAAc,OAAO,iBAAW;IAChC,OAAc,OAAO,iBAAW;CAChC"}
+{"version":3,"file":"aftermath.d.ts","sourceRoot":"","sources":["../../../src/general/providers/aftermath.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,4BAA4B,CAAC;AACnD,OAAO,EACN,QAAQ,EACR,eAAe,EACf,UAAU,EACV,UAAU,EACV,GAAG,EACH,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AAC5D,OAAO,EAAE,IAAI,EAAE,MAAM,0BAA0B,CAAC;AAChD,OAAO,EAAE,MAAM,EAAE,MAAM,8BAA8B,CAAC;AACtD,OAAO,EAAE,OAAO,EAAE,MAAM,gCAAgC,CAAC;AACzD,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAC3C,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AACzC,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AACpE,OAAO,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAC;AAClE,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACvD,OAAO,EAAE,KAAK,EAAE,MAAM,4BAA4B,CAAC;AACnD,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AAEtD;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,SAAU,SAAQ,MAAM;IAKpC;;;;;OAKG;gBACS,OAAO,CAAC,EAAE,UAAU,GAAG,GAAG;IAQtC;;;OAGG;IACU,YAAY;IAYzB;;;OAGG;IACI,KAAK,cAAiC;IAC7C;;;OAGG;IACI,OAAO,gBAAmC;IAC1C,QAAQ,iBAAoC;IAC5C,MAAM,eAAkC;IAC/C;;;OAGG;IACI,MAAM,eAAkC;IACxC,MAAM,eAAkC;IACxC,aAAa,sBAAyC;IACtD,UAAU,mBAAsC;IACvD;;;OAGG;IACI,KAAK,cAAiC;IAMtC,GAAG,YAA+B;IAClC,MAAM,eAAkC;IAC/C;;;;OAIG;IACI,MAAM,YAAa,UAAU,YAAuC;IAC3E;;;;OAIG;IACI,IAAI,cAAe,QAAQ,UAAsC;IACjE,cAAc,uBAA0C;IACxD,UAAU,mBAAsC;IAMvD,OAAc,OAAO,iBAAW;IAChC,OAAc,OAAO,iBAAW;CAChC"}

package/dist/general/providers/aftermath.js

@@ -59,21 +59,47 @@ class Aftermath extends caller_1.Caller {
         // =========================================================================
         //  Packages
         // =========================================================================
+        /**
+         * Returns an instance of the Pools class.
+         * @returns {Pools} An instance of the Pools class.
+         */
         this.Pools = () => new pools_1.Pools(this.network);
+        /**
+         * Creates a new instance of the Staking class.
+         * @returns A new instance of the Staking class.
+         */
         this.Staking = () => new staking_1.Staking(this.network);
         this.SuiFrens = () => new suiFrens_1.SuiFrens(this.network);
         this.Faucet = () => new faucet_1.Faucet(this.network);
+        /**
+         * Creates a new instance of the Router class with the current network.
+         * @returns A new instance of the Router class.
+         */
         this.Router = () => new packages_1.Router(this.network);
         this.NftAmm = () => new packages_1.NftAmm(this.network);
         this.ReferralVault = () => new packages_1.ReferralVault(this.network);
         this.Perpetuals = () => new perpetuals_1.Perpetuals(this.network);
+        /**
+         * Creates a new instance of the Farms class.
+         * @returns A new instance of the Farms class.
+         */
         this.Farms = () => new farms_1.Farms(this.network);
         // =========================================================================
         //  General
         // =========================================================================
         this.Sui = () => new packages_1.Sui(this.network);
         this.Prices = () => new prices_1.Prices(this.network);
+        /**
+         * Creates a new instance of the Wallet class.
+         * @param address - The address of the wallet.
+         * @returns A new instance of the Wallet class.
+         */
         this.Wallet = (address) => new wallet_1.Wallet(address, this.network);
+        /**
+         * Creates a new instance of the Coin class.
+         * @param coinType The type of coin to create.
+         * @returns A new instance of the Coin class.
+         */
         this.Coin = (coinType) => new coin_1.Coin(coinType, this.network);
         this.HistoricalData = () => new historicalData_1.HistoricalData(this.network);
         this.DynamicGas = () => new dynamicGas_1.DynamicGas(this.network);
@@ -81,6 +107,10 @@ class Aftermath extends caller_1.Caller {
     // =========================================================================
     //  Public Methods
     // =========================================================================
+    /**
+     * Retrieves the addresses from the Aftermath API.
+     * @returns A promise that resolves to a ConfigAddresses object.
+     */
     getAddresses() {
         return __awaiter(this, void 0, void 0, function* () {
             return this.fetchApi("addresses");

package/dist/general/providers/aftermathApi.d.ts

@@ -25,6 +25,10 @@ import { CoinGeckoCoinApiId } from "../prices/coingecko/coinGeckoTypes";
 import { IndexerCaller } from "../utils";
 import { SuiClient } from "@mysten/sui.js/client";
 import { DynamicGasApi } from "../dynamicGas/dynamicGasApi";
+/**
+ * This class represents the Aftermath API and provides helper methods for various functionalities.
+ * @class
+ */
 export declare class AftermathApi {
     readonly provider: SuiClient;
     readonly addresses: ConfigAddresses;
@@ -40,6 +44,13 @@ export declare class AftermathApi {
         coin: typeof CoinApi;
         sui: typeof SuiApi;
     };
+    /**
+     * 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 indexerCaller - The IndexerCaller instance to use for querying the blockchain.
+     * @param coinGeckoApiKey - (Optional) The API key to use for querying CoinGecko for token prices.
+     */
     constructor(provider: SuiClient, addresses: ConfigAddresses, indexerCaller: IndexerCaller, coinGeckoApiKey?: string | undefined);
     DynamicFields: () => DynamicFieldsApiHelpers;
     Events: () => EventsApiHelpers;
@@ -60,6 +71,13 @@ export declare class AftermathApi {
     ReferralVault: () => ReferralVaultApi;
     Perpetuals: () => PerpetualsApi;
     Farms: () => FarmsApi;
+    /**
+     * Creates a new instance of the RouterApi class.
+     * @param protocols An optional array of protocol names to use for the router.
+     * @param regularOptions An optional object containing regular router options.
+     * @param preAsyncOptions An optional object containing pre-async router options.
+     * @returns A new instance of the RouterApi class.
+     */
     Router: (protocols?: RouterProtocolName[], regularOptions?: PartialRouterOptions, preAsyncOptions?: Partial<RouterSynchronousOptions>) => RouterApi;
 }
 //# sourceMappingURL=aftermathApi.d.ts.map

package/dist/general/providers/aftermathApi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"aftermathApi.d.ts","sourceRoot":"","sources":["../../../src/general/providers/aftermathApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,QAAQ,EAAE,MAAM,mCAAmC,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAChE,OAAO,EAAE,OAAO,EAAE,MAAM,iCAAiC,CAAC;AAC1D,OAAO,EAAE,uBAAuB,EAAE,MAAM,gCAAgC,CAAC;AACzE,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AACrE,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAC7D,OAAO,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AACvE,OAAO,EAAE,MAAM,EAAE,MAAM,+BAA+B,CAAC;AACvD,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAChE,OAAO,EAAE,oBAAoB,EAAE,MAAM,4CAA4C,CAAC;AAClF,OAAO,EAAE,WAAW,EAAE,MAAM,yCAAyC,CAAC;AACtE,OAAO,EAAE,UAAU,EAAE,MAAM,uCAAuC,CAAC;AACnE,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAChE,OAAO,EAAE,gBAAgB,EAAE,MAAM,mDAAmD,CAAC;AACrF,OAAO,EACN,QAAQ,EACR,oBAAoB,EACpB,kBAAkB,EAClB,wBAAwB,EACxB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,iBAAiB,EAAE,MAAM,qCAAqC,CAAC;AACxE,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,EAAE,4BAA4B,EAAE,MAAM,gDAAgD,CAAC;AAC9F,OAAO,EAAE,aAAa,EAAE,MAAM,6CAA6C,CAAC;AAC5E,OAAO,EAAE,QAAQ,EAAE,MAAM,mCAAmC,CAAC;AAC7D,OAAO,EAAE,kBAAkB,EAAE,MAAM,oCAAoC,CAAC;AACxE,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAE5D,qBAAa,YAAY;aAmCP,QAAQ,EAAE,SAAS;aACnB,SAAS,EAAE,eAAe;aAC1B,aAAa,EAAE,aAAa;IAC5C,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC;IAjClC,OAAc,OAAO;;;;;;;;;MAuBnB;gBAOe,QAAQ,EAAE,SAAS,EACnB,SAAS,EAAE,eAAe,EAC1B,aAAa,EAAE,aAAa,EAC3B,eAAe,CAAC,oBAAQ;IAWnC,aAAa,gCAA2C;IACxD,MAAM,yBAAoC;IAC1C,WAAW,8BAAyC;IACpD,OAAO,0BAAqC;IAC5C,YAAY,+BAA0C;IAMtD,MAAM,kBAA6B;IACnC,UAAU,sBAAiC;IAE3C,MAAM,2BACc,OAAO,kBAAkB,EAAE,QAAQ,EAAE,CAAC,wDAK7B;IAE7B,cAAc,2BACM,OAAO,kBAAkB,EAAE,QAAQ,EAAE,CAAC,+DAKrB;IAMrC,IAAI,gBAA2B;IAC/B,GAAG,eAA0B;IAM7B,KAAK,iBAA4B;IACjC,MAAM,kBAA6B;IACnC,QAAQ,oBAA+B;IACvC,OAAO,mBAA8B;IACrC,MAAM,kBAA6B;IACnC,aAAa,yBAAoC;IACjD,UAAU,sBAAiC;IAC3C,KAAK,iBAA4B;IAEjC,MAAM,eACA,kBAAkB,EAAE,mBACf,oBAAoB,oBACnB,QAAQ,wBAAwB,CAAC,eACiB;CACrE"}
+{"version":3,"file":"aftermathApi.d.ts","sourceRoot":"","sources":["../../../src/general/providers/aftermathApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,QAAQ,EAAE,MAAM,mCAAmC,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAChE,OAAO,EAAE,OAAO,EAAE,MAAM,iCAAiC,CAAC;AAC1D,OAAO,EAAE,uBAAuB,EAAE,MAAM,gCAAgC,CAAC;AACzE,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AACrE,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAC7D,OAAO,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AACvE,OAAO,EAAE,MAAM,EAAE,MAAM,+BAA+B,CAAC;AACvD,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAChE,OAAO,EAAE,oBAAoB,EAAE,MAAM,4CAA4C,CAAC;AAClF,OAAO,EAAE,WAAW,EAAE,MAAM,yCAAyC,CAAC;AACtE,OAAO,EAAE,UAAU,EAAE,MAAM,uCAAuC,CAAC;AACnE,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAChE,OAAO,EAAE,gBAAgB,EAAE,MAAM,mDAAmD,CAAC;AACrF,OAAO,EACN,QAAQ,EACR,oBAAoB,EACpB,kBAAkB,EAClB,wBAAwB,EACxB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,iBAAiB,EAAE,MAAM,qCAAqC,CAAC;AACxE,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,EAAE,4BAA4B,EAAE,MAAM,gDAAgD,CAAC;AAC9F,OAAO,EAAE,aAAa,EAAE,MAAM,6CAA6C,CAAC;AAC5E,OAAO,EAAE,QAAQ,EAAE,MAAM,mCAAmC,CAAC;AAC7D,OAAO,EAAE,kBAAkB,EAAE,MAAM,oCAAoC,CAAC;AACxE,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAE5D;;;GAGG;AACH,qBAAa,YAAY;aA0CP,QAAQ,EAAE,SAAS;aACnB,SAAS,EAAE,eAAe;aAC1B,aAAa,EAAE,aAAa;IAC5C,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC;IAxClC,OAAc,OAAO;;;;;;;;;MAuBnB;IAMF;;;;;;OAMG;gBAEc,QAAQ,EAAE,SAAS,EACnB,SAAS,EAAE,eAAe,EAC1B,aAAa,EAAE,aAAa,EAC3B,eAAe,CAAC,oBAAQ;IAWnC,aAAa,gCAA2C;IACxD,MAAM,yBAAoC;IAC1C,WAAW,8BAAyC;IACpD,OAAO,0BAAqC;IAC5C,YAAY,+BAA0C;IAMtD,MAAM,kBAA6B;IACnC,UAAU,sBAAiC;IAE3C,MAAM,2BACc,OAAO,kBAAkB,EAAE,QAAQ,EAAE,CAAC,wDAK7B;IAE7B,cAAc,2BACM,OAAO,kBAAkB,EAAE,QAAQ,EAAE,CAAC,+DAKrB;IAMrC,IAAI,gBAA2B;IAC/B,GAAG,eAA0B;IAM7B,KAAK,iBAA4B;IACjC,MAAM,kBAA6B;IACnC,QAAQ,oBAA+B;IACvC,OAAO,mBAA8B;IACrC,MAAM,kBAA6B;IACnC,aAAa,yBAAoC;IACjD,UAAU,sBAAiC;IAC3C,KAAK,iBAA4B;IAExC;;;;;;OAMG;IACI,MAAM,eACA,kBAAkB,EAAE,mBACf,oBAAoB,oBACnB,QAAQ,wBAAwB,CAAC,eACiB;CACrE"}

package/dist/general/providers/aftermathApi.js

@@ -23,10 +23,21 @@ const placeholderHistoricalDataApi_1 = require("../historicalData/placeholderHis
 const perpetualsApi_1 = require("../../packages/perpetuals/api/perpetualsApi");
 const farmsApi_1 = require("../../packages/farms/api/farmsApi");
 const dynamicGasApi_1 = require("../dynamicGas/dynamicGasApi");
+/**
+ * This class represents the Aftermath API and provides helper methods for various functionalities.
+ * @class
+ */
 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 indexerCaller - The IndexerCaller instance to use for querying the blockchain.
+     * @param coinGeckoApiKey - (Optional) The API key to use for querying CoinGecko for token prices.
+     */
     constructor(provider, addresses, indexerCaller, coinGeckoApiKey) {
         this.provider = provider;
         this.addresses = addresses;
@@ -76,6 +87,13 @@ class AftermathApi {
         this.ReferralVault = () => new referralVaultApi_1.ReferralVaultApi(this);
         this.Perpetuals = () => new perpetualsApi_1.PerpetualsApi(this);
         this.Farms = () => new farmsApi_1.FarmsApi(this);
+        /**
+         * Creates a new instance of the RouterApi class.
+         * @param protocols An optional array of protocol names to use for the router.
+         * @param regularOptions An optional object containing regular router options.
+         * @param preAsyncOptions An optional object containing pre-async router options.
+         * @returns A new instance of the RouterApi class.
+         */
         this.Router = (protocols, regularOptions, preAsyncOptions) => new routerApi_1.RouterApi(this, protocols, regularOptions, preAsyncOptions);
     }
 }

package/dist/general/utils/casting.d.ts

@@ -7,6 +7,10 @@ import { Byte, SuiAddress } from "../types";
 import { RouterApiCasting } from "../../packages/router/api/routerApiCasting";
 import { PerpetualsApiCasting } from "../../packages/perpetuals/api/perpetualsApiCasting";
 import { FarmsApiCasting } from "../../packages/farms/api/farmsApiCasting";
+/**
+ * Utility class for casting and conversion functions.
+ * @class
+ */
 export declare class Casting {
     static pools: typeof PoolsApiCasting;
     static suiFrens: typeof SuiFrensApiCasting;

package/dist/general/utils/casting.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"casting.d.ts","sourceRoot":"","sources":["../../../src/general/utils/casting.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,MAAM,gDAAgD,CAAC;AACpF,OAAO,EAAE,gBAAgB,EAAE,MAAM,4CAA4C,CAAC;AAC9E,OAAO,EAAE,gBAAgB,EAAE,MAAM,4CAA4C,CAAC;AAC9E,OAAO,EAAE,eAAe,EAAE,MAAM,0CAA0C,CAAC;AAC3E,OAAO,EAAE,iBAAiB,EAAE,MAAM,8CAA8C,CAAC;AACjF,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAC5C,OAAO,EAAE,gBAAgB,EAAE,MAAM,4CAA4C,CAAC;AAC9E,OAAO,EAAE,oBAAoB,EAAE,MAAM,oDAAoD,CAAC;AAC1F,OAAO,EAAE,eAAe,EAAE,MAAM,0CAA0C,CAAC;AAE3E,qBAAa,OAAO;IAKnB,OAAc,KAAK,yBAAmB;IACtC,OAAc,QAAQ,4BAAsB;IAC5C,OAAc,MAAM,0BAAoB;IACxC,OAAc,OAAO,2BAAqB;IAC1C,OAAc,MAAM,0BAAoB;IACxC,OAAc,MAAM,0BAAoB;IACxC,OAAc,UAAU,8BAAwB;IAChD,OAAc,KAAK,yBAAmB;IAUtC,OAAc,cAAc,EAAE,MAAM,CAAiC;IACrE,OAAc,cAAc,EAAE,MAAM,CAA+B;IACnE,OAAc,YAAY,EAAE,MAAM,CAAgC;IAClE,OAAc,aAAa,EAAE,MAAM,CAEjC;IACF,OAAc,UAAU,EAAE,MAAM,CAAa;IAU7C,OAAc,mBAAmB,MAAO,MAAM,KAAG,MAAM,CACV;IAC7C,OAAc,mBAAmB,MAAO,MAAM,KAAG,MAAM,CACtB;IAEjC,OAAc,mBAAmB,WAAY,MAAM,OAAO,MAAM,KAAG,MAAM,CAC/B;IAM1C,OAAc,eAAe,UAAW,IAAI,EAAE,YACN;IAExC,OAAc,eAAe,UAAW,IAAI,EAAE,YAO3C;IAEH,OAAc,gBAAgB,UAAW,IAAI,EAAE,KAAG,UAAU,CACX;IAEjD,OAAc,wBAAwB,qBACnB,GAAG,KACnB,GAAG,GAAG,SAAS,CAEhB;IAEF,OAAc,kBAAkB,QAAS,MAAM,cAS7C;IAEF,OAAc,0BAA0B,sBAAuB,MAAM,YAEnE;CACF"}
+{"version":3,"file":"casting.d.ts","sourceRoot":"","sources":["../../../src/general/utils/casting.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,MAAM,gDAAgD,CAAC;AACpF,OAAO,EAAE,gBAAgB,EAAE,MAAM,4CAA4C,CAAC;AAC9E,OAAO,EAAE,gBAAgB,EAAE,MAAM,4CAA4C,CAAC;AAC9E,OAAO,EAAE,eAAe,EAAE,MAAM,0CAA0C,CAAC;AAC3E,OAAO,EAAE,iBAAiB,EAAE,MAAM,8CAA8C,CAAC;AACjF,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAC5C,OAAO,EAAE,gBAAgB,EAAE,MAAM,4CAA4C,CAAC;AAC9E,OAAO,EAAE,oBAAoB,EAAE,MAAM,oDAAoD,CAAC;AAC1F,OAAO,EAAE,eAAe,EAAE,MAAM,0CAA0C,CAAC;AAE3E;;;GAGG;AACH,qBAAa,OAAO;IAKnB,OAAc,KAAK,yBAAmB;IACtC,OAAc,QAAQ,4BAAsB;IAC5C,OAAc,MAAM,0BAAoB;IACxC,OAAc,OAAO,2BAAqB;IAC1C,OAAc,MAAM,0BAAoB;IACxC,OAAc,MAAM,0BAAoB;IACxC,OAAc,UAAU,8BAAwB;IAChD,OAAc,KAAK,yBAAmB;IAUtC,OAAc,cAAc,EAAE,MAAM,CAAiC;IACrE,OAAc,cAAc,EAAE,MAAM,CAA+B;IACnE,OAAc,YAAY,EAAE,MAAM,CAAgC;IAClE,OAAc,aAAa,EAAE,MAAM,CAEjC;IACF,OAAc,UAAU,EAAE,MAAM,CAAa;IAU7C,OAAc,mBAAmB,MAAO,MAAM,KAAG,MAAM,CACV;IAC7C,OAAc,mBAAmB,MAAO,MAAM,KAAG,MAAM,CACtB;IAEjC,OAAc,mBAAmB,WAAY,MAAM,OAAO,MAAM,KAAG,MAAM,CAC/B;IAM1C,OAAc,eAAe,UAAW,IAAI,EAAE,YACN;IAExC,OAAc,eAAe,UAAW,IAAI,EAAE,YAO3C;IAEH,OAAc,gBAAgB,UAAW,IAAI,EAAE,KAAG,UAAU,CACX;IAEjD,OAAc,wBAAwB,qBACnB,GAAG,KACnB,GAAG,GAAG,SAAS,CAEhB;IAEF,OAAc,kBAAkB,QAAS,MAAM,cAS7C;IAEF,OAAc,0BAA0B,sBAAuB,MAAM,YAEnE;CACF"}

package/dist/general/utils/casting.js

@@ -11,6 +11,10 @@ const stakingApiCasting_1 = require("../../packages/staking/api/stakingApiCastin
 const routerApiCasting_1 = require("../../packages/router/api/routerApiCasting");
 const perpetualsApiCasting_1 = require("../../packages/perpetuals/api/perpetualsApiCasting");
 const farmsApiCasting_1 = require("../../packages/farms/api/farmsApiCasting");
+/**
+ * Utility class for casting and conversion functions.
+ * @class
+ */
 class Casting {
 }
 exports.Casting = Casting;

package/dist/general/utils/helpers.d.ts

@@ -5,13 +5,28 @@ import { EventsApiHelpers } from "../api/eventsApiHelpers";
 import { InspectionsApiHelpers } from "../api/inspectionsApiHelpers";
 import { ObjectsApiHelpers } from "../api/objectsApiHelpers";
 import { TransactionsApiHelpers } from "../api/transactionsApiHelpers";
+/**
+ * A utility class containing various helper functions for general use.
+ */
 export declare class Helpers {
     static readonly dynamicFields: typeof DynamicFieldsApiHelpers;
     static readonly events: typeof EventsApiHelpers;
     static readonly inspections: typeof InspectionsApiHelpers;
     static readonly objects: typeof ObjectsApiHelpers;
     static readonly transactions: typeof TransactionsApiHelpers;
+    /**
+     * Removes leading zeroes from the hexadecimal representation of a given object type.
+     * @param type - The object type to strip leading zeroes from.
+     * @returns The object type with leading zeroes removed from its hexadecimal representation.
+     */
     static stripLeadingZeroesFromType: (type: AnyObjectType) => AnyObjectType;
+    /**
+     * Adds leading zeroes to a given `AnyObjectType` until it reaches a length of 64 characters.
+     * If the input type already has a length greater than 64, an error is thrown.
+     * @param type - The `AnyObjectType` to add leading zeroes to.
+     * @returns The modified `AnyObjectType` with leading zeroes added.
+     * @throws An error if the input type has a length greater than 64.
+     */
     static addLeadingZeroesToType: (type: AnyObjectType) => AnyObjectType;
     static isNumber: (str: string) => boolean;
     static sum: (arr: number[]) => number;

package/dist/general/utils/helpers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../../src/general/utils/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,qBAAqB,EAErB,iBAAiB,EACjB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACzE,OAAO,EAAE,uBAAuB,EAAE,MAAM,gCAAgC,CAAC;AACzE,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AACrE,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAC7D,OAAO,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AAIvE,qBAAa,OAAO;IAKnB,gBAAuB,aAAa,iCAA2B;IAC/D,gBAAuB,MAAM,0BAAoB;IACjD,gBAAuB,WAAW,+BAAyB;IAC3D,gBAAuB,OAAO,2BAAqB;IACnD,gBAAuB,YAAY,gCAA0B;IAM7D,OAAc,0BAA0B,SACjC,aAAa,KACjB,aAAa,CAAiC;IAEjD,OAAc,sBAAsB,SAC7B,aAAa,KACjB,aAAa,CA0Bd;IAMF,OAAc,QAAQ,QAAS,MAAM,KAAG,OAAO,CAA6B;IAE5E,OAAc,GAAG,QAAS,MAAM,EAAE,YACQ;IAE1C,OAAc,SAAS,QAAS,MAAM,EAAE,YACU;IAElD,OAAc,WAAW,MAAO,MAAM,KAAK,MAAM,aAAa,MAAM,aACrB;IAE/C,OAAc,iBAAiB,MAC3B,MAAM,KACN,MAAM,aACE,MAAM,aACwC;IAE1D,OAAc,YAAY,MAAO,MAAM,KAAK,MAAM,YAAY,MAAM,aACA;IAEpE,OAAc,iBAAiB;oBAClB,MAAM,KAAK,MAAM,KAAG,MAAM;oBAC1B,MAAM,KAAK,MAAM,KAAG,MAAM;oBAC1B,MAAM,KAAK,MAAM,KAAG,MAAM;oBAC1B,MAAM,KAAK,MAAM,KAAG,MAAM;oBAE1B,MAAM,KAAK,MAAM,KAAG,MAAM;oBAC1B,MAAM,KAAK,MAAM,KAAG,MAAM;MACrC;IAEF,OAAc,SAAS,YAAa,MAAM,EAAE,YACJ;IAMxC,OAAc,yBAAyB,QAAS,MAAM,YACI;IAM1D,OAAc,mBAAmB,SAC1B,MAAM,iDAiBT;IAMJ,OAAc,QAAQ,sBAwBpB;IAEF,OAAc,UAAU,QAAS,GAAG,EAAE,YAcpC;IAEF,OAAc,WAAW,uBAA2C;IAEpE,OAAc,KAAK,OAAQ,MAAM,sBAA2C;IAE5E,OAAc,SAAS,eAC4C;IAEnE,OAAc,QAAQ,iEAEU,MAAM,uBAAuB,OAAO,+CASlE;IAEF,OAAc,aAAa,iEAIlB,MAAM,uBAET,QAAQ,OAAO,CAAC,wDAIpB;IAEF,OAAc,YAAY,uDAER,MAAM,mBAAmB,OAAO,2BAWjB;IAEjC,OAAc,mBAAmB,WACxB,OAAO,YACL,QAAQ,YAWjB;IAEF,OAAc,aAAa,WAAY,MAAM,YAAY,QAAQ,YAE/D;WAMY,gBAAgB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,EAAE;WAWnD,aAAa,CAAC,IAAI,EAAE,iBAAiB,GAAG,QAAQ;WAOhD,WAAW,CAAC,IAAI,EAAE,iBAAiB,GAAG,QAAQ;WAO9C,eAAe,CAC5B,IAAI,EAAE,iBAAiB,GACrB,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;WASR,gBAAgB,CAC7B,IAAI,EAAE,iBAAiB,GACrB,qBAAqB;CAMxB"}
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../../src/general/utils/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,qBAAqB,EAErB,iBAAiB,EACjB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACzE,OAAO,EAAE,uBAAuB,EAAE,MAAM,gCAAgC,CAAC;AACzE,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AACrE,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAC7D,OAAO,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AAIvE;;GAEG;AACH,qBAAa,OAAO;IAKnB,gBAAuB,aAAa,iCAA2B;IAC/D,gBAAuB,MAAM,0BAAoB;IACjD,gBAAuB,WAAW,+BAAyB;IAC3D,gBAAuB,OAAO,2BAAqB;IACnD,gBAAuB,YAAY,gCAA0B;IAM7D;;;;OAIG;IACH,OAAc,0BAA0B,SACjC,aAAa,KACjB,aAAa,CAAiC;IAEjD;;;;;;OAMG;IACH,OAAc,sBAAsB,SAC7B,aAAa,KACjB,aAAa,CA0Bd;IAMF,OAAc,QAAQ,QAAS,MAAM,KAAG,OAAO,CAA6B;IAE5E,OAAc,GAAG,QAAS,MAAM,EAAE,YACQ;IAE1C,OAAc,SAAS,QAAS,MAAM,EAAE,YACU;IAElD,OAAc,WAAW,MAAO,MAAM,KAAK,MAAM,aAAa,MAAM,aACrB;IAE/C,OAAc,iBAAiB,MAC3B,MAAM,KACN,MAAM,aACE,MAAM,aACwC;IAE1D,OAAc,YAAY,MAAO,MAAM,KAAK,MAAM,YAAY,MAAM,aACA;IAEpE,OAAc,iBAAiB;oBAClB,MAAM,KAAK,MAAM,KAAG,MAAM;oBAC1B,MAAM,KAAK,MAAM,KAAG,MAAM;oBAC1B,MAAM,KAAK,MAAM,KAAG,MAAM;oBAC1B,MAAM,KAAK,MAAM,KAAG,MAAM;oBAE1B,MAAM,KAAK,MAAM,KAAG,MAAM;oBAC1B,MAAM,KAAK,MAAM,KAAG,MAAM;MACrC;IAEF,OAAc,SAAS,YAAa,MAAM,EAAE,YACJ;IAMxC,OAAc,yBAAyB,QAAS,MAAM,YACI;IAM1D,OAAc,mBAAmB,SAC1B,MAAM,iDAiBT;IAMJ,OAAc,QAAQ,sBAwBpB;IAEF,OAAc,UAAU,QAAS,GAAG,EAAE,YAcpC;IAEF,OAAc,WAAW,uBAA2C;IAEpE,OAAc,KAAK,OAAQ,MAAM,sBAA2C;IAE5E,OAAc,SAAS,eAC4C;IAEnE,OAAc,QAAQ,iEAEU,MAAM,uBAAuB,OAAO,+CASlE;IAEF,OAAc,aAAa,iEAIlB,MAAM,uBAET,QAAQ,OAAO,CAAC,wDAIpB;IAEF,OAAc,YAAY,uDAER,MAAM,mBAAmB,OAAO,2BAWjB;IAEjC,OAAc,mBAAmB,WACxB,OAAO,YACL,QAAQ,YAWjB;IAEF,OAAc,aAAa,WAAY,MAAM,YAAY,QAAQ,YAE/D;WAMY,gBAAgB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,EAAE;WAWnD,aAAa,CAAC,IAAI,EAAE,iBAAiB,GAAG,QAAQ;WAOhD,WAAW,CAAC,IAAI,EAAE,iBAAiB,GAAG,QAAQ;WAO9C,eAAe,CAC5B,IAAI,EAAE,iBAAiB,GACrB,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;WASR,gBAAgB,CAC7B,IAAI,EAAE,iBAAiB,GACrB,qBAAqB;CAMxB"}

package/dist/general/utils/helpers.js

@@ -17,6 +17,9 @@ const inspectionsApiHelpers_1 = require("../api/inspectionsApiHelpers");
 const objectsApiHelpers_1 = require("../api/objectsApiHelpers");
 const transactionsApiHelpers_1 = require("../api/transactionsApiHelpers");
 const casting_1 = require("./casting");
+/**
+ * A utility class containing various helper functions for general use.
+ */
 class Helpers {
     // =========================================================================
     //  Type Checking
@@ -73,7 +76,19 @@ Helpers.transactions = transactionsApiHelpers_1.TransactionsApiHelpers;
 // =========================================================================
 //  Type Manipulation
 // =========================================================================
+/**
+ * Removes leading zeroes from the hexadecimal representation of a given object type.
+ * @param type - The object type to strip leading zeroes from.
+ * @returns The object type with leading zeroes removed from its hexadecimal representation.
+ */
 Helpers.stripLeadingZeroesFromType = (type) => type.replaceAll(/x0+/g, "x");
+/**
+ * Adds leading zeroes to a given `AnyObjectType` until it reaches a length of 64 characters.
+ * If the input type already has a length greater than 64, an error is thrown.
+ * @param type - The `AnyObjectType` to add leading zeroes to.
+ * @returns The modified `AnyObjectType` with leading zeroes added.
+ * @throws An error if the input type has a length greater than 64.
+ */
 Helpers.addLeadingZeroesToType = (type) => {
     const expectedTypeLength = 64;
     let strippedType = type.replace("0x", "");