@appliedblockchain/silentdatarollup-viem 1.0.2

package/README.md

@@ -0,0 +1,121 @@
+# Silent Data [Rollup] Providers - Viem Transport Package
+
+## Table of Contents
+
+- [Introduction](#introduction)
+- [Prerequisites](#prerequisites)
+- [Integration](#integration)
+  - [Basic Usage](#basic-usage)
+    - [Installing Basic Usage Dependencies](#installing-basic-usage-dependencies)
+    - [Basic Usage Example](#basic-usage-example)
+- [Troubleshooting](#troubleshooting)
+- [License](#license)
+- [Additional Resources](#additional-resources)
+
+## Introduction
+
+Viem custom transport for Silent Data [Rollup].
+
+## Prerequisites
+
+- Node.js (version 18 or higher)
+- npm
+- Basic knowledge of Ethereum and smart contracts
+- Viem
+
+## Integration
+
+### Basic Usage
+
+#### Installing Basic Usage Dependencies
+
+```bash
+npm install @appliedblockchain/silentdatarollup-core @appliedblockchain/silentdatarollup-viem
+```
+
+#### Basic Usage Example
+
+```typescript
+import {
+  type Chain,
+  defineChain,
+  createPublicClient,
+  createWalletClient,
+  formatEther,
+  type CallParameters,
+  publicActions,
+} from 'viem'
+import { transport } from '@appliedblockchain/silentdatarollup-viem'
+
+// For transaction signing and sending, create an account from the private key
+const account = privateKeyToAccount(providerConfig.privateKey as `0x${string}`)
+const walletClient = createWalletClient({
+  chain: silentDataChain,
+  transport,
+  account,
+})
+
+const transport = sdTransport({
+  rpcUrl: 'SILENT_DATA_ROLLUP_RPC_URL',
+  chainId: SILENT_DATA_CHAIN_ID,
+  privateKey: 'YOUR_PRIVATE_KEY',
+})
+
+const client = createPublicClient({
+  transport,
+})
+
+const balance = await publicClient.getBalance({ address })
+console.log('Balance:', balance)
+
+const transactionCount = await publicClient.getTransactionCount({ address })
+console.log('Transaction count:', transactionCount)
+
+const sdChain = defineChain({
+  id: SILENT_DATA_CHAIN_ID,
+  name: 'SILENT_DATA_CHAIN_NAME',
+  nativeCurrency: {
+    name: 'Ether',
+    symbol: 'ETH',
+    decimals: 18,
+  },
+  rpcUrls: {
+    default: {
+      http: ['SILENT_DATA_ROLLUP_RPC_URL'],
+    },
+  },
+})
+
+const walletClient = createWalletClient({
+  chain: silentDataChain,
+  transport,
+  account,
+})
+
+const recipientAddress = 'RECIPIENT_ADDRESS'
+const amountInWei = BigInt('1')
+
+const transactionHash = await walletClient.sendTransaction({
+  to: recipientAddress,
+  value: amountInWei,
+})
+
+console.log('Transaction Hash:', transactionHash)
+```
+
+## License
+
+This project is licensed under the [MIT License](LICENSE).
+
+## Troubleshooting
+
+If you encounter any issues, please check the following:
+
+1. Ensure you're using the correct RPC URL for your desired network.
+2. Verify that your private key is correctly set.
+3. Ensure that your token is active on the SilentData AppChains dashboard.
+
+## Additional Resources
+
+- [Silent Data [Rollup] Documentation](https://docs.silentdata.com)
+- [Viem Documentation](https://viem.sh/docs/)

package/dist/index.d.mts

@@ -0,0 +1,6 @@
+import { SilentDataRollupProviderConfig } from '@appliedblockchain/silentdatarollup-ethers-provider';
+import { CustomTransport } from 'viem';
+
+declare const sdTransport: (config: SilentDataRollupProviderConfig) => CustomTransport;
+
+export { sdTransport };

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+import { SilentDataRollupProviderConfig } from '@appliedblockchain/silentdatarollup-ethers-provider';
+import { CustomTransport } from 'viem';
+
+declare const sdTransport: (config: SilentDataRollupProviderConfig) => CustomTransport;
+
+export { sdTransport };

package/dist/index.js

@@ -0,0 +1,55 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  sdTransport: () => sdTransport
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/transport.ts
+var import_silentdatarollup_ethers_provider = require("@appliedblockchain/silentdatarollup-ethers-provider");
+var import_viem = require("viem");
+var sdTransport = (config) => {
+  const providerConfig = config;
+  const ethersProvider = new import_silentdatarollup_ethers_provider.SilentDataRollupProvider(providerConfig);
+  const transport = (0, import_viem.custom)({
+    request: async ({ method, params }) => {
+      const txData = params?.[0] ?? {};
+      if (method === "eth_sendTransaction" && ethersProvider.signer && !txData.nonce) {
+        const signerAddress = await ethersProvider.signer.getAddress();
+        const nonce = await ethersProvider.getTransactionCount(
+          signerAddress,
+          "latest"
+        );
+        txData.nonce = nonce;
+      }
+      if (method === "eth_getBlockByNumber" && Array.isArray(params) && params.length > 1) {
+        params[1] = false;
+      }
+      return await ethersProvider.send(method, params || []);
+    }
+  });
+  return transport;
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  sdTransport
+});

package/dist/index.mjs

@@ -0,0 +1,30 @@
+// src/transport.ts
+import {
+  SilentDataRollupProvider
+} from "@appliedblockchain/silentdatarollup-ethers-provider";
+import { custom } from "viem";
+var sdTransport = (config) => {
+  const providerConfig = config;
+  const ethersProvider = new SilentDataRollupProvider(providerConfig);
+  const transport = custom({
+    request: async ({ method, params }) => {
+      const txData = params?.[0] ?? {};
+      if (method === "eth_sendTransaction" && ethersProvider.signer && !txData.nonce) {
+        const signerAddress = await ethersProvider.signer.getAddress();
+        const nonce = await ethersProvider.getTransactionCount(
+          signerAddress,
+          "latest"
+        );
+        txData.nonce = nonce;
+      }
+      if (method === "eth_getBlockByNumber" && Array.isArray(params) && params.length > 1) {
+        params[1] = false;
+      }
+      return await ethersProvider.send(method, params || []);
+    }
+  });
+  return transport;
+};
+export {
+  sdTransport
+};

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@appliedblockchain/silentdatarollup-viem",
+  "version": "1.0.2",
+  "description": "Viem package for Silent Data [Rollup]",
+  "author": "Applied Blockchain",
+  "homepage": "https://github.com/appliedblockchain/silent-data-rollup-providers#readme",
+  "keywords": [
+    "ethereum",
+    "provider",
+    "silentdata",
+    "rollup",
+    "ethers",
+    "viem"
+  ],
+  "license": "MIT",
+  "repository": "https://github.com/appliedblockchain/silent-data-rollup-providers",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts --clean",
+    "check-exports": "attw --pack . --profile node16",
+    "prepack": "npm run build",
+    "test": "jest"
+  },
+  "dependencies": {
+    "@appliedblockchain/silentdatarollup-core": "1.0.2",
+    "@appliedblockchain/silentdatarollup-ethers-provider": "1.0.2",
+    "viem": "2.31.4"
+  },
+  "devDependencies": {
+    "@types/node": "22.5.4",
+    "ts-node": "10.9.2",
+    "typescript": "5.6.2"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}