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.

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

Enable examples on public networks #26

Merged
merged 3 commits into from Jan 22, 2024

Conversation

ferranbt
Copy link
Contributor

@ferranbt ferranbt commented Jan 11, 2024

This PR modifies the framework so that the examples can be run on public networks. The configuration parameters (rpc endpoints, funded private keys) can be set with env variables. By default, if nothing is set, the parameters are hardcoded with values from the local devnet.
The env variables are:

  • KETTLE_PRIVKEY: Funded private key in the Suave network.
  • KETTLE_RPC: Rpc of the kettle. (i.e. https://rpc.rigil.suave.flashbots.net).
  • L1_PRIVKEY: Funded private key for the suave-enabled node network.
  • L1_RPC: Rpc of the suave-enabled node (i.e. http://goerli.rigil.suave.flashbots.net:8545)
  • RELAYER_URL: Url of the relayer to send bundles. (i.e. https://relay-goerli.flashbots.net). This is only required for the app-ofa-example.

Requires flashbots/suave-geth#159

@dmarzzz
Copy link
Contributor

dmarzzz commented Jan 11, 2024

can we change RELAYER_URL to BUILDER_URL? That is more inline with how people use the term. It was original called the bundle relay pre POS but now people send directly to "builders"

@andytudhope
Copy link
Collaborator

Could we include a .env.example file for people to copy and work from easily?

@@ -10,7 +9,8 @@ User transactions are stored in the confidential datastore and only a small hint
Run `Suave` in development mode:

```
$ suave --suave.dev
$ cd ../..
$ docker-compose up
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

switch back to docker compose? which directory is ../.. supposed to be?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, we use docker compose to enable the Suave<>L1 integration. The ../.. directory is supposed to mean the root directory of suapp-examples.

@ferranbt ferranbt merged commit 4c8d0f5 into main Jan 22, 2024
2 checks passed
@ferranbt ferranbt deleted the feature/run-examples-on-public-networks branch January 22, 2024 21:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants