1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68

// Copyright (C) 2023 Polytope Labs.
// SPDX-License-Identifier: Apache-2.0

// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// 	http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#![doc = include_str!("../README.md")]
#![cfg_attr(not(feature = "std"), no_std)]
#![allow(clippy::too_many_arguments)]
#![deny(missing_docs)]

extern crate alloc;

use alloc::vec::Vec;
use ismp::{
    consensus::{ConsensusClientId, StateMachineId},
    host::StateMachine,
    router::{Request, Response},
};
use pallet_ismp::mmr::{Leaf, Proof, ProofKeys};
use primitive_types::H256;
use sp_mmr_primitives::Error;

sp_api::decl_runtime_apis! {
    /// Required runtime APIs needed for client subsystems like the RPC
    pub trait IsmpRuntimeApi<Hash: codec::Codec> {
        /// Should return the host's state machine identifier
        fn host_state_machine() -> StateMachine;

        /// Generate a proof for the provided leaf indices
        fn generate_proof(
            commitments: ProofKeys
        ) -> Result<(Vec<Leaf>, Proof<Hash>), Error>;

        /// Fetch all ISMP events
        fn block_events() -> Vec<pallet_ismp::events::Event>;

        /// Fetch all ISMP events and their extrinsic metadata
        fn block_events_with_metadata() -> Vec<(pallet_ismp::events::Event, u32)>;

        /// Return the scale encoded consensus state
        fn consensus_state(id: ConsensusClientId) -> Option<Vec<u8>>;

        /// Return the timestamp this client was last updated in seconds
        fn consensus_update_time(id: ConsensusClientId) -> Option<u64>;

        /// Return the challenge period timestamp
        fn challenge_period(id: ConsensusClientId) -> Option<u64>;

        /// Return the latest height of the state machine
        fn latest_state_machine_height(id: StateMachineId) -> Option<u64>;

        /// Fetch the requests for the given commitments.
        fn requests(request_commitments: Vec<H256>) -> Vec<Request>;

        /// Fetch the responses for the given commitments.
        fn responses(response_commitments: Vec<H256>) -> Vec<Response>;
    }
}