Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
avilagaston9 committed Aug 9, 2024
1 parent 2d2e77d commit 206dee6
Showing 1 changed file with 23 additions and 2 deletions.
25 changes: 23 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,8 @@ Some public endpoints can be found in [eth-clients.github.io/checkpoint-sync-end
> The data retrieved from the URL is stored in the DB once the node is initiated (i.e. the iex prompt shows).
> Once this happens, following runs of `make iex` will start the node using that data.
### Beacon API
### APIs
#### Beacon API

You can start the application with the Beacon API on the default port `4000` running:
```shell
Expand All @@ -100,7 +101,27 @@ make start
You can also specify a port with the "--beacon-api-port" flag:

```shell
iex -S mix run -- --beacon-api --beacon-api-port <your_port_here>
iex -S mix run -- --beacon-api-port <your_port_here>
```
> [!WARNING]
> In case checkpoint-sync is needed, following the instructions above will end immediately with an error (see [Checkpoint Sync](#checkpoint-sync)).
>
#### Key-Manager API

Implemented following the [Ethereum specification](https://ethereum.github.io/keymanager-APIs/#/).

You can start the application with the key manager API on the default port `5000` running:

```shell
iex -S mix run -- --validator-api
```


You can also specify a port with the "--validator-api-port" flag:

```shell
iex -S mix run -- --validator-api-port <your_port_here>
```
> [!WARNING]
> In case checkpoint-sync is needed, following the instructions above will end immediately with an error (see [Checkpoint Sync](#checkpoint-sync)).
Expand Down

0 comments on commit 206dee6

Please sign in to comment.