genlayer-js 0.18.4 → 0.18.5

package/CHANGELOG.md

@@ -1,5 +1,7 @@
 
 
+## 0.18.5 (2025-12-03)
+
 ## 0.18.4 (2025-11-11)
 
 

package/CLAUDE.md

@@ -0,0 +1,66 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Build & Development
+
+```bash
+npm install             # Install dependencies
+npm run build           # Production build (tsup, outputs ESM+CJS to dist/)
+npm run build:watch     # Watch mode for development
+npm run lint            # ESLint with auto-fix
+npm link                # Link package locally for testing in other projects
+```
+
+## Testing
+
+```bash
+npm test                # Run tests with typecheck (vitest)
+npm run test:watch      # Watch mode
+```
+
+## Architecture
+
+### Module Structure & Exports
+
+The SDK exports three entry points (see `package.json` exports):
+- `genlayer-js` - Main: client, accounts, transaction decoders, staking utils
+- `genlayer-js/chains` - Chain configs: `localnet`, `studionet`, `testnetAsimov`
+- `genlayer-js/types` - TypeScript types for all SDK entities
+
+### Client Factory Pattern
+
+`createClient()` in `src/client/client.ts` builds a composable client by extending viem's base client with action modules:
+
+```
+baseClient → publicActions → walletActions → accountActions
+           → transactionActions → chainActions → contractActions
+           → receiptActions → stakingActions
+```
+
+Each action module (`src/<domain>/actions.ts`) returns an object of methods that get merged into the client. The client auto-initializes the consensus smart contract on creation.
+
+### Chain Configurations
+
+`GenLayerChain` extends viem's `Chain` with GenLayer-specific properties:
+- `isStudio` - Whether using studio-based localnet
+- `consensusMainContract` / `consensusDataContract` - On-chain consensus contracts
+- `stakingContract` - Staking contract (testnet-asimov only)
+- `defaultNumberOfInitialValidators` / `defaultConsensusMaxRotations`
+
+### Calldata Encoding
+
+Custom binary encoding for GenLayer transactions in `src/abi/calldata/`:
+- `encoder.ts` - Encodes JS values to GenLayer binary format
+- `decoder.ts` - Decodes binary responses back to JS
+- Uses MessagePack-like format with type tags
+
+### Path Aliases
+
+- `@/*` → `./src/*`
+- `@@/tests/*` → `./tests/*`
+
+### Key Dependencies
+
+- `viem` - Ethereum client, used as foundation for all blockchain interactions
+- `typescript-parsec` - Parser combinator for calldata string parsing

package/README.md

@@ -106,10 +106,61 @@ const receipt = await client.waitForTransactionReceipt({
 })
 
 ```
+### Staking Operations
+
+The SDK provides staking functionality for validators and delegators on testnet-asimov.
+
+```typescript
+import { testnetAsimov } from 'genlayer-js/chains';
+import { createClient, createAccount } from "genlayer-js";
+
+const account = createAccount();
+const client = createClient({
+  chain: testnetAsimov,
+  account,
+});
+
+// Get epoch info (includes timing estimates and inflation data)
+const epochInfo = await client.getEpochInfo();
+// {
+//   currentEpoch: 2n,
+//   epochMinDuration: 86400n,        // 1 day in seconds
+//   currentEpochStart: Date,
+//   currentEpochEnd: Date | null,
+//   nextEpochEstimate: Date | null,
+//   validatorMinStake: "0.01 GEN",
+//   delegatorMinStake: "42 GEN",
+//   activeValidatorsCount: 6n,
+//   inflation: "1000 GEN",           // Total inflation for current epoch
+//   inflationRaw: 1000000000000000000000n,
+//   totalWeight: 500000000000000000000000n,  // Total stake weight
+//   totalClaimed: "500 GEN",         // Total claimed rewards
+// }
+
+// Get active validators
+const validators = await client.getActiveValidators();
+
+// Check if address is a validator
+const isValidator = await client.isValidator("0x...");
+
+// Get validator info
+const validatorInfo = await client.getValidatorInfo("0x...");
+
+// Join as validator (requires account with funds)
+const result = await client.validatorJoin({ amount: "42000gen" });
+
+// Join as delegator
+const delegateResult = await client.delegatorJoin({
+  validator: "0x...",
+  amount: "42gen",
+});
+```
+
 ## 🚀 Key Features
 
-* **Client Creation**: Easily create and configure a client to connect to GenLayer’s network.
+* **Client Creation**: Easily create and configure a client to connect to GenLayer's network.
 * **Transaction Handling**: Send and manage transactions on the GenLayer network.
+* **Staking**: Full staking support for validators and delegators on testnet-asimov.
 * **Wallet Integration***: Seamless integration with MetaMask for managing user accounts.
 * **Gas Estimation***: Estimate gas fees for executing transactions on GenLayer.
 

package/dist/chains/index.cjs

@@ -2,10 +2,10 @@
 
 
 
-var _chunkSMGWE7OHcjs = require('../chunk-SMGWE7OH.cjs');
+var _chunkTBF5WZHLcjs = require('../chunk-TBF5WZHL.cjs');
 require('../chunk-75ZPJI57.cjs');
 
 
 
 
-exports.localnet = _chunkSMGWE7OHcjs.localnet; exports.studionet = _chunkSMGWE7OHcjs.studionet; exports.testnetAsimov = _chunkSMGWE7OHcjs.testnetAsimov;
+exports.localnet = _chunkTBF5WZHLcjs.localnet; exports.studionet = _chunkTBF5WZHLcjs.studionet; exports.testnetAsimov = _chunkTBF5WZHLcjs.testnetAsimov;

package/dist/chains/index.d.cts

@@ -1,3 +1,3 @@
-export { l as localnet, s as studionet, t as testnetAsimov } from '../index-C5zeayBB.cjs';
-import '../chains-BIe_Q0mF.cjs';
+export { l as localnet, s as studionet, t as testnetAsimov } from '../index-BVDASTaU.cjs';
+import '../chains-B7B7UXdn.cjs';
 import 'viem';

package/dist/chains/index.d.ts

@@ -1,3 +1,3 @@
-export { l as localnet, s as studionet, t as testnetAsimov } from '../index-BpFWfpio.js';
-import '../chains-BIe_Q0mF.js';
+export { l as localnet, s as studionet, t as testnetAsimov } from '../index-ucNO2REF.js';
+import '../chains-B7B7UXdn.js';
 import 'viem';

package/dist/chains/index.js

@@ -2,7 +2,7 @@ import {
   localnet,
   studionet,
   testnetAsimov
-} from "../chunk-NO75TOQL.js";
+} from "../chunk-NZI52PRP.js";
 import "../chunk-MLKGABMK.js";
 export {
   localnet,

package/dist/{chains-BIe_Q0mF.d.cts → chains-B7B7UXdn.d.cts}

@@ -4,14 +4,18 @@ type GenLayerChain = Chain & {
     isStudio: boolean;
     consensusMainContract: {
         address: Address;
-        abi: any[];
+        abi: readonly unknown[];
         bytecode: string;
     } | null;
     consensusDataContract: {
         address: Address;
-        abi: any[];
+        abi: readonly unknown[];
         bytecode: string;
     } | null;
+    stakingContract: {
+        address: Address;
+        abi: readonly unknown[];
+    } | null;
     defaultNumberOfInitialValidators: number;
     defaultConsensusMaxRotations: number;
 };

package/dist/{chains-BIe_Q0mF.d.ts → chains-B7B7UXdn.d.ts}

@@ -4,14 +4,18 @@ type GenLayerChain = Chain & {
     isStudio: boolean;
     consensusMainContract: {
         address: Address;
-        abi: any[];
+        abi: readonly unknown[];
         bytecode: string;
     } | null;
     consensusDataContract: {
         address: Address;
-        abi: any[];
+        abi: readonly unknown[];
         bytecode: string;
     } | null;
+    stakingContract: {
+        address: Address;
+        abi: readonly unknown[];
+    } | null;
     defaultNumberOfInitialValidators: number;
     defaultConsensusMaxRotations: number;
 };