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.

Sign up for GitHub

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

Update doc to emphasize address usage #44

Merged
merged 1 commit into from
Aug 7, 2024
Merged

Update doc to emphasize address usage #44

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,13 +150,16 @@ The `tool` binary currently supports a few helper commands:
Below describes the steps to deploy a gas pool service:

1. Get a sponsor address keypair, either by generating it manually if you want to use in-memory signer, or get a KMS
instance from some cloud providers (or implement your own).
instance from some cloud providers (or implement your own). Note that the **gas pool must use a dedicated address**,
and
this address cannot be used for any other purpose. Otherwise transactions sent outside of the gas pool could mess up
the gas coin setup.
2. Send a sufficiently funded SUI coin into that address. This will be the initial funding of the gas pool.
3. Deploy a Redis instance.
4. Create a YAML config file (see details below).
5. Pick a secure secret token for the RPC server, this will be passed through the `GAS_STATION_AUTH` environment
variable when starting the gas pool server.
5. Deploy the gas pool server.
6. Deploy the gas pool server.

To create a YAML config file, you can use the following command to generate a sample config:

Expand Down