From 5931c7d4ade6ed5236ef7935db43127392fdb7ba Mon Sep 17 00:00:00 2001 From: bobinstein Date: Fri, 9 Aug 2024 13:57:28 -0400 Subject: [PATCH] docs: updated bundler doc --- docs/src/gateways/ar-io-node/bundler.md | 6 ++---- docs/src/glossary.md | 4 ++++ 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/src/gateways/ar-io-node/bundler.md b/docs/src/gateways/ar-io-node/bundler.md index dafdb510..527e70df 100644 --- a/docs/src/gateways/ar-io-node/bundler.md +++ b/docs/src/gateways/ar-io-node/bundler.md @@ -109,13 +109,11 @@ ANS104_UNBUNDLE_FILTER={ "attributes": { "owner_address": "$BUNDLER_ARWEAVE_ADDR **NOTE**: The above filters must be placed in the `.env` file for the core gateway service, not the bundler. -Gateways handle data item indexing asynchronously. This means they establish a que of items to index, and work on processing the que in the background while the gateway continues with its normal operations. If a gateway has broad indexing filters, there can be some latency in indexing data items from the bundler while the gateway works through its que. +Gateways handle data item indexing asynchronously. This means they establish a queue of items to index, and work on processing the queue in the background while the gateway continues with its normal operations. If a gateway has broad indexing filters, there can be some latency in indexing data items from the bundler while the gateway works through its queue. #### Optimistic Indexing -Gateway operators can prioritize indexing specific data items, putting them at the front of the que. The bundler service can submit data items for prioritized indexing on their associated gateway. - -Only gateway operators are able to prioritize indexing, so an admin key is required for the request to be successful. This key should be made available in the environmental files for BOTH the core gateway, and the bundler, and should be provided as `AR_IO_ADMIN_KEY`: +Gateway operators control access to their [optimistic data item indexing](../../glossary.md#optimistic-indexing) API via an admin key that must be supplied by all bundling clients in order for their requests to be accepted. This key should be made available in the environment configuration files for BOTH the core gateway, and the bundler, and should be provided as `AR_IO_ADMIN_KEY`: ```bash AR_IO_ADMIN_KEY="Admin password" diff --git a/docs/src/glossary.md b/docs/src/glossary.md index 5ae0337e..333489c6 100644 --- a/docs/src/glossary.md +++ b/docs/src/glossary.md @@ -95,6 +95,10 @@ The way public addresses are commonly (or by spec) represented in their native b A gateway selected to evaluate the performance of peer gateways in resolving ArNS names. Observers assess and report on the operational efficacy of other gateways. +## **Optimistic Indexing**: + +Indexing transaction or data item headers before the associated L1 transaction has been accepted and confirmed in a chain block. + ## **Owner**: Generally, the public key of the signer.