Skip to content

Commit

Permalink
Updated the the quickstart guide
Browse files Browse the repository at this point in the history
  • Loading branch information
Olshansk committed Dec 14, 2023
1 parent 2136494 commit b30f4bb
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 30 deletions.
3 changes: 0 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -523,13 +523,10 @@ go_docs: check_godoc ## Generate documentation for the project
openapi_gen: ## Generate the OpenAPI spec for the Ignite API
ignite generate openapi --yes


.PHONY: docusaurus_start
docusaurus_start: ## Start the Docusaurus server
(cd docusaurus && npm run start)



######################
### Ignite Helpers ###
######################
Expand Down
42 changes: 19 additions & 23 deletions docusaurus/docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ title: Quickstart
- [Send a relay](#send-a-relay)
- [Send a relay a shannon](#send-a-relay-a-shannon)
- [Explore the tools](#explore-the-tools)
- [E2E Tests](#e2e-tests)
- [poktrolld](#poktrolld)
- [Makefile](#makefile)
- [Ignite](#ignite)
Expand Down Expand Up @@ -177,7 +178,7 @@ TODO(@red-0ne): Link to the document for all the config files once ready.
:::

We already have a supplier pre-configured (try running `make supplier_list`) to
supply services for anvil (an local ethereum testing node), so we can simply
supply services for `anvil` (an local ethereum testing node), so we can simply
reused that for simplicity.

Next, run the stake command:
Expand Down Expand Up @@ -225,7 +226,7 @@ TODO(@Olshansk, @red-0ne, @okdas): This part is still a WIP and the last sentenc
will likely throw an error.
:::

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

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

Expand All @@ -246,6 +247,12 @@ poktrolld --home=./localnet/poktrolld appgate-server \
--node tcp://127.0.0.1:36657
```

:::warning
You might need to add the following to your `/etc/hosts` file:
127.0.0.1 anvil
127.0.0.1 relayminers
:::

Repeat sending the relay to the new port:

```bash
Expand All @@ -269,6 +276,16 @@ functionality in your day-to-day development. However, knowing of their existenc
will help you when you need to do something that you haven't done before.
:::

### E2E Tests

The `e2e` package contains a collection of end-to-end tests that leverage
[Cucumber & Gherkin](https://cucumber.io/docs/gherkin/). You can execute all of
them with:

```bash
make test_e2e
```

### poktrolld

Run `poktrolld --help` in order to explore all the different. You will likely
Expand All @@ -282,24 +299,3 @@ improve our development experience.
### Ignite

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

```

Things to add:

```
flow: curl (client) -> AppGateServer -> Supplier -> Anvil
defaut: localhost -> k8s -> k8s -> k8s
quickstart: localhost -> localhost -.-> k8s -> k8s
```

1. Update /etc/hosts
127.0.0.1 anvil
127.0.0.1 relayminers


TODO(@okdas): avoid restarting celestia when restarting localnet
TODO(@Olshansk): A script that runs all the things at once
```
9 changes: 5 additions & 4 deletions pkg/relayer/proxy/relay_verifier.go
Original file line number Diff line number Diff line change
Expand Up @@ -94,10 +94,11 @@ func (rp *relayerProxy) VerifyRelayRequest(
}).
Msg("verifying relay request session")

// TODO_IN_THIS_PR: Slow down blocks OR/AND increase numBlocksPerSession AND/OR make the following change:
currentBlock := rp.blockClient.LastNBlocks(ctx, 1)[0]
session, err := rp.sessionQuerier.GetSession(ctx, appAddress, service.Id, currentBlock.Height())
// session, err := rp.sessionQuerier.GetSession(ctx, appAddress, service.Id, relayRequest.Meta.SessionHeader.SessionStartBlockHeight)
// TODO_IN_THIS_PR: Either slow down blocks, or increase numBlocksPerSession,
// or create a ticket related to session rollovers and link to it here.
// currentBlock := rp.blockClient.LastNBlocks(ctx, 1)[0]
// session, err := rp.sessionQuerier.GetSession(ctx, appAddress, service.Id, currentBlock.Height())
session, err := rp.sessionQuerier.GetSession(ctx, appAddress, service.Id, relayRequest.Meta.SessionHeader.SessionStartBlockHeight)

if err != nil {
return err
Expand Down

0 comments on commit b30f4bb

Please sign in to comment.