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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
#![cfg_attr(not(feature = "std"), no_std)]
#[cfg(not(any(feature = "v12", feature = "v13", feature = "v14")))]
compile_error!("Enable one of the metadata versions");
#[cfg(all(feature = "v12", feature = "v13", feature = "v14"))]
compile_error!("Only one metadata version can be enabled at the moment");
#[cfg(all(feature = "v12", feature = "v13"))]
compile_error!("Only one metadata version can be enabled at the moment");
#[cfg(all(feature = "v12", feature = "v14"))]
compile_error!("Only one metadata version can be enabled at the moment");
#[cfg(all(feature = "v13", feature = "v14"))]
compile_error!("Only one metadata version can be enabled at the moment");
#[macro_use]
extern crate alloc;
pub use codec;
pub use frame_metadata::RuntimeMetadataPrefixed;
pub use meta::Metadata;
pub use meta_ext as meta;
#[cfg(feature = "json")]
pub use scales::JsonValue;
#[cfg(feature = "v14")]
pub use scales::Value;
use async_trait::async_trait;
use core::{fmt, ops::Deref};
use meta::{Entry, Meta};
#[cfg(feature = "std")]
use once_cell::sync::OnceCell;
#[cfg(not(feature = "std"))]
use once_cell::unsync::OnceCell;
use prelude::*;
#[cfg(feature = "v14")]
use scale_info::PortableRegistry;
mod prelude {
pub use alloc::boxed::Box;
pub use alloc::string::{String, ToString};
pub use alloc::vec::Vec;
}
pub type Result<T> = core::result::Result<T, Error>;
#[cfg(any(feature = "http", feature = "http-web"))]
pub mod http;
#[cfg(feature = "ws")]
pub mod ws;
mod hasher;
pub mod meta_ext;
#[cfg(any(feature = "http", feature = "http-web", feature = "ws"))]
mod rpc;
#[derive(Debug)]
pub struct Sube<B> {
backend: B,
meta: OnceCell<Metadata>,
}
impl<B: Backend> Sube<B> {
pub fn new(backend: B) -> Self {
Sube {
backend,
meta: OnceCell::new(),
}
}
pub fn new_with_meta(backend: B, meta: Metadata) -> Self {
Sube {
backend,
meta: meta.into(),
}
}
pub async fn metadata(&self) -> Result<&Metadata> {
match self.meta.get() {
Some(meta) => Ok(meta),
None => {
let meta = self.backend.metadata().await?;
self.meta.set(meta).expect("unset");
Ok(self.meta.get().unwrap())
}
}
}
#[cfg(feature = "v14")]
pub async fn query(&self, key: &str) -> Result<Value<'_>> {
let key = self.key_from_path(key).await?;
let res = self.query_storage(&key).await?;
let reg = self.registry().await?;
Ok(Value::new(res, key.1, reg))
}
pub async fn key_from_path(&self, path: &str) -> Result<StorageKey> {
StorageKey::from_uri(self.metadata().await?, path)
}
#[cfg(feature = "v14")]
pub async fn registry(&self) -> Result<&PortableRegistry> {
Ok(&self.metadata().await?.types)
}
#[cfg(feature = "decode")]
pub async fn decode<'a, T>(
&'a self,
data: T,
ty: u32,
) -> Result<impl serde::Serialize + codec::Encode + 'a>
where
T: Into<scales::Bytes> + 'static,
{
Ok(Value::new(data.into(), ty, self.registry().await?))
}
}
impl<B: Backend> From<B> for Sube<B> {
fn from(b: B) -> Self {
Sube::new(b)
}
}
impl<T: Backend> Deref for Sube<T> {
type Target = T;
fn deref(&self) -> &Self::Target {
&self.backend
}
}
#[async_trait]
pub trait Backend {
async fn query_storage(&self, key: &StorageKey) -> Result<Vec<u8>>;
async fn submit<T>(&self, ext: T) -> Result<()>
where
T: AsRef<[u8]> + Send;
async fn metadata(&self) -> Result<Metadata>;
}
pub struct Offline(pub Metadata);
#[async_trait]
impl Backend for Offline {
async fn query_storage(&self, _key: &StorageKey) -> Result<Vec<u8>> {
Err(Error::ChainUnavailable)
}
async fn submit<T>(&self, _ext: T) -> Result<()>
where
T: AsRef<[u8]> + Send,
{
Err(Error::ChainUnavailable)
}
async fn metadata(&self) -> Result<Metadata> {
Ok(self.0.clone_meta())
}
}
#[derive(Clone, Debug)]
pub enum Error {
ChainUnavailable,
BadInput,
BadKey,
BadMetadata,
Decode(codec::Error),
NoMetadataLoaded,
Node(String),
ParseStorageItem,
StorageKeyNotFound,
}
impl fmt::Display for Error {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
Self::Node(e) => write!(f, "{:}", e),
_ => write!(f, "{:?}", self),
}
}
}
#[cfg(feature = "ws")]
impl From<async_tungstenite::tungstenite::Error> for Error {
fn from(_err: async_tungstenite::tungstenite::Error) -> Self {
Error::ChainUnavailable
}
}
#[cfg(feature = "std")]
impl std::error::Error for Error {}
#[derive(Clone, Debug)]
pub struct StorageKey(Vec<u8>, u32);
impl StorageKey {
pub fn from_uri(meta: &Metadata, uri: &str) -> Result<Self> {
let (pallet, item, map_keys) = Self::parse_uri(uri).ok_or(Error::ParseStorageItem)?;
log::debug!(
"StorageKey parts: [module]={} [item]={} [keys]={:?}",
pallet,
item,
map_keys,
);
Self::new(meta, &pallet, &item, &map_keys)
}
pub fn new(meta: &Metadata, pallet: &str, item: &str, map_keys: &[&str]) -> Result<Self> {
let entry = meta
.storage_entry(pallet, item)
.ok_or(Error::StorageKeyNotFound)?;
let key = entry
.key(pallet, map_keys)
.ok_or(Error::StorageKeyNotFound)?;
Ok(StorageKey(key, entry.ty_id()))
}
pub fn parse_uri(uri: &str) -> Option<(String, String, Vec<&str>)> {
let mut path = uri.trim_matches('/').split('/');
let pallet = path.next().map(to_camel)?;
let item = path.next().map(to_camel)?;
let map_keys = path.collect::<Vec<_>>();
Some((pallet, item, map_keys))
}
}
impl fmt::Display for StorageKey {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "0x{}", hex::encode(&self.0))
}
}
impl AsRef<[u8]> for StorageKey {
fn as_ref(&self) -> &[u8] {
self.0.as_ref()
}
}
fn to_camel(term: &str) -> String {
let underscore_count = term.chars().filter(|c| *c == '-').count();
let mut result = String::with_capacity(term.len() - underscore_count);
let mut at_new_word = true;
for c in term.chars().skip_while(|&c| c == '-') {
if c == '-' {
at_new_word = true;
} else if at_new_word {
result.push(c.to_ascii_uppercase());
at_new_word = false;
} else {
result.push(c);
}
}
result
}