/ic-eth-rpc

Interact with EVM blockchains from the Internet Computer.

Primary LanguageRustApache License 2.0Apache-2.0

EVM RPC  GitHub license PRs Welcome

Interact with EVM blockchains from the Internet Computer.


This project is currently under active development. The canister interface may change unexpectedly, and the codebase has not yet undergone a comprehensive security audit. We will continue updating this message to reflect the current status of this repository.

Thank you for your interest! Please feel free to submit an issue if you would like to request a feature, report a bug, or start a conversation about the EVM RPC canister.

Overview

EVM RPC is an Internet Computer canister smart contract for communicating with Ethereum and other EVM blockchains using an on-chain API.

This canister facilitates API requests to JSON-RPC services such as CloudFlare, Alchemy, Ankr, or BlockPI using HTTPS outcalls. This enables functionality similar to traditional Ethereum dApps, including querying Ethereum smart contract states and submitting raw transactions.

Beyond the Ethereum blockchain, this canister also supports Polygon, Avalanche, and other popular EVM networks. Check out this webpage for a list of all supported networks and RPC providers.

Canisters

Quick Start

Add the following to your dfx.json config file (replace the ic principal with any option from the list of available canisters above):

{
  "canisters": {
    "evm_rpc": {
      "type": "custom",
      "candid": "https://github.com/internet-computer-protocol/ic-eth-rpc/releases/latest/download/evm_rpc.did",
      "wasm": "https://github.com/internet-computer-protocol/ic-eth-rpc/releases/latest/download/evm_rpc_dev.wasm.gz",
      "remote": {
        "id": {
          "ic": "a6d44-nyaaa-aaaap-abp7q-cai"
        }
      }
    }
  }
}

Run the following commands to run the canister in your local environment:

# Start the local replica
dfx start --background

# Deploy the `evm_rpc` canister
dfx deploy evm_rpc

# Call the `eth_gasPrice` JSON-RPC method
dfx canister call evm_rpc request '(variant {Url="https://cloudflare-eth.com/v1/mainnet"}, "{\"jsonrpc\":\"2.0\",\"method\":\"eth_gasPrice\",\"params\":[],\"id\":1}", 1000)' --wallet $(dfx identity get-wallet) --with-cycles 600000000

Examples

JSON-RPC (IC mainnet)

dfx canister call evm_rpc --network ic --wallet $(dfx identity --network ic get-wallet) --with-cycles 600000000 request '(variant {Chain=0x1},"{\"jsonrpc\":\"2.0\",\"method\":\"eth_gasPrice\",\"params\":[],\"id\":1}",1000)'

JSON-RPC (local replica)

# Use a custom provider
dfx canister call evm_rpc --wallet $(dfx identity get-wallet) --with-cycles 600000000 request '(variant {Url="https://cloudflare-eth.com"},"{\"jsonrpc\":\"2.0\",\"method\":\"eth_gasPrice\",\"params\":[],\"id\":1}",1000)'
dfx canister call evm_rpc --wallet $(dfx identity get-wallet) --with-cycles 600000000 request '(variant {Url="https://ethereum.publicnode.com"},"{\"jsonrpc\":\"2.0\",\"method\":\"eth_gasPrice\",\"params\":[],\"id\":1}",1000)'

# Register your own provider
dfx canister call evm_rpc register_provider '(record { chain_id=1; base_url="https://cloudflare-eth.com"; credential_path="/v1/mainnet"; cycles_per_call=10; cycles_per_message_byte=1; })'

# Use a specific EVM chain
dfx canister call evm_rpc --wallet $(dfx identity get-wallet) --with-cycles 600000000 request '(variant {Chain=0x1},"{\"jsonrpc\":\"2.0\",\"method\":\"eth_gasPrice\",\"params\":[],\"id\":1}",1000)'

Authorization (local replica)

PRINCIPAL=$(dfx identity get-principal)
dfx canister call evm_rpc authorize "(principal \"$PRINCIPAL\", variant { RegisterProvider })"
dfx canister call evm_rpc get_authorized '(variant { RegisterProvider })'
dfx canister call evm_rpc deauthorize "(principal \"$PRINCIPAL\", variant { RegisterProvider })"

Contributing

Contributions are welcome! Please check out the contributor guidelines for more information.

Run the following commands to set up a local development environment:

# Clone the repository and install dependencies
git clone https://github.com/internet-computer-protocol/ic-eth-rpc
cd ic-eth-rpc
npm install

# Deploy to the local replica
dfx start --background
npm run generate
dfx deploy evm_rpc

Regenerate language bindings with the generate npm script:

npm run generate

Learn More

Related Projects

  • IC 🔗 ETH: a full-stack starter project for calling Ethereum smart contracts from an IC dApp.
  • Bitcoin canister: interact with the Bitcoin blockchain from the Internet Computer.