sp_transaction_storage_proof/runtime_api.rs
1// This file is part of Substrate.
2
3// Copyright (C) Parity Technologies (UK) Ltd.
4// SPDX-License-Identifier: Apache-2.0
5
6// Licensed under the Apache License, Version 2.0 (the "License");
7// you may not use this file except in compliance with the License.
8// You may obtain a copy of the License at
9//
10// http://www.apache.org/licenses/LICENSE-2.0
11//
12// Unless required by applicable law or agreed to in writing, software
13// distributed under the License is distributed on an "AS IS" BASIS,
14// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15// See the License for the specific language governing permissions and
16// limitations under the License.
17
18//! Runtime API definition for the transaction storage proof processing.
19
20use alloc::vec::Vec;
21use sp_runtime::traits::NumberFor;
22
23sp_api::decl_runtime_apis! {
24 /// Runtime API trait for transaction storage support.
25 #[api_version(2)]
26 pub trait TransactionStorageApi {
27 /// Retention period for indexed data, in blocks.
28 fn retention_period() -> NumberFor<Block>;
29
30 /// Indexed-transaction metadata for `block`.
31 ///
32 /// Returns an empty vector if the block has no indexed transactions or
33 /// is outside the retention window.
34 fn indexed_transactions(block: NumberFor<Block>) -> Vec<crate::IndexedTransactionInfo>;
35 }
36}