Skip to content

Conversation

@neekolas
Copy link
Contributor

@neekolas neekolas commented Oct 22, 2025

TL;DR

Updated the Gateway Service documentation with new configuration parameters and improved examples.

What changed?

  • Added two new required configuration parameters:
    • 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)
  • Changed the valid environment values from local to anvil in the documentation
  • Removed Enable Redis as a required configuration parameter
  • Added a new code example for Rate Limiting
  • Updated the Docker section to reference the example repository instead of the xmtpd dev/docker directory

How to test?

  1. Review the updated configuration table to ensure all parameters are correctly documented
  2. Check that the new Rate Limiting code example works as expected
  3. Verify the link to the example repository is correct and accessible

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.

@vercel
Copy link

vercel bot commented Oct 22, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
docs-xmtp-org Ready Ready Preview Comment Oct 23, 2025 6:09pm

Copy link
Contributor Author

neekolas commented Oct 22, 2025

This stack of pull requests is managed by Graphite. Learn more about stacking.

@neekolas neekolas marked this pull request as ready for review October 22, 2025 20:14
@neekolas neekolas requested a review from a team as a code owner October 22, 2025 20:14
@macroscopeapp
Copy link

macroscopeapp bot commented Oct 22, 2025

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 authorizers.RateLimitBuilder with minute and hour limits in run-gateway.mdx

Update gateway configuration documentation and examples in run-gateway.mdx.

  • Add configuration rows for App Chain RPC URL and Settlement Chain RPC URL with command line flags and environment variables in run-gateway.mdx
  • Change Environment option values to 'anvil', 'testnet', and 'mainnet' in run-gateway.mdx
  • Remove the 'Enable Redis' configuration row in run-gateway.mdx
  • Add Go snippet showing Redis-backed rate limiting via authorizers.RateLimitBuilder with minute and hour limits in run-gateway.mdx
  • Update production customization guidance to reference an example repository and Dockerfile in run-gateway.mdx

📍Where to Start

Start with the configuration options table and the new rate limiting Go snippet in run-gateway.mdx.


📊 Macroscope summarized 490ddb3. 0 files reviewed, 0 issues evaluated, 0 issues filtered, 0 comments posted

🗂️ Filtered Issues

No issues evaluated.

Copy link
Collaborator

@jhaaaa jhaaaa left a 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 !

Copy link
Contributor Author

neekolas commented Oct 23, 2025

Merge activity

  • Oct 23, 6:08 PM UTC: A user started a stack merge that includes this pull request via Graphite.
  • Oct 23, 6:09 PM UTC: Graphite rebased this pull request as part of a merge.
  • Oct 23, 6:10 PM UTC: @neekolas merged this pull request with Graphite.

@neekolas neekolas force-pushed the 10-16-gateway_config_updates branch from 09e2ada to 490ddb3 Compare October 23, 2025 18:08
@neekolas neekolas merged commit 4f8fc9b into main Oct 23, 2025
4 checks passed
@neekolas neekolas deleted the 10-16-gateway_config_updates branch October 23, 2025 18:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants