docs: add guide for aws-kms #2388
Conversation
Summary of ChangesHello @jcstein, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request introduces a new, detailed guide for integrating the 'op-alt-da' data availability server with AWS Key Management Service (KMS). The guide provides step-by-step instructions for both local development using Localstack and production deployment, ensuring secure key management for Celestia keys. To accommodate this new content, the existing 'op-alt-da' documentation has been reorganized, and various project dependencies have been updated to their latest versions. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
|
🚀 Preview Deployment Your preview is ready: https://celestiaorg.github.io/docs-preview/pr-2388/ |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds a new guide for using op-alt-da with AWS KMS, which is a valuable addition to the documentation. The changes also include restructuring the existing op-alt-da documentation into an introduction page. My review focuses on the new guide, with suggestions to improve clarity, consistency, and user-friendliness. Specifically, I've recommended using HTTPS for git cloning, fixing some markdown formatting, and ensuring commands and placeholders are consistent throughout the guide.
| 2. Clone and build op-alt-da ([v0.11.0](https://github.com/celestiaorg/op-alt-da/releases/tag/v0.11.0)+): | ||
|
|
||
| ```bash | ||
| git clone git@github.com:celestiaorg/op-alt-da.git && cd op-alt-da |
There was a problem hiding this comment.
The git clone command uses an SSH URL. While this works for users with SSH keys configured for GitHub, an HTTPS URL is more universally accessible and doesn't require prior setup. It would be more user-friendly to use the HTTPS URL.
git clone https://github.com/celestiaorg/op-alt-da.git && cd op-alt-da
| import_key_hex = "YOUR_EXPORTED_PRIVATE_KEY_HEX" | ||
| ``` | ||
|
|
||
| When you run the DA server with `auto_create = true`, it will automatically create a new key in AWS KMS if it doesn't exist. |
There was a problem hiding this comment.
This explanatory note is indented, which makes it look like part of a code block and can be confusing. For better readability, it should be a regular paragraph without indentation.
When you run the DA server with `auto_create = true`, it will automatically create a new key in AWS KMS if it doesn't exist.
| 1. Run the op-alt-da server: | ||
|
|
||
| ```bash | ||
| AWS_ACCESS_KEY_ID=test AWS_SECRET_ACCESS_KEY=test ./bin/da-server -config config.toml |
There was a problem hiding this comment.
For consistency with other commands in this guide (e.g., line 168), it's good practice to include AWS_DEFAULT_REGION when running AWS-related commands. While it was exported earlier, explicitly including it here makes the command self-contained and less prone to errors if the user's shell session changes.
AWS_ACCESS_KEY_ID=test AWS_SECRET_ACCESS_KEY=test AWS_DEFAULT_REGION=us-east-1 ./bin/da-server -config config.toml
| INFO [01-20|14:54:15.342] Blob submitted successfully commitment=010c74a5940000000000677e645183667f4d9efe506226fd0dd0b70a4144c8fd05c0aa68407ccf886507 size=14 duration=11.5436025s | ||
| ``` | ||
|
|
||
| Check on [Celenium](https://mocha.celenium.io): `https://mocha.celenium.io/address/YOUR_CELESTIA_ADDRESS` |
There was a problem hiding this comment.
The current formatting for checking the transaction on Celenium is a bit confusing, as it presents a clickable link followed by a raw URL in a code block. It would be clearer to integrate the instruction into a single sentence.
Check your transaction on [Celenium](https://mocha.celenium.io) by navigating to `https://mocha.celenium.io/address/YOUR_CELESTIA_ADDRESS`.
| alias_prefix = "alias/op-alt-da/" | ||
| auto_create = false | ||
| import_key_name = "celestia_key" | ||
| import_key_hex = "YOUR_PRIVATE_KEY" |
There was a problem hiding this comment.
The placeholder YOUR_PRIVATE_KEY is inconsistent with the one used earlier in the guide (YOUR_EXPORTED_PRIVATE_KEY_HEX). Using consistent placeholder names improves clarity and reduces the chance of user error.
import_key_hex = "YOUR_EXPORTED_PRIVATE_KEY_HEX"
Overview