@appliedblockchain/silentdatarollup-ethers-provider 1.0.0

package/README.md

@@ -0,0 +1,126 @@
+# Silent Data [Rollup] Providers - Ethers Provider 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)
+  - [Usage with a Contract](#usage-with-a-contract)
+    - [Installing Usage with a Contract Dependencies](#installing-usage-with-a-contract-dependencies)
+    - [Usage with a Contract Example](#usage-with-a-contract-example)
+- [Troubleshooting](#troubleshooting)
+- [License](#license)
+- [Additional Resources](#additional-resources)
+
+## Introduction
+
+Custom providers for Silent Data [Rollup], compatible with ethers.js.
+
+## Prerequisites
+
+- Node.js (version 18 or higher)
+- npm
+- Basic knowledge of Ethereum and smart contracts
+- Ethers.js v6
+
+## Integration
+
+### Basic Usage
+
+#### Installing Basic Usage Dependencies
+
+```bash
+npm install @appliedblockchain/silentdatarollup-core @appliedblockchain/silentdatarollup-ethers-provider ethers@6
+```
+
+#### Basic Usage Example
+
+```typescript
+import { NetworkName } from '@appliedblockchain/silentdatarollup-core'
+import {
+  NetworkName,
+  SilentDataRollupProvider,
+} from '@appliedblockchain/silentdatarollup-ethers-provider'
+import { Wallet } from 'ethers'
+
+const providerConfig = {
+  rpcUrl: 'SILENT_DATA_ROLLUP_RPC_URL',
+  network: NetworkName.TESTNET,
+  privateKey: 'YOUR_PRIVATE_KEY',
+}
+
+const provider = new SilentDataRollupProvider(providerConfig)
+
+const balance = await provider.getBalance('YOUR_ADDRESS')
+console.log(balance)
+```
+
+### Usage with a Contract
+
+#### Installing Usage with a Contract Dependencies
+
+```bash
+npm install @appliedblockchain/silentdatarollup-core @appliedblockchain/silentdatarollup-ethers-provider ethers@6
+```
+
+#### Usage with a Contract Example
+
+```typescript
+import {
+  ChainId,
+  SilentDataRollupContract,
+} from '@appliedblockchain/silentdatarollup-core'
+import { SilentDataRollupProvider } from '@appliedblockchain/silentdatarollup-ethers-provider'
+import { ethers } from 'ethers'
+
+const providerConfig = {
+  rpcUrl: 'SILENT_DATA_ROLLUP_RPC_URL',
+  network: NetworkName.TESTNET,
+  privateKey: 'YOUR_PRIVATE_KEY',
+}
+
+const provider = new SilentDataRollupProvider(providerConfig)
+
+const contractAddress = 'YOUR_CONTRACT_ADDRESS'
+const abi = [
+  /* Your contract ABI */
+]
+const methodsToSign = ['method1', 'method2'] // Contract read calls that require signing
+
+const contract = new SilentDataRollupContract(
+  contractAddress,
+  abi,
+  provider,
+  methodsToSign,
+)
+
+// Now you can call "private" contract methods. These calls will be signed,
+// and msg.sender will be available in the contract, representing the signer's address.
+const privateMethodResult = await contract.method1('param1', 'param2')
+console.log('Private method result:', privateMethodResult)
+
+// You can also call methods that don't require signing.
+// These calls won't include a signature, and msg.sender won't be available in the contract.
+const publicMethodResult = await contract.method3('param1', 'param2')
+console.log('Public method result:', publicMethodResult)
+```
+
+## 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)
+- [Ethers.js Documentation](https://docs.ethers.org/v6/)

package/dist/index.d.mts

@@ -0,0 +1,27 @@
+import { Signer, JsonRpcApiProviderOptions, JsonRpcProvider, JsonRpcPayload, JsonRpcResult, FetchRequest } from 'ethers';
+import { BaseConfig, NetworkName } from '@appliedblockchain/silentdatarollup-core';
+
+declare const SIGN_RPC_METHODS: string[];
+
+interface SilentDataRollupProviderConfig extends BaseConfig {
+    rpcUrl: string;
+    network?: NetworkName;
+    chainId?: number;
+    privateKey?: string;
+    signer?: Signer;
+    options?: JsonRpcApiProviderOptions;
+}
+
+declare class SilentDataRollupProvider extends JsonRpcProvider {
+    private config;
+    signer: Signer;
+    private baseProvider;
+    constructor(config: SilentDataRollupProviderConfig);
+    _send(payload: JsonRpcPayload | Array<JsonRpcPayload>): Promise<Array<JsonRpcResult>>;
+    static getRequest({ rpcUrl }: {
+        rpcUrl: string;
+    }): FetchRequest;
+    clone(): SilentDataRollupProvider;
+}
+
+export { SIGN_RPC_METHODS, SilentDataRollupProvider, type SilentDataRollupProviderConfig };

package/dist/index.d.ts

@@ -0,0 +1,27 @@
+import { Signer, JsonRpcApiProviderOptions, JsonRpcProvider, JsonRpcPayload, JsonRpcResult, FetchRequest } from 'ethers';
+import { BaseConfig, NetworkName } from '@appliedblockchain/silentdatarollup-core';
+
+declare const SIGN_RPC_METHODS: string[];
+
+interface SilentDataRollupProviderConfig extends BaseConfig {
+    rpcUrl: string;
+    network?: NetworkName;
+    chainId?: number;
+    privateKey?: string;
+    signer?: Signer;
+    options?: JsonRpcApiProviderOptions;
+}
+
+declare class SilentDataRollupProvider extends JsonRpcProvider {
+    private config;
+    signer: Signer;
+    private baseProvider;
+    constructor(config: SilentDataRollupProviderConfig);
+    _send(payload: JsonRpcPayload | Array<JsonRpcPayload>): Promise<Array<JsonRpcResult>>;
+    static getRequest({ rpcUrl }: {
+        rpcUrl: string;
+    }): FetchRequest;
+    clone(): SilentDataRollupProvider;
+}
+
+export { SIGN_RPC_METHODS, SilentDataRollupProvider, type SilentDataRollupProviderConfig };

package/dist/index.js

@@ -0,0 +1,159 @@
+"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, {
+  SIGN_RPC_METHODS: () => SIGN_RPC_METHODS,
+  SilentDataRollupProvider: () => SilentDataRollupProvider
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/constants.ts
+var SIGN_RPC_METHODS = [
+  "eth_getTransactionByHash",
+  "eth_getBalance",
+  "eth_getTransactionCount",
+  "eth_getProof",
+  "eth_getTransactionReceipt"
+];
+
+// src/provider.ts
+var import_silentdatarollup_core = require("@appliedblockchain/silentdatarollup-core");
+var import_ethers = require("ethers");
+function getNetwork(name, chainId) {
+  switch (name) {
+    case import_silentdatarollup_core.NetworkName.MAINNET:
+      return new import_ethers.Network(name, chainId || import_silentdatarollup_core.ChainId.MAINNET);
+    case import_silentdatarollup_core.NetworkName.TESTNET:
+      return new import_ethers.Network(name, chainId || import_silentdatarollup_core.ChainId.TESTNET);
+    default:
+      (0, import_ethers.assertArgument)(false, "unsupported network", "network", name);
+  }
+}
+var providerDefaultOptions = {
+  batchMaxCount: 1
+};
+var SilentDataRollupProvider = class _SilentDataRollupProvider extends import_ethers.JsonRpcProvider {
+  constructor(config) {
+    if (!config.network) {
+      config.network = import_silentdatarollup_core.NetworkName.MAINNET;
+    }
+    (0, import_ethers.assertArgument)(config.rpcUrl, "rpcUrl is mandatory", "config", config);
+    const network = getNetwork(config.network, config.chainId);
+    const request = _SilentDataRollupProvider.getRequest({
+      rpcUrl: config.rpcUrl
+    });
+    const combinedOptions = {
+      ...providerDefaultOptions,
+      ...config.options
+    };
+    super(request, network, combinedOptions);
+    (0, import_ethers.assertArgument)(
+      config.signer || config.privateKey,
+      "signer or privateKey is mandatory",
+      "config",
+      config
+    );
+    this.baseProvider = new import_silentdatarollup_core.SilentDataRollupBase(config);
+    this.config = config;
+    this.config.authSignatureType = config.authSignatureType || import_silentdatarollup_core.SignatureType.Raw;
+    if (config.signer) {
+      try {
+        this.signer = config.signer.connect(this);
+      } catch {
+        this.signer = config.signer;
+      }
+    } else {
+      const wallet = new import_ethers.Wallet(config.privateKey);
+      this.signer = wallet.connect(this);
+    }
+  }
+  async _send(payload) {
+    if (Array.isArray(payload)) {
+      throw new Error("Batch requests are not currently supported");
+    }
+    if (payload.method === "eth_call" && Array.isArray(payload.params)) {
+      const txParams = payload.params[0];
+      if (typeof txParams === "object" && txParams !== null) {
+        txParams.from = await this.signer.getAddress();
+      }
+    }
+    const request = this._getConnection();
+    request.body = JSON.stringify(payload);
+    request.setHeader("content-type", "application/json");
+    const requiresAuthHeaders = import_silentdatarollup_core.SIGN_RPC_METHODS.includes(payload.method) || (0, import_silentdatarollup_core.isSignableContractCall)(
+      payload,
+      this.baseProvider.contractMethodsToSign,
+      this.baseProvider.contract
+    );
+    if (requiresAuthHeaders) {
+      if (this.config.delegate) {
+        const {
+          [import_silentdatarollup_core.HEADER_DELEGATE]: xDelegate,
+          [import_silentdatarollup_core.HEADER_DELEGATE_SIGNATURE]: xDelegateSignature,
+          [import_silentdatarollup_core.HEADER_EIP712_DELEGATE_SIGNATURE]: xEip712DelegateSignature
+        } = await this.baseProvider.getDelegateHeaders(this);
+        request.setHeader(import_silentdatarollup_core.HEADER_DELEGATE, xDelegate);
+        if (xDelegateSignature) {
+          request.setHeader(import_silentdatarollup_core.HEADER_DELEGATE_SIGNATURE, xDelegateSignature);
+        }
+        if (xEip712DelegateSignature) {
+          request.setHeader(
+            import_silentdatarollup_core.HEADER_EIP712_DELEGATE_SIGNATURE,
+            xEip712DelegateSignature
+          );
+        }
+      }
+      const {
+        [import_silentdatarollup_core.HEADER_TIMESTAMP]: xTimestamp,
+        [import_silentdatarollup_core.HEADER_SIGNATURE]: xSignature,
+        [import_silentdatarollup_core.HEADER_EIP712_SIGNATURE]: xEip712Signature
+      } = await this.baseProvider.getAuthHeaders(this, payload);
+      request.setHeader(import_silentdatarollup_core.HEADER_TIMESTAMP, xTimestamp);
+      if (xSignature) {
+        request.setHeader(import_silentdatarollup_core.HEADER_SIGNATURE, xSignature);
+      }
+      if (xEip712Signature) {
+        request.setHeader(import_silentdatarollup_core.HEADER_EIP712_SIGNATURE, xEip712Signature);
+      }
+    }
+    const response = await request.send();
+    response.assertOk();
+    let resp = response.bodyJson;
+    if (!Array.isArray(resp)) {
+      resp = [resp];
+    }
+    return resp;
+  }
+  static getRequest({ rpcUrl }) {
+    const request = new import_ethers.FetchRequest(rpcUrl);
+    request.allowGzip = true;
+    return request;
+  }
+  clone() {
+    const clonedProvider = new _SilentDataRollupProvider(this.config);
+    return clonedProvider;
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  SIGN_RPC_METHODS,
+  SilentDataRollupProvider
+});

package/dist/index.mjs

@@ -0,0 +1,150 @@
+// src/constants.ts
+var SIGN_RPC_METHODS = [
+  "eth_getTransactionByHash",
+  "eth_getBalance",
+  "eth_getTransactionCount",
+  "eth_getProof",
+  "eth_getTransactionReceipt"
+];
+
+// src/provider.ts
+import {
+  ChainId,
+  HEADER_DELEGATE,
+  HEADER_DELEGATE_SIGNATURE,
+  HEADER_EIP712_DELEGATE_SIGNATURE,
+  HEADER_EIP712_SIGNATURE,
+  HEADER_SIGNATURE,
+  HEADER_TIMESTAMP,
+  isSignableContractCall,
+  NetworkName,
+  SIGN_RPC_METHODS as SIGN_RPC_METHODS2,
+  SignatureType,
+  SilentDataRollupBase
+} from "@appliedblockchain/silentdatarollup-core";
+import {
+  assertArgument,
+  FetchRequest,
+  JsonRpcProvider,
+  Network,
+  Wallet
+} from "ethers";
+function getNetwork(name, chainId) {
+  switch (name) {
+    case NetworkName.MAINNET:
+      return new Network(name, chainId || ChainId.MAINNET);
+    case NetworkName.TESTNET:
+      return new Network(name, chainId || ChainId.TESTNET);
+    default:
+      assertArgument(false, "unsupported network", "network", name);
+  }
+}
+var providerDefaultOptions = {
+  batchMaxCount: 1
+};
+var SilentDataRollupProvider = class _SilentDataRollupProvider extends JsonRpcProvider {
+  constructor(config) {
+    if (!config.network) {
+      config.network = NetworkName.MAINNET;
+    }
+    assertArgument(config.rpcUrl, "rpcUrl is mandatory", "config", config);
+    const network = getNetwork(config.network, config.chainId);
+    const request = _SilentDataRollupProvider.getRequest({
+      rpcUrl: config.rpcUrl
+    });
+    const combinedOptions = {
+      ...providerDefaultOptions,
+      ...config.options
+    };
+    super(request, network, combinedOptions);
+    assertArgument(
+      config.signer || config.privateKey,
+      "signer or privateKey is mandatory",
+      "config",
+      config
+    );
+    this.baseProvider = new SilentDataRollupBase(config);
+    this.config = config;
+    this.config.authSignatureType = config.authSignatureType || SignatureType.Raw;
+    if (config.signer) {
+      try {
+        this.signer = config.signer.connect(this);
+      } catch {
+        this.signer = config.signer;
+      }
+    } else {
+      const wallet = new Wallet(config.privateKey);
+      this.signer = wallet.connect(this);
+    }
+  }
+  async _send(payload) {
+    if (Array.isArray(payload)) {
+      throw new Error("Batch requests are not currently supported");
+    }
+    if (payload.method === "eth_call" && Array.isArray(payload.params)) {
+      const txParams = payload.params[0];
+      if (typeof txParams === "object" && txParams !== null) {
+        txParams.from = await this.signer.getAddress();
+      }
+    }
+    const request = this._getConnection();
+    request.body = JSON.stringify(payload);
+    request.setHeader("content-type", "application/json");
+    const requiresAuthHeaders = SIGN_RPC_METHODS2.includes(payload.method) || isSignableContractCall(
+      payload,
+      this.baseProvider.contractMethodsToSign,
+      this.baseProvider.contract
+    );
+    if (requiresAuthHeaders) {
+      if (this.config.delegate) {
+        const {
+          [HEADER_DELEGATE]: xDelegate,
+          [HEADER_DELEGATE_SIGNATURE]: xDelegateSignature,
+          [HEADER_EIP712_DELEGATE_SIGNATURE]: xEip712DelegateSignature
+        } = await this.baseProvider.getDelegateHeaders(this);
+        request.setHeader(HEADER_DELEGATE, xDelegate);
+        if (xDelegateSignature) {
+          request.setHeader(HEADER_DELEGATE_SIGNATURE, xDelegateSignature);
+        }
+        if (xEip712DelegateSignature) {
+          request.setHeader(
+            HEADER_EIP712_DELEGATE_SIGNATURE,
+            xEip712DelegateSignature
+          );
+        }
+      }
+      const {
+        [HEADER_TIMESTAMP]: xTimestamp,
+        [HEADER_SIGNATURE]: xSignature,
+        [HEADER_EIP712_SIGNATURE]: xEip712Signature
+      } = await this.baseProvider.getAuthHeaders(this, payload);
+      request.setHeader(HEADER_TIMESTAMP, xTimestamp);
+      if (xSignature) {
+        request.setHeader(HEADER_SIGNATURE, xSignature);
+      }
+      if (xEip712Signature) {
+        request.setHeader(HEADER_EIP712_SIGNATURE, xEip712Signature);
+      }
+    }
+    const response = await request.send();
+    response.assertOk();
+    let resp = response.bodyJson;
+    if (!Array.isArray(resp)) {
+      resp = [resp];
+    }
+    return resp;
+  }
+  static getRequest({ rpcUrl }) {
+    const request = new FetchRequest(rpcUrl);
+    request.allowGzip = true;
+    return request;
+  }
+  clone() {
+    const clonedProvider = new _SilentDataRollupProvider(this.config);
+    return clonedProvider;
+  }
+};
+export {
+  SIGN_RPC_METHODS,
+  SilentDataRollupProvider
+};

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@appliedblockchain/silentdatarollup-ethers-provider",
+  "version": "1.0.0",
+  "description": "Ethers.js provider for Silent Data [Rollup]",
+  "author": "Applied Blockchain",
+  "homepage": "https://github.com/appliedblockchain/silent-data-rollup-providers#readme",
+  "keywords": [
+    "ethereum",
+    "provider",
+    "silentdata",
+    "rollup",
+    "ethers"
+  ],
+  "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.0",
+    "ethers": "6.13.2"
+  },
+  "devDependencies": {
+    "@types/node": "22.5.4",
+    "ts-node": "10.9.2",
+    "typescript": "5.6.2"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}