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

package/dist/general/types/suiTypes.js

@@ -1,27 +1,5 @@
 "use strict";
+// =========================================================================
+//  Network
+// =========================================================================
 Object.defineProperty(exports, "__esModule", { value: true });
-// export interface StakedSui {
-// 	objectId: ObjectId;
-// 	validatorAddress: SuiAddress;
-// 	poolStartingEpoch: number;
-// 	delegationRequestEpoch: number;
-// 	principal: Balance;
-// }
-// export interface Delegation {
-// 	objectId: ObjectId;
-// 	stakedSuiId: ObjectId;
-// 	poolTokens: Balance;
-// 	principalSuiAmount: Balance;
-// }
-// export interface StakedSuiWithDelegation {
-// 	stakedSui: StakedSui;
-// 	delegation?: Delegation;
-// }
-// export interface AuthorityPublicKeyBytes {
-// 	pubKey: string;
-// 	bytes: bigint;
-// }
-// export interface CommitteeInfo {
-// 	committeeInfo: AuthorityPublicKeyBytes[];
-// 	epoch: EpochTimeStamp;
-// }

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

@@ -15,43 +15,199 @@ import { SuiObjectResponse } from "@mysten/sui/client";
 import { NftsApiCasting } from "../nfts/nftsApiCasting";
 import { OracleApiCasting } from "../../packages/oracle/api/oracleApiCasting";
 /**
- * Utility class for casting and conversion functions.
- * @class
+ * A central utility class for casting and conversion routines across
+ * different Aftermath modules. Provides both direct numeric transformations
+ * (e.g., fixed-point arithmetic) and advanced BCS-based object deserialization.
  */
 export declare class Casting {
+    /**
+     * Casting utilities for pools-related data (AMM pools, liquidity, etc.).
+     */
     static pools: typeof PoolsApiCasting;
+    /**
+     * Casting utilities for SuiFrens-related data or objects.
+     */
     static suiFrens: typeof SuiFrensApiCasting;
+    /**
+     * Casting utilities for faucet-related data, typically for devnet or testnet tokens.
+     */
     static faucet: typeof FaucetApiCasting;
+    /**
+     * Casting utilities for staking-related data (positions, pools, etc.).
+     */
     static staking: typeof StakingApiCasting;
+    /**
+     * Casting utilities for leveraged staking data structures.
+     */
     static leveragedStaking: typeof LeveragedStakingApiCasting;
+    /**
+     * Casting utilities for NFT AMM objects and events.
+     */
     static nftAmm: typeof NftAmmApiCasting;
+    /**
+     * Casting utilities for router-based data, such as trade routes and DEX interactions.
+     */
     static router: typeof RouterApiCasting;
+    /**
+     * Casting utilities for perpetuals/futures data.
+     */
     static perpetuals: typeof PerpetualsApiCasting;
+    /**
+     * Casting utilities for oracle-based data or price feed objects.
+     */
     static oracle: typeof OracleApiCasting;
+    /**
+     * Casting utilities for farming data (yield farms, locked positions, etc.).
+     */
     static farms: typeof FarmsApiCasting;
+    /**
+     * Casting utilities for NFT structures and data retrieval logic.
+     */
     static nfts: typeof NftsApiCasting;
+    /**
+     * Reference to the standard fixed-point arithmetic utilities (18 decimals).
+     */
     static Fixed: typeof FixedUtils;
+    /**
+     * Reference to the intermediate fixed type (signed 18 decimals).
+     */
     static IFixed: typeof IFixedUtils;
+    /**
+     * The maximum unsigned 64-bit integer value as a bigint (0xFFFFFFFFFFFFFFFF).
+     */
     static u64MaxBigInt: bigint;
+    /**
+     * Converts a floating-point number to a fixed bigint with 18 decimals.
+     * For example, `1.23` => `1230000000000000000n` if we consider 18 decimals.
+     *
+     * @param a - The number to convert.
+     * @returns A bigint representing the number in 18-decimal fixed format.
+     */
     static numberToFixedBigInt: (a: number) => bigint;
+    /**
+     * Converts an 18-decimal fixed bigint to a floating-point number.
+     * For example, `1230000000000000000n` => `1.23`.
+     *
+     * @param a - The fixed bigint to convert.
+     * @returns A floating-point representation of the 18-decimal fixed value.
+     */
     static bigIntToFixedNumber: (a: bigint) => number;
+    /**
+     * Scales a bigint by a floating-point scalar. For instance, a scalar of 0.5
+     * and a bigint of 100 => 50n.
+     *
+     * @param scalar - The floating-point multiplier (e.g., 0.5).
+     * @param int - The bigint to be scaled.
+     * @returns A bigint result after scaling.
+     */
     static scaleNumberByBigInt: (scalar: number, int: bigint) => bigint;
+    /**
+     * Converts a decimal percentage into basis points (bps), returned as a bigint.
+     * For example, 0.05 => 500 bps.
+     *
+     * @param percentage - The decimal percentage to convert (e.g., 0.05 for 5%).
+     * @returns A bigint representing basis points.
+     */
     static percentageToBps(percentage: Percentage): bigint;
+    /**
+     * Converts a bigint basis points value back to a decimal percentage.
+     * For example, 500n => 0.05 (5%).
+     *
+     * @param bps - The bigint basis points to convert (e.g., 500n).
+     * @returns The decimal percentage (0.05).
+     */
     static bpsToPercentage(bps: bigint): Percentage;
+    /**
+     * Converts an array of bytes into a string by interpreting each byte as a character code.
+     *
+     * @param bytes - An array of bytes to convert.
+     * @returns The resulting ASCII string.
+     */
     static stringFromBytes: (bytes: Byte[]) => string;
+    /**
+     * Interprets an array of bytes as a little-endian hex string, converting
+     * that string into a bigint. For example, `[0x01, 0x02]` => `0x0201` => `513n`.
+     *
+     * @param bytes - An array of bytes.
+     * @returns The resulting bigint from the hex.
+     */
     static bigIntFromBytes: (bytes: Byte[]) => bigint;
+    /**
+     * Converts BCS-encoded address bytes into a SuiAddress (0x...) string,
+     * preserving any needed leading zeroes.
+     *
+     * @param bytes - The address bytes in BCS-encoded form.
+     * @returns A normalized Sui address string (e.g., "0x000123...").
+     */
     static addressFromBcsBytes: (bytes: Byte[]) => SuiAddress;
+    /**
+     * Converts an array of bytes directly to a Sui address string in "0x..." format,
+     * adding any leading zeros if needed.
+     *
+     * @param bytes - The raw bytes for the address.
+     * @returns A normalized Sui address.
+     */
     static addressFromBytes: (bytes: Byte[]) => SuiAddress;
+    /**
+     * Converts an array of hex string bytes into a Sui address. Each element of
+     * the array is a string representing a byte (e.g., `["255", "0", ...]`).
+     *
+     * @param bytes - An array of stringified bytes to convert.
+     * @returns A normalized Sui address.
+     */
     static addressFromStringBytes: (bytes: string[]) => SuiAddress;
+    /**
+     * Converts an array of decimal-encoded string bytes (e.g., `["255", "0"]`)
+     * into a numeric `Byte[]` array.
+     *
+     * @param bytes - The string array representing decimal values.
+     * @returns A numeric array of bytes.
+     */
     static bytesFromStringBytes: (bytes: string[]) => Byte[];
+    /**
+     * Unwraps a deserialized "Option" type from the BCS, returning its contents
+     * if present, or `undefined` if not.
+     *
+     * @param deserializedData - The BCS-deserialized structure that might contain `{ Some: value }` or `{ None: true }`.
+     * @returns The unwrapped data if present, or `undefined`.
+     */
     static unwrapDeserializedOption: (deserializedData: any) => any | undefined;
+    /**
+     * Encodes a JavaScript string into a UTF-8 `Uint8Array`, suitable for
+     * on-chain usage or hashing.
+     *
+     * @param str - The string to encode.
+     * @returns An array of numeric bytes representing the UTF-8 encoded string.
+     */
     static u8VectorFromString: (str: string) => number[];
+    /**
+     * Normalizes a user-provided slippage tolerance from an integer percentage
+     * into a decimal fraction. E.g., `1 => 0.01`.
+     *
+     * @param slippageTolerance - The slippage in integer percent form (e.g., 1 for 1%).
+     * @returns A decimal fraction (e.g., 0.01).
+     */
     static normalizeSlippageTolerance: (slippageTolerance: number) => number;
+    /**
+     * Deserializes a `SuiObjectResponse`'s BCS bytes into an object of type `T` using
+     * a specified `bcsType`. Typically used for on-chain object decoding.
+     *
+     * @param inputs - The inputs including `suiObjectResponse`, `bcsType`, and a `fromDeserialized` transform function.
+     * @returns The transformed object of type `T` after BCS deserialization.
+     * @throws If no BCS bytes are found in the object.
+     */
     static castObjectBcs: <T, U>(inputs: {
         suiObjectResponse: SuiObjectResponse;
         bcsType: BcsType<U, U>;
-        fromDeserialized: (deserialized: any) => T;
+        fromDeserialized: (deserialized: U) => T;
     }) => T;
+    /**
+     * Extracts base64 BCS bytes from a `SuiObjectResponse` if present. Throws an error otherwise.
+     *
+     * @param suiObjectResponse - The Sui object response containing `bcsBytes`.
+     * @returns A base64 string representing the object's BCS data.
+     * @throws If the object response does not contain `bcsBytes`.
+     */
     static bcsBytesFromSuiObjectResponse(suiObjectResponse: SuiObjectResponse): string;
 }
 //# sourceMappingURL=casting.d.ts.map

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":"AAAA,OAAO,EAAE,OAAO,EAAO,MAAM,iBAAiB,CAAC;AAC/C,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,EAAU,UAAU,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAChE,OAAO,EAAE,gBAAgB,EAAE,MAAM,4CAA4C,CAAC;AAC9E,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,oBAAoB,EAAE,MAAM,oDAAoD,CAAC;AAC1F,OAAO,EAAE,eAAe,EAAE,MAAM,0CAA0C,CAAC;AAC3E,OAAO,EAAE,0BAA0B,EAAE,MAAM,gEAAgE,CAAC;AAG5G,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAAE,gBAAgB,EAAE,MAAM,4CAA4C,CAAC;AAC9E;;;GAGG;AACH,qBAAa,OAAO;IAKnB,OAAc,KAAK,yBAAmB;IACtC,OAAc,QAAQ,4BAAsB;IAC5C,OAAc,MAAM,0BAAoB;IACxC,OAAc,OAAO,2BAAqB;IAC1C,OAAc,gBAAgB,oCAA8B;IAC5D,OAAc,MAAM,0BAAoB;IACxC,OAAc,MAAM,0BAAoB;IACxC,OAAc,UAAU,8BAAwB;IAChD,OAAc,MAAM,0BAAoB;IACxC,OAAc,KAAK,yBAAmB;IACtC,OAAc,IAAI,wBAAkB;IAUpC,OAAc,KAAK,oBAAc;IACjC,OAAc,MAAM,qBAAe;IAEnC,OAAc,YAAY,EAAE,MAAM,CAAgC;IAYlE,OAAc,mBAAmB,MAAO,MAAM,KAAG,MAAM,CACT;IAC9C,OAAc,mBAAmB,MAAO,MAAM,KAAG,MAAM,CACrB;IAElC,OAAc,mBAAmB,WAAY,MAAM,OAAO,MAAM,KAAG,MAAM,CAC/B;WAM5B,eAAe,CAAC,UAAU,EAAE,UAAU,GAAG,MAAM;WAQ/C,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU;IAYtD,OAAc,eAAe,UAAW,IAAI,EAAE,YACN;IAExC,OAAc,eAAe,UAAW,IAAI,EAAE,YAO3C;IAEH,OAAc,mBAAmB,UAAW,IAAI,EAAE,KAAG,UAAU,CAG5D;IAEH,OAAc,gBAAgB,UAAW,IAAI,EAAE,KAAG,UAAU,CASzD;IAEH,OAAc,sBAAsB,UAAW,MAAM,EAAE,KAAG,UAAU,CACX;IAEzD,OAAc,oBAAoB,UAAW,MAAM,EAAE,KAAG,IAAI,EAAE,CAC3B;IAEnC,OAAc,wBAAwB,qBACnB,GAAG,KACnB,GAAG,GAAG,SAAS,CAOhB;IAEF,OAAc,kBAAkB,QAAS,MAAM,cAS7C;IAEF,OAAc,0BAA0B,sBAAuB,MAAM,YAEnE;IAEF,OAAc,aAAa;2BACP,iBAAiB;;yCAEH,GAAG;YASnC;WAEY,6BAA6B,CAC1C,iBAAiB,EAAE,iBAAiB,GAClC,MAAM;CAOT"}
+{"version":3,"file":"casting.d.ts","sourceRoot":"","sources":["../../../src/general/utils/casting.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAO,MAAM,iBAAiB,CAAC;AAC/C,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,EAAU,UAAU,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAChE,OAAO,EAAE,gBAAgB,EAAE,MAAM,4CAA4C,CAAC;AAC9E,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,oBAAoB,EAAE,MAAM,oDAAoD,CAAC;AAC1F,OAAO,EAAE,eAAe,EAAE,MAAM,0CAA0C,CAAC;AAC3E,OAAO,EAAE,0BAA0B,EAAE,MAAM,gEAAgE,CAAC;AAG5G,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAAE,gBAAgB,EAAE,MAAM,4CAA4C,CAAC;AAE9E;;;;GAIG;AACH,qBAAa,OAAO;IAKnB;;OAEG;IACH,OAAc,KAAK,yBAAmB;IACtC;;OAEG;IACH,OAAc,QAAQ,4BAAsB;IAC5C;;OAEG;IACH,OAAc,MAAM,0BAAoB;IACxC;;OAEG;IACH,OAAc,OAAO,2BAAqB;IAC1C;;OAEG;IACH,OAAc,gBAAgB,oCAA8B;IAC5D;;OAEG;IACH,OAAc,MAAM,0BAAoB;IACxC;;OAEG;IACH,OAAc,MAAM,0BAAoB;IACxC;;OAEG;IACH,OAAc,UAAU,8BAAwB;IAChD;;OAEG;IACH,OAAc,MAAM,0BAAoB;IACxC;;OAEG;IACH,OAAc,KAAK,yBAAmB;IACtC;;OAEG;IACH,OAAc,IAAI,wBAAkB;IAMpC;;OAEG;IACH,OAAc,KAAK,oBAAc;IACjC;;OAEG;IACH,OAAc,MAAM,qBAAe;IAEnC;;OAEG;IACH,OAAc,YAAY,EAAE,MAAM,CAAgC;IAUlE;;;;;;OAMG;IACH,OAAc,mBAAmB,MAAO,MAAM,KAAG,MAAM,CACT;IAE9C;;;;;;OAMG;IACH,OAAc,mBAAmB,MAAO,MAAM,KAAG,MAAM,CACrB;IAElC;;;;;;;OAOG;IACH,OAAc,mBAAmB,WAAY,MAAM,OAAO,MAAM,KAAG,MAAM,CAC/B;IAM1C;;;;;;OAMG;WACW,eAAe,CAAC,UAAU,EAAE,UAAU,GAAG,MAAM;IAO7D;;;;;;OAMG;WACW,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU;IAYtD;;;;;OAKG;IACH,OAAc,eAAe,UAAW,IAAI,EAAE,YACC;IAE/C;;;;;;OAMG;IACH,OAAc,eAAe,UAAW,IAAI,EAAE,YAO3C;IAEH;;;;;;OAMG;IACH,OAAc,mBAAmB,UAAW,IAAI,EAAE,KAAG,UAAU,CAG5D;IAEH;;;;;;OAMG;IACH,OAAc,gBAAgB,UAAW,IAAI,EAAE,KAAG,UAAU,CASzD;IAEH;;;;;;OAMG;IACH,OAAc,sBAAsB,UAAW,MAAM,EAAE,KAAG,UAAU,CACX;IAEzD;;;;;;OAMG;IACH,OAAc,oBAAoB,UAAW,MAAM,EAAE,KAAG,IAAI,EAAE,CAC3B;IAEnC;;;;;;OAMG;IACH,OAAc,wBAAwB,qBACnB,GAAG,KACnB,GAAG,GAAG,SAAS,CAEhB;IAEF;;;;;;OAMG;IACH,OAAc,kBAAkB,QAAS,MAAM,cAS7C;IAEF;;;;;;OAMG;IACH,OAAc,0BAA0B,sBAAuB,MAAM,YAEnE;IAEF;;;;;;;OAOG;IACH,OAAc,aAAa;2BACP,iBAAiB;;;YAWnC;IAEF;;;;;;OAMG;WACW,6BAA6B,CAC1C,iBAAiB,EAAE,iBAAiB,GAClC,MAAM;CAOT"}

package/dist/general/utils/casting.js

@@ -18,20 +18,34 @@ const __1 = require("../..");
 const nftsApiCasting_1 = require("../nfts/nftsApiCasting");
 const oracleApiCasting_1 = require("../../packages/oracle/api/oracleApiCasting");
 /**
- * Utility class for casting and conversion functions.
- * @class
+ * A central utility class for casting and conversion routines across
+ * different Aftermath modules. Provides both direct numeric transformations
+ * (e.g., fixed-point arithmetic) and advanced BCS-based object deserialization.
  */
 class Casting {
     // =========================================================================
-    //  Fixed
+    //  Percentage <-> Bps
     // =========================================================================
+    /**
+     * Converts a decimal percentage into basis points (bps), returned as a bigint.
+     * For example, 0.05 => 500 bps.
+     *
+     * @param percentage - The decimal percentage to convert (e.g., 0.05 for 5%).
+     * @returns A bigint representing basis points.
+     */
     static percentageToBps(percentage) {
         // Convert decimal percentage to basis points
         const bps = percentage * 10000;
         // Convert basis points to bigint
-        const bpsBigint = BigInt(Math.round(bps));
-        return bpsBigint;
+        return BigInt(Math.round(bps));
     }
+    /**
+     * Converts a bigint basis points value back to a decimal percentage.
+     * For example, 500n => 0.05 (5%).
+     *
+     * @param bps - The bigint basis points to convert (e.g., 500n).
+     * @returns The decimal percentage (0.05).
+     */
     static bpsToPercentage(bps) {
         // Convert bigint basis points to number
         const bpsNumber = Number(bps);
@@ -39,6 +53,13 @@ class Casting {
         const percentage = bpsNumber / 10000;
         return percentage;
     }
+    /**
+     * Extracts base64 BCS bytes from a `SuiObjectResponse` if present. Throws an error otherwise.
+     *
+     * @param suiObjectResponse - The Sui object response containing `bcsBytes`.
+     * @returns A base64 string representing the object's BCS data.
+     * @throws If the object response does not contain `bcsBytes`.
+     */
     static bcsBytesFromSuiObjectResponse(suiObjectResponse) {
         var _b, _c;
         const rawData = (_b = suiObjectResponse.data) === null || _b === void 0 ? void 0 : _b.bcs;
@@ -52,46 +73,133 @@ _a = Casting;
 // =========================================================================
 //  Api Casting
 // =========================================================================
+/**
+ * Casting utilities for pools-related data (AMM pools, liquidity, etc.).
+ */
 Casting.pools = poolsApiCasting_1.PoolsApiCasting;
+/**
+ * Casting utilities for SuiFrens-related data or objects.
+ */
 Casting.suiFrens = suiFrensApiCasting_1.SuiFrensApiCasting;
+/**
+ * Casting utilities for faucet-related data, typically for devnet or testnet tokens.
+ */
 Casting.faucet = faucetApiCasting_1.FaucetApiCasting;
+/**
+ * Casting utilities for staking-related data (positions, pools, etc.).
+ */
 Casting.staking = stakingApiCasting_1.StakingApiCasting;
+/**
+ * Casting utilities for leveraged staking data structures.
+ */
 Casting.leveragedStaking = leveragedStakingApiCasting_1.LeveragedStakingApiCasting;
+/**
+ * Casting utilities for NFT AMM objects and events.
+ */
 Casting.nftAmm = nftAmmApiCasting_1.NftAmmApiCasting;
+/**
+ * Casting utilities for router-based data, such as trade routes and DEX interactions.
+ */
 Casting.router = routerApiCasting_1.RouterApiCasting;
+/**
+ * Casting utilities for perpetuals/futures data.
+ */
 Casting.perpetuals = perpetualsApiCasting_1.PerpetualsApiCasting;
+/**
+ * Casting utilities for oracle-based data or price feed objects.
+ */
 Casting.oracle = oracleApiCasting_1.OracleApiCasting;
+/**
+ * Casting utilities for farming data (yield farms, locked positions, etc.).
+ */
 Casting.farms = farmsApiCasting_1.FarmsApiCasting;
+/**
+ * Casting utilities for NFT structures and data retrieval logic.
+ */
 Casting.nfts = nftsApiCasting_1.NftsApiCasting;
 // =========================================================================
 //  Constants
 // =========================================================================
-// =========================================================================
-//  Fixed / IFixed
-// =========================================================================
+/**
+ * Reference to the standard fixed-point arithmetic utilities (18 decimals).
+ */
 Casting.Fixed = fixedUtils_1.FixedUtils;
+/**
+ * Reference to the intermediate fixed type (signed 18 decimals).
+ */
 Casting.IFixed = iFixedUtils_1.IFixedUtils;
+/**
+ * The maximum unsigned 64-bit integer value as a bigint (0xFFFFFFFFFFFFFFFF).
+ */
 Casting.u64MaxBigInt = BigInt("0xFFFFFFFFFFFFFFFF");
 // =========================================================================
 //  Functions
 // =========================================================================
 // =========================================================================
-//  Fixed
+//  Fixed / IFixed
 // =========================================================================
-// TODO: only use fixed class for these functions, remove from here
+/**
+ * Converts a floating-point number to a fixed bigint with 18 decimals.
+ * For example, `1.23` => `1230000000000000000n` if we consider 18 decimals.
+ *
+ * @param a - The number to convert.
+ * @returns A bigint representing the number in 18-decimal fixed format.
+ */
 Casting.numberToFixedBigInt = (a) => BigInt(Math.floor(a * _a.Fixed.fixedOneN));
+/**
+ * Converts an 18-decimal fixed bigint to a floating-point number.
+ * For example, `1230000000000000000n` => `1.23`.
+ *
+ * @param a - The fixed bigint to convert.
+ * @returns A floating-point representation of the 18-decimal fixed value.
+ */
 Casting.bigIntToFixedNumber = (a) => Number(a) / _a.Fixed.fixedOneN;
+/**
+ * Scales a bigint by a floating-point scalar. For instance, a scalar of 0.5
+ * and a bigint of 100 => 50n.
+ *
+ * @param scalar - The floating-point multiplier (e.g., 0.5).
+ * @param int - The bigint to be scaled.
+ * @returns A bigint result after scaling.
+ */
 Casting.scaleNumberByBigInt = (scalar, int) => BigInt(Math.floor(scalar * Number(int)));
 // =========================================================================
 //  Bytes / BCS
 // =========================================================================
+/**
+ * Converts an array of bytes into a string by interpreting each byte as a character code.
+ *
+ * @param bytes - An array of bytes to convert.
+ * @returns The resulting ASCII string.
+ */
 Casting.stringFromBytes = (bytes) => String.fromCharCode.apply(null, bytes);
+/**
+ * Interprets an array of bytes as a little-endian hex string, converting
+ * that string into a bigint. For example, `[0x01, 0x02]` => `0x0201` => `513n`.
+ *
+ * @param bytes - An array of bytes.
+ * @returns The resulting bigint from the hex.
+ */
 Casting.bigIntFromBytes = (bytes) => BigInt("0x" +
     bytes
         .reverse()
         .map((byte) => byte.toString(16).padStart(2, "0"))
         .join(""));
+/**
+ * Converts BCS-encoded address bytes into a SuiAddress (0x...) string,
+ * preserving any needed leading zeroes.
+ *
+ * @param bytes - The address bytes in BCS-encoded form.
+ * @returns A normalized Sui address string (e.g., "0x000123...").
+ */
 Casting.addressFromBcsBytes = (bytes) => __1.Helpers.addLeadingZeroesToType(bcs_1.bcs.Address.parse(new Uint8Array(bytes)));
+/**
+ * Converts an array of bytes directly to a Sui address string in "0x..." format,
+ * adding any leading zeros if needed.
+ *
+ * @param bytes - The raw bytes for the address.
+ * @returns A normalized Sui address.
+ */
 Casting.addressFromBytes = (bytes) => __1.Helpers.addLeadingZeroesToType("0x" +
     bytes
         .map((byte) => {
@@ -99,28 +207,66 @@ Casting.addressFromBytes = (bytes) => __1.Helpers.addLeadingZeroesToType("0x" +
         return hex.length === 1 ? "0" + hex : hex;
     })
         .join(""));
+/**
+ * Converts an array of hex string bytes into a Sui address. Each element of
+ * the array is a string representing a byte (e.g., `["255", "0", ...]`).
+ *
+ * @param bytes - An array of stringified bytes to convert.
+ * @returns A normalized Sui address.
+ */
 Casting.addressFromStringBytes = (bytes) => _a.addressFromBytes(_a.bytesFromStringBytes(bytes));
+/**
+ * Converts an array of decimal-encoded string bytes (e.g., `["255", "0"]`)
+ * into a numeric `Byte[]` array.
+ *
+ * @param bytes - The string array representing decimal values.
+ * @returns A numeric array of bytes.
+ */
 Casting.bytesFromStringBytes = (bytes) => bytes.map((byte) => Number(byte));
+/**
+ * Unwraps a deserialized "Option" type from the BCS, returning its contents
+ * if present, or `undefined` if not.
+ *
+ * @param deserializedData - The BCS-deserialized structure that might contain `{ Some: value }` or `{ None: true }`.
+ * @returns The unwrapped data if present, or `undefined`.
+ */
 Casting.unwrapDeserializedOption = (deserializedData) => {
-    // return "vec" in deserializedData
-    // 	? deserializedData.vec.length > 0
-    // 		? deserializedData.vec[0]
-    // 		: undefined
-    // 	: undefined;
     return "Some" in deserializedData ? deserializedData.Some : undefined;
 };
+/**
+ * Encodes a JavaScript string into a UTF-8 `Uint8Array`, suitable for
+ * on-chain usage or hashing.
+ *
+ * @param str - The string to encode.
+ * @returns An array of numeric bytes representing the UTF-8 encoded string.
+ */
 Casting.u8VectorFromString = (str) => {
     const textEncode = new TextEncoder();
     const encodedStr = textEncode.encode(str);
-    let uint8s = [];
+    const uint8s = [];
     for (const uint8 of encodedStr.values()) {
         uint8s.push(uint8);
     }
     return uint8s;
 };
+/**
+ * Normalizes a user-provided slippage tolerance from an integer percentage
+ * into a decimal fraction. E.g., `1 => 0.01`.
+ *
+ * @param slippageTolerance - The slippage in integer percent form (e.g., 1 for 1%).
+ * @returns A decimal fraction (e.g., 0.01).
+ */
 Casting.normalizeSlippageTolerance = (slippageTolerance) => {
     return slippageTolerance / 100;
 };
+/**
+ * Deserializes a `SuiObjectResponse`'s BCS bytes into an object of type `T` using
+ * a specified `bcsType`. Typically used for on-chain object decoding.
+ *
+ * @param inputs - The inputs including `suiObjectResponse`, `bcsType`, and a `fromDeserialized` transform function.
+ * @returns The transformed object of type `T` after BCS deserialization.
+ * @throws If no BCS bytes are found in the object.
+ */
 Casting.castObjectBcs = (inputs) => {
     const { suiObjectResponse, bcsType, fromDeserialized } = inputs;
     const deserialized = bcsType.fromBase64(_a.bcsBytesFromSuiObjectResponse(suiObjectResponse));

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

@@ -1,22 +1,109 @@
 import { Balance, DecimalsScalar, NormalizedBalance } from "../../types";
+/**
+ * The `FixedUtils` class provides utilities for fixed-point arithmetic
+ * with a standard 18-decimal precision, along with some convenience
+ * methods for normalizing/un-normalizing amounts based on token decimals.
+ */
 export declare class FixedUtils {
+    /**
+     * Represents 1.0 in 18-decimal fixed math as a float: 1_000_000_000_000_000_000.
+     */
     static readonly fixedOneN: number;
+    /**
+     * Represents 1.0 in 18-decimal fixed math as a bigint: 1000000000000000000n.
+     */
     static readonly fixedOneB: bigint;
+    /**
+     * Represents 1.0 in 9-decimal fixed math as a float: 1_000_000_000.
+     */
     static readonly fixedOneN9 = 1000000000;
+    /**
+     * Represents 1.0 in 9-decimal fixed math as a bigint: 1000000000n.
+     */
     static readonly fixedOneB9: bigint;
+    /**
+     * Directly convert an on-chain `u64` (stored as a bigint) into a float, effectively no scaling.
+     *
+     * @param n - The on-chain number as a bigint.
+     * @returns The converted number as a float.
+     */
     static readonly convertFromInt: (n: OnChainNumber) => LocalNumber;
+    /**
+     * Convert a floating number back to an on-chain integer (bigint),
+     * truncating decimals.
+     *
+     * @param n - The local float.
+     * @returns The truncated bigint.
+     */
     static readonly convertToInt: (n: LocalNumber) => OnChainNumber;
+    /**
+     * Converts a fixed-18 on-chain number to a floating local number by dividing by `fixedOneN`.
+     *
+     * @param n - The on-chain 18-decimal fixed number (as a bigint).
+     * @returns A float representing the unscaled value.
+     */
     static readonly directCast: (n: OnChainNumber) => LocalNumber;
+    /**
+     * Converts a floating local number to an on-chain 18-decimal fixed bigint by multiplying by `fixedOneN`.
+     *
+     * @param n - The local float to be scaled.
+     * @returns The scaled 18-decimal fixed as a bigint.
+     */
     static readonly directUncast: (n: LocalNumber) => OnChainNumber;
+    /**
+     * Returns the complement of the number in `[0,1]`, i.e., `1 - n`.
+     * If `n` is negative, it's treated as zero; if `n` > 1, also treated as zero for the complement.
+     *
+     * @param n - The local float in [0,1].
+     * @returns The complement of `n` in [0,1].
+     */
     static readonly complement: (n: LocalNumber) => number;
+    /**
+     * Multiplies a raw integer `amount` by a `decimalsScalar` to produce
+     * a "normalized" form. E.g., if decimals = 9, we store it as 10^9 scale.
+     *
+     * @param decimalsScalar - The scale factor for the coin (e.g., 1e9).
+     * @param amount - The raw integer (balance) to be scaled.
+     * @returns The scaled (normalized) amount as a `number`.
+     */
     static readonly normalizeAmount: (decimalsScalar: DecimalsScalar, amount: Balance) => NormalizedBalance;
+    /**
+     * Divides a normalized amount by the `decimalsScalar` to get back the
+     * raw on-chain integer. This is typically used after floating computations.
+     *
+     * @param decimalsScalar - The scale factor for the coin (e.g., 1e9).
+     * @param normalizedAmount - The scaled amount to reduce.
+     * @returns The raw integer balance.
+     */
     static readonly unnormalizeAmount: (decimalsScalar: DecimalsScalar, normalizedAmount: NormalizedBalance) => Balance;
+    /**
+     * Directly cast a `Balance` to an 18-decimal float, factoring in token decimals.
+     *
+     * @param decimalsScalar - The token's decimal scale factor.
+     * @param amount - The raw integer `Balance`.
+     * @returns A float representing the 18-decimal scale cast.
+     */
     static readonly castAndNormalize: (decimalsScalar: DecimalsScalar, amount: Balance) => LocalNumber;
+    /**
+     * Reverse the cast of a normalized float back to a raw `Balance`,
+     * factoring in the token decimals.
+     *
+     * @param decimalsScalar - The token's decimal scale factor.
+     * @param normalizedAmount - A local float in 18-decimal domain.
+     * @returns A raw integer `Balance`.
+     */
     static readonly uncastAndUnnormalize: (decimalsScalar: DecimalsScalar, normalizedAmount: LocalNumber) => Balance;
 }
+/**
+ * A numeric type used on chain, typically fixed 18 decimals or direct u64.
+ */
 export type OnChainNumber = bigint;
+/**
+ * A local floating value for user calculations or UI representation.
+ */
 export type LocalNumber = number;
-export type OnChainRawInteger = OnChainNumber;
-export type OnChainUnitaryParameter = OnChainNumber;
+/**
+ * A scalar is any fixed 18-point number. They are stored on chain as a u128 and are always directly cast.
+ */
 export type OnChainScalar = OnChainNumber;
 //# sourceMappingURL=fixedUtils.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"fixedUtils.d.ts","sourceRoot":"","sources":["../../../src/general/utils/fixedUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAEzE,qBAAa,UAAU;IAEtB,gBAAuB,SAAS,EAAE,MAAM,CAA6B;IACrE,gBAAuB,SAAS,EAAE,MAAM,CAAiC;IAEzE,gBAAuB,UAAU,cAAiB;IAClD,gBAAuB,UAAU,SAAyB;IAI1D,gBAAuB,cAAc,MAAO,aAAa,KAAG,WAAW,CAC5D;IACX,gBAAuB,YAAY,MAAO,WAAW,KAAG,aAAa,CAC9C;IACvB,gBAAuB,UAAU,MAAO,aAAa,KAAG,WAAW,CACjC;IAClC,gBAAuB,YAAY,MAAO,WAAW,KAAG,aAAa,CACvB;IAE9C,gBAAuB,UAAU,MAAO,WAAW,YAClB;IAEjC,gBAAuB,eAAe,mBACrB,cAAc,UACtB,OAAO,KACb,iBAAiB,CAA4B;IAEhD,gBAAuB,iBAAiB,mBACvB,cAAc,oBACZ,iBAAiB,KACjC,OAAO,CAAsC;IAEhD,gBAAuB,gBAAgB,mBACtB,cAAc,UACtB,OAAO,KACb,WAAW,CAGX;IAEH,gBAAuB,oBAAoB,mBAC1B,cAAc,oBACZ,WAAW,KAC3B,OAAO,CAIP;CACH;AAID,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC;AACnC,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC;AAGjC,MAAM,MAAM,iBAAiB,GAAG,aAAa,CAAC;AAG9C,MAAM,MAAM,uBAAuB,GAAG,aAAa,CAAC;AAGpD,MAAM,MAAM,aAAa,GAAG,aAAa,CAAC"}
+{"version":3,"file":"fixedUtils.d.ts","sourceRoot":"","sources":["../../../src/general/utils/fixedUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAEzE;;;;GAIG;AACH,qBAAa,UAAU;IACtB;;OAEG;IACH,gBAAuB,SAAS,EAAE,MAAM,CAA6B;IAErE;;OAEG;IACH,gBAAuB,SAAS,EAAE,MAAM,CAAiC;IAEzE;;OAEG;IACH,gBAAuB,UAAU,cAAiB;IAElD;;OAEG;IACH,gBAAuB,UAAU,SAAyB;IAI1D;;;;;OAKG;IACH,gBAAuB,cAAc,MAAO,aAAa,KAAG,WAAW,CAC5D;IAEX;;;;;;OAMG;IACH,gBAAuB,YAAY,MAAO,WAAW,KAAG,aAAa,CAC9C;IAEvB;;;;;OAKG;IACH,gBAAuB,UAAU,MAAO,aAAa,KAAG,WAAW,CACjC;IAElC;;;;;OAKG;IACH,gBAAuB,YAAY,MAAO,WAAW,KAAG,aAAa,CACvB;IAE9C;;;;;;OAMG;IACH,gBAAuB,UAAU,MAAO,WAAW,YAClB;IAEjC;;;;;;;OAOG;IACH,gBAAuB,eAAe,mBACrB,cAAc,UACtB,OAAO,KACb,iBAAiB,CAA4B;IAEhD;;;;;;;OAOG;IACH,gBAAuB,iBAAiB,mBACvB,cAAc,oBACZ,iBAAiB,KACjC,OAAO,CAAsC;IAEhD;;;;;;OAMG;IACH,gBAAuB,gBAAgB,mBACtB,cAAc,UACtB,OAAO,KACb,WAAW,CAGX;IAEH;;;;;;;OAOG;IACH,gBAAuB,oBAAoB,mBAC1B,cAAc,oBACZ,WAAW,KAC3B,OAAO,CAIP;CACH;AAID;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC;AACnC;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC;AACjC;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,aAAa,CAAC"}