-
Notifications
You must be signed in to change notification settings - Fork 39
Gateway config updates #449
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
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
|
jhaaaa
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for this @neekolas !
09e2ada to
490ddb3
Compare

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.