Skip to content

Commit 52beaf8

Browse files
committed
Use proper markdown heading syntax instead of emphasis
1 parent 91868cf commit 52beaf8

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# EVM Gateway
44

5-
**EVM Gateway enables seamless interaction with EVM on Flow, mirroring the experience of engaging with any other EVM blockchain.**
5+
## EVM Gateway enables seamless interaction with EVM on Flow, mirroring the experience of engaging with any other EVM blockchain
66

77
EVM Gateway implements the Ethereum JSON-RPC API for [EVM on Flow](https://developers.flow.com/evm/about) which conforms to the Ethereum [JSON-RPC specification](https://ethereum.github.io/execution-apis/api-documentation/). The EVM Gateway is tailored for integration with the EVM environment on the Flow blockchain. Rather than implementing the full `geth` stack, the JSON-RPC API available in EVM Gateway is a lightweight implementation that uses Flow's underlying consensus and smart contract language, [Cadence](https://cadence-lang.org/docs/), to handle calls received by the EVM Gateway. For those interested in the underlying implementation details, please refer to the [FLIP #243](https://github.com/onflow/flips/issues/243) (EVM Gateway) and [FLIP #223](https://github.com/onflow/flips/issues/223) (EVM on Flow Core) improvement proposals.
88

@@ -23,7 +23,7 @@ The basic design of the EVM Gateway is as follows:
2323

2424
# Building
2525

26-
**Build from source**
26+
## Build from source
2727

2828
```bash
2929
# Make sure you pull the latest changes before running `make build`
@@ -76,7 +76,7 @@ It is acceptable to create a single Cadence account for the COA and use the EVM
7676

7777
For local development, first install [Flow CLI](https://developers.flow.com/tools/flow-cli/install). The examples below require no configuration and are intended for local development.
7878

79-
**Run from CLI**
79+
### Run from CLI
8080

8181
Before running the gateway locally you need to start the Flow Emulator:
8282

@@ -96,7 +96,7 @@ make start-local
9696
Note that the gateway will be starting from the latest emulator block, so if the emulator is run before any transactions happen in the meantime, the gateway will not fetch those historical blocks & transactions.
9797
This will be improved soon.
9898

99-
**Run with Docker**
99+
### Run with Docker
100100

101101
Using Docker for local development is also supported. The following target builds the current source directory into a docker image
102102

@@ -108,7 +108,7 @@ This target starts the flow emulator and then runs the EVM Gateway using the ima
108108
make docker-run-local
109109
```
110110

111-
**Verify**
111+
## Verify
112112

113113
To verify the service is up and running:
114114

@@ -131,7 +131,7 @@ it should return:
131131
Running against the testnet with a local build can be done by pointing the gateway to the testnet ANs and providing the correct configuration.
132132
Please refer to the configuration section and read through all the configuration flags before proceeding.
133133

134-
**Create Flow account to use for COA**
134+
### Create Flow account to use for COA
135135

136136
If you don't already have a Flow account you will need to create account keys using the following command.
137137

@@ -153,7 +153,7 @@ Signature Algorithm ECDSA_P256
153153
Then visit https://faucet.flow.com/, and use the generated `Public Key`, to create and fund your Flow testnet account.
154154
Make sure to use the Flow address and the `Private Key` for the `--coa-address` & `--coa-key` flags.
155155

156-
**Run EVM Gateway connected to Testnet**
156+
### Run EVM Gateway connected to Testnet
157157

158158
Below is an example configuration for running against testnet, with a preconfigured testnet account.
159159

@@ -191,7 +191,7 @@ Should return a response similar to:
191191
}
192192
```
193193

194-
**Run local EVM GW docker container connected to Testnet**
194+
### Run local EVM GW docker container connected to Testnet
195195

196196
To use the `make` target to connect a container based gateway instance to testnet requires the following environment variables to be set.
197197

@@ -294,14 +294,14 @@ To connect using Websockets you can use the same DNS names as above but change `
294294
# JSON-RPC API
295295
The EVM Gateway implements APIs according to the Ethereum specification: https://ethereum.org/en/developers/docs/apis/json-rpc/#json-rpc-methods.
296296

297-
**Additional APIs**
297+
## Additional APIs
298298
- Tracing APIs allows you to fetch execution traces
299299
* `debug_traceTransaction`
300300
* `debug_traceBlockByNumber`
301301
* `debug_traceBlockByHash`
302302
- `debug_flowHeightByBlock` - returns the flow block height for the given EVM block (id or height)
303303

304-
**Unsupported APIs**
304+
## Unsupported APIs
305305
- Wallet APIs: we don't officially support wallet APIs (`eth_accounts`, `eth_sign`, `eth_signTransaction`, `eth_sendTransaction`) due to security
306306
concerns that come with managing the keys on production environments, however, it is possible to configure the gateway to allow these
307307
methods for local development by using a special flag `--wallet-api-key`.

0 commit comments

Comments
 (0)