@appliedblockchain/silentdatarollup-hardhat-plugin 1.0.0

package/README.md

@@ -0,0 +1,87 @@
+# Silent Data [Rollup] Providers - Hardhat Plugin Package
+
+## Table of Contents
+
+- [Introduction](#introduction)
+- [Prerequisites](#prerequisites)
+- [Integration](#integration)
+  - [Hardhat Integration](#hardhat-integration)
+    - [Installing Hardhat Integration Dependencies](#installing-hardhat-integration-dependencies)
+    - [Hardhat Integration Example](#hardhat-integration-example)
+- [Troubleshooting](#troubleshooting)
+- [License](#license)
+- [Additional Resources](#additional-resources)
+
+## Introduction
+
+Custom providers for integrating Silent Data [Rollup] with Hardhat.
+
+## Prerequisites
+
+- Node.js (version 18 or higher)
+- Hardhat v2
+- npm
+- Basic knowledge of Ethereum and smart contracts
+
+## Integration
+
+### Hardhat Integration
+
+#### Installing Hardhat Integration Dependencies
+
+```bash
+npm install @appliedblockchain/silentdatarollup-hardhat-plugin @nomicfoundation/hardhat-ignition-ethers@0.15.7
+```
+
+#### Hardhat Integration Example
+
+To integrate the Silent Data [Rollup] Provider with Hardhat, you need to configure your Silent Data network in the `hardhat.config.ts` file. Below is an example of how to set it up, and note that a `silentdata` property is needed on the network config to enable it. This property can be an empty object to apply defaults, or you can specify the configurations.
+
+```typescript
+import '@nomicfoundation/hardhat-ignition-ethers'
+import '@appliedblockchain/silentdatarollup-hardhat-plugin'
+
+const RPC_URL = 'SILENT_DATA_ROLLUP_RPC_URL'
+const PRIVATE_KEY = process.env.PRIVATE_KEY
+
+export default {
+  solidity: '0.8.21',
+  defaultNetwork: 'sdr',
+  networks: {
+    sdr: {
+      url: RPC_URL,
+      accounts: [PRIVATE_KEY], // Note: Currently, only one private key can be passed to the network accounts configuration.
+      silentdata: {
+        authSignatureType: SignatureType.EIP712, // Optional, defaults to RAW
+      },
+    },
+  },
+}
+```
+
+Note: With the above configuration, you can deploy a contract using Hardhat Ignition. For a detailed example, including a sample contract and an Ignition module, please refer to the [Hardhat Ignition Getting Started Guide](https://hardhat.org/ignition/docs/getting-started).
+
+To deploy your contract using Hardhat Ignition, run the following command:
+
+```bash
+npx hardhat ignition deploy ignition/modules/Apollo.ts --network sdr
+```
+
+## 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 still active on the SilentData AppChains dashboard.
+
+## License
+
+This project is licensed under the [MIT License](LICENSE).
+
+## Additional Resources
+
+- [Silent Data [Rollup] Documentation](https://docs.silentdata.com)
+- [Ethers.js Documentation](https://docs.ethers.org/v6/)
+- [Hardhat Documentation](https://hardhat.org/docs)
+- [Hardhat Ignition](https://hardhat.org/hardhat-runner/plugins/nomiclabs-hardhat-ignition)

package/dist/index.d.mts

@@ -0,0 +1,18 @@
+import { SignatureType } from '@appliedblockchain/silentdatarollup-core';
+
+interface SilentdataNetworkConfig {
+    /**
+     * Signature type to use for authentication headers.
+     * If not provided, defaults to SignatureType.Raw.
+     */
+    authSignatureType: SignatureType;
+}
+
+declare module 'hardhat/types/config' {
+    interface HttpNetworkUserConfig {
+        silentdata?: SilentdataNetworkConfig;
+    }
+    interface HttpNetworkConfig {
+        silentdata?: SilentdataNetworkConfig;
+    }
+}

package/dist/index.d.ts

@@ -0,0 +1,18 @@
+import { SignatureType } from '@appliedblockchain/silentdatarollup-core';
+
+interface SilentdataNetworkConfig {
+    /**
+     * Signature type to use for authentication headers.
+     * If not provided, defaults to SignatureType.Raw.
+     */
+    authSignatureType: SignatureType;
+}
+
+declare module 'hardhat/types/config' {
+    interface HttpNetworkUserConfig {
+        silentdata?: SilentdataNetworkConfig;
+    }
+    interface HttpNetworkConfig {
+        silentdata?: SilentdataNetworkConfig;
+    }
+}

package/dist/index.js

@@ -0,0 +1,147 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+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 __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+
+// src/type-extensions.ts
+var import_config = require("hardhat/types/config");
+
+// src/index.ts
+var import_silentdatarollup_core3 = require("@appliedblockchain/silentdatarollup-core");
+var import_debug2 = __toESM(require("debug"));
+var import_ethers = require("ethers");
+var import_config2 = require("hardhat/config");
+
+// src/provider.ts
+var import_silentdatarollup_core2 = require("@appliedblockchain/silentdatarollup-core");
+var import_debug = __toESM(require("debug"));
+var import_plugins = require("hardhat/plugins");
+
+// src/constants.ts
+var import_silentdatarollup_core = require("@appliedblockchain/silentdatarollup-core");
+var SIGN_RPC_METHODS = [...import_silentdatarollup_core.SIGN_RPC_METHODS, "eth_call"];
+
+// src/provider.ts
+var log = (0, import_debug.default)(import_silentdatarollup_core2.DEBUG_NAMESPACE);
+var HardhatSilentDataRollupProvider = class extends import_plugins.ProviderWrapper {
+  constructor(signer, _wrappedProvider, config) {
+    super(_wrappedProvider);
+    this._wrappedProvider = _wrappedProvider;
+    this.signer = signer;
+    this.config = {
+      ...config,
+      authSignatureType: config?.authSignatureType ?? import_silentdatarollup_core2.SignatureType.Raw
+    };
+    log("HardhatSilentDataRollupProvider initialized");
+  }
+  async request(args) {
+    log("Request: %s", args);
+    const requiresAuthHeaders = SIGN_RPC_METHODS.includes(args.method);
+    if (requiresAuthHeaders) {
+      log("Requesting auth headers for method: %s", args.method);
+      const clonedProvider = this.cloneWrappedProvider();
+      const rpcRequest = clonedProvider._getJsonRpcRequest(
+        args.method,
+        args.params
+      );
+      clonedProvider._extraHeaders = await this.getAuthHeaders(rpcRequest);
+      return clonedProvider.request(args);
+    }
+    log("Forwarding request to wrapped provider");
+    return this._wrappedProvider.request(args);
+  }
+  /**
+   * Creates a clone of the wrapped provider with a modified _getJsonRpcRequest method.
+   *
+   * This method is necessary due to the way the wrapped provider handles headers.
+   * The original provider uses a shared _extraHeaders property, which can lead to race conditions
+   * in concurrent calls, potentially resulting in requests with incorrect headers.
+   *
+   * By cloning the provider and assigning a unique ID to each request, we ensure that:
+   * 1. Each request uses its own set of headers
+   * 2. Concurrent calls don't interfere with each other's header information
+   *
+   * This approach effectively prevents race conditions and ensures the integrity of each request's headers.
+   */
+  cloneWrappedProvider() {
+    const clonedProvider = Object.create(
+      Object.getPrototypeOf(this._wrappedProvider),
+      Object.getOwnPropertyDescriptors(this._wrappedProvider)
+    );
+    const payloadId = Math.floor(Math.random() * 1e10);
+    clonedProvider._getJsonRpcRequest = (method, params = []) => {
+      return {
+        jsonrpc: "2.0",
+        method,
+        params,
+        id: payloadId
+      };
+    };
+    return clonedProvider;
+  }
+  async getAuthHeaders(request) {
+    log("Getting auth headers for request", JSON.stringify(request, null, 2));
+    const headers = await (0, import_silentdatarollup_core2.getAuthHeaders)(
+      this.signer,
+      request,
+      this.config.authSignatureType
+    );
+    log("Auth headers generated successfully", headers);
+    return headers;
+  }
+};
+
+// src/index.ts
+var log2 = (0, import_debug2.default)(import_silentdatarollup_core3.DEBUG_NAMESPACE);
+(0, import_config2.extendProvider)(
+  async (provider, config, network) => {
+    const networkConfig = config.networks[network];
+    const httpNetworkConfig = networkConfig;
+    if (!httpNetworkConfig.silentdata) {
+      log2(
+        "SilentData configuration not found. Returning the original provider."
+      );
+      return provider;
+    }
+    if (!("url" in networkConfig)) {
+      throw new Error("Network config is not an HTTP network");
+    }
+    const accounts = httpNetworkConfig.accounts;
+    if (!Array.isArray(accounts) || accounts.length === 0) {
+      throw new Error("No accounts found in network config");
+    }
+    if (accounts.length > 1) {
+      throw new Error("Multiple accounts not supported");
+    }
+    const account = accounts[0];
+    if (typeof account !== "string") {
+      throw new Error("Account is not a private key string");
+    }
+    const signer = new import_ethers.Wallet(account);
+    const newProvider = new HardhatSilentDataRollupProvider(
+      signer,
+      provider,
+      httpNetworkConfig.silentdata
+    );
+    return newProvider;
+  }
+);

package/dist/index.mjs

@@ -0,0 +1,127 @@
+// src/type-extensions.ts
+import "hardhat/types/config";
+
+// src/index.ts
+import { DEBUG_NAMESPACE as DEBUG_NAMESPACE2 } from "@appliedblockchain/silentdatarollup-core";
+import debug2 from "debug";
+import { Wallet } from "ethers";
+import { extendProvider } from "hardhat/config";
+
+// src/provider.ts
+import {
+  DEBUG_NAMESPACE,
+  getAuthHeaders,
+  SignatureType
+} from "@appliedblockchain/silentdatarollup-core";
+import debug from "debug";
+import { ProviderWrapper } from "hardhat/plugins";
+
+// src/constants.ts
+import { SIGN_RPC_METHODS as CORE_SIGN_RPC_METHODS } from "@appliedblockchain/silentdatarollup-core";
+var SIGN_RPC_METHODS = [...CORE_SIGN_RPC_METHODS, "eth_call"];
+
+// src/provider.ts
+var log = debug(DEBUG_NAMESPACE);
+var HardhatSilentDataRollupProvider = class extends ProviderWrapper {
+  constructor(signer, _wrappedProvider, config) {
+    super(_wrappedProvider);
+    this._wrappedProvider = _wrappedProvider;
+    this.signer = signer;
+    this.config = {
+      ...config,
+      authSignatureType: config?.authSignatureType ?? SignatureType.Raw
+    };
+    log("HardhatSilentDataRollupProvider initialized");
+  }
+  async request(args) {
+    log("Request: %s", args);
+    const requiresAuthHeaders = SIGN_RPC_METHODS.includes(args.method);
+    if (requiresAuthHeaders) {
+      log("Requesting auth headers for method: %s", args.method);
+      const clonedProvider = this.cloneWrappedProvider();
+      const rpcRequest = clonedProvider._getJsonRpcRequest(
+        args.method,
+        args.params
+      );
+      clonedProvider._extraHeaders = await this.getAuthHeaders(rpcRequest);
+      return clonedProvider.request(args);
+    }
+    log("Forwarding request to wrapped provider");
+    return this._wrappedProvider.request(args);
+  }
+  /**
+   * Creates a clone of the wrapped provider with a modified _getJsonRpcRequest method.
+   *
+   * This method is necessary due to the way the wrapped provider handles headers.
+   * The original provider uses a shared _extraHeaders property, which can lead to race conditions
+   * in concurrent calls, potentially resulting in requests with incorrect headers.
+   *
+   * By cloning the provider and assigning a unique ID to each request, we ensure that:
+   * 1. Each request uses its own set of headers
+   * 2. Concurrent calls don't interfere with each other's header information
+   *
+   * This approach effectively prevents race conditions and ensures the integrity of each request's headers.
+   */
+  cloneWrappedProvider() {
+    const clonedProvider = Object.create(
+      Object.getPrototypeOf(this._wrappedProvider),
+      Object.getOwnPropertyDescriptors(this._wrappedProvider)
+    );
+    const payloadId = Math.floor(Math.random() * 1e10);
+    clonedProvider._getJsonRpcRequest = (method, params = []) => {
+      return {
+        jsonrpc: "2.0",
+        method,
+        params,
+        id: payloadId
+      };
+    };
+    return clonedProvider;
+  }
+  async getAuthHeaders(request) {
+    log("Getting auth headers for request", JSON.stringify(request, null, 2));
+    const headers = await getAuthHeaders(
+      this.signer,
+      request,
+      this.config.authSignatureType
+    );
+    log("Auth headers generated successfully", headers);
+    return headers;
+  }
+};
+
+// src/index.ts
+var log2 = debug2(DEBUG_NAMESPACE2);
+extendProvider(
+  async (provider, config, network) => {
+    const networkConfig = config.networks[network];
+    const httpNetworkConfig = networkConfig;
+    if (!httpNetworkConfig.silentdata) {
+      log2(
+        "SilentData configuration not found. Returning the original provider."
+      );
+      return provider;
+    }
+    if (!("url" in networkConfig)) {
+      throw new Error("Network config is not an HTTP network");
+    }
+    const accounts = httpNetworkConfig.accounts;
+    if (!Array.isArray(accounts) || accounts.length === 0) {
+      throw new Error("No accounts found in network config");
+    }
+    if (accounts.length > 1) {
+      throw new Error("Multiple accounts not supported");
+    }
+    const account = accounts[0];
+    if (typeof account !== "string") {
+      throw new Error("Account is not a private key string");
+    }
+    const signer = new Wallet(account);
+    const newProvider = new HardhatSilentDataRollupProvider(
+      signer,
+      provider,
+      httpNetworkConfig.silentdata
+    );
+    return newProvider;
+  }
+);

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@appliedblockchain/silentdatarollup-hardhat-plugin",
+  "version": "1.0.0",
+  "description": "Hardhat plugin for Silent Data [Rollup]",
+  "author": "Applied Blockchain",
+  "homepage": "https://github.com/appliedblockchain/silent-data-rollup-providers#readme",
+  "keywords": [
+    "ethereum",
+    "provider",
+    "silentdata",
+    "rollup",
+    "hardhat"
+  ],
+  "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"
+  },
+  "dependencies": {
+    "@appliedblockchain/silentdatarollup-core": "1.0.0",
+    "@nomicfoundation/hardhat-ethers": "3.0.8",
+    "debug": "4.3.7",
+    "ethers": "6.13.2"
+  },
+  "devDependencies": {
+    "@types/debug": "4.1.12",
+    "@types/node": "22.5.4",
+    "hardhat": "2.22.10",
+    "ts-node": "10.9.2",
+    "typescript": "5.6.2"
+  },
+  "peerDependencies": {
+    "ethers": "6.13.2",
+    "hardhat": "2.22.10"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}