genlayer-js 0.5.0 → 0.6.1

package/.eslintrc.cjs

@@ -39,7 +39,7 @@ module.exports = {
         "no-fallthrough": "off",
         "@typescript-eslint/explicit-module-boundary-types": "off",
         "@typescript-eslint/no-floating-promises": ["error"],
-        "@typescript-eslint/no-unused-vars": ["error", { argsIgnorePattern: "^_" }],
+        "@typescript-eslint/no-unused-vars": ["error", { argsIgnorePattern: "^_", varsIgnorePattern: "^_" }],
       },
     },
   ],

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 
 
+## 0.6.1 (2025-01-14)
+
+
+### Bug Fixes
+
+* refactor abi to prevent confusion ([#51](https://github.com/yeagerai/genlayer-js/issues/51)) ([6ccb09e](https://github.com/yeagerai/genlayer-js/commit/6ccb09eba33eaedb147a0dde5112f54d56dd1e09))
+
+## 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/{chunk-M7SA3INM.js → chunk-2EJVFGKU.js}

@@ -1,8 +1,8 @@
 // src/types/calldata.ts
-var Address = class {
+var CalldataAddress = class {
   bytes;
   constructor(addr) {
-    if (addr.length != 32) {
+    if (addr.length != 20) {
       throw new Error(`invalid address length ${addr}`);
     }
     this.bytes = addr;
@@ -23,6 +23,6 @@ var TransactionStatus = /* @__PURE__ */ ((TransactionStatus2) => {
 })(TransactionStatus || {});
 
 export {
-  Address,
+  CalldataAddress,
   TransactionStatus
 };

package/dist/{chunk-YI62SDKV.cjs → chunk-52HYC24L.cjs}

@@ -1,8 +1,8 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});// src/types/calldata.ts
-var Address = class {
+var CalldataAddress = class {
   
   constructor(addr) {
-    if (addr.length != 32) {
+    if (addr.length != 20) {
       throw new Error(`invalid address length ${addr}`);
     }
     this.bytes = addr;
@@ -25,4 +25,4 @@ var TransactionStatus = /* @__PURE__ */ ((TransactionStatus2) => {
 
 
 
-exports.Address = Address; exports.TransactionStatus = TransactionStatus;
+exports.CalldataAddress = CalldataAddress; exports.TransactionStatus = TransactionStatus;

package/dist/index-B1ZR98OZ.d.ts

@@ -0,0 +1,172 @@
+import { S as SimulatorChain } from './chains-BV4Glo-M.js';
+import { Client, Transport, PublicActions, Account } from 'viem';
+
+type Address = `0x${string}` & {
+    length: 42;
+};
+
+declare class CalldataAddress {
+    bytes: Uint8Array;
+    constructor(addr: Uint8Array);
+}
+type CalldataEncodable = null | boolean | CalldataAddress | number | bigint | string | Uint8Array | Array<CalldataEncodable> | Map<string, CalldataEncodable> | {
+    [key: string]: CalldataEncodable;
+};
+type MethodDescription = {
+    method: string;
+    args: Array<CalldataEncodable>;
+};
+type TransactionDataElement$1 = string | number | bigint | boolean | Uint8Array;
+
+type TransactionHash = `0x${string}` & {
+    length: 66;
+};
+declare enum TransactionStatus {
+    PENDING = "PENDING",
+    CANCELED = "CANCELED",
+    PROPOSING = "PROPOSING",
+    COMMITTING = "COMMITTING",
+    REVEALING = "REVEALING",
+    ACCEPTED = "ACCEPTED",
+    FINALIZED = "FINALIZED",
+    UNDETERMINED = "UNDETERMINED"
+}
+type GenLayerTransaction = {
+    hash: TransactionHash;
+    status: TransactionStatus;
+    from_address?: string;
+    to_address?: string;
+    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;
+    gaslimit?: bigint;
+    created_at?: Date;
+    r?: number;
+    s?: number;
+    v?: number;
+};
+type TransactionDataElement = string | number | bigint | boolean | Uint8Array;
+
+type ContractParamsArraySchemaElement = ContractParamsSchema | {
+    $rep: ContractParamsSchema;
+};
+type ContractParamsSchema = "null" | "bool" | "int" | "address" | "string" | "bytes" | "any" | "array" | "dict" | {
+    $or: ContractParamsSchema[];
+} | {
+    $dict: ContractParamsSchema;
+} | {
+    [key: string]: ContractParamsSchema;
+} | ContractParamsArraySchemaElement[];
+interface ContractMethodBase {
+    params: [string, ContractParamsSchema][];
+    kwparams: {
+        [key: string]: ContractParamsSchema;
+    };
+}
+interface ContractMethod extends ContractMethodBase {
+    ret: ContractParamsSchema;
+    readonly: boolean;
+}
+type ContractSchema = {
+    ctor: ContractMethodBase;
+    methods: ContractMethod[];
+};
+
+type GenLayerMethod = {
+    method: "sim_fundAccount";
+    params: [address: string, amount: number];
+} | {
+    method: "eth_getTransactionByHash";
+    params: [hash: TransactionHash];
+} | {
+    method: "eth_call";
+    params: [requestParams: any, blockNumberOrHash: string];
+} | {
+    method: "eth_sendRawTransaction";
+    params: [signedTransaction: string];
+} | {
+    method: "gen_getContractSchema";
+    params: [address: string];
+} | {
+    method: "gen_getContractSchemaForCode";
+    params: [contractCode: string];
+} | {
+    method: "sim_getTransactionsForAddress";
+    params: [address: string, filter?: "all" | "from" | "to"];
+} | {
+    method: "eth_getTransactionCount";
+    params: [address: string, block: string];
+};
+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"];
+        }>): Promise<unknown>;
+    };
+    readContract: <RawReturn extends boolean | undefined>(args: {
+        account?: Account;
+        address: Address;
+        functionName: string;
+        stateStatus?: TransactionStatus;
+        args?: CalldataEncodable[];
+        kwargs?: Map<string, CalldataEncodable> | {
+            [key: string]: CalldataEncodable;
+        };
+        rawReturn?: RawReturn;
+    }) => Promise<RawReturn extends true ? `0x${string}` : CalldataEncodable>;
+    writeContract: (args: {
+        account?: Account;
+        address: Address;
+        functionName: string;
+        args?: CalldataEncodable[];
+        kwargs?: Map<string, CalldataEncodable> | {
+            [key: string]: CalldataEncodable;
+        };
+        value: bigint;
+        leaderOnly?: boolean;
+    }) => Promise<any>;
+    deployContract: (args: {
+        account?: Account;
+        code: string | Uint8Array;
+        args?: CalldataEncodable[];
+        kwargs?: Map<string, CalldataEncodable> | {
+            [key: string]: CalldataEncodable;
+        };
+        leaderOnly?: boolean;
+    }) => 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 | Uint8Array) => Promise<ContractSchema>;
+};
+
+export { type Address as A, type CalldataEncodable as C, type GenLayerClient as G, type MethodDescription as M, type TransactionDataElement$1 as T, CalldataAddress as a, type GenLayerMethod as b, type ContractParamsArraySchemaElement as c, type ContractParamsSchema as d, type ContractMethodBase as e, type ContractMethod as f, type ContractSchema as g, type TransactionHash as h, TransactionStatus as i, type GenLayerTransaction as j, type TransactionDataElement as k };

package/dist/index-CIFGsVKF.d.cts

@@ -0,0 +1,172 @@
+import { S as SimulatorChain } from './chains-BV4Glo-M.cjs';
+import { Client, Transport, PublicActions, Account } from 'viem';
+
+type Address = `0x${string}` & {
+    length: 42;
+};
+
+declare class CalldataAddress {
+    bytes: Uint8Array;
+    constructor(addr: Uint8Array);
+}
+type CalldataEncodable = null | boolean | CalldataAddress | number | bigint | string | Uint8Array | Array<CalldataEncodable> | Map<string, CalldataEncodable> | {
+    [key: string]: CalldataEncodable;
+};
+type MethodDescription = {
+    method: string;
+    args: Array<CalldataEncodable>;
+};
+type TransactionDataElement$1 = string | number | bigint | boolean | Uint8Array;
+
+type TransactionHash = `0x${string}` & {
+    length: 66;
+};
+declare enum TransactionStatus {
+    PENDING = "PENDING",
+    CANCELED = "CANCELED",
+    PROPOSING = "PROPOSING",
+    COMMITTING = "COMMITTING",
+    REVEALING = "REVEALING",
+    ACCEPTED = "ACCEPTED",
+    FINALIZED = "FINALIZED",
+    UNDETERMINED = "UNDETERMINED"
+}
+type GenLayerTransaction = {
+    hash: TransactionHash;
+    status: TransactionStatus;
+    from_address?: string;
+    to_address?: string;
+    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;
+    gaslimit?: bigint;
+    created_at?: Date;
+    r?: number;
+    s?: number;
+    v?: number;
+};
+type TransactionDataElement = string | number | bigint | boolean | Uint8Array;
+
+type ContractParamsArraySchemaElement = ContractParamsSchema | {
+    $rep: ContractParamsSchema;
+};
+type ContractParamsSchema = "null" | "bool" | "int" | "address" | "string" | "bytes" | "any" | "array" | "dict" | {
+    $or: ContractParamsSchema[];
+} | {
+    $dict: ContractParamsSchema;
+} | {
+    [key: string]: ContractParamsSchema;
+} | ContractParamsArraySchemaElement[];
+interface ContractMethodBase {
+    params: [string, ContractParamsSchema][];
+    kwparams: {
+        [key: string]: ContractParamsSchema;
+    };
+}
+interface ContractMethod extends ContractMethodBase {
+    ret: ContractParamsSchema;
+    readonly: boolean;
+}
+type ContractSchema = {
+    ctor: ContractMethodBase;
+    methods: ContractMethod[];
+};
+
+type GenLayerMethod = {
+    method: "sim_fundAccount";
+    params: [address: string, amount: number];
+} | {
+    method: "eth_getTransactionByHash";
+    params: [hash: TransactionHash];
+} | {
+    method: "eth_call";
+    params: [requestParams: any, blockNumberOrHash: string];
+} | {
+    method: "eth_sendRawTransaction";
+    params: [signedTransaction: string];
+} | {
+    method: "gen_getContractSchema";
+    params: [address: string];
+} | {
+    method: "gen_getContractSchemaForCode";
+    params: [contractCode: string];
+} | {
+    method: "sim_getTransactionsForAddress";
+    params: [address: string, filter?: "all" | "from" | "to"];
+} | {
+    method: "eth_getTransactionCount";
+    params: [address: string, block: string];
+};
+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"];
+        }>): Promise<unknown>;
+    };
+    readContract: <RawReturn extends boolean | undefined>(args: {
+        account?: Account;
+        address: Address;
+        functionName: string;
+        stateStatus?: TransactionStatus;
+        args?: CalldataEncodable[];
+        kwargs?: Map<string, CalldataEncodable> | {
+            [key: string]: CalldataEncodable;
+        };
+        rawReturn?: RawReturn;
+    }) => Promise<RawReturn extends true ? `0x${string}` : CalldataEncodable>;
+    writeContract: (args: {
+        account?: Account;
+        address: Address;
+        functionName: string;
+        args?: CalldataEncodable[];
+        kwargs?: Map<string, CalldataEncodable> | {
+            [key: string]: CalldataEncodable;
+        };
+        value: bigint;
+        leaderOnly?: boolean;
+    }) => Promise<any>;
+    deployContract: (args: {
+        account?: Account;
+        code: string | Uint8Array;
+        args?: CalldataEncodable[];
+        kwargs?: Map<string, CalldataEncodable> | {
+            [key: string]: CalldataEncodable;
+        };
+        leaderOnly?: boolean;
+    }) => 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 | Uint8Array) => Promise<ContractSchema>;
+};
+
+export { type Address as A, type CalldataEncodable as C, type GenLayerClient as G, type MethodDescription as M, type TransactionDataElement$1 as T, CalldataAddress as a, type GenLayerMethod as b, type ContractParamsArraySchemaElement as c, type ContractParamsSchema as d, type ContractMethodBase as e, type ContractMethod as f, type ContractSchema as g, type TransactionHash as h, TransactionStatus as i, type GenLayerTransaction as j, type TransactionDataElement as k };