genlayer-js 0.5.0 → 0.6.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 
 
+## 0.6.0 (2025-01-09)
+
+
+### Features
+
+* add stateStatus in readContract ([#50](https://github.com/yeagerai/genlayer-js/issues/50)) ([a9bcf8d](https://github.com/yeagerai/genlayer-js/commit/a9bcf8d83890448b85282ceb0c33060a19ea4e9a))
+
 ## 0.5.0 (2025-01-08)
 
 

package/README.md

@@ -52,6 +52,7 @@ const result = await client.readContract({
   address: contractAddress,
   functionName: 'get_complete_storage',
   args: []
+  stateStatus: "accepted",
 })
 ```
 

package/dist/index.cjs

@@ -4,7 +4,7 @@
 var _chunkIINRDYKFcjs = require('./chunk-IINRDYKF.cjs');
 
 
-var _chunkYI62SDKVcjs = require('./chunk-YI62SDKV.cjs');
+var _chunkX6WK4DK4cjs = require('./chunk-X6WK4DK4.cjs');
 require('./chunk-75ZPJI57.cjs');
 
 // src/client/client.ts
@@ -76,7 +76,7 @@ function decodeImpl(data, index) {
     case BigInt(SPECIAL_ADDR): {
       const res = data.slice(index.i, index.i + 20);
       index.i += 20;
-      return new (0, _chunkYI62SDKVcjs.Address)(res);
+      return new (0, _chunkX6WK4DK4cjs.Address)(res);
     }
   }
   const type = Number(cur & 0xffn) & (1 << BITS_IN_TYPE) - 1;
@@ -241,7 +241,7 @@ function encodeImpl(to, data) {
         }
       } else if (data instanceof Map) {
         encodeMap(to, data);
-      } else if (data instanceof _chunkYI62SDKVcjs.Address) {
+      } else if (data instanceof _chunkX6WK4DK4cjs.Address) {
         to.push(SPECIAL_ADDR);
         for (const c of data.bytes) {
           to.push(c);
@@ -265,9 +265,6 @@ function encode(data) {
 function serialize(data) {
   return _viem.toRlp.call(void 0, data.map((param) => _viem.toHex.call(void 0, param)));
 }
-function encodeAndSerialize(data) {
-  return serialize([encode(data)]);
-}
 
 // src/contracts/actions.ts
 var contractActions = (client) => {
@@ -290,13 +287,14 @@ var contractActions = (client) => {
 };
 var overrideContractActions = (client) => {
   client.readContract = async (args) => {
-    const { account, address, functionName, args: params } = args;
-    const encodedData = encodeAndSerialize({ method: functionName, args: params });
-    let senderAddress = _nullishCoalesce(_optionalChain([account, 'optionalAccess', _5 => _5.address]), () => ( _optionalChain([client, 'access', _6 => _6.account, 'optionalAccess', _7 => _7.address])));
+    const { account, address, functionName, args: params, stateStatus = "ACCEPTED" /* ACCEPTED */ } = args;
+    const encodedData = [encode({ method: functionName, args: params }), stateStatus];
+    const serializedData = serialize(encodedData);
+    const senderAddress = _nullishCoalesce(_optionalChain([account, 'optionalAccess', _5 => _5.address]), () => ( _optionalChain([client, 'access', _6 => _6.account, 'optionalAccess', _7 => _7.address])));
     const requestParams = {
       to: address,
       from: senderAddress,
-      data: encodedData
+      data: serializedData
     };
     const result = await client.request({
       method: "eth_call",

package/dist/index.js

@@ -4,7 +4,7 @@ import {
 } from "./chunk-3TYB36DW.js";
 import {
   Address
-} from "./chunk-M7SA3INM.js";
+} from "./chunk-G7EQ6KPE.js";
 import "./chunk-MLKGABMK.js";
 
 // src/client/client.ts
@@ -265,9 +265,6 @@ function encode(data) {
 function serialize(data) {
   return toRlp(data.map((param) => toHex(param)));
 }
-function encodeAndSerialize(data) {
-  return serialize([encode(data)]);
-}
 
 // src/contracts/actions.ts
 var contractActions = (client) => {
@@ -290,13 +287,14 @@ var contractActions = (client) => {
 };
 var overrideContractActions = (client) => {
   client.readContract = async (args) => {
-    const { account, address, functionName, args: params } = args;
-    const encodedData = encodeAndSerialize({ method: functionName, args: params });
-    let senderAddress = account?.address ?? client.account?.address;
+    const { account, address, functionName, args: params, stateStatus = "ACCEPTED" /* ACCEPTED */ } = args;
+    const encodedData = [encode({ method: functionName, args: params }), stateStatus];
+    const serializedData = serialize(encodedData);
+    const senderAddress = account?.address ?? client.account?.address;
     const requestParams = {
       to: address,
       from: senderAddress,
-      data: encodedData
+      data: serializedData
     };
     const result = await client.request({
       method: "eth_call",

package/dist/types/index.cjs

@@ -1,7 +1,7 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
-var _chunkYI62SDKVcjs = require('../chunk-YI62SDKV.cjs');
+var _chunkX6WK4DK4cjs = require('../chunk-X6WK4DK4.cjs');
 require('../chunk-75ZPJI57.cjs');
 
 
-exports.TransactionStatus = _chunkYI62SDKVcjs.TransactionStatus;
+exports.TransactionStatus = _chunkX6WK4DK4cjs.TransactionStatus;

package/dist/types/index.d.cts

@@ -131,6 +131,7 @@ type GenLayerClient<TSimulatorChain extends SimulatorChain> = Omit<Client<Transp
         address: Address$1;
         functionName: string;
         args: CalldataEncodable[];
+        stateStatus?: TransactionStatus;
     }) => Promise<unknown>;
     writeContract: (args: {
         account?: Account;

package/dist/types/index.d.ts

@@ -131,6 +131,7 @@ type GenLayerClient<TSimulatorChain extends SimulatorChain> = Omit<Client<Transp
         address: Address$1;
         functionName: string;
         args: CalldataEncodable[];
+        stateStatus?: TransactionStatus;
     }) => Promise<unknown>;
     writeContract: (args: {
         account?: Account;

package/dist/types/index.js

@@ -1,6 +1,6 @@
 import {
   TransactionStatus
-} from "../chunk-M7SA3INM.js";
+} from "../chunk-G7EQ6KPE.js";
 import "../chunk-MLKGABMK.js";
 export {
   TransactionStatus

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "genlayer-js",
   "type": "module",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "GenLayer JavaScript SDK",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/contracts/actions.ts

@@ -1,6 +1,14 @@
 import {decode} from "@/abi/calldata/decoder";
-import {encode, serialize, encodeAndSerialize} from "@/abi/calldata/encoder";
-import {Account, ContractSchema, SimulatorChain, GenLayerClient, CalldataEncodable, Address} from "@/types";
+import {encode, serialize} from "@/abi/calldata/encoder";
+import {
+  Account,
+  ContractSchema,
+  SimulatorChain,
+  GenLayerClient,
+  CalldataEncodable,
+  Address,
+  TransactionStatus,
+} from "@/types";
 
 export const contractActions = (client: GenLayerClient<SimulatorChain>) => {
   return {
@@ -27,16 +35,18 @@ export const overrideContractActions = (client: GenLayerClient<SimulatorChain>)
     address: Address;
     functionName: string;
     args: CalldataEncodable[];
+    stateStatus?: TransactionStatus;
   }): Promise<unknown> => {
-    const { account, address, functionName, args: params } = args;
-    const encodedData = encodeAndSerialize({ method: functionName, args: params });
+    const {account, address, functionName, args: params, stateStatus = TransactionStatus.ACCEPTED} = args;
+    const encodedData = [encode({method: functionName, args: params}), stateStatus];
+    const serializedData = serialize(encodedData);
 
-    let senderAddress = account?.address ?? client.account?.address;
+    const senderAddress = account?.address ?? client.account?.address;
 
     const requestParams = {
       to: address,
       from: senderAddress,
-      data: encodedData,
+      data: serializedData,
     };
     const result = await client.request({
       method: "eth_call",
@@ -51,7 +61,6 @@ export const overrideContractActions = (client: GenLayerClient<SimulatorChain>)
     }
   };
 
-
   client.writeContract = async (args: {
     account?: Account;
     address: Address;
@@ -60,14 +69,12 @@ export const overrideContractActions = (client: GenLayerClient<SimulatorChain>)
     value: bigint;
     leaderOnly?: boolean;
   }): Promise<`0x${string}`> => {
-    const { account, address, functionName, args: params, value = 0n, leaderOnly = false } = args;
-    const data = [encode({ method: functionName, args: params }), leaderOnly];
+    const {account, address, functionName, args: params, value = 0n, leaderOnly = false} = args;
+    const data = [encode({method: functionName, args: params}), leaderOnly];
     const serializedData = serialize(data);
     const senderAccount = account || client.account;
 
-
     if (senderAccount?.type !== "local") {
-
       const transaction = {
         from: senderAccount?.address,
         to: address,
@@ -83,7 +90,7 @@ export const overrideContractActions = (client: GenLayerClient<SimulatorChain>)
 
     if (!senderAccount) {
       throw new Error(
-          "No account set. Configure the client with an account or pass an account to this function."
+        "No account set. Configure the client with an account or pass an account to this function.",
       );
     }
 
@@ -91,7 +98,7 @@ export const overrideContractActions = (client: GenLayerClient<SimulatorChain>)
       throw new Error("Account does not support signTransaction");
     }
 
-    const nonce = await client.getCurrentNonce({ address: senderAccount.address });
+    const nonce = await client.getCurrentNonce({address: senderAccount.address});
 
     const signedTransaction = await senderAccount.signTransaction({
       data: serializedData,
@@ -113,13 +120,12 @@ export const overrideContractActions = (client: GenLayerClient<SimulatorChain>)
     args: CalldataEncodable[];
     leaderOnly?: boolean;
   }) => {
-    const { account, code, args: constructorArgs, leaderOnly = false } = args;
-    const data = [code, encode({ args: constructorArgs }), leaderOnly];
+    const {account, code, args: constructorArgs, leaderOnly = false} = args;
+    const data = [code, encode({args: constructorArgs}), leaderOnly];
     const serializedData = serialize(data);
     const senderAccount = account || client.account;
 
     if (senderAccount?.type !== "local") {
-
       const transaction = {
         from: senderAccount?.address,
         to: null,
@@ -127,7 +133,7 @@ export const overrideContractActions = (client: GenLayerClient<SimulatorChain>)
         value: "0x0",
       };
 
-      return  await client.request({
+      return await client.request({
         method: "eth_sendTransaction",
         params: [transaction as any],
       });
@@ -135,7 +141,7 @@ export const overrideContractActions = (client: GenLayerClient<SimulatorChain>)
 
     if (!senderAccount) {
       throw new Error(
-          "No account set. Configure the client with an account or pass an account to this function."
+        "No account set. Configure the client with an account or pass an account to this function.",
       );
     }
 
@@ -143,7 +149,7 @@ export const overrideContractActions = (client: GenLayerClient<SimulatorChain>)
       throw new Error("Account does not support signTransaction");
     }
 
-    const nonce = await client.getCurrentNonce({ address: senderAccount.address });
+    const nonce = await client.getCurrentNonce({address: senderAccount.address});
 
     const signedTransaction = await senderAccount.signTransaction({
       data: serializedData,
@@ -151,7 +157,7 @@ export const overrideContractActions = (client: GenLayerClient<SimulatorChain>)
       nonce,
     });
 
-    return  await client.request({
+    return await client.request({
       method: "eth_sendRawTransaction",
       params: [signedTransaction],
     });

package/src/types/clients.ts

@@ -39,6 +39,7 @@ export type GenLayerClient<TSimulatorChain extends SimulatorChain> = Omit<
       address: Address;
       functionName: string;
       args: CalldataEncodable[];
+      stateStatus?: TransactionStatus;
     }) => Promise<unknown>;
     writeContract: (args: {
       account?: Account;

package/tests/client.test.ts

@@ -4,6 +4,7 @@ import {simulator} from "../src/chains/simulator";
 import {Address} from "../src/types/accounts";
 import {createAccount, generatePrivateKey} from "../src/accounts/account";
 import {vi} from "vitest";
+import {TransactionStatus} from "../src/types/transactions";
 
 describe("Client Creation", () => {
   it("should create a client for the simulator", () => {
@@ -29,6 +30,7 @@ describe("Client Overrides", () => {
       address: contractAddress as Address,
       functionName: "testFunction",
       args: ["arg1", "arg2"],
+      stateStatus: TransactionStatus.ACCEPTED,
     });
 
     expect(client.request).toHaveBeenCalledWith({
@@ -62,6 +64,7 @@ describe("Client Overrides", () => {
       address: contractAddress as Address,
       functionName: "testFunction",
       args: ["arg1", "arg2"],
+      stateStatus: TransactionStatus.ACCEPTED,
     });
 
     expect(client.request).toHaveBeenCalledWith({
@@ -77,7 +80,7 @@ describe("Client Overrides", () => {
     });
   });
   it("should override client account if address is provided", async () => {
-    const account = '0x65e03a3e916CF1dC92d3C8E8186a89CfAB0D2bc2';
+    const account = "0x65e03a3e916CF1dC92d3C8E8186a89CfAB0D2bc2";
     const client = createClient({
       chain: simulator,
       account,
@@ -105,5 +108,4 @@ describe("Client Overrides", () => {
       ],
     });
   });
-
 });