@autonomys/auto-consensus 1.5.2 → 1.5.4

package/dist/account.d.ts

@@ -1,4 +1,30 @@
 import type { Api } from '@autonomys/auto-utils';
 import type { AccountData } from './types/account';
+/**
+ * Retrieves detailed account information including nonce and balance data.
+ *
+ * This function queries the system account storage to get comprehensive account information
+ * including the account nonce (transaction counter) and balance details (free, reserved, frozen, flags).
+ *
+ * @param api - The connected API instance to query the blockchain
+ * @param address - The account address to query information for
+ * @returns Promise that resolves to AccountData containing nonce and balance information
+ * @throws Error if the account query fails or if there's an issue parsing the data
+ *
+ * @example
+ * ```typescript
+ * import { account } from '@autonomys/auto-consensus'
+ * import { activate } from '@autonomys/auto-utils'
+ *
+ * const api = await activate({ networkId: 'gemini-3h' })
+ * const accountData = await account(api, '5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY')
+ *
+ * console.log(`Nonce: ${accountData.nonce}`)
+ * console.log(`Free Balance: ${accountData.data.free}`)
+ * console.log(`Reserved Balance: ${accountData.data.reserved}`)
+ *
+ * await api.disconnect()
+ * ```
+ */
 export declare const account: (api: Api, address: string) => Promise<AccountData>;
 //# sourceMappingURL=account.d.ts.map

package/dist/account.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"account.d.ts","sourceRoot":"","sources":["../src/account.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,uBAAuB,CAAA;AAChD,OAAO,KAAK,EAAE,WAAW,EAAkB,MAAM,iBAAiB,CAAA;AAGlE,eAAO,MAAM,OAAO,GAAU,KAAK,GAAG,EAAE,SAAS,MAAM,KAAG,OAAO,CAAC,WAAW,CAc5E,CAAA"}
+{"version":3,"file":"account.d.ts","sourceRoot":"","sources":["../src/account.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,uBAAuB,CAAA;AAChD,OAAO,KAAK,EAAE,WAAW,EAAkB,MAAM,iBAAiB,CAAA;AAGlE;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,OAAO,GAAU,KAAK,GAAG,EAAE,SAAS,MAAM,KAAG,OAAO,CAAC,WAAW,CAc5E,CAAA"}

package/dist/account.js

@@ -12,6 +12,32 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.account = void 0;
 const utils_1 = require("./utils");
+/**
+ * Retrieves detailed account information including nonce and balance data.
+ *
+ * This function queries the system account storage to get comprehensive account information
+ * including the account nonce (transaction counter) and balance details (free, reserved, frozen, flags).
+ *
+ * @param api - The connected API instance to query the blockchain
+ * @param address - The account address to query information for
+ * @returns Promise that resolves to AccountData containing nonce and balance information
+ * @throws Error if the account query fails or if there's an issue parsing the data
+ *
+ * @example
+ * ```typescript
+ * import { account } from '@autonomys/auto-consensus'
+ * import { activate } from '@autonomys/auto-utils'
+ *
+ * const api = await activate({ networkId: 'gemini-3h' })
+ * const accountData = await account(api, '5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY')
+ *
+ * console.log(`Nonce: ${accountData.nonce}`)
+ * console.log(`Free Balance: ${accountData.data.free}`)
+ * console.log(`Reserved Balance: ${accountData.data.reserved}`)
+ *
+ * await api.disconnect()
+ * ```
+ */
 const account = (api, address) => __awaiter(void 0, void 0, void 0, function* () {
     try {
         const rawAccount = yield api.query.system.account(address);

package/dist/balances.d.ts

@@ -1,5 +1,55 @@
 import { Api } from '@autonomys/auto-utils';
 import type { BalanceData } from './types/balance';
+/**
+ * Retrieves the total token issuance of the network.
+ *
+ * This function queries the blockchain to get the total amount of tokens that have been issued
+ * across the entire network. This includes all tokens in circulation, staked, reserved, and frozen.
+ *
+ * @param networkId - Optional network identifier. If not provided, uses the default network
+ * @returns Promise that resolves to a Codec containing the total issuance value as a hex string
+ * @throws Error if the network connection fails or the query is unsuccessful
+ *
+ * @example
+ * ```typescript
+ * import { totalIssuance } from '@autonomys/auto-consensus'
+ *
+ * // Query total issuance for default network
+ * const issuance = await totalIssuance()
+ * const totalTokens = BigInt(issuance.toString())
+ * console.log(`Total tokens issued: ${totalTokens}`)
+ *
+ * // Query for specific network
+ * const taurusIssuance = await totalIssuance('taurus')
+ * ```
+ */
 export declare const totalIssuance: (networkId?: string) => Promise<import("@autonomys/auto-utils").Codec>;
+/**
+ * Retrieves the balance information for a specific account.
+ *
+ * This function queries the balance data for a given account address, returning information
+ * about free, reserved, frozen, and flag balances. It uses the account function internally
+ * to get comprehensive account data and extracts the balance portion.
+ *
+ * @param api - The connected API instance to query the blockchain
+ * @param address - The account address to query balance information for
+ * @returns Promise that resolves to BalanceData containing balance details
+ * @throws Error if the account query fails or balance data cannot be retrieved
+ *
+ * @example
+ * ```typescript
+ * import { balance } from '@autonomys/auto-consensus'
+ * import { activate } from '@autonomys/auto-utils'
+ *
+ * const api = await activate({ networkId: 'gemini-3h' })
+ * const balanceData = await balance(api, '5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY')
+ *
+ * console.log(`Free Balance: ${balanceData.free}`)
+ * console.log(`Reserved Balance: ${balanceData.reserved}`)
+ * console.log(`Frozen Balance: ${balanceData.frozen}`)
+ *
+ * await api.disconnect()
+ * ```
+ */
 export declare const balance: (api: Api, address: string) => Promise<BalanceData>;
 //# sourceMappingURL=balances.d.ts.map

package/dist/balances.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"balances.d.ts","sourceRoot":"","sources":["../src/balances.ts"],"names":[],"mappings":"AAAA,OAAO,EAAY,GAAG,EAAE,MAAM,uBAAuB,CAAA;AAErD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAA;AAElD,eAAO,MAAM,aAAa,GAAU,YAAY,MAAM,mDAQrD,CAAA;AAED,eAAO,MAAM,OAAO,GAAU,KAAK,GAAG,EAAE,SAAS,MAAM,KAAG,OAAO,CAAC,WAAW,CAY5E,CAAA"}
+{"version":3,"file":"balances.d.ts","sourceRoot":"","sources":["../src/balances.ts"],"names":[],"mappings":"AAAA,OAAO,EAAY,GAAG,EAAE,MAAM,uBAAuB,CAAA;AAErD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAA;AAElD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,aAAa,GAAU,YAAY,MAAM,mDAQrD,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,OAAO,GAAU,KAAK,GAAG,EAAE,SAAS,MAAM,KAAG,OAAO,CAAC,WAAW,CAY5E,CAAA"}

package/dist/balances.js

@@ -12,6 +12,29 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.balance = exports.totalIssuance = void 0;
 const auto_utils_1 = require("@autonomys/auto-utils");
 const account_1 = require("./account");
+/**
+ * Retrieves the total token issuance of the network.
+ *
+ * This function queries the blockchain to get the total amount of tokens that have been issued
+ * across the entire network. This includes all tokens in circulation, staked, reserved, and frozen.
+ *
+ * @param networkId - Optional network identifier. If not provided, uses the default network
+ * @returns Promise that resolves to a Codec containing the total issuance value as a hex string
+ * @throws Error if the network connection fails or the query is unsuccessful
+ *
+ * @example
+ * ```typescript
+ * import { totalIssuance } from '@autonomys/auto-consensus'
+ *
+ * // Query total issuance for default network
+ * const issuance = await totalIssuance()
+ * const totalTokens = BigInt(issuance.toString())
+ * console.log(`Total tokens issued: ${totalTokens}`)
+ *
+ * // Query for specific network
+ * const taurusIssuance = await totalIssuance('taurus')
+ * ```
+ */
 const totalIssuance = (networkId) => __awaiter(void 0, void 0, void 0, function* () {
     // Get the api instance for the network
     const api = yield (0, auto_utils_1.activate)({ networkId });
@@ -20,6 +43,33 @@ const totalIssuance = (networkId) => __awaiter(void 0, void 0, void 0, function*
     return totalIssuance;
 });
 exports.totalIssuance = totalIssuance;
+/**
+ * Retrieves the balance information for a specific account.
+ *
+ * This function queries the balance data for a given account address, returning information
+ * about free, reserved, frozen, and flag balances. It uses the account function internally
+ * to get comprehensive account data and extracts the balance portion.
+ *
+ * @param api - The connected API instance to query the blockchain
+ * @param address - The account address to query balance information for
+ * @returns Promise that resolves to BalanceData containing balance details
+ * @throws Error if the account query fails or balance data cannot be retrieved
+ *
+ * @example
+ * ```typescript
+ * import { balance } from '@autonomys/auto-consensus'
+ * import { activate } from '@autonomys/auto-utils'
+ *
+ * const api = await activate({ networkId: 'gemini-3h' })
+ * const balanceData = await balance(api, '5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY')
+ *
+ * console.log(`Free Balance: ${balanceData.free}`)
+ * console.log(`Reserved Balance: ${balanceData.reserved}`)
+ * console.log(`Frozen Balance: ${balanceData.frozen}`)
+ *
+ * await api.disconnect()
+ * ```
+ */
 const balance = (api, address) => __awaiter(void 0, void 0, void 0, function* () {
     // Query the balance of the address and parse the data
     try {

package/dist/batch.d.ts

@@ -1,3 +1,32 @@
 import type { ApiPromise } from '@autonomys/auto-utils';
+/**
+ * Creates a batch transaction that executes multiple transactions atomically.
+ *
+ * This function creates a utility batch transaction that allows multiple operations to be
+ * executed together in a single transaction. All operations in the batch will either
+ * succeed together or fail together, ensuring atomicity.
+ *
+ * @param api - The connected API promise instance
+ * @param txs - Array of transaction objects to be batched together
+ * @returns A batch transaction that can be signed and submitted
+ *
+ * @example
+ * ```typescript
+ * import { batch, transfer } from '@autonomys/auto-consensus'
+ * import { activate, signAndSendTx } from '@autonomys/auto-utils'
+ *
+ * const api = await activate({ networkId: 'gemini-3h' })
+ *
+ * // Create multiple transfer transactions
+ * const tx1 = transfer(api, 'recipient1', '1000000000000')
+ * const tx2 = transfer(api, 'recipient2', '2000000000000')
+ *
+ * // Batch them together
+ * const batchTx = batch(api, [tx1, tx2])
+ *
+ * // Sign and send the batch transaction
+ * await signAndSendTx(sender, batchTx)
+ * ```
+ */
 export declare const batch: (api: ApiPromise, txs: any[]) => import("@autonomys/auto-utils").SubmittableExtrinsic<"promise", import("@autonomys/auto-utils").ISubmittableResult>;
 //# sourceMappingURL=batch.d.ts.map

package/dist/batch.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"batch.d.ts","sourceRoot":"","sources":["../src/batch.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAA;AAEvD,eAAO,MAAM,KAAK,GAAI,KAAK,UAAU,EAAE,KAAK,GAAG,EAAE,wHAA8B,CAAA"}
+{"version":3,"file":"batch.d.ts","sourceRoot":"","sources":["../src/batch.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAA;AAEvD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,eAAO,MAAM,KAAK,GAAI,KAAK,UAAU,EAAE,KAAK,GAAG,EAAE,wHAA8B,CAAA"}

package/dist/batch.js

@@ -1,5 +1,34 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.batch = void 0;
+/**
+ * Creates a batch transaction that executes multiple transactions atomically.
+ *
+ * This function creates a utility batch transaction that allows multiple operations to be
+ * executed together in a single transaction. All operations in the batch will either
+ * succeed together or fail together, ensuring atomicity.
+ *
+ * @param api - The connected API promise instance
+ * @param txs - Array of transaction objects to be batched together
+ * @returns A batch transaction that can be signed and submitted
+ *
+ * @example
+ * ```typescript
+ * import { batch, transfer } from '@autonomys/auto-consensus'
+ * import { activate, signAndSendTx } from '@autonomys/auto-utils'
+ *
+ * const api = await activate({ networkId: 'gemini-3h' })
+ *
+ * // Create multiple transfer transactions
+ * const tx1 = transfer(api, 'recipient1', '1000000000000')
+ * const tx2 = transfer(api, 'recipient2', '2000000000000')
+ *
+ * // Batch them together
+ * const batchTx = batch(api, [tx1, tx2])
+ *
+ * // Sign and send the batch transaction
+ * await signAndSendTx(sender, batchTx)
+ * ```
+ */
 const batch = (api, txs) => api.tx.utility.batch(txs);
 exports.batch = batch;

package/dist/domain.d.ts

@@ -1,7 +1,63 @@
 import type { Api } from '@autonomys/auto-utils';
 import { ConfirmedDomainBlock, DomainRegistry, DomainStakingSummary } from './types';
+/**
+ * Retrieves all registered domains on the network.
+ *
+ * This function queries the domain registry to get information about all domains
+ * registered on the Autonomys network, including their configuration, ownership,
+ * and creation details.
+ *
+ * @param api - The connected API instance to query the blockchain
+ * @returns Promise that resolves to an array of DomainRegistry objects
+ * @throws Error if the domain registry query fails
+ *
+ * @example
+ * ```typescript
+ * import { domains } from '@autonomys/auto-consensus'
+ * import { activate } from '@autonomys/auto-utils'
+ *
+ * const api = await activate({ networkId: 'gemini-3h' })
+ * const domainList = await domains(api)
+ *
+ * domainList.forEach(domain => {
+ *   console.log(`Domain ID: ${domain.domainId}`)
+ *   console.log(`Owner: ${domain.ownerAccountId}`)
+ *   console.log(`Name: ${domain.domainConfig.domainName}`)
+ * })
+ *
+ * await api.disconnect()
+ * ```
+ */
 export declare const domains: (api: Api) => Promise<DomainRegistry[]>;
 export declare function domainStakingSummary(api: Api): Promise<DomainStakingSummary[]>;
 export declare function domainStakingSummary(api: Api, domainId: string | number | bigint): Promise<DomainStakingSummary | undefined>;
+/**
+ * Retrieves the latest confirmed domain blocks for all domains.
+ *
+ * This function queries the latest confirmed block information for each domain,
+ * providing details about the most recent blocks that have been confirmed
+ * on each domain chain.
+ *
+ * @param api - The connected API instance to query the blockchain
+ * @returns Promise that resolves to an array of ConfirmedDomainBlock objects
+ * @throws Error if the confirmed domain block query fails
+ *
+ * @example
+ * ```typescript
+ * import { latestConfirmedDomainBlock } from '@autonomys/auto-consensus'
+ * import { activate } from '@autonomys/auto-utils'
+ *
+ * const api = await activate({ networkId: 'gemini-3h' })
+ * const confirmedBlocks = await latestConfirmedDomainBlock(api)
+ *
+ * confirmedBlocks.forEach(block => {
+ *   console.log(`Domain ${block.id}: Block #${block.blockNumber}`)
+ *   console.log(`Block Hash: ${block.blockHash}`)
+ *   console.log(`State Root: ${block.stateRoot}`)
+ * })
+ *
+ * await api.disconnect()
+ * ```
+ */
 export declare const latestConfirmedDomainBlock: (api: Api) => Promise<ConfirmedDomainBlock[]>;
 //# sourceMappingURL=domain.d.ts.map

package/dist/domain.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"domain.d.ts","sourceRoot":"","sources":["../src/domain.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,uBAAuB,CAAA;AAChD,OAAO,EAAE,oBAAoB,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;AAGpF,eAAO,MAAM,OAAO,GAAU,KAAK,GAAG,KAAG,OAAO,CAAC,cAAc,EAAE,CAQhE,CAAA;AAGD,wBAAsB,oBAAoB,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC,oBAAoB,EAAE,CAAC,CAAA;AACrF,wBAAsB,oBAAoB,CACxC,GAAG,EAAE,GAAG,EACR,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GACjC,OAAO,CAAC,oBAAoB,GAAG,SAAS,CAAC,CAAA;AAoC5C,eAAO,MAAM,0BAA0B,GAAU,KAAK,GAAG,KAAG,OAAO,CAAC,oBAAoB,EAAE,CAWzF,CAAA"}
+{"version":3,"file":"domain.d.ts","sourceRoot":"","sources":["../src/domain.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,uBAAuB,CAAA;AAChD,OAAO,EAAE,oBAAoB,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;AAGpF;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,eAAO,MAAM,OAAO,GAAU,KAAK,GAAG,KAAG,OAAO,CAAC,cAAc,EAAE,CAQhE,CAAA;AAGD,wBAAsB,oBAAoB,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC,oBAAoB,EAAE,CAAC,CAAA;AACrF,wBAAsB,oBAAoB,CACxC,GAAG,EAAE,GAAG,EACR,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GACjC,OAAO,CAAC,oBAAoB,GAAG,SAAS,CAAC,CAAA;AAuE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,eAAO,MAAM,0BAA0B,GAAU,KAAK,GAAG,KAAG,OAAO,CAAC,oBAAoB,EAAE,CAWzF,CAAA"}

package/dist/domain.js

@@ -13,6 +13,34 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.latestConfirmedDomainBlock = exports.domains = void 0;
 exports.domainStakingSummary = domainStakingSummary;
 const parse_1 = require("./utils/parse");
+/**
+ * Retrieves all registered domains on the network.
+ *
+ * This function queries the domain registry to get information about all domains
+ * registered on the Autonomys network, including their configuration, ownership,
+ * and creation details.
+ *
+ * @param api - The connected API instance to query the blockchain
+ * @returns Promise that resolves to an array of DomainRegistry objects
+ * @throws Error if the domain registry query fails
+ *
+ * @example
+ * ```typescript
+ * import { domains } from '@autonomys/auto-consensus'
+ * import { activate } from '@autonomys/auto-utils'
+ *
+ * const api = await activate({ networkId: 'gemini-3h' })
+ * const domainList = await domains(api)
+ *
+ * domainList.forEach(domain => {
+ *   console.log(`Domain ID: ${domain.domainId}`)
+ *   console.log(`Owner: ${domain.ownerAccountId}`)
+ *   console.log(`Name: ${domain.domainConfig.domainName}`)
+ * })
+ *
+ * await api.disconnect()
+ * ```
+ */
 const domains = (api) => __awaiter(void 0, void 0, void 0, function* () {
     try {
         const _domains = yield api.query.domains.domainRegistry.entries();
@@ -24,6 +52,41 @@ const domains = (api) => __awaiter(void 0, void 0, void 0, function* () {
     }
 });
 exports.domains = domains;
+/**
+ * Retrieves staking summary information for domains.
+ *
+ * This function can be used in two ways:
+ * 1. Without domainId: Returns staking summaries for all domains
+ * 2. With domainId: Returns staking summary for a specific domain
+ *
+ * The staking summary includes information about current epoch, total stake,
+ * operators, and epoch rewards for each domain.
+ *
+ * @param api - The connected API instance to query the blockchain
+ * @param domainId - Optional domain ID to query specific domain summary
+ * @returns Promise that resolves to array of summaries (all domains) or single summary (specific domain)
+ * @throws Error if the staking summary query fails
+ *
+ * @example
+ * ```typescript
+ * import { domainStakingSummary } from '@autonomys/auto-consensus'
+ * import { activate } from '@autonomys/auto-utils'
+ *
+ * const api = await activate({ networkId: 'gemini-3h' })
+ *
+ * // Get all domain staking summaries
+ * const allSummaries = await domainStakingSummary(api)
+ * console.log(`Found ${allSummaries.length} domains`)
+ *
+ * // Get specific domain summary
+ * const specificSummary = await domainStakingSummary(api, '0')
+ * if (specificSummary) {
+ *   console.log(`Domain 0 total stake: ${specificSummary.currentTotalStake}`)
+ * }
+ *
+ * await api.disconnect()
+ * ```
+ */
 // Implementation function
 function domainStakingSummary(api, domainId) {
     return __awaiter(this, void 0, void 0, function* () {
@@ -47,6 +110,34 @@ function domainStakingSummary(api, domainId) {
         }
     });
 }
+/**
+ * Retrieves the latest confirmed domain blocks for all domains.
+ *
+ * This function queries the latest confirmed block information for each domain,
+ * providing details about the most recent blocks that have been confirmed
+ * on each domain chain.
+ *
+ * @param api - The connected API instance to query the blockchain
+ * @returns Promise that resolves to an array of ConfirmedDomainBlock objects
+ * @throws Error if the confirmed domain block query fails
+ *
+ * @example
+ * ```typescript
+ * import { latestConfirmedDomainBlock } from '@autonomys/auto-consensus'
+ * import { activate } from '@autonomys/auto-utils'
+ *
+ * const api = await activate({ networkId: 'gemini-3h' })
+ * const confirmedBlocks = await latestConfirmedDomainBlock(api)
+ *
+ * confirmedBlocks.forEach(block => {
+ *   console.log(`Domain ${block.id}: Block #${block.blockNumber}`)
+ *   console.log(`Block Hash: ${block.blockHash}`)
+ *   console.log(`State Root: ${block.stateRoot}`)
+ * })
+ *
+ * await api.disconnect()
+ * ```
+ */
 const latestConfirmedDomainBlock = (api) => __awaiter(void 0, void 0, void 0, function* () {
     try {
         const _latestConfirmedDomainBlock = yield api.query.domains.latestConfirmedDomainBlock.entries();