substrate-api-client 1.21.0

Json-rpc client with helper functions compatible with any Substrate node
Documentation 
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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131

/*
   Copyright 2024 Supercomputing Systems AG
   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.
*/

use super::{RuntimeApi, RuntimeApiClient};
use crate::{api::Result, rpc::Request};
use ac_primitives::{config::Config, UncheckedExtrinsic};
#[cfg(all(not(feature = "sync-api"), not(feature = "std")))]
use alloc::boxed::Box;
use alloc::{vec, vec::Vec};
use sp_core::{Bytes, Encode};
use sp_inherents::{CheckInherentsResult, InherentData};
use sp_runtime::ApplyExtrinsicResult;

#[maybe_async::maybe_async(?Send)]
pub trait BlockBuilderApi: RuntimeApi {
	type ApplyExtrinsicResult;
	type Block;
	type InherentData;
	type CheckInherentsResult;
	type Header;

	/// Apply the given extrinsic.
	async fn apply_extrinsic<Address, Call, Signature, TransactionExtension>(
		&self,
		extrinsic: UncheckedExtrinsic<Address, Call, Signature, TransactionExtension>,
		at_block: Option<Self::Hash>,
	) -> Result<Self::ApplyExtrinsicResult>
	where
		Address: Encode,
		Call: Encode,
		Signature: Encode,
		TransactionExtension: Encode;

	/// Apply the given opaque extrinsic.
	async fn apply_opaque_extrinsic(
		&self,
		extrinsic: Vec<u8>,
		at_block: Option<Self::Hash>,
	) -> Result<Self::ApplyExtrinsicResult>;

	/// Check that the inherents are valid.
	async fn check_inherents(
		&self,
		block: Self::Block,
		data: Self::InherentData,
		at_block: Option<Self::Hash>,
	) -> Result<Self::CheckInherentsResult>;

	/// Finish the current block.
	async fn finalize_block(&self, at_block: Option<Self::Hash>) -> Result<Self::Header>;

	/// Generate inherent extrinsics and return them as encoded Bytes.
	async fn inherent_extrinsics(
		&self,
		inherent: Self::InherentData,
		at_block: Option<Self::Hash>,
	) -> Result<Vec<Bytes>>;
}

#[maybe_async::maybe_async(?Send)]
impl<T, Client> BlockBuilderApi for RuntimeApiClient<T, Client>
where
	T: Config,
	Client: Request,
{
	type ApplyExtrinsicResult = ApplyExtrinsicResult;
	type Block = T::Block;
	type InherentData = InherentData;
	type CheckInherentsResult = CheckInherentsResult;
	type Header = T::Header;

	async fn apply_extrinsic<Address, Call, Signature, TransactionExtension>(
		&self,
		extrinsic: UncheckedExtrinsic<Address, Call, Signature, TransactionExtension>,
		at_block: Option<Self::Hash>,
	) -> Result<Self::ApplyExtrinsicResult>
	where
		Address: Encode,
		Call: Encode,
		Signature: Encode,
		TransactionExtension: Encode,
	{
		self.apply_opaque_extrinsic(extrinsic.encode(), at_block).await
	}

	async fn apply_opaque_extrinsic(
		&self,
		extrinsic: Vec<u8>,
		at_block: Option<Self::Hash>,
	) -> Result<Self::ApplyExtrinsicResult> {
		self.runtime_call("BlockBuilder_apply_extrinsic", vec![extrinsic], at_block)
			.await
	}

	async fn check_inherents(
		&self,
		block: Self::Block,
		data: Self::InherentData,
		at_block: Option<Self::Hash>,
	) -> Result<Self::CheckInherentsResult> {
		self.runtime_call(
			"BlockBuilder_check_inherents",
			vec![block.encode(), data.encode()],
			at_block,
		)
		.await
	}

	async fn finalize_block(&self, at_block: Option<Self::Hash>) -> Result<Self::Header> {
		self.runtime_call("BlockBuilder_finalize_block", vec![], at_block).await
	}

	async fn inherent_extrinsics(
		&self,
		inherent: Self::InherentData,
		at_block: Option<Self::Hash>,
	) -> Result<Vec<Bytes>> {
		self.runtime_call("BlockBuilder_inherent_extrinsics", vec![inherent.encode()], at_block)
			.await
	}
}