update getting-started #65
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
WalkthroughThe pull request involves updates to the Changes
Possibly related PRs
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 5
🧹 Outside diff range and nitpick comments (2)
docs/develop/astraeus/getting-started.md (2)
368-369: Add example of environment variable configuration.The document mentions setting
WITHDRAW_TESTNET_RPCin the.envfile but doesn't show the format.Add an example of the environment variable configuration:
Before executing the command, make sure to set the RPC of the chain to broadcast the Tx as `WITHDRAW_TESTNET_RPC` in your `.env` file. +Example: +```plaintext +WITHDRAW_TESTNET_RPC=https://eth-sepolia.g.alchemy.com/v2/your-api-key +```
412-413: Add version information to the API documentation link.The link to the API documentation should specify which version of the documentation it refers to, as API specifications may change.
Consider adding version information to the link:
-[API Documentation](https://github.com/mycel-labs/astraeus/blob/main/docs/api.md) +[API Documentation (main branch)](https://github.com/mycel-labs/astraeus/blob/main/docs/api.md)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (2)
docs/develop/astraeus/get-started.md(0 hunks)docs/develop/astraeus/getting-started.md(1 hunks)
💤 Files with no reviewable changes (1)
- docs/develop/astraeus/get-started.md
🧰 Additional context used
🪛 Markdownlint
docs/develop/astraeus/getting-started.md
9-9: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time
(MD001, heading-increment)
375-375: null
Dollar signs used before commands without showing output
(MD014, commands-show-output)
21-21: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
29-29: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
39-39: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
47-47: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
53-53: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
68-68: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
83-83: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
98-98: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
117-117: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
123-123: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
129-129: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
143-143: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
162-162: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
181-181: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
194-194: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
200-200: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
206-206: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
220-220: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
239-239: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
258-258: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
266-266: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
272-272: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
285-285: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
291-291: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
297-297: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
311-311: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
329-329: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
347-347: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
353-353: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
359-359: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
374-374: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
382-382: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
404-404: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🪛 Gitleaks
docs/develop/astraeus/getting-started.md
274-274: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
274-274: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
384-384: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
389-389: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
390-390: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
| ``` | ||
| cp .env.example .env | ||
| ``` |
There was a problem hiding this comment.
Add language identifiers to code blocks.
All code blocks should specify their language for proper syntax highlighting. Add appropriate language identifiers:
- Use
bashfor shell commands - Use
jsonfor JSON responses - Use
plaintextfor command output
Example fix for the first code block:
-```
+```bash
cp .env.example .envAlso applies to: 29-31, 39-41, 47-49, 53-62, 68-79, 83-94, 98-100, 117-119, 123-125, 129-138, 143-158, 162-177, 181-183, 194-196, 200-202, 206-215, 220-235, 239-254, 258-260, 266-268, 272-275, 285-287, 291-293, 297-306, 311-325, 329-343, 347-349, 353-355, 359-362, 374-376, 382-398, 404-406
🧰 Tools
🪛 Markdownlint
21-21: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
| go run scripts/utils/generate_timed_signature/main.go 10c62a6364b1730ec101460c871952403631adb66fe7e043914c7d0056ca8e94 CreateAccount | ||
| ``` |
There was a problem hiding this comment.
Remove sensitive information from code examples.
The documentation contains actual private keys in the examples. This is a security risk as these keys might be accidentally used by users.
Replace the actual private keys with placeholder values:
-10c62a6364b1730ec101460c871952403631adb66fe7e043914c7d0056ca8e94
+<your-private-key>Also applies to: 88-90, 123-125, 200-202, 291-293, 382-384
| - Two accounts on the Toliman Testnet with access to their private keys and TEETH tokens | ||
| - Two accounts on the Sepolia Testnet with access to their private keys and SepoliaETH tokens | ||
|
|
||
| If you do not have these tokens, you can obtain them from the [Toliman Testnet Faucet](https://faucet.toliman.suave.flashbots.net/) and [Sepolia Testne Faucet](https://www.alchemy.com/faucets/ethereum-sepolia) |
There was a problem hiding this comment.
Fix typo in the Sepolia Testnet Faucet link text.
There's a typo in "Sepolia Testne Faucet".
Apply this diff to fix the typo:
-If you do not have these tokens, you can obtain them from the [Toliman Testnet Faucet](https://faucet.toliman.suave.flashbots.net/) and [Sepolia Testne Faucet](https://www.alchemy.com/faucets/ethereum-sepolia)
+If you do not have these tokens, you can obtain them from the [Toliman Testnet Faucet](https://faucet.toliman.suave.flashbots.net/) and [Sepolia Testnet Faucet](https://www.alchemy.com/faucets/ethereum-sepolia)📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| If you do not have these tokens, you can obtain them from the [Toliman Testnet Faucet](https://faucet.toliman.suave.flashbots.net/) and [Sepolia Testne Faucet](https://www.alchemy.com/faucets/ethereum-sepolia) | |
| If you do not have these tokens, you can obtain them from the [Toliman Testnet Faucet](https://faucet.toliman.suave.flashbots.net/) and [Sepolia Testnet Faucet](https://www.alchemy.com/faucets/ethereum-sepolia) |
| You need to create a signature to execute the TransferAccount Function. (As with the previous step) | ||
| Please note that the private key of the account that received the TA on the Toliman Testnet will be required. | ||
|
|
There was a problem hiding this comment.
Correct inconsistency in function name reference.
The text refers to "TransferAccount Function" when it should be "UnlockAccount Function" based on the context.
Apply this diff to fix the inconsistency:
-You need to create a signature to execute the TransferAccount Function. (As with the previous step)
+You need to create a signature to execute the UnlockAccount Function. (As with the previous step)Committable suggestion skipped: line range outside the PR's diff.
| --- | ||
| sidebar_position: 1 | ||
| --- | ||
|
|
||
| # Getting Started | ||
|
|
||
| This guide will help you set up the Astraeus API server on the Suave Toliman Testnet to easily use Transferable Accounts (TA). You will learn how to create, approve, and transfer TAs using the API server. Additionally, you will learn how to sign transactions on external chains using TAs. | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| - An environment capable of running Docker | ||
| - Two accounts on the Toliman Testnet with access to their private keys and TEETH tokens | ||
| - Two accounts on the Sepolia Testnet with access to their private keys and SepoliaETH tokens | ||
|
|
||
| If you do not have these tokens, you can obtain them from the [Toliman Testnet Faucet](https://faucet.toliman.suave.flashbots.net/) and [Sepolia Testne Faucet](https://www.alchemy.com/faucets/ethereum-sepolia) |
There was a problem hiding this comment.
Fix document structure and heading hierarchy.
The document structure needs improvement to follow markdown best practices:
- The "Prerequisites" section should be an h2 heading (##) instead of h3 (###) to maintain proper heading hierarchy.
Apply this diff to fix the heading hierarchy:
-### Prerequisites
+## Prerequisites📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| --- | |
| sidebar_position: 1 | |
| --- | |
| # Getting Started | |
| This guide will help you set up the Astraeus API server on the Suave Toliman Testnet to easily use Transferable Accounts (TA). You will learn how to create, approve, and transfer TAs using the API server. Additionally, you will learn how to sign transactions on external chains using TAs. | |
| ### Prerequisites | |
| - An environment capable of running Docker | |
| - Two accounts on the Toliman Testnet with access to their private keys and TEETH tokens | |
| - Two accounts on the Sepolia Testnet with access to their private keys and SepoliaETH tokens | |
| If you do not have these tokens, you can obtain them from the [Toliman Testnet Faucet](https://faucet.toliman.suave.flashbots.net/) and [Sepolia Testne Faucet](https://www.alchemy.com/faucets/ethereum-sepolia) | |
| --- | |
| sidebar_position: 1 | |
| --- | |
| # Getting Started | |
| This guide will help you set up the Astraeus API server on the Suave Toliman Testnet to easily use Transferable Accounts (TA). You will learn how to create, approve, and transfer TAs using the API server. Additionally, you will learn how to sign transactions on external chains using TAs. | |
| ## Prerequisites | |
| - An environment capable of running Docker | |
| - Two accounts on the Toliman Testnet with access to their private keys and TEETH tokens | |
| - Two accounts on the Sepolia Testnet with access to their private keys and SepoliaETH tokens | |
| If you do not have these tokens, you can obtain them from the [Toliman Testnet Faucet](https://faucet.toliman.suave.flashbots.net/) and [Sepolia Testne Faucet](https://www.alchemy.com/faucets/ethereum-sepolia) |
🧰 Tools
🪛 Markdownlint
9-9: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time
(MD001, heading-increment)
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (4)
docs/develop/astraeus/get-started.md (4)
9-9: Fix heading hierarchy.The heading "Prerequisites" should be an h2 (##) to maintain proper document structure.
-### Prerequisites +## Prerequisites🧰 Tools
🪛 Markdownlint
9-9: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time(MD001, heading-increment)
39-39: Add language specifiers to code blocks.Add appropriate language specifiers to code blocks for better syntax highlighting. For example:
- Use
bashfor shell commands- Use
jsonfor JSON responses- Use
httpfor curl commandsAlso applies to: 47-47, 53-53, 83-83, 98-98, 117-117, 123-123, 129-129, 143-143, 162-162, 181-181, 194-194, 200-200, 206-206, 220-220, 239-239, 258-258, 266-266, 272-272, 285-285, 291-291, 297-297, 311-311, 329-329, 347-347, 353-353, 359-359, 374-374, 382-382, 404-404
🧰 Tools
🪛 Markdownlint
39-39: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
15-15: Fix typo in faucet link text.Correct the spelling of "Testne" to "Testnet".
-If you do not have these tokens, you can obtain them from the [Toliman Testnet Faucet](https://faucet.toliman.suave.flashbots.net/) and [Sepolia Testne Faucet](https://www.alchemy.com/faucets/ethereum-sepolia) +If you do not have these tokens, you can obtain them from the [Toliman Testnet Faucet](https://faucet.toliman.suave.flashbots.net/) and [Sepolia Testnet Faucet](https://www.alchemy.com/faucets/ethereum-sepolia)
375-375: Standardize command formatting.For consistency and better readability, either:
- Remove the
$prefix from commands, or- Include both command and output in the examples
- $ go run scripts/utils/execute_withdraw_tx/main.go <your_private_key> <your TA's accountId> <external chainId> <recipient address on external chain> <transfer amount of ETH on external chain> + go run scripts/utils/execute_withdraw_tx/main.go <your_private_key> <your TA's accountId> <external chainId> <recipient address on external chain> <transfer amount of ETH on external chain>🧰 Tools
🪛 Markdownlint
375-375: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
docs/develop/astraeus/get-started.md(3 hunks)
🧰 Additional context used
🪛 Markdownlint
docs/develop/astraeus/get-started.md
9-9: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time
(MD001, heading-increment)
39-39: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
47-47: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
53-53: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
375-375: null
Dollar signs used before commands without showing output
(MD014, commands-show-output)
83-83: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
98-98: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
117-117: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
123-123: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
129-129: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
143-143: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
162-162: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
181-181: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
194-194: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
200-200: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
206-206: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
220-220: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
239-239: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
258-258: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
266-266: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
272-272: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
285-285: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
291-291: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
297-297: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
311-311: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
329-329: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
347-347: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
353-353: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
359-359: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
374-374: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
382-382: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
404-404: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🪛 Gitleaks
docs/develop/astraeus/get-started.md
274-274: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
274-274: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
384-384: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
389-389: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
390-390: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
| input example: | ||
|
|
||
| ``` | ||
| $ go run scripts/utils/execute_withdraw_tx/main.go 10c62a6364b1730ec101460c871952403631adb66fe7e043914c7d0056ca8e94 0x439376239c54540980f027ac33e1c11a 11155111 0x0A772258e2f36999C6aA57B2Ba09B78caF7EbAd3 0.0001 |
There was a problem hiding this comment.
Use consistent placeholder values for sensitive data.
Replace actual private keys, addresses, and API responses with clearly marked placeholder values to prevent confusion and potential security risks.
-$ go run scripts/utils/execute_withdraw_tx/main.go 10c62a6364b1730ec101460c871952403631adb66fe7e043914c7d0056ca8e94 0x439376239c54540980f027ac33e1c11a 11155111 0x0A772258e2f36999C6aA57B2Ba09B78caF7EbAd3 0.0001
+$ go run scripts/utils/execute_withdraw_tx/main.go <PRIVATE_KEY> <ACCOUNT_ID> 11155111 <RECIPIENT_ADDRESS> 0.0001Also applies to: 384-384, 385-385, 386-386, 387-387, 388-388, 389-389, 390-390
The GettingStarted section in the docs has been updated to align with the latest TimedSignature specifications.
Summary by CodeRabbit