genlayer-js 0.4.1 → 0.4.3

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 
 
+## 0.4.3 (2024-11-26)
+
+
+### Bug Fixes
+
+* readContract return type ([#32](https://github.com/yeagerai/genlayer-js/issues/32)) ([8222453](https://github.com/yeagerai/genlayer-js/commit/82224530cf5c28b17b43943fad92cd5782ecf1be))
+
+## 0.4.2 (2024-11-22)
+
+
+### Bug Fixes
+
+* types ([#29](https://github.com/yeagerai/genlayer-js/issues/29)) ([d8f16fd](https://github.com/yeagerai/genlayer-js/commit/d8f16fdb739e32e6eea52a38e23d96a4433728ad))
+
 ## 0.4.1 (2024-11-20)
 
 ## 0.4.0 (2024-11-14)

package/dist/index.cjs

@@ -1,4 +1,4 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _optionalChain(ops) { let lastAccessLHS = undefined; let value = ops[0]; let i = 1; while (i < ops.length) { const op = ops[i]; const fn = ops[i + 1]; i += 2; if ((op === 'optionalAccess' || op === 'optionalCall') && value == null) { return undefined; } if (op === 'access' || op === 'optionalAccess') { lastAccessLHS = value; value = fn(value); } else if (op === 'call' || op === 'optionalCall') { value = fn((...args) => value.call(lastAccessLHS, ...args)); lastAccessLHS = undefined; } } return value; }
+"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } } function _optionalChain(ops) { let lastAccessLHS = undefined; let value = ops[0]; let i = 1; while (i < ops.length) { const op = ops[i]; const fn = ops[i + 1]; i += 2; if ((op === 'optionalAccess' || op === 'optionalCall') && value == null) { return undefined; } if (op === 'access' || op === 'optionalAccess') { lastAccessLHS = value; value = fn(value); } else if (op === 'call' || op === 'optionalCall') { value = fn((...args) => value.call(lastAccessLHS, ...args)); lastAccessLHS = undefined; } } return value; }
 
 
 var _chunkIINRDYKFcjs = require('./chunk-IINRDYKF.cjs');
@@ -212,7 +212,7 @@ var overrideContractActions = (client) => {
     const encodedData = encodeAndSerialize({ method: functionName, args: params });
     const requestParams = {
       to: address,
-      from: _optionalChain([account, 'optionalAccess', _5 => _5.address]) || _optionalChain([client, 'access', _6 => _6.account, 'optionalAccess', _7 => _7.address]),
+      from: _nullishCoalesce(_optionalChain([account, 'optionalAccess', _5 => _5.address]), () => ( _optionalChain([client, 'access', _6 => _6.account, 'optionalAccess', _7 => _7.address]))),
       data: encodedData
     };
     const result = await client.request({

package/dist/index.js

@@ -212,7 +212,7 @@ var overrideContractActions = (client) => {
     const encodedData = encodeAndSerialize({ method: functionName, args: params });
     const requestParams = {
       to: address,
-      from: account?.address || client.account?.address,
+      from: account?.address ?? client.account?.address,
       data: encodedData
     };
     const result = await client.request({

package/dist/types/index.d.cts

@@ -10,7 +10,7 @@ declare class Address {
     bytes: Uint8Array;
     constructor(addr: Uint8Array);
 }
-type CalldataEncodable = null | boolean | Address | number | bigint | string | Uint8Array | Address | Array<CalldataEncodable> | Map<string, CalldataEncodable> | {
+type CalldataEncodable = null | boolean | Address | number | bigint | string | Uint8Array | Array<CalldataEncodable> | Map<string, CalldataEncodable> | {
     [key: string]: CalldataEncodable;
 };
 type MethodDescription = {
@@ -41,7 +41,24 @@ type GenLayerTransaction = {
     from_address?: string;
     to_address?: string;
     data?: Record<string, unknown>;
-    consensus_data?: Record<string, unknown>;
+    consensus_data?: {
+        final: boolean;
+        leader_receipt?: {
+            calldata: string;
+            class_name: string;
+            contract_state: string;
+            eq_outputs: Record<string, unknown>;
+            error: string | null;
+            execution_result: string;
+            gas_used: number;
+            mode: string;
+            node_config: Record<string, unknown>;
+            pending_transactions: unknown[];
+            vote: string;
+        };
+        validators?: Record<string, unknown>[];
+        votes?: Record<string, string>;
+    };
     nonce?: number;
     value?: number;
     type?: number;
@@ -94,7 +111,7 @@ type GenLayerMethod = {
     method: "eth_getTransactionCount";
     params: [address: string];
 };
-type GenLayerClient<TSimulatorChain extends SimulatorChain> = Omit<Client<Transport, TSimulatorChain>, "transport" | "getTransaction" | "readContract"> & Omit<PublicActions<Transport, TSimulatorChain>, "readContract" | "getTransaction"> & {
+type GenLayerClient<TSimulatorChain extends SimulatorChain> = Omit<Client<Transport, TSimulatorChain>, "transport" | "getTransaction" | "readContract"> & Omit<PublicActions<Transport, TSimulatorChain>, "readContract" | "getTransaction" | "waitForTransactionReceipt"> & {
     request: Client<Transport, TSimulatorChain>["request"] & {
         <TMethod extends GenLayerMethod>(args: Extract<GenLayerMethod, {
             method: TMethod["method"];
@@ -105,7 +122,7 @@ type GenLayerClient<TSimulatorChain extends SimulatorChain> = Omit<Client<Transp
         address: Address$1;
         functionName: string;
         args: CalldataEncodable[];
-    }) => Promise<any>;
+    }) => Promise<unknown>;
     writeContract: (args: {
         account?: Account;
         address: Address$1;
@@ -119,7 +136,7 @@ type GenLayerClient<TSimulatorChain extends SimulatorChain> = Omit<Client<Transp
         code: string;
         args: CalldataEncodable[];
         leader_only?: boolean;
-    }) => Promise<any>;
+    }) => Promise<`0x${string}`>;
     getTransaction: (args: {
         hash: TransactionHash;
     }) => Promise<GenLayerTransaction>;
@@ -129,6 +146,8 @@ type GenLayerClient<TSimulatorChain extends SimulatorChain> = Omit<Client<Transp
     waitForTransactionReceipt: (args: {
         hash: TransactionHash;
         status?: TransactionStatus;
+        interval?: number;
+        retries?: number;
     }) => Promise<GenLayerTransaction>;
     getContractSchema: (address: string) => Promise<ContractSchema>;
     getContractSchemaForCode: (contractCode: string) => Promise<ContractSchema>;

package/dist/types/index.d.ts

@@ -10,7 +10,7 @@ declare class Address {
     bytes: Uint8Array;
     constructor(addr: Uint8Array);
 }
-type CalldataEncodable = null | boolean | Address | number | bigint | string | Uint8Array | Address | Array<CalldataEncodable> | Map<string, CalldataEncodable> | {
+type CalldataEncodable = null | boolean | Address | number | bigint | string | Uint8Array | Array<CalldataEncodable> | Map<string, CalldataEncodable> | {
     [key: string]: CalldataEncodable;
 };
 type MethodDescription = {
@@ -41,7 +41,24 @@ type GenLayerTransaction = {
     from_address?: string;
     to_address?: string;
     data?: Record<string, unknown>;
-    consensus_data?: Record<string, unknown>;
+    consensus_data?: {
+        final: boolean;
+        leader_receipt?: {
+            calldata: string;
+            class_name: string;
+            contract_state: string;
+            eq_outputs: Record<string, unknown>;
+            error: string | null;
+            execution_result: string;
+            gas_used: number;
+            mode: string;
+            node_config: Record<string, unknown>;
+            pending_transactions: unknown[];
+            vote: string;
+        };
+        validators?: Record<string, unknown>[];
+        votes?: Record<string, string>;
+    };
     nonce?: number;
     value?: number;
     type?: number;
@@ -94,7 +111,7 @@ type GenLayerMethod = {
     method: "eth_getTransactionCount";
     params: [address: string];
 };
-type GenLayerClient<TSimulatorChain extends SimulatorChain> = Omit<Client<Transport, TSimulatorChain>, "transport" | "getTransaction" | "readContract"> & Omit<PublicActions<Transport, TSimulatorChain>, "readContract" | "getTransaction"> & {
+type GenLayerClient<TSimulatorChain extends SimulatorChain> = Omit<Client<Transport, TSimulatorChain>, "transport" | "getTransaction" | "readContract"> & Omit<PublicActions<Transport, TSimulatorChain>, "readContract" | "getTransaction" | "waitForTransactionReceipt"> & {
     request: Client<Transport, TSimulatorChain>["request"] & {
         <TMethod extends GenLayerMethod>(args: Extract<GenLayerMethod, {
             method: TMethod["method"];
@@ -105,7 +122,7 @@ type GenLayerClient<TSimulatorChain extends SimulatorChain> = Omit<Client<Transp
         address: Address$1;
         functionName: string;
         args: CalldataEncodable[];
-    }) => Promise<any>;
+    }) => Promise<unknown>;
     writeContract: (args: {
         account?: Account;
         address: Address$1;
@@ -119,7 +136,7 @@ type GenLayerClient<TSimulatorChain extends SimulatorChain> = Omit<Client<Transp
         code: string;
         args: CalldataEncodable[];
         leader_only?: boolean;
-    }) => Promise<any>;
+    }) => Promise<`0x${string}`>;
     getTransaction: (args: {
         hash: TransactionHash;
     }) => Promise<GenLayerTransaction>;
@@ -129,6 +146,8 @@ type GenLayerClient<TSimulatorChain extends SimulatorChain> = Omit<Client<Transp
     waitForTransactionReceipt: (args: {
         hash: TransactionHash;
         status?: TransactionStatus;
+        interval?: number;
+        retries?: number;
     }) => Promise<GenLayerTransaction>;
     getContractSchema: (address: string) => Promise<ContractSchema>;
     getContractSchemaForCode: (contractCode: string) => Promise<ContractSchema>;

package/package.json

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

package/src/contracts/actions.ts

@@ -26,13 +26,13 @@ export const overrideContractActions = (client: GenLayerClient<SimulatorChain>)
     address: Address;
     functionName: string;
     args: CalldataEncodable[];
-  }): Promise<any> => {
+  }): Promise<unknown> => {
     const {account, address, functionName, args: params} = args;
     const encodedData = encodeAndSerialize({method: functionName, args: params});
 
     const requestParams = {
       to: address,
-      from: account?.address || client.account?.address,
+      from: account?.address ?? client.account?.address,
       data: encodedData,
     };
     const result = await client.request({
@@ -49,7 +49,7 @@ export const overrideContractActions = (client: GenLayerClient<SimulatorChain>)
     args: CalldataEncodable[];
     value: bigint;
     leader_only?: boolean;
-  }): Promise<any> => {
+  }): Promise<`0x${string}`> => {
     const {account, address, functionName, args: params, value = 0n, leader_only = false} = args;
     const data = [encode({method: functionName, args: params}), leader_only];
     const serializedData = serialize(data);

package/src/types/calldata.ts

@@ -18,7 +18,6 @@ export type CalldataEncodable =
   | bigint
   | string
   | Uint8Array /// bytes
-  | Address
   | Array<CalldataEncodable>
   | Map<string, CalldataEncodable>
   | {[key: string]: CalldataEncodable}; /// also a "map"

package/src/types/clients.ts

@@ -25,7 +25,10 @@ export type GenLayerClient<TSimulatorChain extends SimulatorChain> = Omit<
   Client<Transport, TSimulatorChain>,
   "transport" | "getTransaction" | "readContract"
 > &
-  Omit<PublicActions<Transport, TSimulatorChain>, "readContract" | "getTransaction"> & {
+  Omit<
+    PublicActions<Transport, TSimulatorChain>,
+    "readContract" | "getTransaction" | "waitForTransactionReceipt"
+  > & {
     request: Client<Transport, TSimulatorChain>["request"] & {
       <TMethod extends GenLayerMethod>(
         args: Extract<GenLayerMethod, {method: TMethod["method"]}>,
@@ -36,7 +39,7 @@ export type GenLayerClient<TSimulatorChain extends SimulatorChain> = Omit<
       address: Address;
       functionName: string;
       args: CalldataEncodable[];
-    }) => Promise<any>;
+    }) => Promise<unknown>;
     writeContract: (args: {
       account?: Account;
       address: Address;
@@ -50,12 +53,14 @@ export type GenLayerClient<TSimulatorChain extends SimulatorChain> = Omit<
       code: string;
       args: CalldataEncodable[];
       leader_only?: boolean;
-    }) => Promise<any>;
+    }) => Promise<`0x${string}`>;
     getTransaction: (args: {hash: TransactionHash}) => Promise<GenLayerTransaction>;
     getCurrentNonce: (args: {address: string}) => Promise<number>;
     waitForTransactionReceipt: (args: {
       hash: TransactionHash;
       status?: TransactionStatus;
+      interval?: number;
+      retries?: number;
     }) => Promise<GenLayerTransaction>;
     getContractSchema: (address: string) => Promise<ContractSchema>;
     getContractSchemaForCode: (contractCode: string) => Promise<ContractSchema>;

package/src/types/transactions.ts

@@ -17,7 +17,24 @@ export type GenLayerTransaction = {
   from_address?: string;
   to_address?: string;
   data?: Record<string, unknown>;
-  consensus_data?: Record<string, unknown>;
+  consensus_data?: {
+    final: boolean;
+    leader_receipt?: {
+      calldata: string;
+      class_name: string;
+      contract_state: string;
+      eq_outputs: Record<string, unknown>;
+      error: string | null;
+      execution_result: string;
+      gas_used: number;
+      mode: string;
+      node_config: Record<string, unknown>;
+      pending_transactions: unknown[];
+      vote: string;
+    };
+    validators?: Record<string, unknown>[];
+    votes?: Record<string, string>;
+  };
   nonce?: number;
   value?: number;
   type?: number;

package/tests/client.test-d.ts

@@ -1,6 +1,7 @@
 import {createClient} from "../src/client/client";
 import {simulator} from "../src/chains/simulator";
 import {createAccount, generatePrivateKey} from "../src/accounts/account";
+import {TransactionHash, TransactionStatus} from "../src/types/transactions";
 
 test("type checks", () => {
   const client = createClient({
@@ -36,4 +37,31 @@ test("type checks", () => {
   void client.getContractSchema(exampleAddress);
 
   void client.getContractSchemaForCode("class SomeContract...");
+
+  void client.waitForTransactionReceipt({
+    hash: "0x1234567890123456789012345678901234567890123456789012345678901234" as TransactionHash,
+  });
+
+  void client.waitForTransactionReceipt({
+    hash: "0x1234567890123456789012345678901234567890123456789012345678901234" as TransactionHash,
+    status: TransactionStatus.FINALIZED,
+  });
+
+  void client.waitForTransactionReceipt({
+    hash: "0x1234567890123456789012345678901234567890123456789012345678901234" as TransactionHash,
+    status: TransactionStatus.FINALIZED,
+    interval: 1000,
+  });
+
+  void client.waitForTransactionReceipt({
+    hash: "0x1234567890123456789012345678901234567890123456789012345678901234" as TransactionHash,
+    status: TransactionStatus.FINALIZED,
+    interval: 1000,
+    retries: 10,
+  });
+
+  // @ts-expect-error missing hash
+  void client.waitForTransactionReceipt({
+    status: TransactionStatus.FINALIZED,
+  });
 });