feat: add provider to edr_napi (#4578)

Author: Wodann

.github/workflows/edr-npm-release.yml

@@ -89,7 +89,7 @@ jobs:
     runs-on: ${{ matrix.settings.host }}
     defaults:
       run:
-        working-directory: ./crates/edr_evm_napi
+        working-directory: ./crates/edr_napi
     steps:
       - uses: actions/checkout@v3
       - name: Setup node
@@ -144,7 +144,7 @@ jobs:
         if: ${{ matrix.settings.docker }}
         with:
           image: ${{ matrix.settings.docker }}
-          options: "--user 0:0 -v ${{ github.workspace }}/.cargo-cache/git/db:/usr/local/cargo/git/db -v ${{ github.workspace }}/.cargo/registry/cache:/usr/local/cargo/registry/cache -v ${{ github.workspace }}/.cargo/registry/index:/usr/local/cargo/registry/index -v ${{ github.workspace }}:/build -w /build/crates/edr_evm_napi"
+          options: "--user 0:0 -v ${{ github.workspace }}/.cargo-cache/git/db:/usr/local/cargo/git/db -v ${{ github.workspace }}/.cargo/registry/cache:/usr/local/cargo/registry/cache -v ${{ github.workspace }}/.cargo/registry/index:/usr/local/cargo/registry/index -v ${{ github.workspace }}:/build -w /build/crates/edr_napi"
           run: ${{ matrix.settings.build }}
       - name: Build
         run: ${{ matrix.settings.build }}
@@ -156,7 +156,7 @@ jobs:
           name: bindings-${{ matrix.settings.target }}
           # The upload artifact action doesn't respect the working directory setting. Unclear if this is a bug or not
           # https://github.com/actions/upload-artifact/issues/294
-          path: ./crates/edr_evm_napi/${{ env.APP_NAME }}.*.node
+          path: ./crates/edr_napi/${{ env.APP_NAME }}.*.node
           if-no-files-found: error
   test-macOS-windows-binding:
     name: Test bindings on ${{ matrix.settings.target }} - node@${{ matrix.node }}
@@ -176,7 +176,7 @@ jobs:
     runs-on: ${{ matrix.settings.host }}
     defaults:
       run:
-        working-directory: ./crates/edr_evm_napi
+        working-directory: ./crates/edr_napi
     steps:
       - uses: actions/checkout@v3
       - name: Setup node
@@ -191,7 +191,7 @@ jobs:
         uses: actions/download-artifact@v3
         with:
           name: bindings-${{ matrix.settings.target }}
-          path: ./crates/edr_evm_napi/
+          path: ./crates/edr_napi/
       - name: List packages
         run: ls -R .
         shell: bash
@@ -222,12 +222,12 @@ jobs:
         uses: actions/download-artifact@v3
         with:
           name: bindings-x86_64-unknown-linux-gnu
-          path: ./crates/edr_evm_napi/
+          path: ./crates/edr_napi/
       - name: List packages
         run: ls -R .
         shell: bash
       - name: Test bindings
-        run: docker run --rm -v $(pwd):/build -w /build/crates/edr_evm_napi node:${{ matrix.node }}-slim yarn test
+        run: docker run --rm -v $(pwd):/build -w /build/crates/edr_napi node:${{ matrix.node }}-slim yarn test
   test-linux-x64-musl-binding:
     name: Test bindings on x86_64-unknown-linux-musl - node@${{ matrix.node }}
     needs:
@@ -255,12 +255,12 @@ jobs:
         uses: actions/download-artifact@v3
         with:
           name: bindings-x86_64-unknown-linux-musl
-          path: ./crates/edr_evm_napi/
+          path: ./crates/edr_napi/
       - name: List packages
         run: ls -R .
         shell: bash
       - name: Test bindings
-        run: docker run --rm -v $(pwd):/build -w /build/crates/edr_evm_napi node:${{ matrix.node }}-alpine yarn test
+        run: docker run --rm -v $(pwd):/build -w /build/crates/edr_napi node:${{ matrix.node }}-alpine yarn test
   test-linux-aarch64-gnu-binding:
     name: Test bindings on aarch64-unknown-linux-gnu - node@${{ matrix.node }}
     needs:
@@ -278,7 +278,7 @@ jobs:
         uses: actions/download-artifact@v3
         with:
           name: bindings-aarch64-unknown-linux-gnu
-          path: ./crates/edr_evm_napi/
+          path: ./crates/edr_napi/
       - name: List packages
         run: ls -R .
         shell: bash
@@ -296,7 +296,7 @@ jobs:
         uses: addnab/docker-run-action@v3
         with:
           image: node:${{ matrix.node }}-slim
-          options: "--platform linux/arm64 -v ${{ github.workspace }}:/build -w /build/crates/edr_evm_napi"
+          options: "--platform linux/arm64 -v ${{ github.workspace }}:/build -w /build/crates/edr_napi"
           run: |
             set -e
             yarn test
@@ -312,7 +312,7 @@ jobs:
         uses: actions/download-artifact@v3
         with:
           name: bindings-aarch64-unknown-linux-musl
-          path: ./crates/edr_evm_napi/
+          path: ./crates/edr_napi/
       - name: List packages
         run: ls -R .
         shell: bash
@@ -330,7 +330,7 @@ jobs:
         uses: addnab/docker-run-action@v3
         with:
           image: node:lts-alpine
-          options: "--platform linux/arm64 -v ${{ github.workspace }}:/build -w /build/crates/edr_evm_napi"
+          options: "--platform linux/arm64 -v ${{ github.workspace }}:/build -w /build/crates/edr_napi"
           run: |
             set -e
             yarn test
@@ -370,7 +370,7 @@ jobs:
     if: ${{ needs.check_commit.outputs.match == 'true' }}
     defaults:
       run:
-        working-directory: ./crates/edr_evm_napi
+        working-directory: ./crates/edr_napi
     steps:
       - uses: actions/checkout@v3
       - name: Setup node
@@ -384,7 +384,7 @@ jobs:
       - name: Download all artifacts
         uses: actions/download-artifact@v3
         with:
-          path: ./crates/edr_evm_napi/artifacts
+          path: ./crates/edr_napi/artifacts
       - name: Move artifacts
         run: yarn artifacts
       - name: List packages

.github/workflows/hardhat-core-ci.yml

@@ -188,7 +188,7 @@ jobs:
             RUSTFLAGS: "-Dwarnings -Ctarget-feature=+crt-static"
     defaults:
       run:
-        working-directory: crates/edr_evm_napi
+        working-directory: crates/edr_napi
     steps:
       - uses: actions/checkout@v3
 

Cargo.lock

@@ -1,5 +1,5 @@
 [package]
-name = "edr_evm_napi"
+name = "edr_napi"
 version = "0.2.0-dev"
 edition = "2021"
 
@@ -17,6 +17,8 @@ napi-derive = "2.12.3"
 edr_defaults = { version = "0.2.0-dev", path = "../edr_defaults" }
 edr_evm = { version = "0.2.0-dev", path = "../edr_evm" }
 edr_eth = { version = "0.2.0-dev", path = "../edr_eth" }
+edr_provider = { version = "0.2.0-dev", path = "../edr_provider" }
+edr_rpc_hardhat = {version = "0.2.0-dev", path = "../edr_rpc_hardhat" }
 serde_json = { version = "1.0.85", default-features = false, features = ["alloc"] }
 tracing = { version = "0.1.37", default-features = false, features = ["std"] }
 tracing-flame = { version = "0.2.0", default-features = false, features = ["smallvec"] }

book/src/02_development/03_local_release.md

@@ -223,6 +223,49 @@ export const enum MineOrdering {
 }
 /** Mines a block using as many transactions as can fit in it. */
 export function mineBlock(blockchain: Blockchain, stateManager: State, memPool: MemPool, config: ConfigOptions, timestamp: bigint, beneficiary: Buffer, minGasPrice: bigint, mineOrdering: MineOrdering, reward: bigint, baseFee?: bigint | undefined | null, prevrandao?: Buffer | undefined | null, tracer?: Tracer | undefined | null): Promise<MineBlockResult>
+/** Configuration for forking a blockchain */
+export interface ForkConfig {
+  /** The URL of the JSON-RPC endpoint to fork from */
+  jsonRpcUrl: string
+  /**
+   * The block number to fork from. If not provided, the latest safe block is
+   * used.
+   */
+  blockNumber?: bigint
+}
+/** Configuration for a provider */
+export interface ProviderConfig {
+  /** Whether to allow blocks with the same timestamp */
+  allowBlocksWithSameTimestamp: boolean
+  /** Whether to allow unlimited contract size */
+  allowUnlimitedContractSize: boolean
+  /** The gas limit of each block */
+  blockGasLimit: bigint
+  /** The directory to cache remote JSON-RPC responses */
+  cacheDir: string
+  /** The chain ID of the blockchain */
+  chainId: bigint
+  /** The address of the coinbase */
+  coinbase: Buffer
+  /**
+   * The configuration for forking a blockchain. If not provided, a local
+   * blockchain will be created
+   */
+  fork?: ForkConfig
+  /** The genesis accounts of the blockchain */
+  genesisAccounts: Array<GenesisAccount>
+  /** The hardfork of the blockchain */
+  hardfork: SpecId
+  /**
+   * The initial base fee per gas of the blockchain. Required for EIP-1559
+   * transactions and later
+   */
+  initialBaseFeePerGas?: bigint
+  /** The initial date of the blockchain, in seconds since the Unix epoch */
+  initialDate?: bigint
+  /** The network ID of the blockchain */
+  networkId: bigint
+}
 /** Executes the provided transaction without changing state. */
 export function dryRun(blockchain: Blockchain, state: State, stateOverrides: StateOverrides, cfg: ConfigOptions, transaction: TransactionRequest, block: BlockConfig, withTrace: boolean, tracer?: Tracer | undefined | null): Promise<TransactionResult>
 /**
@@ -609,6 +652,13 @@ export class MineBlockResult {
   /**Retrieves the transactions' traces. */
   get traces(): Array<Array<TracingMessage | TracingStep | TracingMessageResult>>
 }
+/** A JSON-RPC provider for Ethereum. */
+export class Provider {
+  /**Constructs a new provider with the provided configuration. */
+  static withConfig(config: ProviderConfig): Promise<Provider>
+  /**Handles a JSON-RPC request and returns a JSON-RPC response. */
+  handleRequest(jsonRequest: string): Promise<string>
+}
 export class Receipt {
   /**Returns the hash of the block the receipt is included in. */
   get blockHash(): Buffer

book/src/03_release.md

@@ -252,7 +252,7 @@ if (!nativeBinding) {
   throw new Error(`Failed to load native binding`)
 }
 
-const { BlockBuilder, Block, Blockchain, SpecId, Config, EdrContext, debugTraceTransaction, debugTraceCall, Log, MemPool, MineOrdering, MineBlockResult, mineBlock, Receipt, dryRun, guaranteedDryRun, run, StateOverrides, State, Tracer, OrderedTransaction, PendingTransaction, SuccessReason, ExceptionalHalt, TransactionResult } = nativeBinding
+const { BlockBuilder, Block, Blockchain, SpecId, Config, EdrContext, debugTraceTransaction, debugTraceCall, Log, MemPool, MineOrdering, MineBlockResult, mineBlock, Provider, Receipt, dryRun, guaranteedDryRun, run, StateOverrides, State, Tracer, OrderedTransaction, PendingTransaction, SuccessReason, ExceptionalHalt, TransactionResult } = nativeBinding
 
 module.exports.BlockBuilder = BlockBuilder
 module.exports.Block = Block
@@ -267,6 +267,7 @@ module.exports.MemPool = MemPool
 module.exports.MineOrdering = MineOrdering
 module.exports.MineBlockResult = MineBlockResult
 module.exports.mineBlock = mineBlock
+module.exports.Provider = Provider
 module.exports.Receipt = Receipt
 module.exports.dryRun = dryRun
 module.exports.guaranteedDryRun = guaranteedDryRun

crates/README.md

@@ -1,6 +1,9 @@
 use std::fmt::Debug;
 
-use edr_eth::{signature::secret_key_to_address, Address, Bytes, U256};
+use edr_eth::{
+    signature::{secret_key_from_str, secret_key_to_address},
+    Address, Bytes, U256,
+};
 use edr_evm::{AccountInfo, HashMap, KECCAK_EMPTY};
 use napi::{
     bindgen_prelude::{BigInt, Buffer},
@@ -104,6 +107,20 @@ pub struct GenesisAccount {
     pub balance: BigInt,
 }
 
+impl TryFrom<GenesisAccount> for edr_provider::AccountConfig {
+    type Error = napi::Error;
+
+    fn try_from(value: GenesisAccount) -> Result<Self, Self::Error> {
+        let secret_key = secret_key_from_str(&value.secret_key)
+            .map_err(|e| napi::Error::new(Status::InvalidArg, e.to_string()))?;
+
+        Ok(Self {
+            secret_key,
+            balance: value.balance.try_cast()?,
+        })
+    }
+}
+
 #[cfg_attr(feature = "tracing", tracing::instrument(skip_all))]
 pub fn genesis_accounts(
     accounts: Vec<GenesisAccount>,

crates/edr_evm_napi/.cargo/config.toml crates/edr_napi/.cargo/config.toml

@@ -13,6 +13,7 @@ mod debug_trace;
 mod log;
 mod mempool;
 pub mod miner;
+mod provider;
 mod receipt;
 pub mod runtime;
 mod signature;

crates/edr_evm_napi/.gitignore crates/edr_napi/.gitignore

@@ -0,0 +1,62 @@
+mod config;
+
+use std::sync::Arc;
+
+use napi::{tokio::runtime, Env, JsObject, Status};
+use napi_derive::napi;
+
+use self::config::ProviderConfig;
+
+/// A JSON-RPC provider for Ethereum.
+#[napi]
+pub struct Provider {
+    provider: Arc<edr_provider::Provider>,
+}
+
+#[napi]
+impl Provider {
+    #[doc = "Constructs a new provider with the provided configuration."]
+    #[napi(ts_return_type = "Promise<Provider>")]
+    pub fn with_config(env: Env, config: ProviderConfig) -> napi::Result<JsObject> {
+        let config = edr_provider::ProviderConfig::try_from(config)?;
+        let runtime = runtime::Handle::current();
+
+        let (deferred, promise) = env.create_deferred()?;
+        runtime.clone().spawn(async move {
+            let result = edr_provider::Provider::new(&runtime, &config)
+                .await
+                .map_or_else(
+                    |error| Err(napi::Error::new(Status::GenericFailure, error.to_string())),
+                    |provider| {
+                        Ok(Provider {
+                            provider: Arc::new(provider),
+                        })
+                    },
+                );
+
+            deferred.resolve(|_env| result);
+        });
+
+        Ok(promise)
+    }
+
+    #[doc = "Handles a JSON-RPC request and returns a JSON-RPC response."]
+    #[napi]
+    pub async fn handle_request(&self, json_request: String) -> napi::Result<String> {
+        let request = serde_json::from_str(&json_request).map_err(|error| {
+            napi::Error::new(
+                Status::InvalidArg,
+                format!("Invalid JSON `{json_request}` due to: {error}"),
+            )
+        })?;
+
+        let response = self
+            .provider
+            .handle_request(request)
+            .await
+            .map_err(|e| napi::Error::new(Status::GenericFailure, e.to_string()))?;
+
+        serde_json::to_string(&response)
+            .map_err(|e| napi::Error::new(Status::GenericFailure, e.to_string()))
+    }
+}