genlayer-js 0.25.0 → 0.26.1

package/dist/index.cjs

@@ -530,6 +530,7 @@ function extractGenCallResult(result) {
 }
 var contractActions = (client, publicClient) => {
   return {
+    /** Retrieves the source code of a deployed contract. Localnet only. */
     getContractCode: async (address) => {
       if (client.chain.id !== _chunkNOMVZBCRcjs.localnet.id) {
         throw new Error("Getting contract code is not supported on this network");
@@ -541,6 +542,7 @@ var contractActions = (client, publicClient) => {
       const codeBytes = b64ToArray(result);
       return new TextDecoder().decode(codeBytes);
     },
+    /** Gets the schema (methods and constructor) of a deployed contract. Localnet only. */
     getContractSchema: async (address) => {
       if (client.chain.id !== _chunkNOMVZBCRcjs.localnet.id) {
         throw new Error("Contract schema is not supported on this network");
@@ -551,6 +553,7 @@ var contractActions = (client, publicClient) => {
       });
       return schema;
     },
+    /** Generates a schema for contract code without deploying it. Localnet only. */
     getContractSchemaForCode: async (contractCode) => {
       if (client.chain.id !== _chunkNOMVZBCRcjs.localnet.id) {
         throw new Error("Contract schema is not supported on this network");
@@ -561,6 +564,7 @@ var contractActions = (client, publicClient) => {
       });
       return schema;
     },
+    /** Executes a read-only contract call without modifying state. */
     readContract: async (args) => {
       const {
         account,
@@ -597,6 +601,7 @@ var contractActions = (client, publicClient) => {
       }
       return toJsonSafeDeep(decoded);
     },
+    /** Simulates a state-modifying contract call without executing on-chain. */
     simulateWriteContract: async (args) => {
       const {
         account,
@@ -628,6 +633,7 @@ var contractActions = (client, publicClient) => {
       const resultBinary = _viem.fromHex.call(void 0, prefixedResult, "bytes");
       return decode(resultBinary);
     },
+    /** Executes a state-modifying function on a contract through consensus. Returns the transaction hash. */
     writeContract: async (args) => {
       const {
         account,
@@ -658,6 +664,7 @@ var contractActions = (client, publicClient) => {
         value
       });
     },
+    /** Deploys a new intelligent contract to GenLayer. Returns the transaction hash. */
     deployContract: async (args) => {
       const {
         account,
@@ -689,6 +696,7 @@ var contractActions = (client, publicClient) => {
         senderAccount
       });
     },
+    /** Calculates the minimum bond required to appeal a transaction. */
     getMinAppealBond: async (args) => {
       const { txId } = args;
       if (!_optionalChain([client, 'access', _11 => _11.chain, 'access', _12 => _12.feeManagerContract, 'optionalAccess', _13 => _13.address]) || !_optionalChain([client, 'access', _14 => _14.chain, 'access', _15 => _15.roundsStorageContract, 'optionalAccess', _16 => _16.address])) {
@@ -710,6 +718,7 @@ var contractActions = (client, publicClient) => {
       });
       return minBond;
     },
+    /** Appeals a consensus transaction to trigger a new round of validation. */
     appealTransaction: async (args) => {
       const { account, txId } = args;
       let { value } = args;
@@ -1235,6 +1244,7 @@ var decodeLocalnetTransaction = (tx) => {
 
 // src/transactions/actions.ts
 var receiptActions = (client, publicClient) => ({
+  /** Polls until a transaction reaches the specified status. Returns the transaction receipt. */
   waitForTransactionReceipt: async ({
     hash,
     status = "ACCEPTED" /* ACCEPTED */,
@@ -1274,6 +1284,7 @@ var receiptActions = (client, publicClient) => ({
   }
 });
 var transactionActions = (client, publicClient) => ({
+  /** Fetches transaction data including status, execution result, and consensus details. */
   getTransaction: async ({ hash }) => {
     if (client.chain.isStudio) {
       const transaction2 = await client.getTransaction({ hash });
@@ -1306,6 +1317,7 @@ var transactionActions = (client, publicClient) => ({
     };
     return decodeTransaction(transaction);
   },
+  /** Returns transaction IDs of child transactions created from emitted messages. */
   getTriggeredTransactionIds: async ({ hash }) => {
     if (client.chain.isStudio) {
       const tx2 = await client.getTransaction({ hash });
@@ -1328,6 +1340,7 @@ var transactionActions = (client, publicClient) => ({
     });
     return logs.map((log) => log.topics[1]).filter(Boolean);
   },
+  /** Fetches the full execution trace including return data, stdout, stderr, and GenVM logs. */
   debugTraceTransaction: async ({ hash, round = 0 }) => {
     const result = await client.request({
       method: "gen_dbg_traceTransaction",
@@ -1335,6 +1348,7 @@ var transactionActions = (client, publicClient) => ({
     });
     return result;
   },
+  /** Cancels a pending transaction. Studio networks only. */
   cancelTransaction: async ({ hash }) => {
     if (!client.chain.isStudio) {
       throw new Error("cancelTransaction is only available on studio-based chains (localnet/studionet)");
@@ -1362,6 +1376,7 @@ var transactionActions = (client, publicClient) => ({
       params: [hash, signature]
     });
   },
+  /** Estimates gas required for a transaction. */
   estimateTransactionGas: async (transactionParams) => {
     const formattedParams = {
       from: transactionParams.from || _optionalChain([client, 'access', _108 => _108.account, 'optionalAccess', _109 => _109.address]),
@@ -1649,6 +1664,7 @@ var stakingActions = (client, publicClient) => {
     });
   };
   return {
+    /** Joins as a validator with the specified stake amount. */
     validatorJoin: async (options) => {
       const amount = parseStakingAmount(options.amount);
       const stakingAddress = getStakingAddress();
@@ -1690,6 +1706,7 @@ var stakingActions = (client, publicClient) => {
         amountRaw: amount
       };
     },
+    /** Adds additional self-stake to an active validator position. */
     validatorDeposit: async (options) => {
       const amount = parseStakingAmount(options.amount);
       const data = _viem.encodeFunctionData.call(void 0, {
@@ -1698,6 +1715,7 @@ var stakingActions = (client, publicClient) => {
       });
       return executeWrite({ to: getStakingAddress(), data, value: amount });
     },
+    /** Exits a validator position by burning the specified shares. */
     validatorExit: async (options) => {
       const shares = typeof options.shares === "string" ? BigInt(options.shares) : options.shares;
       const data = _viem.encodeFunctionData.call(void 0, {
@@ -1707,6 +1725,7 @@ var stakingActions = (client, publicClient) => {
       });
       return executeWrite({ to: getStakingAddress(), data });
     },
+    /** Claims pending validator withdrawals. */
     validatorClaim: async (options) => {
       if (!_optionalChain([options, 'optionalAccess', _124 => _124.validator]) && !client.account) {
         throw new Error("Either provide validator address or initialize client with an account");
@@ -1720,6 +1739,7 @@ var stakingActions = (client, publicClient) => {
       const result = await executeWrite({ to: getStakingAddress(), data });
       return { ...result, claimedAmount: 0n };
     },
+    /** Primes a validator for participation in the next epoch. */
     validatorPrime: async (options) => {
       const data = _viem.encodeFunctionData.call(void 0, {
         abi: _chunkNOMVZBCRcjs.STAKING_ABI,
@@ -1728,6 +1748,7 @@ var stakingActions = (client, publicClient) => {
       });
       return executeWrite({ to: getStakingAddress(), data });
     },
+    /** Sets the operator address for a validator wallet. */
     setOperator: async (options) => {
       const data = _viem.encodeFunctionData.call(void 0, {
         abi: _chunkNOMVZBCRcjs.VALIDATOR_WALLET_ABI,
@@ -1736,6 +1757,7 @@ var stakingActions = (client, publicClient) => {
       });
       return executeWrite({ to: options.validator, data });
     },
+    /** Sets validator identity information (name, website, social links). */
     setIdentity: async (options) => {
       let extraCidBytes = "0x";
       if (options.extraCid) {
@@ -1762,6 +1784,7 @@ var stakingActions = (client, publicClient) => {
       });
       return executeWrite({ to: options.validator, data });
     },
+    /** Delegates stake to a validator. */
     delegatorJoin: async (options) => {
       const amount = parseStakingAmount(options.amount);
       const data = _viem.encodeFunctionData.call(void 0, {
@@ -1778,6 +1801,7 @@ var stakingActions = (client, publicClient) => {
         amountRaw: amount
       };
     },
+    /** Exits a delegation by burning the specified shares. */
     delegatorExit: async (options) => {
       const shares = typeof options.shares === "string" ? BigInt(options.shares) : options.shares;
       const data = _viem.encodeFunctionData.call(void 0, {
@@ -1787,6 +1811,7 @@ var stakingActions = (client, publicClient) => {
       });
       return executeWrite({ to: getStakingAddress(), data });
     },
+    /** Claims pending delegator withdrawals. */
     delegatorClaim: async (options) => {
       if (!options.delegator && !client.account) {
         throw new Error("Either provide delegator address or initialize client with an account");
@@ -1799,10 +1824,12 @@ var stakingActions = (client, publicClient) => {
       });
       return executeWrite({ to: getStakingAddress(), data });
     },
+    /** Checks if an address is an active validator. */
     isValidator: async (address) => {
       const contract = getReadOnlyStakingContract();
       return contract.read.isValidator([address]);
     },
+    /** Returns comprehensive information about a validator including stake, identity, and status. */
     getValidatorInfo: async (validator) => {
       const contract = getReadOnlyStakingContract();
       const isVal = await contract.read.isValidator([validator]);
@@ -1882,6 +1909,7 @@ var stakingActions = (client, publicClient) => {
         pendingWithdrawals
       };
     },
+    /** Returns delegation stake information for a delegator-validator pair. */
     getStakeInfo: async (delegator, validator) => {
       const contract = getReadOnlyStakingContract();
       const shares = await contract.read.sharesOf([delegator, validator]);
@@ -1935,6 +1963,7 @@ var stakingActions = (client, publicClient) => {
         pendingWithdrawals
       };
     },
+    /** Returns current epoch information including timing, stake requirements, and inflation data. */
     getEpochInfo: async () => {
       const contract = getReadOnlyStakingContract();
       const [
@@ -1991,6 +2020,7 @@ var stakingActions = (client, publicClient) => {
         delegatorMinStakeRaw: delMinStake
       };
     },
+    /** Returns detailed data for a specific epoch. */
     getEpochData: async (epochNumber) => {
       const contract = getReadOnlyStakingContract();
       const [currentEpoch, epochOdd, epochEven] = await Promise.all([
@@ -2019,19 +2049,23 @@ var stakingActions = (client, publicClient) => {
         slashed: raw[10]
       };
     },
+    /** Returns addresses of all currently active validators. */
     getActiveValidators: async () => {
       const contract = getReadOnlyStakingContract();
       const validators = await contract.read.activeValidators();
       return validators.filter((v) => v !== "0x0000000000000000000000000000000000000000");
     },
+    /** Returns the count of active validators. */
     getActiveValidatorsCount: async () => {
       const contract = getReadOnlyStakingContract();
       return contract.read.activeValidatorsCount();
     },
+    /** Returns addresses of validators currently in quarantine. */
     getQuarantinedValidators: async () => {
       const contract = getReadOnlyStakingContract();
       return contract.read.getValidatorQuarantineList();
     },
+    /** Returns banned validators with ban duration and permanent ban status. */
     getBannedValidators: async (startIndex = 0n, size = 100n) => {
       const contract = getReadOnlyStakingContract();
       const result = await contract.read.getAllBannedValidators([startIndex, size]);
@@ -2041,6 +2075,7 @@ var stakingActions = (client, publicClient) => {
         permanentlyBanned: v.permanentlyBanned
       }));
     },
+    /** Returns detailed quarantine information with pagination. */
     getQuarantinedValidatorsDetailed: async (startIndex = 0n, size = 100n) => {
       const contract = getReadOnlyStakingContract();
       const result = await contract.read.getAllQuarantinedValidators([startIndex, size]);

package/dist/index.d.cts

@@ -32,6 +32,16 @@ interface ClientConfig {
     account?: Account | Address;
     provider?: EthereumProvider;
 }
+/**
+ * Creates a GenLayer client instance for interacting with the network.
+ *
+ * @param config - Client configuration options
+ * @param config.chain - Chain to connect to (localnet, testnetBradbury, etc.)
+ * @param config.endpoint - Custom RPC endpoint URL
+ * @param config.account - Account or address for signing transactions
+ * @param config.provider - EthereumProvider for wallet integration
+ * @returns Configured client with contract, transaction, and staking methods
+ */
 declare const createClient: (config?: ClientConfig) => GenLayerClient<GenLayerChain>;
 
 declare const generatePrivateKey: () => `0x${string}`;

package/dist/index.d.ts

@@ -32,6 +32,16 @@ interface ClientConfig {
     account?: Account | Address;
     provider?: EthereumProvider;
 }
+/**
+ * Creates a GenLayer client instance for interacting with the network.
+ *
+ * @param config - Client configuration options
+ * @param config.chain - Chain to connect to (localnet, testnetBradbury, etc.)
+ * @param config.endpoint - Custom RPC endpoint URL
+ * @param config.account - Account or address for signing transactions
+ * @param config.provider - EthereumProvider for wallet integration
+ * @returns Configured client with contract, transaction, and staking methods
+ */
 declare const createClient: (config?: ClientConfig) => GenLayerClient<GenLayerChain>;
 
 declare const generatePrivateKey: () => `0x${string}`;

package/dist/index.js

@@ -530,6 +530,7 @@ function extractGenCallResult(result) {
 }
 var contractActions = (client, publicClient) => {
   return {
+    /** Retrieves the source code of a deployed contract. Localnet only. */
     getContractCode: async (address) => {
       if (client.chain.id !== localnet.id) {
         throw new Error("Getting contract code is not supported on this network");
@@ -541,6 +542,7 @@ var contractActions = (client, publicClient) => {
       const codeBytes = b64ToArray(result);
       return new TextDecoder().decode(codeBytes);
     },
+    /** Gets the schema (methods and constructor) of a deployed contract. Localnet only. */
     getContractSchema: async (address) => {
       if (client.chain.id !== localnet.id) {
         throw new Error("Contract schema is not supported on this network");
@@ -551,6 +553,7 @@ var contractActions = (client, publicClient) => {
       });
       return schema;
     },
+    /** Generates a schema for contract code without deploying it. Localnet only. */
     getContractSchemaForCode: async (contractCode) => {
       if (client.chain.id !== localnet.id) {
         throw new Error("Contract schema is not supported on this network");
@@ -561,6 +564,7 @@ var contractActions = (client, publicClient) => {
       });
       return schema;
     },
+    /** Executes a read-only contract call without modifying state. */
     readContract: async (args) => {
       const {
         account,
@@ -597,6 +601,7 @@ var contractActions = (client, publicClient) => {
       }
       return toJsonSafeDeep(decoded);
     },
+    /** Simulates a state-modifying contract call without executing on-chain. */
     simulateWriteContract: async (args) => {
       const {
         account,
@@ -628,6 +633,7 @@ var contractActions = (client, publicClient) => {
       const resultBinary = fromHex(prefixedResult, "bytes");
       return decode(resultBinary);
     },
+    /** Executes a state-modifying function on a contract through consensus. Returns the transaction hash. */
     writeContract: async (args) => {
       const {
         account,
@@ -658,6 +664,7 @@ var contractActions = (client, publicClient) => {
         value
       });
     },
+    /** Deploys a new intelligent contract to GenLayer. Returns the transaction hash. */
     deployContract: async (args) => {
       const {
         account,
@@ -689,6 +696,7 @@ var contractActions = (client, publicClient) => {
         senderAccount
       });
     },
+    /** Calculates the minimum bond required to appeal a transaction. */
     getMinAppealBond: async (args) => {
       const { txId } = args;
       if (!client.chain.feeManagerContract?.address || !client.chain.roundsStorageContract?.address) {
@@ -710,6 +718,7 @@ var contractActions = (client, publicClient) => {
       });
       return minBond;
     },
+    /** Appeals a consensus transaction to trigger a new round of validation. */
     appealTransaction: async (args) => {
       const { account, txId } = args;
       let { value } = args;
@@ -1235,6 +1244,7 @@ var decodeLocalnetTransaction = (tx) => {
 
 // src/transactions/actions.ts
 var receiptActions = (client, publicClient) => ({
+  /** Polls until a transaction reaches the specified status. Returns the transaction receipt. */
   waitForTransactionReceipt: async ({
     hash,
     status = "ACCEPTED" /* ACCEPTED */,
@@ -1274,6 +1284,7 @@ var receiptActions = (client, publicClient) => ({
   }
 });
 var transactionActions = (client, publicClient) => ({
+  /** Fetches transaction data including status, execution result, and consensus details. */
   getTransaction: async ({ hash }) => {
     if (client.chain.isStudio) {
       const transaction2 = await client.getTransaction({ hash });
@@ -1306,6 +1317,7 @@ var transactionActions = (client, publicClient) => ({
     };
     return decodeTransaction(transaction);
   },
+  /** Returns transaction IDs of child transactions created from emitted messages. */
   getTriggeredTransactionIds: async ({ hash }) => {
     if (client.chain.isStudio) {
       const tx2 = await client.getTransaction({ hash });
@@ -1328,6 +1340,7 @@ var transactionActions = (client, publicClient) => ({
     });
     return logs.map((log) => log.topics[1]).filter(Boolean);
   },
+  /** Fetches the full execution trace including return data, stdout, stderr, and GenVM logs. */
   debugTraceTransaction: async ({ hash, round = 0 }) => {
     const result = await client.request({
       method: "gen_dbg_traceTransaction",
@@ -1335,6 +1348,7 @@ var transactionActions = (client, publicClient) => ({
     });
     return result;
   },
+  /** Cancels a pending transaction. Studio networks only. */
   cancelTransaction: async ({ hash }) => {
     if (!client.chain.isStudio) {
       throw new Error("cancelTransaction is only available on studio-based chains (localnet/studionet)");
@@ -1362,6 +1376,7 @@ var transactionActions = (client, publicClient) => ({
       params: [hash, signature]
     });
   },
+  /** Estimates gas required for a transaction. */
   estimateTransactionGas: async (transactionParams) => {
     const formattedParams = {
       from: transactionParams.from || client.account?.address,
@@ -1649,6 +1664,7 @@ var stakingActions = (client, publicClient) => {
     });
   };
   return {
+    /** Joins as a validator with the specified stake amount. */
     validatorJoin: async (options) => {
       const amount = parseStakingAmount(options.amount);
       const stakingAddress = getStakingAddress();
@@ -1690,6 +1706,7 @@ var stakingActions = (client, publicClient) => {
         amountRaw: amount
       };
     },
+    /** Adds additional self-stake to an active validator position. */
     validatorDeposit: async (options) => {
       const amount = parseStakingAmount(options.amount);
       const data = encodeFunctionData2({
@@ -1698,6 +1715,7 @@ var stakingActions = (client, publicClient) => {
       });
       return executeWrite({ to: getStakingAddress(), data, value: amount });
     },
+    /** Exits a validator position by burning the specified shares. */
     validatorExit: async (options) => {
       const shares = typeof options.shares === "string" ? BigInt(options.shares) : options.shares;
       const data = encodeFunctionData2({
@@ -1707,6 +1725,7 @@ var stakingActions = (client, publicClient) => {
       });
       return executeWrite({ to: getStakingAddress(), data });
     },
+    /** Claims pending validator withdrawals. */
     validatorClaim: async (options) => {
       if (!options?.validator && !client.account) {
         throw new Error("Either provide validator address or initialize client with an account");
@@ -1720,6 +1739,7 @@ var stakingActions = (client, publicClient) => {
       const result = await executeWrite({ to: getStakingAddress(), data });
       return { ...result, claimedAmount: 0n };
     },
+    /** Primes a validator for participation in the next epoch. */
     validatorPrime: async (options) => {
       const data = encodeFunctionData2({
         abi: STAKING_ABI,
@@ -1728,6 +1748,7 @@ var stakingActions = (client, publicClient) => {
       });
       return executeWrite({ to: getStakingAddress(), data });
     },
+    /** Sets the operator address for a validator wallet. */
     setOperator: async (options) => {
       const data = encodeFunctionData2({
         abi: VALIDATOR_WALLET_ABI,
@@ -1736,6 +1757,7 @@ var stakingActions = (client, publicClient) => {
       });
       return executeWrite({ to: options.validator, data });
     },
+    /** Sets validator identity information (name, website, social links). */
     setIdentity: async (options) => {
       let extraCidBytes = "0x";
       if (options.extraCid) {
@@ -1762,6 +1784,7 @@ var stakingActions = (client, publicClient) => {
       });
       return executeWrite({ to: options.validator, data });
     },
+    /** Delegates stake to a validator. */
     delegatorJoin: async (options) => {
       const amount = parseStakingAmount(options.amount);
       const data = encodeFunctionData2({
@@ -1778,6 +1801,7 @@ var stakingActions = (client, publicClient) => {
         amountRaw: amount
       };
     },
+    /** Exits a delegation by burning the specified shares. */
     delegatorExit: async (options) => {
       const shares = typeof options.shares === "string" ? BigInt(options.shares) : options.shares;
       const data = encodeFunctionData2({
@@ -1787,6 +1811,7 @@ var stakingActions = (client, publicClient) => {
       });
       return executeWrite({ to: getStakingAddress(), data });
     },
+    /** Claims pending delegator withdrawals. */
     delegatorClaim: async (options) => {
       if (!options.delegator && !client.account) {
         throw new Error("Either provide delegator address or initialize client with an account");
@@ -1799,10 +1824,12 @@ var stakingActions = (client, publicClient) => {
       });
       return executeWrite({ to: getStakingAddress(), data });
     },
+    /** Checks if an address is an active validator. */
     isValidator: async (address) => {
       const contract = getReadOnlyStakingContract();
       return contract.read.isValidator([address]);
     },
+    /** Returns comprehensive information about a validator including stake, identity, and status. */
     getValidatorInfo: async (validator) => {
       const contract = getReadOnlyStakingContract();
       const isVal = await contract.read.isValidator([validator]);
@@ -1882,6 +1909,7 @@ var stakingActions = (client, publicClient) => {
         pendingWithdrawals
       };
     },
+    /** Returns delegation stake information for a delegator-validator pair. */
     getStakeInfo: async (delegator, validator) => {
       const contract = getReadOnlyStakingContract();
       const shares = await contract.read.sharesOf([delegator, validator]);
@@ -1935,6 +1963,7 @@ var stakingActions = (client, publicClient) => {
         pendingWithdrawals
       };
     },
+    /** Returns current epoch information including timing, stake requirements, and inflation data. */
     getEpochInfo: async () => {
       const contract = getReadOnlyStakingContract();
       const [
@@ -1991,6 +2020,7 @@ var stakingActions = (client, publicClient) => {
         delegatorMinStakeRaw: delMinStake
       };
     },
+    /** Returns detailed data for a specific epoch. */
     getEpochData: async (epochNumber) => {
       const contract = getReadOnlyStakingContract();
       const [currentEpoch, epochOdd, epochEven] = await Promise.all([
@@ -2019,19 +2049,23 @@ var stakingActions = (client, publicClient) => {
         slashed: raw[10]
       };
     },
+    /** Returns addresses of all currently active validators. */
     getActiveValidators: async () => {
       const contract = getReadOnlyStakingContract();
       const validators = await contract.read.activeValidators();
       return validators.filter((v) => v !== "0x0000000000000000000000000000000000000000");
     },
+    /** Returns the count of active validators. */
     getActiveValidatorsCount: async () => {
       const contract = getReadOnlyStakingContract();
       return contract.read.activeValidatorsCount();
     },
+    /** Returns addresses of validators currently in quarantine. */
     getQuarantinedValidators: async () => {
       const contract = getReadOnlyStakingContract();
       return contract.read.getValidatorQuarantineList();
     },
+    /** Returns banned validators with ban duration and permanent ban status. */
     getBannedValidators: async (startIndex = 0n, size = 100n) => {
       const contract = getReadOnlyStakingContract();
       const result = await contract.read.getAllBannedValidators([startIndex, size]);
@@ -2041,6 +2075,7 @@ var stakingActions = (client, publicClient) => {
         permanentlyBanned: v.permanentlyBanned
       }));
     },
+    /** Returns detailed quarantine information with pagination. */
     getQuarantinedValidatorsDetailed: async (startIndex = 0n, size = 100n) => {
       const contract = getReadOnlyStakingContract();
       const result = await contract.read.getAllQuarantinedValidators([startIndex, size]);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "genlayer-js",
   "type": "module",
-  "version": "0.25.0",
+  "version": "0.26.1",
   "description": "GenLayer JavaScript SDK",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -17,7 +17,8 @@
     "test:smoke": "vitest run --config vitest.smoke.config.ts",
     "test:watch": "vitest --watch",
     "lint": "eslint . --fix --ext .ts",
-    "release": "release-it --ci"
+    "release": "release-it --ci",
+    "docs": "typedoc"
   },
   "exports": {
     ".": {
@@ -55,6 +56,8 @@
     "release-it": "^17.6.0",
     "ts-node": "^10.9.2",
     "tsup": "^8.2.4",
+    "typedoc": "^0.28.18",
+    "typedoc-plugin-markdown": "^4.11.0",
     "typescript": "^5.6.2",
     "vitest": "^2.1.1"
   },