Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Update Gateway docs to add App Chain and Settlement Chain RPC config, revise environment values to 'anvil', 'testnet', 'mainnet', remove Redis option, and document Redis rate limiting using
|
Contributor
Author
neekolas
force-pushed
the
10-16-gateway_config_updates
branch
from
09e2ada to
490ddb3
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
TL;DR
Updated the Gateway Service documentation with new configuration parameters and improved examples.
What changed?
App Chain RPC URL(--contracts.app-chain.rpc-url/XMTPD_APP_CHAIN_RPC_URL)Settlement Chain RPC URL(--contracts.settlement-chain.rpc-url/XMTPD_SETTLEMENT_CHAIN_RPC_URL)localtoanvilin the documentationEnable Redisas a required configuration parameterHow to test?
Why make this change?
These updates provide more accurate and comprehensive documentation for users setting up an XMTP Gateway Service. The addition of RPC URL parameters clarifies the full set of required configurations, while the new Rate Limiting example demonstrates a common use case. Pointing users to the example repository instead of the internal Docker directory provides a better starting point for customization.