genlayer-js 0.0.1

package/.eslintignore

@@ -0,0 +1,2 @@
+node_modules
+dist

package/.eslintrc.js

@@ -0,0 +1,58 @@
+module.exports = {
+  root: true,
+  env: {
+    es6: true,
+    node: true,
+    jest: true,
+  },
+  extends: ["eslint:recommended", "prettier", "plugin:import/typescript"],
+  parser: "@typescript-eslint/parser",
+  plugins: ["@typescript-eslint", "import"],
+  overrides: [
+    {
+      files: "**/*.ts",
+      parserOptions: {
+        project: ["./tsconfig.json"],
+        sourceType: "module",
+      },
+      extends: [
+        "plugin:import/errors",
+        "plugin:import/warnings",
+        "plugin:import/typescript",
+        "plugin:@typescript-eslint/recommended",
+      ],
+      rules: {
+        "import/namespace": "off",
+        "@typescript-eslint/no-empty-function": "off",
+        "@typescript-eslint/no-empty-interface": "off",
+        "no-constant-condition": "off",
+        "@typescript-eslint/no-explicit-any": "off",
+        "prefer-const": "off",
+        "@typescript-eslint/no-non-null-assertion": "off",
+        "@typescript-eslint/ban-ts-ignore": "off",
+        "@typescript-eslint/no-loss-of-precision": "off",
+        "@typescript-eslint/ban-types": "off",
+        "@typescript-eslint/ban-ts-comment": "off",
+        "@typescript-eslint/no-non-null-asserted-optional-chain": "off",
+        "@typescript-eslint/no-var-requires": "off",
+        "import/export": "off",
+        "no-fallthrough": "off",
+        "@typescript-eslint/explicit-module-boundary-types": "off",
+        "@typescript-eslint/no-floating-promises": ["error"],
+        "@typescript-eslint/no-unused-vars": ["error", { argsIgnorePattern: "^_" }],
+      },
+    },
+  ],
+  ignorePatterns: [
+    "**/dist/**/*", // Ignore built files.
+    "esbuild.config.js",
+    "jest.config.js",
+    "Config.js",
+    "commitLint.config.ts",
+  ],
+  settings: {
+    "import/resolver": {
+      typescript: {},
+    },
+  },
+};

package/.github/pull_request_template.md

@@ -0,0 +1,43 @@
+<!-- This is a TEMPLATE, modify it to fit your needs. -->
+
+Fixes #issue-number-here
+
+# What
+
+<!-- Describe the changes you made. -->
+
+- changed thing a for b
+- also did this other unrelated thing in my path
+
+# Why
+
+<!-- Why are you making these changes? This should be related to the issue created, and the value we are adding with this PR -->
+
+- to fix a bug
+- to add more value to the user
+
+# Testing done
+
+<!-- Describe the tests you ran to verify your changes. -->
+
+- tested the new feature
+- tested the bug fix
+
+# Decisions made
+
+<!-- Describe any decisions made during the implementation of this PR. This should in general be in the code, but sometimes they are more related to the issue. For example: decisions on PR workflow -->
+
+# Checks
+
+- [ ] I have tested this code
+- [ ] I have reviewed my own PR
+- [ ] I have created an issue for this PR
+- [ ] I have set a descriptive PR title compliant with [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/)
+
+# Reviewing tips
+
+<!-- What can you tell the reviewer to make the review easier? -->
+
+# User facing release notes
+
+<!-- What should the user know about this change? Think of it going into public forums for end users to read -->

package/.github/workflows/publish.yml

@@ -0,0 +1,41 @@
+name: Release & Publish Package to NPM
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Get CI Bot Token
+        uses: tibdex/github-app-token@v1
+        id: ci_bot_token
+        with:
+          app_id: ${{ secrets.CI_BOT_APP_ID }}
+          private_key: ${{ secrets.CI_BOT_SECRET }}
+
+      - name: Checkout source code
+        uses: actions/checkout@v4
+        with:
+          token: ${{ steps.ci_bot_token.outputs.token }}
+      - name: Setup Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: "18"
+      - name: Install the dependencies
+        run: npm ci
+      - name: Initialize Git User
+        run: |
+          git config --global user.email "github-actions[bot]@genlayer.com"
+          git config --global user.name "github-actions[bot]"
+      - name: Initialize the NPM configuration
+        run: npm config set //registry.npmjs.org/:_authToken=$NPM_AUTH_TOKEN
+        env:
+          NPM_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
+      - run: npm run release
+        env:
+          GITHUB_TOKEN: ${{ steps.ci_bot_token.outputs.token }}
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}

package/.prettierignore

@@ -0,0 +1,19 @@
+# Node artifact files
+node_modules/
+dist/
+package-lock.json
+yarn.lock
+pnpm-lock.yaml
+
+# Log files
+*.log
+
+# Generated by MacOS
+.DS_Store
+
+# Generated by Windows
+Thumbs.db
+
+# aws
+.aws-sam
+.sam

package/.prettierrc

@@ -0,0 +1,12 @@
+{
+  "tabWidth": 2,
+  "useTabs": false,
+  "semi": true,
+  "singleQuote": false,
+  "jsxSingleQuote": false,
+  "trailingComma": "all",
+  "bracketSpacing": false,
+  "bracketSameLine": false,
+  "arrowParens": "avoid",
+  "printWidth": 110
+}

package/.release-it.json

@@ -0,0 +1,64 @@
+{
+  "git": {
+    "commitMessage": "Release v${version} [skip ci]",
+    "tagName": "v${version}",
+    "requireCleanWorkingDir": false,
+    "requireUpstream": false,
+    "requireCommits": false,
+    "push": true
+  },
+  "github": {
+    "release": true,
+    "tokenRef": "GITHUB_TOKEN"
+  },
+  "npm": {
+    "publish": true
+  },
+  "plugins": {
+    "@release-it/conventional-changelog": {
+      "preset": "conventionalcommits",
+      "infile": "CHANGELOG.md",
+      "types": [
+        {
+          "type": "feat",
+          "section": "Features"
+        },
+        {
+          "type": "fix",
+          "section": "Bug Fixes"
+        },
+        {
+          "type": "chore",
+          "section": "Improvement Tasks"
+        },
+        {
+          "type": "ci",
+          "section": "Continuous Integration"
+        },
+        {
+          "type": "docs",
+          "section": "Documentation"
+        },
+        {
+          "type": "style",
+          "section": "Styles"
+        },
+        {
+          "type": "refactor",
+          "section": "Refactor Tasks"
+        },
+        {
+          "type": "perf",
+          "section": "Performance Improvements"
+        },
+        {
+          "type": "test",
+          "section": "Testing"
+        }
+      ]
+    }
+  },
+  "hooks": {
+    "after:bump": "npm run build"
+  }
+}

package/CONTRIBUTING.md

@@ -0,0 +1,87 @@
+# Contributing to GenLayerJS SDK
+
+We're thrilled that you're interested in contributing to the GenLayerJS SDK! This document will guide you through the contribution process.
+
+## What is the GenLayerJS SDK?
+
+The GenLayerJS SDK is a TypeScript library designed for developers building decentralized applications (Dapps) on the GenLayer protocol. It provides a comprehensive set of tools to interact with the GenLayer network, including client creation, transaction handling, event subscriptions, and more, all while leveraging the power of Viem as the underlying blockchain client.
+
+## How You Can Contribute?
+
+Contributions to the GenLayerJS SDK are welcome in several forms:
+
+### Testing the SDK and Providing Feedback
+
+Help us make the SDK better by testing and giving feedback:
+
+- Start by installing the SDK in your Dapp using the command:
+  ```sh
+  $ npm install genlayer-js
+  ```
+- Try out the SDK features and tell us what you think through our [feedback form](https://docs.google.com/forms/d/1IVNsZwm936kSNCiXmlAP8bgJnbik7Bqaoc3I6UYhr-o/viewform) or on our [Discord Channel](https://discord.gg/8Jm4v89VAu).
+- If you find any issues, please report them on our [GitHub issues page](https://github.com/yeagerai/genlayer-js/issues).
+
+### Sharing New Ideas and Use Cases
+
+Have ideas for new features or use cases? We're eager to hear them! But first:
+
+- Ensure you have the SDK installed to explore existing use cases.
+- After familiarizing yourself with the SDK, contribute your unique use case and share your ideas in our [Discord channel](https://discord.gg/8Jm4v89VAu).
+
+### Bug fixing and Feature development
+
+#### 1. Set yourself up to start coding
+
+- **1.1. Pick an issue**: Select one from the project GitHub repository [issue list](https://github.com/yeagerai/genlayer-js/issues) and assign it to yourself.
+
+- **1.2. Create a branch**: create the branch that you will work on by using the link provided in the issue details page (right panel at the bottom - section "Development")
+
+- **1.3. Setup the SDK locally**: clone the repository and install dependencies
+
+   ```sh
+   $ git clone https://github.com/yeagerai/genlayer-js.git
+   $ cd genlayer-js
+   $ npm install
+   ```
+
+- **1.4. Run the SDK in dev mode**: to run the SDK in development mode with hot reload enabled:
+
+   ```sh
+   $ npm run build:watch
+   ```
+- **1.5. Link the package locally**: to link the package locally, use the command:
+
+   ```sh
+   $ npm link
+   ```
+
+This will allow you to use the package in your project without publishing it.
+
+- **1.6. Add the package to your project**: to add the package to your project, use the command:
+
+   ```sh
+   $ npm link genlayer-js
+   ```
+
+#### 2. Submit your solution
+
+- **2.1. Prettier Formatter on Save File**: Configure IDE extensions to format your code with [Prettier](https://prettier.io/) before submitting it.
+- **2.2. Code solution**: implement the solution in the code.
+- **2.3. Pull Request**: Submit your changes through a pull request (PR). Fill the entire PR template and set the PR title as a valid conventional commit.
+- **2.4. Check PR and issue linking**: if the issue and the PR are not linked, you can do it manually in the right panel of the Pull Request details page.  
+- **2.5. Peer Review**: One or more core contributors will review your PR. They may suggest changes or improvements.
+- **2.6. Approval and Merge**: After approval from the reviewers, you can merge your PR with a squash and merge type of action.
+
+
+### Improving Documentation
+
+To contribute to our docs, visit our [Documentation Repository](https://github.com/yeagerai/genlayer-docs) to create new issues or contribute to existing issues.
+
+## Community
+
+Connect with the GenLayer community to discuss, collaborate, and share insights:
+
+- **[Discord Channel](https://discord.gg/8Jm4v89VAu)**: Our primary hub for discussions, support, and announcements.
+- **[Telegram Group](https://t.me/genlayer)**: For more informal chats and quick updates.
+
+Your continuous feedback drives better product development. Please engage with us regularly to test, discuss, and improve the GenLayerJS SDK.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-present YeagerAI LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,99 @@
+# [Your Project Name]
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/license/mit/)
+[![Discord](https://dcbadge.vercel.app/api/server/8Jm4v89VAu?compact=true&style=flat)](https://discord.gg/VpfmXEMN66)
+[![Twitter](https://img.shields.io/twitter/url/https/twitter.com/yeagerai.svg?style=social&label=Follow%20%40GenLayer)](https://x.com/GenLayer)
+[![GitHub star chart](https://img.shields.io/github/stars/yeagerai/genlayer-js?style=social)](https://star-history.com/#yeagerai/genlayer-js)
+
+## 👀 About
+
+GenLayerJS SDK is a TypeScript library designed for developers building decentralized applications (Dapps) on the GenLayer protocol. This SDK provides a comprehensive set of tools to interact with the GenLayer network, including client creation, transaction handling, event subscriptions, and more, all while leveraging the power of Viem as the underlying blockchain client.
+
+## Prerequisites
+
+Before installing GenLayerJS SDK, ensure you have the following prerequisites installed:
+
+- Node.js (>= 16.x)
+- npm (>= 7.x)
+
+## 🛠️ Installation and Usage
+
+To install the GenLayerJS SDK, use the following command:
+```bash
+$ npm install genlayer-js
+```
+Here’s how to initialize the client and connect to the GenLayer Simulator:
+
+### Reading a Transaction
+```typescript
+import { simulator } from 'genlayer-js/chains';
+import { createClient } from "genlayer-js";
+
+const client = createClient({
+  network: simulator,
+});
+
+const transaction = await client.getTransaction({ hash: transactionHash })
+```
+
+### Readding a contract
+```typescript
+import { simulator } from 'genlayer-js/chains';
+import { createClient, createAccount } from "genlayer-js";
+
+const account = createAccount();
+const client = createClient({
+  network: simulator,
+  account: account, // hoist the account to use it on next calls
+});
+
+const result = await client.readContract({
+  address: contractAddress,
+  functionName: 'get_complete_storage',
+  args: []
+})
+```
+
+### Writing a transaction
+```typescript
+import { simulator } from 'genlayer-js/chains';
+import { createClient, createAccount } from "genlayer-js";
+
+const client = createClient({
+  network: simulator,
+});
+
+const account = createAccount();
+const transactionHash = await client.writeContract({
+  account: account, // using this account for this transaction
+  address: contractAddress,
+  functionName: 'account',
+  args: ['new_storage'],
+  value: 0, // value is optional, if you want to send some native token to the contract
+});
+
+const receipt = await client.waitForTransactionReceipt({ hash: txHash, status: TransactionStatus.FINALIZED}) //or ACCEPTED
+
+```
+## 🚀 Key Features
+
+* **Client Creation**: Easily create and configure a client to connect to GenLayer’s network.
+* **Transaction Handling**: Send and manage transactions on the GenLayer network.
+* **Wallet Integration***: Seamless integration with MetaMask for managing user accounts.
+* **Gas Estimation***: Estimate gas fees for executing transactions on GenLayer.
+
+_* under development_
+
+## 📖 Documentation
+
+For detailed information on how to use GenLayerJS SDK, please refer to our [documentation](https://docs.genlayer.io/).
+
+
+
+## Contributing
+
+We welcome contributions to GenLayerJS SDK! Whether it's new features, improved infrastructure, or better documentation, your input is valuable. Please read our [CONTRIBUTING](https://github.com/yeagerai/genlayer-js/blob/main/CONTRIBUTING.md) guide for guidelines on how to submit your contributions.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "genlayer-js",
+  "type": "module",
+  "version": "0.0.1",
+  "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:watch": "vitest --watch",
+    "lint": "eslint . --ext .ts",
+    "release": "release-it --ci"
+  },
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.js"
+    },
+    "./chains": {
+      "import": "./dist/chains/index.js",
+      "require": "./dist/chains/index.js"
+    },
+    "./types": {
+      "import": "./dist/types/index.js",
+      "require": "./dist/types/index.js"
+    }
+  },
+  "keywords": [],
+  "author": "GenLayer",
+  "license": "MIT",
+  "devDependencies": {
+    "@release-it/conventional-changelog": "^8.0.2",
+    "@types/jest": "^29.5.13",
+    "@types/node": "^22.5.5",
+    "@typescript-eslint/eslint-plugin": "^8.5.0",
+    "@typescript-eslint/parser": "^8.5.0",
+    "cross-env": "^7.0.3",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-import-resolver-typescript": "^3.6.3",
+    "prettier": "^3.3.3",
+    "release-it": "^17.6.0",
+    "ts-node": "^10.9.2",
+    "tsup": "^8.2.4",
+    "typescript": "^5.6.2",
+    "vitest": "^2.1.1"
+  },
+  "dependencies": {
+    "eslint-plugin-import": "^2.30.0",
+    "viem": "^2.21.7"
+  }
+}

package/src/accounts/IAccountActions.ts

@@ -0,0 +1,10 @@
+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,
+> = {
+  fundAccount: ({address, amount}: {address: string; amount: number}) => Promise<TransactionHash>;
+};

package/src/accounts/account.ts

@@ -0,0 +1,7 @@
+import {generatePrivateKey, privateKeyToAccount} from "viem/accounts";
+
+export const createAccount = () => {
+  const privateKey = generatePrivateKey();
+  const account = privateKeyToAccount(privateKey);
+  return account;
+};

package/src/accounts/actions.ts

@@ -0,0 +1,22 @@
+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<Transport, SimulatorChain, Account>) {
+  return {
+    fundAccount: async ({address, amount}: {address: string; amount: number}): Promise<TransactionHash> => {
+      if (client.chain?.id !== simulator.id) {
+        throw new Error("Client is not connected to the simulator");
+      }
+
+      return client.request({
+        method: "sim_fundAccount",
+        params: [address, amount],
+      }) as Promise<TransactionHash>;
+    },
+  };
+}

package/src/chains/index.ts

@@ -0,0 +1,2 @@
+// src/chains/index.ts
+export {simulator} from "./simulator";

package/src/chains/simulator.ts

@@ -0,0 +1,27 @@
+import {defineChain} from "viem";
+import {SimulatorChain} from "@/types";
+
+// chains/simulator.ts
+const SIMULATOR_JSON_RPC_URL = "http://127.0.0.1:4000/api";
+
+export const simulator: SimulatorChain = defineChain({
+  id: 61_999,
+  name: "GenLayer Simulator",
+  rpcUrls: {
+    default: {
+      http: [SIMULATOR_JSON_RPC_URL],
+    },
+  },
+  nativeCurrency: {
+    name: "GEN Token",
+    symbol: "GEN",
+    decimals: 18,
+  },
+  blockExplorers: {
+    default: {
+      name: "GenLayer Explorer",
+      url: "http://127.0.0.1:4000/api",
+    },
+  },
+  testnet: true,
+});

package/src/client/client.ts

@@ -0,0 +1,48 @@
+import {Account, createClient as createViemClient, http, publicActions, Transport} from "viem";
+import {simulator} from "../chains/simulator";
+import {accountActions} from "../accounts/actions";
+import {contractActions, overrideContractActions} from "../contracts/actions";
+import {transactionActions} from "../transactions/actions";
+import {GenLayerClient, SimulatorChain} from "@/types";
+import {createAccount} from "@/accounts/account";
+
+// Define the configuration interface for the client
+interface ClientConfig {
+  chain?: {
+    id: number;
+    name: string;
+    rpcUrls: {default: {http: readonly string[]}};
+    nativeCurrency: {name: string; symbol: string; decimals: number};
+    blockExplorers?: {default: {name: string; url: string}};
+  };
+  endpoint?: string; // Optional: Custom RPC endpoint override
+  account?: Account;
+}
+
+// Extend Viem client to work with GenLayer-specific chains (simulator, testnet, etc.)
+export const createClient = (config: ClientConfig = {chain: simulator}) => {
+  // Determine the RPC URL based on the provided configuration or default to the simulator's RPC UR
+  const chainConfig = config.chain || simulator;
+  const rpcUrl = config.endpoint || chainConfig.rpcUrls.default.http[0];
+
+  // Create a Viem client connected to the GenLayer Simulator (or custom chain)
+  const baseClient = createViemClient({
+    chain: chainConfig,
+    transport: http(rpcUrl),
+    ...(config.account ? {account: config.account} : {}),
+  })
+    .extend(publicActions)
+    .extend(client => accountActions(client as unknown as GenLayerClient<Transport, SimulatorChain, Account>))
+    .extend(client =>
+      transactionActions(client as unknown as GenLayerClient<Transport, SimulatorChain, Account>),
+    )
+    .extend(client =>
+      contractActions(client as unknown as GenLayerClient<Transport, SimulatorChain, Account>),
+    );
+
+  const genLayerClient = overrideContractActions(
+    baseClient as unknown as GenLayerClient<Transport, SimulatorChain, Account>,
+  );
+
+  return genLayerClient;
+};

package/src/config/transactions.ts

@@ -0,0 +1,9 @@
+type TransactionsConfig = {
+  waitInterval: number;
+  retries: number;
+};
+
+export const transactionsConfig: TransactionsConfig = {
+  waitInterval: 3000,
+  retries: 10,
+};

package/src/contracts/IContractActions.ts

@@ -0,0 +1,8 @@
+import {ContractSchema} from "@/types";
+import {Address} from "viem";
+
+export type IContractActions = {
+  getContractSchema: (code: string) => Promise<ContractSchema>;
+  getContractSchemaForCode: (address: string) => Promise<ContractSchema>;
+  readContract: (args: {address: Address; functionName: string; args: any[]}) => Promise<unknown>;
+};

package/src/contracts/actions.ts

@@ -0,0 +1,86 @@
+import {toRlp, toHex, Transport, Account, Address} from "viem";
+
+import {ContractSchema, SimulatorChain, GenLayerClient} from "@/types";
+import {createAccount} from "@/accounts/account";
+
+export const contractActions = (client: GenLayerClient<Transport, SimulatorChain, Account>) => {
+  return {
+    getContractSchema: async (address: string): Promise<ContractSchema> => {
+      const schema = (await client.request({
+        method: "gen_getContractSchema",
+        params: [address],
+      })) as string;
+      return schema as unknown as ContractSchema;
+    },
+    getContractSchemaForCode: async (contractCode: string): Promise<ContractSchema> => {
+      const schema = (await client.request({
+        method: "gen_getContractSchemaForCode",
+        params: [contractCode],
+      })) as string;
+      return schema as unknown as ContractSchema;
+    },
+  };
+};
+
+export const overrideContractActions = (client: GenLayerClient<Transport, SimulatorChain, Account>) => {
+  client.readContract = async (args: {
+    account: Account;
+    address: Address;
+    functionName: string;
+    args: any[];
+  }): Promise<any> => {
+    const {account, address, functionName, args: params} = args;
+    const methodParamsAsString = JSON.stringify(params);
+    const data = [functionName, methodParamsAsString];
+    const encodedData = toRlp(data.map(param => toHex(param)));
+
+    const requestParams = {
+      to: address,
+      from: account?.address || client.account?.address,
+      data: encodedData,
+    };
+    const result = await client.request({
+      method: "eth_call",
+      params: [requestParams, "latest"],
+    });
+    return result;
+  };
+
+  client.writeContract = async (args: {
+    account: Account;
+    address: Address;
+    functionName: string;
+    args: any[];
+    value: bigint;
+  }): Promise<any> => {
+    const {account, address, functionName, args: params, value = 0n} = args;
+    const methodParamsAsString = JSON.stringify(params);
+    const data = [functionName, methodParamsAsString];
+    const encodedData = toRlp(data.map(param => toHex(param)));
+
+    const senderAccount = account || client.account;
+    if (!senderAccount) {
+      throw new Error(
+        "No account set. Configure the client with an account or pass an account to this function.",
+      );
+    }
+
+    if (!senderAccount?.signTransaction) {
+      throw new Error("Account does not support signTransaction");
+    }
+
+    const signedTransaction = await senderAccount.signTransaction({
+      data: encodedData,
+      to: address,
+      value,
+      type: "legacy",
+    });
+    const result = await client.request({
+      method: "eth_sendRawTransaction",
+      params: [signedTransaction],
+    });
+    return result;
+  };
+
+  return client;
+};

package/src/index.ts

@@ -0,0 +1,4 @@
+// src/index.ts
+export {createClient} from "./client/client";
+export {createAccount} from "./accounts/account";
+export * as chains from "./chains";

package/src/transactions/ITransactionActions.ts

@@ -0,0 +1,20 @@
+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,
+> = {
+  waitForTransactionReceipt: ({
+    hash,
+    status,
+    interval,
+    retries,
+  }: {
+    hash: TransactionHash;
+    status: TransactionStatus;
+    interval?: number;
+    retries?: number;
+  }) => Promise<GenLayerTransaction>;
+};

package/src/transactions/actions.ts

@@ -0,0 +1,48 @@
+import {GenLayerClient} from "../types/clients";
+import {TransactionHash, TransactionStatus, GenLayerTransaction} from "../types/transactions";
+import {transactionsConfig} from "../config/transactions";
+import {sleep} from "../utils/async";
+import {ITransactionActions} from "./ITransactionActions";
+import {Account, Transport} from "viem";
+import {SimulatorChain} from "@/types";
+
+export const transactionActions = (
+  client: GenLayerClient<Transport, SimulatorChain, Account>,
+): ITransactionActions => ({
+  waitForTransactionReceipt: async ({
+    hash,
+    status = TransactionStatus.FINALIZED,
+    interval = transactionsConfig.waitInterval,
+    retries = transactionsConfig.retries,
+  }: {
+    hash: TransactionHash;
+    status: TransactionStatus;
+    interval?: number;
+    retries?: number;
+  }): Promise<GenLayerTransaction> => {
+    const transaction = (await client.getTransaction({hash})) as GenLayerTransaction;
+
+    if (!transaction) {
+      throw new Error("Transaction not found");
+    }
+
+    if (
+      transaction.status === status ||
+      (status === TransactionStatus.ACCEPTED && transaction.status === TransactionStatus.FINALIZED)
+    ) {
+      return transaction;
+    }
+
+    if (retries === 0) {
+      throw new Error("Transaction status is not " + status);
+    }
+
+    await sleep(interval);
+    return transactionActions(client).waitForTransactionReceipt({
+      hash,
+      status,
+      interval,
+      retries: retries - 1,
+    });
+  },
+});

package/src/types/accounts.ts

@@ -0,0 +1 @@
+export type Address = `0x${string}` & {length: 42};

package/src/types/chains.ts

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

package/src/types/clients.ts

@@ -0,0 +1,38 @@
+import {Account, Transport, Client} from "viem";
+import {GenLayerTransaction, TransactionHash} from "./transactions";
+import {SimulatorChain} from "./chains";
+import {Address} from "./accounts";
+
+export 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_sedRawTransaction"; params: [signedTransaction: string]}
+  | {method: "gen_getContractSchema"; params: [address: string]}
+  | {method: "gen_getContractSchemaForCode"; params: [contractCode: string]};
+
+export type GenLayerClient<
+  TTransport extends Transport,
+  TSimulatorChain extends SimulatorChain,
+  TAccount extends Account,
+> = Client<TTransport, TSimulatorChain, TAccount> & {
+  request: Client<TTransport, TSimulatorChain, TAccount>["request"] & {
+    <TMethod extends GenLayerMethod>(
+      args: Extract<GenLayerMethod, {method: TMethod["method"]}>,
+    ): Promise<unknown>;
+  };
+  readContract: (args: {
+    account: Account;
+    address: Address;
+    functionName: string;
+    args: any[];
+  }) => Promise<any>;
+  writeContract: (args: {
+    account: Account;
+    address: Address;
+    functionName: string;
+    args: any[];
+    value: bigint;
+  }) => Promise<any>;
+  getTransaction: (args: {hash: TransactionHash}) => Promise<GenLayerTransaction>;
+};

package/src/types/contracts.ts

@@ -0,0 +1,15 @@
+export type ContractSchema = {
+  abi: Array<{
+    inputs?: Array<{
+      name: string;
+      type: string;
+    }>;
+    name?: string;
+    outputs?: Array<{
+      name: string;
+      type: string;
+    }>;
+    type: "constructor" | "function";
+  }>;
+  class: string;
+};

package/src/types/index.ts

@@ -0,0 +1,5 @@
+export * from "./accounts";
+export * from "./chains";
+export * from "./clients";
+export * from "./contracts";
+export * from "./transactions";

package/src/types/transactions.ts

@@ -0,0 +1,29 @@
+export type TransactionHash = `0x${string}` & {length: 66};
+
+export enum TransactionStatus {
+  PENDING = "PENDING",
+  CANCELED = "CANCELED",
+  PROPOSING = "PROPOSING",
+  COMMITTING = "COMMITTING",
+  REVEALING = "REVEALING",
+  ACCEPTED = "ACCEPTED",
+  FINALIZED = "FINALIZED",
+  UNDETERMINED = "UNDETERMINED",
+}
+
+export type GenLayerTransaction = {
+  hash: TransactionHash;
+  status: TransactionStatus;
+  from_address?: string;
+  to_address?: string;
+  data?: Record<string, unknown>;
+  consensus_data?: Record<string, unknown>;
+  nonce?: number;
+  value?: number;
+  type?: number;
+  gaslimit?: bigint;
+  created_at?: Date;
+  r?: number;
+  s?: number;
+  v?: number;
+};

package/src/utils/async.ts

@@ -0,0 +1,3 @@
+export async function sleep(ms: number) {
+  return new Promise(resolve => setTimeout(resolve, ms));
+}

package/tsconfig.json

@@ -0,0 +1,119 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+
+    /* Projects */
+    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+    /* Language and Environment */
+    "target": "ES2022" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
+    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for legacy experimental decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
+    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
+
+    /* Modules */
+    "module": "ES2022" /* Specify what module code is generated. */,
+    // "rootDir":  /* Specify the root folder within your source files. */,
+    "moduleResolution": "node" /* Specify how TypeScript looks up a file from a given module specifier. */,
+    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+    "paths": {
+      "@/*": ["./src/*"],
+      "@@/tests/*": ["./tests/*"]
+    } /* Specify a set of entries that re-map imports to additional lookup locations. */,
+    "rootDirs": [
+      "./src",
+      "./tests"
+    ] /* Allow multiple folders to be treated as one when resolving modules. */,
+    // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
+    "types": [
+      "node",
+      "jest"
+    ] /* Specify type package names to be included without being referenced in a source file. */,
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
+    // "allowImportingTsExtensions": true,               /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
+    // "resolvePackageJsonExports": true,                /* Use the package.json 'exports' field when resolving package imports. */
+    // "resolvePackageJsonImports": true,                /* Use the package.json 'imports' field when resolving imports. */
+    // "customConditions": [],                           /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
+    "resolveJsonModule": true /* Enable importing .json files. */,
+    // "allowArbitraryExtensions": true,                 /* Enable importing files with any extension, provided a declaration file is present. */
+    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
+
+    /* JavaScript Support */
+    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
+    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
+
+    /* Emit */
+    // "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+    "sourceMap": true /* Create source map files for emitted JavaScript files. */,
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
+    "outDir": "./dist" /* Specify an output folder for all emitted files. */,
+    // "removeComments": true,                           /* Disable emitting comments. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types. */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
+    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
+
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "verbatimModuleSyntax": true,                     /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
+    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
+
+    /* Type Checking */
+    "strict": true /* Enable all strict type-checking options. */,
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
+    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
+    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true /* Skip type checking all .d.ts files. */
+  },
+  "include": ["src/**/*", "tests/**/*"]
+}

package/vitest.config.ts

@@ -0,0 +1,12 @@
+import { defineConfig } from "vitest/config";
+
+export default defineConfig({
+  test: {
+    globals: true,
+    environment: "node",
+    coverage: {
+      reporter: ["text", "json", "html"],
+      exclude: ["node_modules/"],
+    },
+  },
+});