genlayer-js 0.3.3 → 0.3.4

package/{.eslintrc.js → .eslintrc.cjs}

@@ -49,6 +49,7 @@ module.exports = {
     "jest.config.js",
     "Config.js",
     "commitLint.config.ts",
+    "vitest.config.ts",
   ],
   settings: {
     "import/resolver": {

package/.github/workflows/test.yml

@@ -0,0 +1,33 @@
+name: Run Tests
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: npm
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run tests
+        run: npm test
+        timeout-minutes: 5
+
+      - name: Run linting
+        run: npm run lint

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 
 
+## 0.3.4 (2024-11-14)
+
+
+### Bug Fixes
+
+* allow accounts to be nullable in `readContract` and add `sim_getTransactionsForAddress` method ([#16](https://github.com/yeagerai/genlayer-js/issues/16)) ([ea4bb6c](https://github.com/yeagerai/genlayer-js/commit/ea4bb6cb53809f6c17a3794ed35aede979bd89e5))
+
 ## 0.3.3 (2024-11-11)
 
 ## 0.3.2 (2024-11-06)

package/dist/chains/index.cjs

@@ -1,7 +1,7 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
-var _chunkBAGFDCQEcjs = require('../chunk-BAGFDCQE.cjs');
+var _chunkIINRDYKFcjs = require('../chunk-IINRDYKF.cjs');
 require('../chunk-75ZPJI57.cjs');
 
 
-exports.simulator = _chunkBAGFDCQEcjs.simulator;
+exports.simulator = _chunkIINRDYKFcjs.simulator;

package/dist/chains/index.d.cts

@@ -1,3 +1,3 @@
-export { s as simulator } from '../index-DLN-2YXE.cjs';
-import '../chains-CtZJFz4Q.cjs';
+export { s as simulator } from '../index-SfwloK-R.cjs';
+import '../chains-BV4Glo-M.cjs';
 import 'viem';

package/dist/chains/index.d.ts

@@ -1,3 +1,3 @@
-export { s as simulator } from '../index-vHLY9ggt.js';
-import '../chains-CtZJFz4Q.js';
+export { s as simulator } from '../index-B5TpaPQ6.js';
+import '../chains-BV4Glo-M.js';
 import 'viem';

package/dist/chains/index.js

@@ -1,6 +1,6 @@
 import {
   simulator
-} from "../chunk-D7VZGQ4K.js";
+} from "../chunk-3TYB36DW.js";
 import "../chunk-MLKGABMK.js";
 export {
   simulator

package/dist/{chains-CtZJFz4Q.d.cts → chains-BV4Glo-M.d.cts}

@@ -1,6 +1,5 @@
 import { Chain } from 'viem';
 
-interface SimulatorChain extends Chain {
-}
+type SimulatorChain = Chain;
 
 export type { SimulatorChain as S };

package/dist/{chains-CtZJFz4Q.d.ts → chains-BV4Glo-M.d.ts}

@@ -1,6 +1,5 @@
 import { Chain } from 'viem';
 
-interface SimulatorChain extends Chain {
-}
+type SimulatorChain = Chain;
 
 export type { SimulatorChain as S };

package/dist/{chunk-D7VZGQ4K.js → chunk-3TYB36DW.js}

@@ -27,7 +27,7 @@ var simulator = defineChain({
   blockExplorers: {
     default: {
       name: "GenLayer Explorer",
-      url: "http://127.0.0.1:4000/api"
+      url: SIMULATOR_JSON_RPC_URL
     }
   },
   testnet: true

package/dist/{chunk-BAGFDCQE.cjs → chunk-IINRDYKF.cjs}

@@ -27,7 +27,7 @@ var simulator = _viem.defineChain.call(void 0, {
   blockExplorers: {
     default: {
       name: "GenLayer Explorer",
-      url: "http://127.0.0.1:4000/api"
+      url: SIMULATOR_JSON_RPC_URL
     }
   },
   testnet: true

package/dist/{clients-DiSeCTYZ.d.cts → clients-B5D5440g.d.cts}

@@ -1,5 +1,5 @@
 import { Client, Transport, PublicActions, Account } from 'viem';
-import { S as SimulatorChain } from './chains-CtZJFz4Q.cjs';
+import { S as SimulatorChain } from './chains-BV4Glo-M.cjs';
 
 type Address$1 = `0x${string}` & {
     length: 42;
@@ -70,6 +70,9 @@ type GenLayerMethod = {
 } | {
     method: "gen_getContractSchemaForCode";
     params: [contractCode: string];
+} | {
+    method: "sim_getTransactionsForAddress";
+    params: [address: string, filter?: "all" | "from" | "to"];
 } | {
     method: "eth_getTransactionCount";
     params: [address: string];

package/dist/{clients-ByaMqS8n.d.ts → clients-CRRMg5Gh.d.ts}

@@ -1,5 +1,5 @@
 import { Client, Transport, PublicActions, Account } from 'viem';
-import { S as SimulatorChain } from './chains-CtZJFz4Q.js';
+import { S as SimulatorChain } from './chains-BV4Glo-M.js';
 
 type Address$1 = `0x${string}` & {
     length: 42;
@@ -70,6 +70,9 @@ type GenLayerMethod = {
 } | {
     method: "gen_getContractSchemaForCode";
     params: [contractCode: string];
+} | {
+    method: "sim_getTransactionsForAddress";
+    params: [address: string, filter?: "all" | "from" | "to"];
 } | {
     method: "eth_getTransactionCount";
     params: [address: string];

package/dist/{index-vHLY9ggt.d.ts → index-B5TpaPQ6.d.ts}

@@ -1,4 +1,4 @@
-import { S as SimulatorChain } from './chains-CtZJFz4Q.js';
+import { S as SimulatorChain } from './chains-BV4Glo-M.js';
 
 declare const simulator: SimulatorChain;
 

package/dist/{index-DLN-2YXE.d.cts → index-SfwloK-R.d.cts}

@@ -1,4 +1,4 @@
-import { S as SimulatorChain } from './chains-CtZJFz4Q.cjs';
+import { S as SimulatorChain } from './chains-BV4Glo-M.cjs';
 
 declare const simulator: SimulatorChain;
 

package/dist/index.cjs

@@ -1,7 +1,7 @@
 "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; }
 
 
-var _chunkBAGFDCQEcjs = require('./chunk-BAGFDCQE.cjs');
+var _chunkIINRDYKFcjs = require('./chunk-IINRDYKF.cjs');
 
 
 var _chunkYI62SDKVcjs = require('./chunk-YI62SDKV.cjs');
@@ -14,7 +14,7 @@ var _viem = require('viem');
 function accountActions(client) {
   return {
     fundAccount: async ({ address, amount }) => {
-      if (_optionalChain([client, 'access', _ => _.chain, 'optionalAccess', _2 => _2.id]) !== _chunkBAGFDCQEcjs.simulator.id) {
+      if (_optionalChain([client, 'access', _ => _.chain, 'optionalAccess', _2 => _2.id]) !== _chunkIINRDYKFcjs.simulator.id) {
         throw new Error("Client is not connected to the simulator");
       }
       return client.request({
@@ -102,7 +102,7 @@ function encodeMap(to, arr) {
     }
   }
   encodeNumWithType(to, BigInt(newEntries.length), TYPE_MAP);
-  for (const [_k, k, v] of newEntries) {
+  for (const [, k, v] of newEntries) {
     writeNum(to, BigInt(k.length));
     for (const c of k) {
       to.push(c);
@@ -315,8 +315,8 @@ var transactionActions = (client) => ({
 });
 
 // src/client/client.ts
-var createClient = (config = { chain: _chunkBAGFDCQEcjs.simulator }) => {
-  const chainConfig = config.chain || _chunkBAGFDCQEcjs.simulator;
+var createClient = (config = { chain: _chunkIINRDYKFcjs.simulator }) => {
+  const chainConfig = config.chain || _chunkIINRDYKFcjs.simulator;
   const rpcUrl = config.endpoint || chainConfig.rpcUrls.default.http[0];
   const baseClient = _viem.createClient.call(void 0, {
     chain: chainConfig,
@@ -340,4 +340,4 @@ var createAccount = (accountPrivateKey) => {
 
 
 
-exports.chains = _chunkBAGFDCQEcjs.chains_exports; exports.createAccount = createAccount; exports.createClient = createClient; exports.generatePrivateKey = generatePrivateKey;
+exports.chains = _chunkIINRDYKFcjs.chains_exports; exports.createAccount = createAccount; exports.createClient = createClient; exports.generatePrivateKey = generatePrivateKey;

package/dist/index.d.cts

@@ -1,11 +1,11 @@
 import * as viem from 'viem';
 import { Account } from 'viem';
-import { S as SimulatorChain } from './chains-CtZJFz4Q.cjs';
-import { G as GenLayerClient } from './clients-DiSeCTYZ.cjs';
+import { S as SimulatorChain } from './chains-BV4Glo-M.cjs';
+import { G as GenLayerClient } from './clients-B5D5440g.cjs';
 import * as abitype from 'abitype';
 import * as viem__types_experimental_eip7702_types_authorization from 'viem/_types/experimental/eip7702/types/authorization';
 import * as viem_accounts from 'viem/accounts';
-export { i as chains } from './index-DLN-2YXE.cjs';
+export { i as chains } from './index-SfwloK-R.cjs';
 
 interface ClientConfig {
     chain?: {

package/dist/index.d.ts

@@ -1,11 +1,11 @@
 import * as viem from 'viem';
 import { Account } from 'viem';
-import { S as SimulatorChain } from './chains-CtZJFz4Q.js';
-import { G as GenLayerClient } from './clients-ByaMqS8n.js';
+import { S as SimulatorChain } from './chains-BV4Glo-M.js';
+import { G as GenLayerClient } from './clients-CRRMg5Gh.js';
 import * as abitype from 'abitype';
 import * as viem__types_experimental_eip7702_types_authorization from 'viem/_types/experimental/eip7702/types/authorization';
 import * as viem_accounts from 'viem/accounts';
-export { i as chains } from './index-vHLY9ggt.js';
+export { i as chains } from './index-B5TpaPQ6.js';
 
 interface ClientConfig {
     chain?: {

package/dist/index.js

@@ -1,7 +1,7 @@
 import {
   chains_exports,
   simulator
-} from "./chunk-D7VZGQ4K.js";
+} from "./chunk-3TYB36DW.js";
 import {
   Address
 } from "./chunk-M7SA3INM.js";
@@ -102,7 +102,7 @@ function encodeMap(to, arr) {
     }
   }
   encodeNumWithType(to, BigInt(newEntries.length), TYPE_MAP);
-  for (const [_k, k, v] of newEntries) {
+  for (const [, k, v] of newEntries) {
     writeNum(to, BigInt(k.length));
     for (const c of k) {
       to.push(c);

package/dist/types/index.d.cts

@@ -1,5 +1,5 @@
-export { A as Address, C as CalldataEncodable, G as GenLayerClient, a as GenLayerMethod, d as GenLayerTransaction, M as MethodDescription, T as TransactionData, e as TransactionDataElement, b as TransactionHash, c as TransactionStatus } from '../clients-DiSeCTYZ.cjs';
-export { S as SimulatorChain } from '../chains-CtZJFz4Q.cjs';
+export { A as Address, C as CalldataEncodable, G as GenLayerClient, a as GenLayerMethod, d as GenLayerTransaction, M as MethodDescription, T as TransactionData, e as TransactionDataElement, b as TransactionHash, c as TransactionStatus } from '../clients-B5D5440g.cjs';
+export { S as SimulatorChain } from '../chains-BV4Glo-M.cjs';
 export { Account } from 'viem';
 
 type ContractSchema = {

package/dist/types/index.d.ts

@@ -1,5 +1,5 @@
-export { A as Address, C as CalldataEncodable, G as GenLayerClient, a as GenLayerMethod, d as GenLayerTransaction, M as MethodDescription, T as TransactionData, e as TransactionDataElement, b as TransactionHash, c as TransactionStatus } from '../clients-ByaMqS8n.js';
-export { S as SimulatorChain } from '../chains-CtZJFz4Q.js';
+export { A as Address, C as CalldataEncodable, G as GenLayerClient, a as GenLayerMethod, d as GenLayerTransaction, M as MethodDescription, T as TransactionData, e as TransactionDataElement, b as TransactionHash, c as TransactionStatus } from '../clients-CRRMg5Gh.js';
+export { S as SimulatorChain } from '../chains-BV4Glo-M.js';
 export { Account } from 'viem';
 
 type ContractSchema = {

package/package.json

@@ -1,16 +1,16 @@
 {
   "name": "genlayer-js",
   "type": "module",
-  "version": "0.3.3",
+  "version": "0.3.4",
   "description": "GenLayer JavaScript SDK",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
     "build": "tsup src/index.ts src/chains/index.ts src/types/index.ts --format cjs,esm --dts --splitting --out-dir dist --no-treeshake",
     "build:watch": "tsup src/index.ts src/chains/index.ts src/types/index.ts --format cjs,esm --dts --splitting --out-dir dist --no-treeshake --watch",
-    "test": "vitest",
+    "test": "vitest --typecheck",
     "test:watch": "vitest --watch",
-    "lint": "eslint . --ext .ts",
+    "lint": "eslint . --fix --ext .ts",
     "release": "release-it --ci"
   },
   "exports": {

package/src/abi/calldata/encoder.ts

@@ -77,7 +77,7 @@ function encodeMap(to: number[], arr: Iterable<[string, CalldataEncodable]>) {
   }
 
   encodeNumWithType(to, BigInt(newEntries.length), TYPE_MAP);
-  for (const [_k, k, v] of newEntries) {
+  for (const [, k, v] of newEntries) {
     writeNum(to, BigInt(k.length));
     for (const c of k) {
       to.push(c);

package/src/abi/index.ts

@@ -1,2 +1 @@
 export * from "./calldata/encoder";
-export * from "./calldata/parser";

package/src/accounts/IAccountActions.ts

@@ -1,10 +1,5 @@
 import {TransactionHash} from "@/types";
-import {Account, Chain, Transport} from "viem";
 
-export type IAccountActions<
-  transport extends Transport = Transport,
-  chain extends Chain | undefined = Chain | undefined,
-  account extends Account | undefined = Account | undefined,
-> = {
+export type IAccountActions = {
   fundAccount: ({address, amount}: {address: string; amount: number}) => Promise<TransactionHash>;
 };

package/src/accounts/actions.ts

@@ -1,12 +1,7 @@
 import {GenLayerClient, TransactionHash, SimulatorChain} from "../types";
 import {simulator} from "../chains";
-import {Account, Transport} from "viem";
 
-export function accountActions<
-  transport extends Transport = Transport,
-  chain extends SimulatorChain | undefined = SimulatorChain | undefined,
-  account extends Account | undefined = Account | undefined,
->(client: GenLayerClient<SimulatorChain>) {
+export function accountActions(client: GenLayerClient<SimulatorChain>) {
   return {
     fundAccount: async ({address, amount}: {address: string; amount: number}): Promise<TransactionHash> => {
       if (client.chain?.id !== simulator.id) {

package/src/chains/simulator.ts

@@ -20,7 +20,7 @@ export const simulator: SimulatorChain = defineChain({
   blockExplorers: {
     default: {
       name: "GenLayer Explorer",
-      url: "http://127.0.0.1:4000/api",
+      url: SIMULATOR_JSON_RPC_URL,
     },
   },
   testnet: true,

package/src/transactions/ITransactionActions.ts

@@ -1,11 +1,6 @@
-import {Account, Chain, Transport} from "viem";
 import {TransactionHash, TransactionStatus, GenLayerTransaction} from "@/types";
 
-export type ITransactionActions<
-  transport extends Transport = Transport,
-  chain extends Chain | undefined = Chain | undefined,
-  account extends Account | undefined = Account | undefined,
-> = {
+export type ITransactionActions = {
   waitForTransactionReceipt: ({
     hash,
     status,

package/src/types/chains.ts

@@ -1,3 +1,3 @@
 import {Chain} from "viem";
 
-export interface SimulatorChain extends Chain {}
+export type SimulatorChain = Chain;

package/src/types/clients.ts

@@ -11,6 +11,7 @@ export type GenLayerMethod =
   | {method: "eth_sedRawTransaction"; 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]};
 
 /*

package/tests/client.test-d.ts

@@ -0,0 +1,33 @@
+import {createClient} from "../src/client/client";
+import {simulator} from "../src/chains/simulator";
+import {createAccount, generatePrivateKey} from "../src/accounts/account";
+
+test("type checks", () => {
+  const client = createClient({
+    chain: simulator,
+    account: createAccount(generatePrivateKey()),
+  });
+
+  // This should fail type checking - "whatever" is not a valid filter
+  // @ts-expect-error "whatever" is not a valid filter type
+  void client.request({
+    method: "sim_getTransactionsForAddress",
+    params: ["0x1234567890123456789012345678901234567890", "whatever"],
+  });
+
+  // This should pass type checking - "all", "to" and "from" are valid filters
+  void client.request({
+    method: "sim_getTransactionsForAddress",
+    params: ["0x1234567890123456789012345678901234567890", "all"],
+  });
+
+  void client.request({
+    method: "sim_getTransactionsForAddress",
+    params: ["0x1234567890123456789012345678901234567890", "to"],
+  });
+
+  void client.request({
+    method: "sim_getTransactionsForAddress",
+    params: ["0x1234567890123456789012345678901234567890", "from"],
+  });
+});

package/tests/client.test.ts

@@ -1,6 +1,9 @@
 // tests/client.test.ts
 import {createClient} from "../src/client/client";
 import {simulator} from "../src/chains/simulator";
+import {Address} from "../src/types/accounts";
+import {createAccount, generatePrivateKey} from "../src/accounts/account";
+import {vi} from "vitest";
 
 describe("Client Creation", () => {
   it("should create a client for the simulator", () => {
@@ -9,3 +12,68 @@ describe("Client Creation", () => {
     expect(client.chain).toBe(simulator);
   });
 });
+
+describe("Client Overrides", () => {
+  it("should default to client account if no account is provided", async () => {
+    const account = createAccount(generatePrivateKey());
+    const client = createClient({
+      chain: simulator,
+      account,
+    });
+
+    // Mock the client.request method
+    vi.spyOn(client, "request").mockResolvedValue(undefined);
+
+    const contractAddress = "0x1234567890123456789012345678901234567890";
+    await client.readContract({
+      address: contractAddress as Address,
+      functionName: "testFunction",
+      args: ["arg1", "arg2"],
+    });
+
+    expect(client.request).toHaveBeenCalledWith({
+      method: "eth_call",
+      params: [
+        {
+          to: contractAddress,
+          from: account.address,
+          data: expect.any(String),
+        },
+        "latest",
+      ],
+    });
+  });
+
+  it("should override client account if account is provided", async () => {
+    const account = createAccount(generatePrivateKey());
+    const client = createClient({
+      chain: simulator,
+      account,
+    });
+
+    const overrideAccount = createAccount(generatePrivateKey());
+
+    // Mock the client.request method
+    vi.spyOn(client, "request").mockResolvedValue(undefined);
+
+    const contractAddress = "0x1234567890123456789012345678901234567890";
+    await client.readContract({
+      account: overrideAccount,
+      address: contractAddress as Address,
+      functionName: "testFunction",
+      args: ["arg1", "arg2"],
+    });
+
+    expect(client.request).toHaveBeenCalledWith({
+      method: "eth_call",
+      params: [
+        {
+          to: contractAddress,
+          from: overrideAccount.address,
+          data: expect.any(String),
+        },
+        "latest",
+      ],
+    });
+  });
+});

package/vitest.config.ts

@@ -1,4 +1,5 @@
-import { defineConfig } from "vitest/config";
+import {defineConfig} from "vitest/config";
+import path from "path";
 
 export default defineConfig({
   test: {
@@ -9,4 +10,9 @@ export default defineConfig({
       exclude: ["node_modules/"],
     },
   },
+  resolve: {
+    alias: {
+      "@": path.resolve(__dirname, "./src"),
+    },
+  },
 });