Skip to content

Commit

Permalink
Rough draft complete
Browse files Browse the repository at this point in the history
  • Loading branch information
Olshansk committed Dec 11, 2023
1 parent 2720509 commit f95e18d
Show file tree
Hide file tree
Showing 4 changed files with 41 additions and 3 deletions.
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -77,3 +77,7 @@ go.work.sum

# TODO_TECHDEBT: It seems that .dot files come and go so we need to figure out the root cause: https://github.com/pokt-network/poktroll/pull/177/files#r1392521547
# **/*.dot

# Quickstart helpers
shannon_appgate_config.yaml
shannon_app_config.yaml
5 changes: 5 additions & 0 deletions docusaurus/docs/architecture/network.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ sidebar_position: 1

# Pocket Nodes in the Celestia Network <!-- omit in toc -->

:::danger
TODO(@Olshansk): This file was copied over from the `poktroll-alpha` repo and has
not been updated to reflect recent changse & learnings.
:::

- [Dependant Node](#dependant-node)
- [Sovereign Node](#sovereign-node)

Expand Down
33 changes: 32 additions & 1 deletion docusaurus/docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ This is related to some techdebt(#180) that will be fixed soon.
If you look in `localnet/poktrolld/config/appgate_server_config.yaml`, you'll find
the configurations for an appgate server that is listening on port `42069`.

Afterwards, you can send a relay to the `anvil` service (i.e. locally running
You can send a relay to the `anvil` service (i.e. locally running
ethereum node) like so:

```bash
Expand All @@ -197,11 +197,38 @@ If everything worked as expected, you should see output similar to the following

### Send a relay a shannon

:::danger
TODO(@Olshansk, @red-0ne, @okdas): This part is still a WIP and the last sentence
will likely throw an error.
:::

However, the appgate server above is not configured to sign relays on behalf of Shannon.

To do so, you'll need to create a similar configuration like so:

```yaml
cat <<EOF >> shannon_appgate_config.yaml
self_signing: true
signing_key: shannon
listening_endpoint: http://localhost:42042
query_node_url: tcp://127.0.0.1:36657
EOF
```

And the start the appgate server locally:

```bash
poktrolld --home=./localnet/poktrolld appgate-server \
--config shannon_appgate_config.yaml --keyring-backend test \
--node tcp://127.0.0.1:36657
```

Repeat sending the relay to the new port:

```bash
curl -X POST -H "Content-Type: application/json" \
--data '{"jsonrpc":"2.0","method":"eth_blockNumber","params":[],"id":1}' \
http://localhost:42042/anvil
```

## Explore the tools
Expand Down Expand Up @@ -232,3 +259,7 @@ improve our development experience.
### Ignite

Run `ignite --help` in order to explore all the different commands.

```

```
2 changes: 0 additions & 2 deletions shannon_app_config.yaml

This file was deleted.

0 comments on commit f95e18d

Please sign in to comment.