{"templateId":"markdown","versions":[{"version":"v1.39","label":"v1.39 STS","link":"/products/custody/overview/architecture/unified-indexer-service","default":true,"active":true,"folderId":"c15a2701"},{"version":"v1.38","label":"v1.38 STS","link":"/products/custody/v1.38/overview/architecture/unified-indexer-service","default":false,"active":false,"folderId":"c15a2701"},{"version":"v1.34","label":"v1.34 LTS","link":"/products/custody/v1.34/overview/architecture/unified-indexer-service","default":false,"active":false,"folderId":"c15a2701"},{"version":"v1.26","label":"v1.26 LTS","link":"/products/custody/v1.26/overview/architecture/unified-indexer-service","default":false,"active":false,"folderId":"c15a2701"},{"version":"v1.19","label":"v1.19 LTS","link":"/products/custody/v1.19/overview/architecture/unified-indexer-service","default":false,"active":false,"folderId":"c15a2701"},{"version":"v1.15","label":"v1.15 LTS","link":"/products/custody/v1.15/overview/architecture/unified-indexer-service","default":false,"active":false,"folderId":"c15a2701"}],"sharedDataIds":{"sidebar":"sidebar-products/custody/@v1.15/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Unified Indexer Service","description":"User guides, API reference, and support resources.","siteUrl":"https://docs.ripple.com","lang":"en-US","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"unified-indexer-service","__idx":0},"children":["Unified Indexer Service"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Unified Indexer Service (UIS) is the blockchain indexing architecture used by ","Ripple Custody"," for ledger-specific indexing, event processing, and ledger APIs. UIS uses a decomposed, chain-specific adapter architecture with isolated ledger and network components."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For a complete and up-to-date list of which ledgers are supported, please refer to the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/reference/supported-ledgers"},"children":["Supported blockchain ledgers"]}," page."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["UIS is available for SaaS deployments and for on-premises deployments from v1.26. If you are migrating an on-premises deployment from legacy indexers to UIS, see the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/operations-and-maintenance/upgrading/unified-indexer-service-migration"},"children":["UIS on-premises migration guide"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"architecture","__idx":1},"children":["Architecture"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following diagram shows how UIS components fetch blockchain data, normalize it, and expose indexed events to internal consumers such as Ledger Accounting."]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"flowchart LR\n subgraph OnPrem[\"On-prem\"]\n direction LR\n LA[\"Ledger Accounting\"]\n APIGW[\"API GW\"]\n EventsAPI[\"Events API\"]\n EventsDB[(\"Events DB\")]\n\n subgraph Unified[\"Unified Indexers\"]\n direction LR\n Processor[\"Processor\"]\n IndexerDB[(\"Indexer DB\")]\n GenericIndexer[\"Generic Indexer\"]\n end\n\n subgraph LedgerServices[\"Ledger services\"]\n direction TB\n LedgerAPI[\"Ledger API
(XRPL API)\"]\n Adapter[\"Ledger Adapter
(XRPL Adapter)
xrpl-mainnet
xrpl-testnet\"]\n end\n\n XRPL[\"XRPL\"]\n end\n\n LA --> APIGW\n APIGW --> EventsAPI\n EventsAPI --> EventsDB\n Processor --> IndexerDB\n GenericIndexer --> IndexerDB\n Processor --> EventsDB\n GenericIndexer --> Adapter\n Adapter --> XRPL\n APIGW --> LedgerAPI\n APIGW --> Adapter\n LedgerAPI --> XRPL\n\n EventsDB ~~~ Processor\n IndexerDB ~~~ GenericIndexer\n GenericIndexer ~~~ LedgerAPI\n","diagramHtml":"

On-prem

Ledger services

Ledger API
(XRPL API)

Ledger Adapter
(XRPL Adapter)
xrpl-mainnet
xrpl-testnet

Ledger Accounting

API GW

Events API

Events DB

XRPL

Unified Indexers

Processor

Indexer DB

Generic Indexer

","diagramHtmlDark":"

On-prem

Ledger services

Ledger API
(XRPL API)

Ledger Adapter
(XRPL Adapter)
xrpl-mainnet
xrpl-testnet

Ledger Accounting

API GW

Events API

Events DB

XRPL

Unified Indexers

Processor

Indexer DB

Generic Indexer

"},"children":["flowchart LR\n subgraph OnPrem[\"On-prem\"]\n direction LR\n LA[\"Ledger Accounting\"]\n APIGW[\"API GW\"]\n EventsAPI[\"Events API\"]\n EventsDB[(\"Events DB\")]\n\n subgraph Unified[\"Unified Indexers\"]\n direction LR\n Processor[\"Processor\"]\n IndexerDB[(\"Indexer DB\")]\n GenericIndexer[\"Generic Indexer\"]\n end\n\n subgraph LedgerServices[\"Ledger services\"]\n direction TB\n LedgerAPI[\"Ledger API
(XRPL API)\"]\n Adapter[\"Ledger Adapter
(XRPL Adapter)
xrpl-mainnet
xrpl-testnet\"]\n end\n\n XRPL[\"XRPL\"]\n end\n\n LA --> APIGW\n APIGW --> EventsAPI\n EventsAPI --> EventsDB\n Processor --> IndexerDB\n GenericIndexer --> IndexerDB\n Processor --> EventsDB\n GenericIndexer --> Adapter\n Adapter --> XRPL\n APIGW --> LedgerAPI\n APIGW --> Adapter\n LedgerAPI --> XRPL\n\n EventsDB ~~~ Processor\n IndexerDB ~~~ GenericIndexer\n GenericIndexer ~~~ LedgerAPI\n"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Data flow:"]}]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Ledger Adapters connect to blockchain nodes and fetch blockchain data. For EVM chains with node authentication configured, the Ledger Adapter routes requests through the Node Gateway sidecar, which injects the required credentials before forwarding to the node."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The Generic Indexer orchestrates data fetching through adapters. Each ledger and network combination has its own stateful Generic Indexer instance."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["After data is fetched, the Generic Indexer indexes the data and stores it in the outbox table."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The Processor reads the outbox table and generates standardized events."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The Processor writes events to the database."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The Events API reads from the database and provides indexed data to consumers."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Ledger Accounting pulls events through the Events API."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Ledger APIs provide stateless access to live blockchain data from nodes, not indexed data."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"components","__idx":2},"children":["Components"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The UIS consists of several components that work together:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Component"},"children":["Component"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Generic Indexer"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The core orchestration engine that fetches blockchain data and stores it in a common format. While the indexer code is generic and reusable, a separate instance is deployed for each ledger and network combination (e.g., ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["uis-indexer-solana-devnet"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["uis-indexer-xrpl-testnet"]},")."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Processor"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Handles business logic and generates standardized events from indexed data. It reads from the Generic Indexer's outbox table and creates customer-facing events. This indexed data is then served by the Events API."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Ledger Adapters"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Chain-specific translation layers that connect to blockchain nodes and convert blockchain-specific data into the unified model consumed by the Generic Indexer."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Ledger APIs"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Provide RESTful interfaces for accessing live blockchain data directly from the nodes. These APIs return stateless data and are called by ledger adapters or other components when checking balances, creating transactions, broadcasting transactions, or getting fees. These are stateless and can scale horizontally."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Node Gateway"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional reverse-proxy sidecar automatically co-deployed alongside an EVM indexer when an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["authentication"]}," block is present in the ledger's node configuration. It intercepts outbound requests from the Ledger Adapter to the blockchain node and injects the required credentials (static headers, custom JWT tokens), so the indexer itself has no auth-specific code. No additional Helm flag is required — the presence of the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["authentication"]}," block triggers deployment. Applies to EVM chains only (Ethereum, Arbitrum, Base, Optimism, Polygon)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Events API"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Provides RESTful interface for accessing indexed data. This is the primary interface where indexed data is accessed by consumers, such as Ledger Accounting. Handles authentication and provides HTTP endpoints for consumers to pull events. Product-level webhook delivery is handled separately by event distribution."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API Gateway"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Single entry point for all UIS communication, routing requests to appropriate internal services."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"component-requirements","__idx":3},"children":["Component requirements"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All installed UIS components are required for proper operation. The system is designed as an integrated whole, and removing any component will cause failures."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For example, if you are using Solana:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Component"},"children":["Component"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Status"},"children":["Status"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Generic Indexer (per ledger/network)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A dedicated instance orchestrates data fetching for each ledger/network (e.g., mainnet, devnet)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Processor"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Generates events for Ledger Accounting"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Events API"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Provides the pull-based interface for event consumption"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Solana Ledger Adapter"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Translates Solana-specific data"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Solana Ledger API"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Provides access to live Solana blockchain data"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each component plays a critical role in the data flow pipeline."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"isolation-pattern","__idx":4},"children":["Isolation pattern"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The UIS uses the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Bulkhead Pattern"]}," for fault isolation. Three components are run for each ledger and network combination:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Ledger API"]}," - Provides access to live blockchain data for that specific ledger/network"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Ledger Adapter"]}," - Translates blockchain-specific data for that ledger/network"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Generic Indexer"]}," - Orchestrates data fetching for that specific ledger/network"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["These three components are duplicated for each ledger and network. This means:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Network-level isolation:"]}," If XRPL testnet goes down, XRPL mainnet remains unaffected"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Ledger-level isolation:"]}," If Solana experiences issues (node failure, resource spike), it does not impact XRPL, TRON, or other ledgers"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Independent scaling:"]}," Each ledger/network combination can be scaled independently based on its specific needs"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This isolation ensures that failures are contained and do not cascade across the system."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"supported-chains-and-indexer-types","__idx":5},"children":["Supported chains and indexer types"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Ripple Custody"," supports a wide range of blockchains. Depending on the chain, indexing is handled either by UIS or by a standalone indexer. For on-premises deployments from v1.26:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Solana, TRON, and XRPL use UIS automatically and do not require a per-network UIS configuration setting."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Arbitrum, Base, and Optimism require UIS and must be explicitly configured with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type: \"uis\""]}," to be operable."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Ethereum, Polygon, and Stellar continue to use existing standalone indexers unless you explicitly configure them to use UIS."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"on-premises-node-requirements","__idx":6},"children":["On-premises node requirements"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For an on-premises deployment of UIS, you are responsible for provisioning and maintaining your own blockchain nodes. The service must be able to connect to these nodes to index transactions. The following table lists minimum node requirements for on-premises UIS deployments. Check the configuration packaged with your release for release-specific changes."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Blockchain"},"children":["Blockchain"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Node type"},"children":["Node type"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Minimum version"},"children":["Minimum version"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Connection"},"children":["Connection"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Archive requirement"},"children":["Archive requirement"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Additional details"},"children":["Additional details"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Arbitrum"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Geth compatible"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["v3.7.X"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["JSON-RPC over HTTP"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Non-Archive"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Debug mode must be enabled."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Base"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Geth compatible"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["v0.14.1"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["JSON-RPC over HTTP"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Non-Archive"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Debug mode must be enabled."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Ethereum"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Geth"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["v1.16.4"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["JSON-RPC over HTTP"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Archive (Required)"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Debug APIs must be enabled. High request volume (~1.2k - 300k/hour)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Optimism"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Geth compatible"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["v1.101511"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["JSON-RPC over HTTP"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Non-Archive"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Debug mode must be enabled."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Polygon"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Geth compatible"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["v1.16.4"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["JSON-RPC over HTTP"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Archive (Required)"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Debug mode must be enabled."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Solana"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Agave"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["mainnet 2.3.10 / devnet 3.0.0"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["JSON-RPC over HTTP"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Archive Recommended"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Estimated request volume is ~9000/hour. No debug mode needed."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Stellar"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Horizon"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["v23.0.0"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["HTTP"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Archive (Preferred)"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Requires ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["application/x-www-form-urlencoded"]}," content-type for broadcasting transactions."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["TRON"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["FullNode"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["v4.8.0"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["RPC over HTTP"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Archive (Preferred)"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Estimated request volume is ~150k/day."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["XRPL"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["FullNode"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["2.6.X"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["HTTP"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Archive Recommended"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Request volume is not based on tracked accounts."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"configuration","__idx":7},"children":["Configuration"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"saas-deployments","__idx":8},"children":["SaaS deployments"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For SaaS deployments, UIS is enabled and managed by Ripple for supported chains."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"on-premises-deployments","__idx":9},"children":["On-premises deployments"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For on-premises deployments, UIS is available from v1.26 or later."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Use UIS automatically:"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Chain"},"children":["Chain"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Status"},"children":["Status"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Solana"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Uses UIS automatically. No per-network ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type: \"uis\""]}," setting is required."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["XRPL"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Uses UIS automatically. No per-network ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type: \"uis\""]}," setting is required."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["TRON"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Uses UIS automatically. No per-network ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type: \"uis\""]}," setting is required."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Must be explicitly configured to use UIS:"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Chain"},"children":["Chain"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Status"},"children":["Status"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Arbitrum"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Requires UIS. Configure the network with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type: \"uis\""]}," and provide node access settings."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Base"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Requires UIS. Configure the network with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type: \"uis\""]}," and provide node access settings."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optimism"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Requires UIS. Configure the network with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type: \"uis\""]}," and provide node access settings."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Ethereum"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional. You can continue using the legacy indexer or migrate to UIS."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Polygon"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional. You can continue using the legacy indexer or migrate to UIS."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Stellar"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional. You can continue using the legacy indexer or migrate to UIS."]}]}]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Arbitrum, Base, and Optimism require UIS because there is no supported legacy-indexer path for those chains. They still need explicit configuration in on-premises deployments because ","Ripple Custody"," must know which network to run, which node endpoint to use, and which authentication settings to apply."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Other EVM chains like Ethereum and Polygon can optionally use UIS or continue with legacy indexers."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Stellar can also optionally use UIS or continue with legacy indexers."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Migrating a chain to the Unified Indexer is a one-way process and cannot be rolled back."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Please plan your migration carefully. For any questions about the deployment process, please contact your CPE or our Support team."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"configuration-example","__idx":10},"children":["Configuration example"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To enable UIS for a specific chain, set the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}," parameter to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"uis\""]}," in that network's configuration block within your Helm chart's ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["values.yaml"]}," file."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The example code below shows the correct structure for enabling the UIS for an Optimism Sepolia testnet:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"ledgers:\n evm:\n networks:\n - name: optimism-sepolia\n type: \"uis\" # Enable UIS for this network\n raw_config: |\n tracker.opindexer-sepolia.base-url = \"http://api-management-uis\"\n ...\n indexer:\n ...\n node:\n # URL for your provisioned Optimism Sepolia node.\n url: \"http://your-optimism-sepolia-node-url\"\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For complete step-by-step migration instructions, including pre-migration setup, database preparation, and validation steps, see the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/operations-and-maintenance/upgrading/unified-indexer-service-migration"},"children":["UIS on-premises migration guide"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"node-authentication-for-evm-chains","__idx":11},"children":["Node authentication for EVM chains"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If your EVM blockchain node requires authentication (for example, a Besu node that issues short-lived JWTs, or a third-party provider that expects a static header token), add an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["authentication"]}," block to the network's ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["indexer.node"]}," config. This automatically deploys a Node Gateway sidecar in the same pod as the EVM indexer."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"header-authentication-static-token-or-api-key","__idx":12},"children":["Header authentication (static token or API key)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["mode: header"]}," to inject a fixed key-value pair into every outbound request:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"ledgers:\n evm:\n networks:\n - name: mainnet\n type: \"uis\"\n indexer:\n node:\n url: \"https://eth-node-provider.internal/\"\n authentication:\n mode: header\n header:\n key: \"x-auth-token\"\n value: \"secret\"\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"custom-jwt-authentication","__idx":13},"children":["Custom JWT authentication"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["mode: customJwt"]}," when the node requires a short-lived bearer token fetched from a separate token endpoint. Node Gateway fetches and caches the token, refreshing it before expiry."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"ledgers:\n evm:\n networks:\n - name: testnet-goerli\n type: \"uis\"\n indexer:\n node:\n url: \"https://example-mas-node.internal/\"\n authentication:\n mode: customJwt\n customJwt:\n tokenUrl: \"https://example.com/api/generate-access-token\"\n tokenMethod: POST\n apiKeyHeader: \"x-api-key\"\n apiKeyValue: \"your-api-key\"\n requestBody:\n signature: \"your-signature\"\n tokenJsonPath: data\n tokenExpirySeconds: 3600\n refreshBufferSeconds: 300\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customJwt"]}," field reference:"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tokenUrl"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String (URL)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Endpoint that issues the access token."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tokenMethod"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["HTTP method for the token request (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]},")."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["apiKeyHeader"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Header name to include in the token request for API-key authentication of the token endpoint itself."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["apiKeyValue"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Value for the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["apiKeyHeader"]},". Store this in a Kubernetes Secret and inject via env var."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["requestBody"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Map"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Key-value pairs sent as the JSON body of the token request."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tokenJsonPath"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["JSON path expression to extract the token value from the token endpoint response (e.g., ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["access_token"]},")."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tokenExpirySeconds"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Lifetime of the fetched token in seconds. Node Gateway caches the token for this duration."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["refreshBufferSeconds"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Seconds before expiry at which Node Gateway proactively fetches a new token. Must be less than ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tokenExpirySeconds"]},"."]}]}]}]}]}]},"headings":[{"value":"Unified Indexer Service","id":"unified-indexer-service","depth":1},{"value":"Architecture","id":"architecture","depth":2},{"value":"Components","id":"components","depth":2},{"value":"Component requirements","id":"component-requirements","depth":2},{"value":"Isolation pattern","id":"isolation-pattern","depth":2},{"value":"Supported chains and indexer types","id":"supported-chains-and-indexer-types","depth":2},{"value":"On-premises node requirements","id":"on-premises-node-requirements","depth":2},{"value":"Configuration","id":"configuration","depth":2},{"value":"SaaS deployments","id":"saas-deployments","depth":3},{"value":"On-premises deployments","id":"on-premises-deployments","depth":3},{"value":"Configuration example","id":"configuration-example","depth":3},{"value":"Node authentication for EVM chains","id":"node-authentication-for-evm-chains","depth":3},{"value":"Header authentication (static token or API key)","id":"header-authentication-static-token-or-api-key","depth":4},{"value":"Custom JWT authentication","id":"custom-jwt-authentication","depth":4}],"frontmatter":{"seo":{"title":"Unified Indexer Service"}},"lastModified":"2026-08-04T20:25:11.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/custody/overview/architecture/unified-indexer-service","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}