aftermath-ts-sdk 1.2.64 → 1.2.66

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

@@ -1,14 +1,78 @@
 import { Byte, IFixed } from "../types";
+/**
+ * The `IFixedUtils` class provides support for signed 18-decimal fixed math,
+ * referred to as "IFixed" in the Aftermath codebase. An `IFixed` value
+ * is a bigint that includes sign bit manipulation.
+ */
 export declare class IFixedUtils {
+    /**
+     * The representation of 1.0 in the IFixed format, i.e. 1e18.
+     */
     static readonly ONE: IFixed;
+    /**
+     * The greatest bit in a 256-bit representation. This is used to indicate negative values in some approaches.
+     */
     static readonly GREATEST_BIT: IFixed;
+    /**
+     * A mask that can be used to flip or remove the greatest bit in a 256-bit number.
+     */
     static readonly NOT_GREATEST_BIT: IFixed;
+    /**
+     * Converts an IFixed bigint into a floating-point number, extracting both the integer
+     * and decimal portions. For negative values, the sign bit is checked and value is negated.
+     *
+     * @param value - The IFixed value (signed 18-decimal) as a bigint.
+     * @returns A standard JavaScript number with fractional parts intact.
+     */
     static numberFromIFixed: (value: IFixed) => number;
+    /**
+     * Converts a floating-point number into an IFixed bigint with 18 decimals of precision.
+     * Negative numbers have the sign bit set.
+     *
+     * @param value - The JavaScript number to convert.
+     * @returns The resulting IFixed bigint in on-chain-compatible format.
+     */
     static iFixedFromNumber: (value: number) => IFixed;
+    /**
+     * Returns the absolute value of an IFixed number. If the value is negative,
+     * it's converted to its positive counterpart by flipping bits.
+     *
+     * @param value - The signed IFixed number as a bigint.
+     * @returns The absolute value in IFixed.
+     */
     static abs: (value: IFixed) => IFixed;
+    /**
+     * Determines the sign of an IFixed number.
+     * - If >= GREATEST_BIT, it's negative (-1).
+     * - If exactly 0, sign is 0.
+     * - Otherwise, sign is +1.
+     *
+     * @param value - The IFixed number to check.
+     * @returns `-1`, `0`, or `1` based on the sign.
+     */
     static sign: (value: IFixed) => number;
+    /**
+     * Negates an IFixed number by flipping bits. This effectively does `-value` for the signed 18-dec representation.
+     *
+     * @param value - The IFixed number to negate.
+     * @returns The negated IFixed number as a bigint.
+     */
     static neg: (value: IFixed) => IFixed;
+    /**
+     * Constructs an IFixed number from an array of bytes in little-endian format.
+     * The sign bit might be set if the top bit is `1`.
+     *
+     * @param bytes - The byte array representing the IFixed number.
+     * @returns The IFixed bigint.
+     */
     static iFixedFromBytes: (bytes: Byte[]) => IFixed;
+    /**
+     * Constructs an IFixed number from an array of stringified bytes,
+     * each representing a decimal numeric value (e.g., `"255"`, `"0"`).
+     *
+     * @param bytes - An array of string bytes.
+     * @returns The IFixed bigint.
+     */
     static iFixedFromStringBytes: (bytes: string[]) => IFixed;
 }
 //# sourceMappingURL=iFixedUtils.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"iFixedUtils.d.ts","sourceRoot":"","sources":["../../../src/general/utils/iFixedUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAGxC,qBAAa,WAAW;IACvB,gBAAuB,GAAG,EAAE,MAAM,CAAqC;IACvE,gBAAuB,YAAY,EAAE,MAAM,CAA4B;IACvE,gBAAuB,gBAAgB,EAAE,MAAM,CACP;IAExC,OAAc,gBAAgB,UAAW,MAAM,KAAG,MAAM,CAKtD;IAEF,OAAc,gBAAgB,UAAW,MAAM,KAAG,MAAM,CAItD;IAEF,OAAc,GAAG,UAAW,MAAM,KAAG,MAAM,CAGzC;IAEF,OAAc,IAAI,UAAW,MAAM,KAAG,MAAM,CAI1C;IAEF,OAAc,GAAG,UAAW,MAAM,KAAG,MAAM,CAIzC;IAEF,OAAc,eAAe,UAAW,IAAI,EAAE,KAAG,MAAM,CAErD;IAEF,OAAc,qBAAqB,UAAW,MAAM,EAAE,KAAG,MAAM,CAE7D;CACF"}
+{"version":3,"file":"iFixedUtils.d.ts","sourceRoot":"","sources":["../../../src/general/utils/iFixedUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAGxC;;;;GAIG;AACH,qBAAa,WAAW;IACvB;;OAEG;IACH,gBAAuB,GAAG,EAAE,MAAM,CAAqC;IAEvE;;OAEG;IACH,gBAAuB,YAAY,EAAE,MAAM,CAA4B;IAEvE;;OAEG;IACH,gBAAuB,gBAAgB,EAAE,MAAM,CACP;IAExC;;;;;;OAMG;IACH,OAAc,gBAAgB,UAAW,MAAM,KAAG,MAAM,CAKtD;IAEF;;;;;;OAMG;IACH,OAAc,gBAAgB,UAAW,MAAM,KAAG,MAAM,CAItD;IAEF;;;;;;OAMG;IACH,OAAc,GAAG,UAAW,MAAM,KAAG,MAAM,CAGzC;IAEF;;;;;;;;OAQG;IACH,OAAc,IAAI,UAAW,MAAM,KAAG,MAAM,CAI1C;IAEF;;;;;OAKG;IACH,OAAc,GAAG,UAAW,MAAM,KAAG,MAAM,CAIzC;IAEF;;;;;;OAMG;IACH,OAAc,eAAe,UAAW,IAAI,EAAE,KAAG,MAAM,CAErD;IAEF;;;;;;OAMG;IACH,OAAc,qBAAqB,UAAW,MAAM,EAAE,KAAG,MAAM,CAE7D;CACF"}

package/dist/general/utils/iFixedUtils.js

@@ -3,30 +3,74 @@ var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.IFixedUtils = void 0;
 const casting_1 = require("./casting");
+/**
+ * The `IFixedUtils` class provides support for signed 18-decimal fixed math,
+ * referred to as "IFixed" in the Aftermath codebase. An `IFixed` value
+ * is a bigint that includes sign bit manipulation.
+ */
 class IFixedUtils {
 }
 exports.IFixedUtils = IFixedUtils;
 _a = IFixedUtils;
+/**
+ * The representation of 1.0 in the IFixed format, i.e. 1e18.
+ */
 IFixedUtils.ONE = BigInt(1000000000000000000);
+/**
+ * The greatest bit in a 256-bit representation. This is used to indicate negative values in some approaches.
+ */
 IFixedUtils.GREATEST_BIT = BigInt(1) << BigInt(255);
+/**
+ * A mask that can be used to flip or remove the greatest bit in a 256-bit number.
+ */
 IFixedUtils.NOT_GREATEST_BIT = (BigInt(1) << BigInt(255)) - BigInt(1);
+/**
+ * Converts an IFixed bigint into a floating-point number, extracting both the integer
+ * and decimal portions. For negative values, the sign bit is checked and value is negated.
+ *
+ * @param value - The IFixed value (signed 18-decimal) as a bigint.
+ * @returns A standard JavaScript number with fractional parts intact.
+ */
 IFixedUtils.numberFromIFixed = (value) => {
     const absVal = _a.abs(value);
     const integerPart = Number(absVal / _a.ONE);
     const decimalPart = Number(absVal % _a.ONE) / Number(_a.ONE);
     return _a.sign(value) * (integerPart + decimalPart);
 };
+/**
+ * Converts a floating-point number into an IFixed bigint with 18 decimals of precision.
+ * Negative numbers have the sign bit set.
+ *
+ * @param value - The JavaScript number to convert.
+ * @returns The resulting IFixed bigint in on-chain-compatible format.
+ */
 IFixedUtils.iFixedFromNumber = (value) => {
     const newValue = BigInt(Math.floor(Math.abs(value) * Number(_a.ONE)));
     if (value < 0)
         return _a.neg(newValue);
     return newValue;
 };
+/**
+ * Returns the absolute value of an IFixed number. If the value is negative,
+ * it's converted to its positive counterpart by flipping bits.
+ *
+ * @param value - The signed IFixed number as a bigint.
+ * @returns The absolute value in IFixed.
+ */
 IFixedUtils.abs = (value) => {
     if (value >= _a.GREATEST_BIT)
         return _a.neg(value);
     return value;
 };
+/**
+ * Determines the sign of an IFixed number.
+ * - If >= GREATEST_BIT, it's negative (-1).
+ * - If exactly 0, sign is 0.
+ * - Otherwise, sign is +1.
+ *
+ * @param value - The IFixed number to check.
+ * @returns `-1`, `0`, or `1` based on the sign.
+ */
 IFixedUtils.sign = (value) => {
     if (value >= _a.GREATEST_BIT)
         return -1;
@@ -34,12 +78,32 @@ IFixedUtils.sign = (value) => {
         return 0;
     return 1;
 };
+/**
+ * Negates an IFixed number by flipping bits. This effectively does `-value` for the signed 18-dec representation.
+ *
+ * @param value - The IFixed number to negate.
+ * @returns The negated IFixed number as a bigint.
+ */
 IFixedUtils.neg = (value) => {
     return (((value ^ _a.NOT_GREATEST_BIT) + BigInt(1)) ^ _a.GREATEST_BIT);
 };
+/**
+ * Constructs an IFixed number from an array of bytes in little-endian format.
+ * The sign bit might be set if the top bit is `1`.
+ *
+ * @param bytes - The byte array representing the IFixed number.
+ * @returns The IFixed bigint.
+ */
 IFixedUtils.iFixedFromBytes = (bytes) => {
     return casting_1.Casting.bigIntFromBytes(bytes);
 };
+/**
+ * Constructs an IFixed number from an array of stringified bytes,
+ * each representing a decimal numeric value (e.g., `"255"`, `"0"`).
+ *
+ * @param bytes - An array of string bytes.
+ * @returns The IFixed bigint.
+ */
 IFixedUtils.iFixedFromStringBytes = (bytes) => {
     return _a.iFixedFromBytes(casting_1.Casting.bytesFromStringBytes(bytes));
 };

package/dist/general/wallet/wallet.d.ts

@@ -2,18 +2,93 @@ import { ApiTransactionsBody, Balance, CallerConfig, SuiAddress, TransactionsWit
 import { CoinType, CoinsToBalance } from "../../packages/coin/coinTypes";
 import { Caller } from "../utils/caller";
 import { AftermathApi } from "../providers";
+/**
+ * The `Wallet` class allows querying a user's balances and transactions.
+ * It handles fetching coin balances, transactions, and more by leveraging
+ * an `AftermathApi.Wallet` provider.
+ */
 export declare class Wallet extends Caller {
     readonly address: SuiAddress;
     private readonly Provider?;
+    /**
+     * Creates a new `Wallet` instance for a specific address.
+     *
+     * @param address - The Sui address for this wallet (e.g., "0x<address>").
+     * @param config - An optional caller configuration including network and authentication.
+     * @param Provider - An optional `AftermathApi` instance for wallet-specific methods.
+     */
     constructor(address: SuiAddress, config?: CallerConfig, Provider?: AftermathApi | undefined);
+    /**
+     * Fetches the balance for a single coin type in this wallet.
+     *
+     * @param inputs - An object containing the `coin` type to look up (e.g., "0x2::sui::SUI").
+     * @returns A promise that resolves to the coin balance as a bigint.
+     *
+     * @example
+     * ```typescript
+     *
+     * const afSdk = new Aftermath("MAINNET");
+     * await afSdk.init(); // initialize provider
+     *
+     * const wallet = afSdk.Wallet("0x<address>");
+     *
+     * const suiBalance = await wallet.getBalance({ coin: "0x2::sui::SUI" });
+     * console.log("SUI Balance:", suiBalance.toString());
+     * ```
+     */
     getBalance(inputs: {
         coin: CoinType;
     }): Promise<Balance>;
+    /**
+     * Fetches the balances for multiple specified coin types in this wallet.
+     * This method currently returns an array of balances in the same order
+     * as the requested coins.
+     *
+     * @param inputs - An object containing an array of `coins` (coin types).
+     * @returns A promise resolving to an array of `Balance`s, each matching the corresponding coin in `inputs.coins`.
+     *
+     * @example
+     * ```typescript
+     * const wallet = new Wallet("0x<address>");
+     * const balances = await wallet.getBalances({ coins: ["0x2::sui::SUI", "0x<...>"] });
+     * console.log(balances); // e.g. [1000000000n, 50000000000n]
+     * ```
+     */
     getBalances(inputs: {
         coins: CoinType[];
     }): Promise<Balance[]>;
+    /**
+     * Fetches all coin balances held by this wallet address, returning a record
+     * keyed by coin type.
+     *
+     * @returns A promise resolving to an object mapping coin types to balances (bigints).
+     *
+     * @example
+     * ```typescript
+     * const wallet = new Wallet("0x<address>");
+     * const allBalances = await wallet.getAllBalances();
+     * console.log(allBalances); // { "0x2::sui::SUI": 1000000000n, "0x<other_coin>": 5000000000n, ... }
+     * ```
+     */
     getAllBalances(): Promise<CoinsToBalance>;
+    /**
+     * Fetches a paginated list of past transactions for this wallet address.
+     *
+     * @param inputs - An object implementing `ApiTransactionsBody`, which includes pagination parameters (`cursor`, `limit`) and an optional `order` or other fields.
+     * @returns A promise that resolves to transaction details, including a cursor if more results exist.
+     *
+     * @example
+     * ```typescript
+     * const wallet = new Wallet("0x<address>");
+     * const txHistory = await wallet.getPastTransactions({ cursor: "abc123", limit: 10 });
+     * console.log(txHistory.transactions, txHistory.nextCursor);
+     * ```
+     */
     getPastTransactions(inputs: ApiTransactionsBody): Promise<TransactionsWithCursor>;
+    /**
+     * Internal helper to return the `Wallet` provider from `AftermathApi`, throwing
+     * an error if the provider is not defined.
+     */
     private useProvider;
 }
 //# sourceMappingURL=wallet.d.ts.map

package/dist/general/wallet/wallet.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"wallet.d.ts","sourceRoot":"","sources":["../../../src/general/wallet/wallet.ts"],"names":[],"mappings":"AACA,OAAO,EACN,mBAAmB,EACnB,OAAO,EACP,YAAY,EACZ,UAAU,EACV,sBAAsB,EAEtB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAC;AACzE,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AACzC,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAE5C,qBAAa,MAAO,SAAQ,MAAM;aAEhB,OAAO,EAAE,UAAU;IAEnC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC;gBAFV,OAAO,EAAE,UAAU,EACnC,MAAM,CAAC,EAAE,YAAY,EACJ,QAAQ,CAAC,0BAAc;IAS5B,UAAU,CAAC,MAAM,EAAE;QAAE,IAAI,EAAE,QAAQ,CAAA;KAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IAQxD,WAAW,CAAC,MAAM,EAAE;QAChC,KAAK,EAAE,QAAQ,EAAE,CAAC;KAClB,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAQT,cAAc,IAAI,OAAO,CAAC,cAAc,CAAC;IAUzC,mBAAmB,CAAC,MAAM,EAAE,mBAAmB;IAW5D,OAAO,CAAC,WAAW,CAIjB;CACF"}
+{"version":3,"file":"wallet.d.ts","sourceRoot":"","sources":["../../../src/general/wallet/wallet.ts"],"names":[],"mappings":"AACA,OAAO,EACN,mBAAmB,EACnB,OAAO,EACP,YAAY,EACZ,UAAU,EACV,sBAAsB,EAEtB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAC;AACzE,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AACzC,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAE5C;;;;GAIG;AACH,qBAAa,MAAO,SAAQ,MAAM;aAShB,OAAO,EAAE,UAAU;IAEnC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC;IAV3B;;;;;;OAMG;gBAEc,OAAO,EAAE,UAAU,EACnC,MAAM,CAAC,EAAE,YAAY,EACJ,QAAQ,CAAC,0BAAc;IASzC;;;;;;;;;;;;;;;;;OAiBG;IACU,UAAU,CAAC,MAAM,EAAE;QAAE,IAAI,EAAE,QAAQ,CAAA;KAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IAOrE;;;;;;;;;;;;;;OAcG;IACU,WAAW,CAAC,MAAM,EAAE;QAChC,KAAK,EAAE,QAAQ,EAAE,CAAC;KAClB,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAItB;;;;;;;;;;;;OAYG;IACU,cAAc,IAAI,OAAO,CAAC,cAAc,CAAC;IAUtD;;;;;;;;;;;;OAYG;IACU,mBAAmB,CAAC,MAAM,EAAE,mBAAmB;IAW5D;;;OAGG;IACH,OAAO,CAAC,WAAW,CAIjB;CACF"}

package/dist/general/wallet/wallet.js

@@ -11,7 +11,19 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Wallet = void 0;
 const caller_1 = require("../utils/caller");
+/**
+ * The `Wallet` class allows querying a user's balances and transactions.
+ * It handles fetching coin balances, transactions, and more by leveraging
+ * an `AftermathApi.Wallet` provider.
+ */
 class Wallet extends caller_1.Caller {
+    /**
+     * Creates a new `Wallet` instance for a specific address.
+     *
+     * @param address - The Sui address for this wallet (e.g., "0x<address>").
+     * @param config - An optional caller configuration including network and authentication.
+     * @param Provider - An optional `AftermathApi` instance for wallet-specific methods.
+     */
     constructor(address, config, Provider) {
         super(config, `wallet/${address}`);
         this.address = address;
@@ -19,6 +31,10 @@ class Wallet extends caller_1.Caller {
         // =========================================================================
         //  Private Helpers
         // =========================================================================
+        /**
+         * Internal helper to return the `Wallet` provider from `AftermathApi`, throwing
+         * an error if the provider is not defined.
+         */
         this.useProvider = () => {
             var _a;
             const provider = (_a = this.Provider) === null || _a === void 0 ? void 0 : _a.Wallet();
@@ -30,21 +46,62 @@ class Wallet extends caller_1.Caller {
     // =========================================================================
     //  Balances
     // =========================================================================
+    /**
+     * Fetches the balance for a single coin type in this wallet.
+     *
+     * @param inputs - An object containing the `coin` type to look up (e.g., "0x2::sui::SUI").
+     * @returns A promise that resolves to the coin balance as a bigint.
+     *
+     * @example
+     * ```typescript
+     *
+     * const afSdk = new Aftermath("MAINNET");
+     * await afSdk.init(); // initialize provider
+     *
+     * const wallet = afSdk.Wallet("0x<address>");
+     *
+     * const suiBalance = await wallet.getBalance({ coin: "0x2::sui::SUI" });
+     * console.log("SUI Balance:", suiBalance.toString());
+     * ```
+     */
     getBalance(inputs) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.useProvider().fetchCoinBalance(Object.assign(Object.assign({}, inputs), { walletAddress: this.address }));
         });
     }
-    // TODO: change return type to Record<Coin, Balance> ?
+    /**
+     * Fetches the balances for multiple specified coin types in this wallet.
+     * This method currently returns an array of balances in the same order
+     * as the requested coins.
+     *
+     * @param inputs - An object containing an array of `coins` (coin types).
+     * @returns A promise resolving to an array of `Balance`s, each matching the corresponding coin in `inputs.coins`.
+     *
+     * @example
+     * ```typescript
+     * const wallet = new Wallet("0x<address>");
+     * const balances = await wallet.getBalances({ coins: ["0x2::sui::SUI", "0x<...>"] });
+     * console.log(balances); // e.g. [1000000000n, 50000000000n]
+     * ```
+     */
     getBalances(inputs) {
         return __awaiter(this, void 0, void 0, function* () {
-            // const balances = await Promise.all(
-            // 	inputs.coins.map((coin) => this.getBalance({ coin }))
-            // );
-            // return balances;
             return this.fetchApi(`balances/coins`, inputs);
         });
     }
+    /**
+     * Fetches all coin balances held by this wallet address, returning a record
+     * keyed by coin type.
+     *
+     * @returns A promise resolving to an object mapping coin types to balances (bigints).
+     *
+     * @example
+     * ```typescript
+     * const wallet = new Wallet("0x<address>");
+     * const allBalances = await wallet.getAllBalances();
+     * console.log(allBalances); // { "0x2::sui::SUI": 1000000000n, "0x<other_coin>": 5000000000n, ... }
+     * ```
+     */
     getAllBalances() {
         return __awaiter(this, void 0, void 0, function* () {
             return this.useProvider().fetchAllCoinBalances({
@@ -55,6 +112,19 @@ class Wallet extends caller_1.Caller {
     // =========================================================================
     //  Transactions
     // =========================================================================
+    /**
+     * Fetches a paginated list of past transactions for this wallet address.
+     *
+     * @param inputs - An object implementing `ApiTransactionsBody`, which includes pagination parameters (`cursor`, `limit`) and an optional `order` or other fields.
+     * @returns A promise that resolves to transaction details, including a cursor if more results exist.
+     *
+     * @example
+     * ```typescript
+     * const wallet = new Wallet("0x<address>");
+     * const txHistory = await wallet.getPastTransactions({ cursor: "abc123", limit: 10 });
+     * console.log(txHistory.transactions, txHistory.nextCursor);
+     * ```
+     */
     getPastTransactions(inputs) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.useProvider().fetchPastTransactions(Object.assign(Object.assign({}, inputs), { walletAddress: this.address }));

package/dist/packages/auth/auth.d.ts

@@ -1,14 +1,105 @@
 import { CallerConfig, SignMessageCallback, SuiAddress } from "../../types";
 import { Caller } from "../../general/utils/caller";
 import { RateLimit } from "./authTypes";
+/**
+ * The `Auth` class manages creation and refreshing of access tokens
+ * to obtain higher rate limits on the Aftermath API. It includes methods
+ * to initialize authorization either by a direct callback-based approach
+ * or by importing a local Sui keystore. Optionally, administrative functions
+ * are provided for creating specialized auth accounts.
+ *
+ * @example
+ * ```typescript
+ * const auth = new Auth();
+ * const stopAuth = await auth.init({
+ *   walletAddress: "0x<address>",
+ *   signMessageCallback: async ({ message }) => {
+ *     // sign message
+ *   },
+ * });
+ * // ... make authenticated requests ...
+ * stopAuth(); // stop auto refresh
+ * ```
+ */
 export declare class Auth extends Caller {
+    /**
+     * Holds the timer reference for scheduled token refreshes.
+     */
     private refreshTimer;
+    /**
+     * Indicates whether the user has canceled auto token refresh.
+     */
     private isCanceled;
+    /**
+     * Creates a new `Auth` instance for token-based rate limit increases.
+     *
+     * @param config - Optional caller configuration, including network and access token.
+     */
     constructor(config?: CallerConfig);
+    /**
+     * Initializes the auth system by fetching an access token for the provided wallet address.
+     * After obtaining the token, it automatically schedules periodic refresh calls until stopped.
+     *
+     * @param inputs - An object containing the user's `walletAddress` and a `signMessageCallback` function
+     *  for cryptographically signing messages.
+     *
+     * @returns A function that, when called, cancels further token refresh attempts.
+     *
+     * @example
+     * ```typescript
+     * const auth = new Auth();
+     * const stopAuth = await auth.init({
+     *   walletAddress: "0x<address>",
+     *   signMessageCallback: async ({ message }) => {
+     *     // sign the message with your private key / keypair
+     *   },
+     * });
+     *
+     * // ... make authorized calls ...
+     *
+     * stopAuth(); // Cancel further token refreshes
+     * ```
+     */
     init(inputs: {
         walletAddress: SuiAddress;
         signMessageCallback: SignMessageCallback;
     }): Promise<() => void>;
+    /**
+     * Initializes the auth system by reading a local Sui keystore file (on the server side),
+     * using the private keys matching a provided address to sign messages for token creation.
+     * After the token is obtained, it automatically schedules periodic refresh calls until stopped.
+     *
+     * @param inputs - An object containing the target `walletAddress` and an optional path to the `.keystore`.
+     *  If `path` is not provided, it defaults to `~/.sui/sui_config/sui.keystore`.
+     * @returns A function that, when called, cancels further token refresh attempts.
+     *
+     * @throws If this method is called in a browser environment (client-side).
+     *
+     * @example
+     * ```typescript
+     * // On server:
+     * const stopAuth = await auth.initFromSuiKeystore({
+     *   walletAddress: "0x<address>",
+     *   path: "/custom/path/to/keystore.json",
+     * });
+     * // authorized calls...
+     * stopAuth();
+     * ```
+     */
+    /**
+     * **Admin-only**: Creates a new auth account with specific rate limits for a given
+     * `accountWalletAddress`. The `walletAddress` performing this action must have
+     * admin privileges, or the call will fail. Use this to create custom sub-accounts
+     * with limited scope or usage rates.
+     *
+     * @param inputs - Contains:
+     *  - `walletAddress`: The admin's wallet address
+     *  - `signMessageCallback`: The admin's signing callback
+     *  - `accountName`: A short name or identifier for the account
+     *  - `accountWalletAddress`: The Sui address representing this sub-account
+     *  - `rateLimits`: An array specifying the rate limits (method-based) for the sub-account
+     * @returns A promise resolving to `true` if successful, otherwise throws or returns `false`.
+     */
     adminCreateAuthAccount(inputs: {
         walletAddress: SuiAddress;
         signMessageCallback: SignMessageCallback;
@@ -16,7 +107,29 @@ export declare class Auth extends Caller {
         accountWalletAddress: SuiAddress;
         rateLimits: RateLimit[];
     }): Promise<boolean>;
+    /**
+     * Requests a new access token from the API by sending a signed message
+     * indicating the user wants a token.
+     *
+     * @param inputs - Contains the user's `walletAddress` and `signMessageCallback`.
+     * @returns A response object that includes the `accessToken` and an `expirationTimestamp`.
+     */
     private getAccessToken;
+    /**
+     * Creates a JSON string with a standard format:
+     * ```json
+     * {
+     *   "date": <epoch-seconds>,
+     *   "nonce": <random_number>,
+     *   "method": <method_string>,
+     *   "value": <passed_value>
+     * }
+     * ```
+     *
+     * @param method - A short method name describing the action ("GetAccessToken", "AccountCreate", etc.).
+     * @param value - The data object to embed under the `value` field.
+     * @returns A JSON-serialized string for signing.
+     */
     private static createSerializedJson;
 }
 //# sourceMappingURL=auth.d.ts.map

package/dist/packages/auth/auth.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../../../src/packages/auth/auth.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,YAAY,EACZ,mBAAmB,EACnB,UAAU,EAEV,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AACpD,OAAO,EAIN,SAAS,EACT,MAAM,aAAa,CAAC;AAGrB,qBAAa,IAAK,SAAQ,MAAM;IAK/B,OAAO,CAAC,YAAY,CAA8C;IAClE,OAAO,CAAC,UAAU,CAAS;gBAMf,MAAM,CAAC,EAAE,YAAY;IAQpB,IAAI,CAAC,MAAM,EAAE;QACzB,aAAa,EAAE,UAAU,CAAC;QAC1B,mBAAmB,EAAE,mBAAmB,CAAC;KACzC,GAAG,OAAO,CAAC,MAAM,IAAI,CAAC;IAgHV,sBAAsB,CAAC,MAAM,EAAE;QAC3C,aAAa,EAAE,UAAU,CAAC;QAC1B,mBAAmB,EAAE,mBAAmB,CAAC;QACzC,WAAW,EAAE,MAAM,CAAC;QACpB,oBAAoB,EAAE,UAAU,CAAC;QACjC,UAAU,EAAE,SAAS,EAAE,CAAC;KACxB,GAAG,OAAO,CAAC,OAAO,CAAC;YAqCN,cAAc;IAyB5B,OAAO,CAAC,MAAM,CAAC,oBAAoB;CAcnC"}
+{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../../../src/packages/auth/auth.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,YAAY,EACZ,mBAAmB,EACnB,UAAU,EAEV,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AACpD,OAAO,EAIN,SAAS,EACT,MAAM,aAAa,CAAC;AAGrB;;;;;;;;;;;;;;;;;;;GAmBG;AACH,qBAAa,IAAK,SAAQ,MAAM;IAK/B;;OAEG;IACH,OAAO,CAAC,YAAY,CAA8C;IAClE;;OAEG;IACH,OAAO,CAAC,UAAU,CAAS;IAM3B;;;;OAIG;gBACS,MAAM,CAAC,EAAE,YAAY;IAQjC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACU,IAAI,CAAC,MAAM,EAAE;QACzB,aAAa,EAAE,UAAU,CAAC;QAC1B,mBAAmB,EAAE,mBAAmB,CAAC;KACzC,GAAG,OAAO,CAAC,MAAM,IAAI,CAAC;IAiCvB;;;;;;;;;;;;;;;;;;;;;OAqBG;IA+EH;;;;;;;;;;;;;OAaG;IACU,sBAAsB,CAAC,MAAM,EAAE;QAC3C,aAAa,EAAE,UAAU,CAAC;QAC1B,mBAAmB,EAAE,mBAAmB,CAAC;QACzC,WAAW,EAAE,MAAM,CAAC;QACpB,oBAAoB,EAAE,UAAU,CAAC;QACjC,UAAU,EAAE,SAAS,EAAE,CAAC;KACxB,GAAG,OAAO,CAAC,OAAO,CAAC;IAsCpB;;;;;;OAMG;YACW,cAAc;IA0B5B;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,MAAM,CAAC,oBAAoB;CAcnC"}