From 1136590d581ea491fc49f5508373d70095bb1257 Mon Sep 17 00:00:00 2001 From: Adrian Sutton Date: Tue, 23 Jul 2024 14:27:09 +1000 Subject: [PATCH] interop: Add crossUnsafe method --- specs/interop/indexing_api.md | 52 +++++++++++++++++++++++++++++------ 1 file changed, 44 insertions(+), 8 deletions(-) diff --git a/specs/interop/indexing_api.md b/specs/interop/indexing_api.md index 13c0ce06f..7dcf357b5 100644 --- a/specs/interop/indexing_api.md +++ b/specs/interop/indexing_api.md @@ -9,6 +9,9 @@ - [`interop_checkMessage`](#interop_checkmessage) - [Parameters](#parameters) - [Returns](#returns) + - [`interop_crossUnsafe`](#interop_crossunsafe) + - [Parameters](#parameters-1) + - [Returns](#returns-1) @@ -20,6 +23,10 @@ backends, a standard API for indexers to expose is defined here. The API uses [JSON-RPC] and follows the same conventions as the [Ethereum JSON-RPC API]. +[JSON-RPC]: https://www.jsonrpc.org/specification + +[Ethereum JSON-RPC API]: https://ethereum.org/en/developers/docs/apis/json-rpc/ + ## Methods ### `interop_checkMessage` @@ -44,13 +51,42 @@ by the tx-pool and block-building, to verify user-input before inclusion into th - `conflicts` - data is available for the block referenced by the identifier but does not contain a matching log - `unknown` - data for the block referenced by the identifier is not yet available - `finalized` - the specified log exists -- `unsafe` - the specified log exists and meets the requirements of [`unsafe` inputs`](./verifier.md#unsafe-inputs) -- `cross-unsafe` - the specified log exists and meets the requirements - of [`cross-unsafe` inputs`](./verifier.md#cross-unsafe-inputs) -- `safe` - the specified log exists and meets the requirements of [`safe` inputs`](./verifier.md#safe-inputs) -- `finalized` - the specified log exists and meets the requirements - of [`finalized` inputs`](./verifier.md#finalized-inputs) +- `unsafe` - the specified log exists and meets the requirements of [`unsafe` inputs] +- `cross-unsafe` - the specified log exists and meets the requirements of [`cross-unsafe` inputs] +- `safe` - the specified log exists and meets the requirements of [`safe` inputs] +- `finalized` - the specified log exists and meets the requirements of [`finalized` inputs] -[JSON-RPC]: https://www.jsonrpc.org/specification +### `interop_crossUnsafe` -[Ethereum JSON-RPC API]: https://ethereum.org/en/developers/docs/apis/json-rpc/ +Returns the latest `cross-unsafe` block in the canonical chain of the indexer, up to and including the +specified `maxBlockNumber`. This can be used by sequencers or verifiers to determine when blocks on their chain have met +all cross-chain dependencies. For example, batchers may avoid posting batch data for transactions that have unsatisfied +cross-chain dependencies. + +As the indexer and caller may have different local views of the chain, e.g. because a reorg has not yet been processed, +callers MUST confirm that the returned block is canonical in their local view of the chain. Callers MAY retry the query +with a lower `maxBlockNumber` if the returned block is non-canonical. + +Indexers SHOULD consider calls where `maxBlockNumber` is ahead of their current `unsafe` head for a chain to be a signal +that additional blocks may be available to be indexed. However, indexers MUST eventually index available blocks even +if `interop_crossUnsafe` is not called. + +#### Parameters + +1. chainID: QUANTITY - Chain ID of the chain to return data for +2. maxBlockNumber: QUANTITY - The maximum block number to return information for + +#### Returns + +`Object` - Block ID that meets the requirements of [`cross-unsafe` inputs] and `block.number <= maxBlockNumber` + +- `hash` - the hash of the block +- `number` the number of the block + +[`unsafe` inputs]: ./verifier.md#unsafe-inputs + +[`cross-unsafe` inputs]: ./verifier.md#cross-unsafe-inputs + +[`safe` inputs]: ./verifier.md#safe-inputs + +[`finalized` inputs]: ./verifier.md#finalized-inputs