Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update EVM RPC docs for custom Candid-RPC services #2450

Merged
merged 4 commits into from
Feb 12, 2024
Merged

Update EVM RPC docs for custom Candid-RPC services #2450

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fa631f0
Update docs for custom Candid-RPC services
rvanasa Feb 2, 2024
32fd461
Adjust wording
rvanasa Feb 2, 2024
75e96c9
Clarify distinction between Candid-RPC and JSON-RPC
rvanasa Feb 2, 2024
5f80912
Update docs
rvanasa Feb 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 24 additions & 11 deletions docs/developer-docs/integrations/ethereum/evm-rpc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,24 +123,37 @@ To use a specific EVM chain, specify the chain's ID in the `Chain` variant:
dfx canister call evm_rpc --wallet $(dfx identity get-wallet) --with-cycles 100000000 request '(variant {Chain=0x1},"{\"jsonrpc\":\"2.0\",\"method\":\"eth_gasPrice\",\"params\":[],\"id\":1}",1000)'
```

## Specifying an RPC provider
## Specifying RPC services

You can also specify an RPC provider:
There are several ways to use specific JSON-RPC services:

```candid
type JsonRpcSource = variant {
// Used for Candid-RPC canister methods (`eth_getLogs`, `eth_getBlockByNumber`, etc.)
type RpcServices = variant {
EthMainnet : opt vec EthMainnetService;
EthSepolia : opt vec EthSepoliaService;
...
Custom : record {
chainId : nat64;
services : vec record { url : text; headers : opt vec (text, text) };
}
};

// Used for the JSON-RPC `request` canister method
type RpcService = variant {
EthMainnet : EthMainnetService;
EthSepolia : EthSepoliaService;
...
Chain : nat64;
Provider : nat64;
Custom : record { url : text; headers : vec (text, text) };
Custom : record { url : text; headers : opt vec (text, text) };
};
```

Here is an example command to submit an RPC request to the [Arbitrum](https://arbitrum.io/) L2 network:

request : (
source : JsonRpcSource,
jsonRequest : text,
maxResponseBytes : nat64
) -> (
Result<text, RpcError>
);
```bash
dfx canister call evm_rpc eth_getBlockByNumber '(variant {Custom = record {chainId = 42161; services = vec {record {url = "https://1rpc.io/arb"}}}}, null, variant {Latest})' --with-cycles 10000000000 --wallet=$(dfx identity get-wallet)
```

## Registering your own provider
Expand Down
Loading