avail-rust-core 0.5.1

Avail Rust SDK core library
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
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
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
use super::substrate::extrinsic::EXTRINSIC_FORMAT_VERSION;
use crate::{
	decoded_events::check_header,
	types::{ExtrinsicSignature, metadata::StringOrBytes},
	utils::decode_already_decoded,
};
use codec::{Compact, Decode, Encode, Error, Input};
use serde::{Deserialize, Serialize};

pub trait HasHeader {
	// Pallet ID, Variant ID
	const HEADER_INDEX: (u8, u8);
}

pub trait TransactionEncodable {
	/// SCALE encodes the event
	///
	/// If you need to Hex and SCALE encode then call `encode_as_hex_event`
	fn to_call(&self) -> Vec<u8>;
}

pub trait ExtrinsicDecodable: Sized {
	fn from_call<'a>(call: impl Into<StringOrBytes<'a>>) -> Result<Self, String>;
	fn from_ext<'a>(call: impl Into<StringOrBytes<'a>>) -> Result<Self, String>;
}

impl<T: HasHeader + Encode> TransactionEncodable for T {
	fn to_call(&self) -> Vec<u8> {
		let pallet_id = Self::HEADER_INDEX.0;
		let variant_id = Self::HEADER_INDEX.1;
		let mut encoded_event: Vec<u8> = vec![pallet_id, variant_id];
		Self::encode_to(self, &mut encoded_event);

		encoded_event
	}
}

impl<T: HasHeader + Decode> ExtrinsicDecodable for T {
	fn from_call<'a>(call: impl Into<StringOrBytes<'a>>) -> Result<T, String> {
		fn inner<T: HasHeader + Decode>(call: StringOrBytes) -> Result<T, String> {
			let call: &[u8] = match &call {
				StringOrBytes::StringRef(s) => {
					&const_hex::decode(s.trim_start_matches("0x")).map_err(|x| x.to_string())?
				},
				StringOrBytes::BoxedString(s) => {
					&const_hex::decode(s.trim_start_matches("0x")).map_err(|x| x.to_string())?
				},
				StringOrBytes::Bytes(b) => b,
				StringOrBytes::BoxedBytes(b) => b,
			};

			check_header(call, T::HEADER_INDEX)?;

			let mut data = if call.len() <= 2 { &[] } else { &call[2..] };
			Ok(T::decode(&mut data).map_err(|x| x.to_string())?)
		}

		inner(call.into())
	}

	fn from_ext<'a>(ext: impl Into<StringOrBytes<'a>>) -> Result<T, String> {
		fn inner<T: HasHeader + Decode>(ext: StringOrBytes) -> Result<T, String> {
			let ext: &[u8] = match &ext {
				StringOrBytes::StringRef(s) => &const_hex::decode(s.trim_start_matches("0x"))
					.map_err(|x: const_hex::FromHexError| x.to_string())?,
				StringOrBytes::BoxedString(s) => {
					&const_hex::decode(s.trim_start_matches("0x")).map_err(|x| x.to_string())?
				},
				StringOrBytes::Bytes(b) => b,
				StringOrBytes::BoxedBytes(b) => b,
			};

			let ext = Extrinsic::<T>::try_from(ext)?;
			Ok(ext.call)
		}

		inner(ext.into())
	}
}

#[derive(Clone)]
pub struct EncodedExtrinsic {
	/// The signature, address, number of extrinsics have come before from
	/// the same signer and an era describing the longevity of this transaction,
	/// if this is a signed extrinsic.
	pub signature: Option<ExtrinsicSignature>,
	/// The function that should be called.
	pub call: Vec<u8>,
}

impl<'a> TryFrom<StringOrBytes<'a>> for EncodedExtrinsic {
	type Error = String;

	fn try_from(value: StringOrBytes<'a>) -> Result<Self, Self::Error> {
		match value {
			StringOrBytes::StringRef(s) => Self::try_from(s),
			StringOrBytes::BoxedString(s) => Self::try_from(&*s),
			StringOrBytes::Bytes(b) => Self::try_from(b),
			StringOrBytes::BoxedBytes(b) => Self::try_from(&*b),
		}
	}
}

impl TryFrom<Vec<u8>> for EncodedExtrinsic {
	type Error = String;

	fn try_from(value: Vec<u8>) -> Result<Self, Self::Error> {
		Self::try_from(value.as_slice())
	}
}

impl TryFrom<&Vec<u8>> for EncodedExtrinsic {
	type Error = String;

	fn try_from(value: &Vec<u8>) -> Result<Self, Self::Error> {
		Self::try_from(value.as_slice())
	}
}

impl TryFrom<&[u8]> for EncodedExtrinsic {
	type Error = String;

	fn try_from(value: &[u8]) -> Result<Self, Self::Error> {
		let mut value = value;
		Self::decode(&mut value).map_err(|x| x.to_string())
	}
}

impl TryFrom<String> for EncodedExtrinsic {
	type Error = String;

	fn try_from(value: String) -> Result<Self, Self::Error> {
		Self::try_from(value.as_str())
	}
}

impl TryFrom<&String> for EncodedExtrinsic {
	type Error = String;

	fn try_from(value: &String) -> Result<Self, Self::Error> {
		Self::try_from(value.as_str())
	}
}

impl TryFrom<&str> for EncodedExtrinsic {
	type Error = String;

	fn try_from(value: &str) -> Result<Self, Self::Error> {
		let Ok(hex_decoded) = const_hex::decode(value.trim_start_matches("0x")) else {
			return Err("Failed to hex decode transaction".into());
		};

		Self::try_from(hex_decoded.as_slice())
	}
}

impl Decode for EncodedExtrinsic {
	fn decode<I: Input>(input: &mut I) -> Result<Self, Error> {
		// This is a little more complicated than usual since the binary format must be compatible
		// with SCALE's generic `Vec<u8>` type. Basically this just means accepting that there
		// will be a prefix of vector length.
		let expected_length: Compact<u32> = Decode::decode(input)?;
		let before_length = input.remaining_len()?;

		let version = input.read_byte()?;

		let is_signed = version & 0b1000_0000 != 0;
		let version = version & 0b0111_1111;
		if version != EXTRINSIC_FORMAT_VERSION {
			return Err("Invalid transaction version".into());
		}

		let signature = is_signed.then(|| Decode::decode(input)).transpose()?;
		let call = decode_already_decoded(input)?;

		if let Some((before_length, after_length)) = input.remaining_len()?.and_then(|a| before_length.map(|b| (b, a)))
		{
			let length = before_length.saturating_sub(after_length);

			if length != expected_length.0 as usize {
				return Err("Invalid length prefix".into());
			}
		}

		Ok(Self { signature, call })
	}
}

impl Encode for EncodedExtrinsic {
	fn encode_to<T: codec::Output + ?Sized>(&self, dest: &mut T) {
		let mut encoded_tx_inner = Vec::new();
		if let Some(signed) = &self.signature {
			0x84u8.encode_to(&mut encoded_tx_inner);
			signed.address.encode_to(&mut encoded_tx_inner);
			signed.signature.encode_to(&mut encoded_tx_inner);
			signed.extra.encode_to(&mut encoded_tx_inner);
		} else {
			0x4u8.encode_to(&mut encoded_tx_inner);
		}

		encoded_tx_inner.extend(&self.call);
		let mut encoded_tx = Compact(encoded_tx_inner.len() as u32).encode();
		encoded_tx.append(&mut encoded_tx_inner);

		dest.write(&encoded_tx)
	}
}

impl Serialize for EncodedExtrinsic {
	fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
	where
		S: serde::Serializer,
	{
		let bytes = self.encode();
		impl_serde::serialize::serialize(&bytes, serializer)
	}
}

impl<'a> Deserialize<'a> for EncodedExtrinsic {
	fn deserialize<D>(de: D) -> Result<Self, D::Error>
	where
		D: serde::Deserializer<'a>,
	{
		let r = impl_serde::serialize::deserialize(de)?;
		Decode::decode(&mut &r[..]).map_err(|e| serde::de::Error::custom(format!("Decode error: {}", e)))
	}
}

#[derive(Debug, Clone)]
pub struct SignedExtrinsic<T: HasHeader + Decode + Sized> {
	pub signature: ExtrinsicSignature,
	pub call: T,
}

impl<'a, T: HasHeader + Decode> TryFrom<StringOrBytes<'a>> for SignedExtrinsic<T> {
	type Error = String;

	fn try_from(value: StringOrBytes<'a>) -> Result<Self, Self::Error> {
		match value {
			StringOrBytes::StringRef(s) => Self::try_from(s),
			StringOrBytes::BoxedString(s) => Self::try_from(&*s),
			StringOrBytes::Bytes(b) => Self::try_from(b),
			StringOrBytes::BoxedBytes(b) => Self::try_from(&*b),
		}
	}
}

impl<T: HasHeader + Decode> TryFrom<Vec<u8>> for SignedExtrinsic<T> {
	type Error = String;

	fn try_from(value: Vec<u8>) -> Result<Self, Self::Error> {
		Self::try_from(value.as_slice())
	}
}

impl<T: HasHeader + Decode> TryFrom<&Vec<u8>> for SignedExtrinsic<T> {
	type Error = String;

	fn try_from(value: &Vec<u8>) -> Result<Self, Self::Error> {
		Self::try_from(value.as_slice())
	}
}

impl<T: HasHeader + Decode> TryFrom<&[u8]> for SignedExtrinsic<T> {
	type Error = String;

	fn try_from(value: &[u8]) -> Result<Self, Self::Error> {
		let ext = EncodedExtrinsic::try_from(value)?;
		Self::try_from(ext)
	}
}

impl<T: HasHeader + Decode> TryFrom<String> for SignedExtrinsic<T> {
	type Error = String;

	fn try_from(value: String) -> Result<Self, Self::Error> {
		Self::try_from(value.as_str())
	}
}

impl<T: HasHeader + Decode> TryFrom<&String> for SignedExtrinsic<T> {
	type Error = String;

	fn try_from(value: &String) -> Result<Self, Self::Error> {
		Self::try_from(value.as_str())
	}
}

impl<T: HasHeader + Decode> TryFrom<&str> for SignedExtrinsic<T> {
	type Error = String;

	fn try_from(value: &str) -> Result<Self, Self::Error> {
		let ext = EncodedExtrinsic::try_from(value)?;
		Self::try_from(ext)
	}
}

impl<T: HasHeader + Decode> TryFrom<EncodedExtrinsic> for SignedExtrinsic<T> {
	type Error = String;

	fn try_from(value: EncodedExtrinsic) -> Result<Self, Self::Error> {
		let signature = value.signature.ok_or("Extrinsic has no signature")?;
		let call = T::from_call(&value.call)?;
		Ok(Self { signature, call })
	}
}

impl<T: HasHeader + Decode> TryFrom<&EncodedExtrinsic> for SignedExtrinsic<T> {
	type Error = String;

	fn try_from(value: &EncodedExtrinsic) -> Result<Self, Self::Error> {
		let signature = value.signature.as_ref().ok_or("Extrinsic has no signature")?.clone();
		let call = T::from_call(&value.call)?;
		Ok(Self { signature, call })
	}
}

#[derive(Debug, Clone)]
pub struct Extrinsic<T: HasHeader + Decode + Sized> {
	pub signature: Option<ExtrinsicSignature>,
	pub call: T,
}

impl<'a, T: HasHeader + Decode> TryFrom<StringOrBytes<'a>> for Extrinsic<T> {
	type Error = String;

	fn try_from(value: StringOrBytes<'a>) -> Result<Self, Self::Error> {
		match value {
			StringOrBytes::StringRef(s) => Self::try_from(s),
			StringOrBytes::BoxedString(s) => Self::try_from(&*s),
			StringOrBytes::Bytes(b) => Self::try_from(b),
			StringOrBytes::BoxedBytes(b) => Self::try_from(&*b),
		}
	}
}

impl<T: HasHeader + Decode> TryFrom<Vec<u8>> for Extrinsic<T> {
	type Error = String;

	fn try_from(value: Vec<u8>) -> Result<Self, Self::Error> {
		Self::try_from(value.as_slice())
	}
}

impl<T: HasHeader + Decode> TryFrom<&Vec<u8>> for Extrinsic<T> {
	type Error = String;

	fn try_from(value: &Vec<u8>) -> Result<Self, Self::Error> {
		Self::try_from(value.as_slice())
	}
}

impl<T: HasHeader + Decode> TryFrom<&[u8]> for Extrinsic<T> {
	type Error = String;

	fn try_from(value: &[u8]) -> Result<Self, Self::Error> {
		let ext = EncodedExtrinsic::try_from(value)?;
		Self::try_from(ext)
	}
}

impl<T: HasHeader + Decode> TryFrom<String> for Extrinsic<T> {
	type Error = String;

	fn try_from(value: String) -> Result<Self, Self::Error> {
		Self::try_from(value.as_str())
	}
}

impl<T: HasHeader + Decode> TryFrom<&String> for Extrinsic<T> {
	type Error = String;

	fn try_from(value: &String) -> Result<Self, Self::Error> {
		Self::try_from(value.as_str())
	}
}

impl<T: HasHeader + Decode> TryFrom<&str> for Extrinsic<T> {
	type Error = String;

	fn try_from(value: &str) -> Result<Self, Self::Error> {
		let ext = EncodedExtrinsic::try_from(value)?;
		Self::try_from(ext)
	}
}

impl<T: HasHeader + Decode> TryFrom<EncodedExtrinsic> for Extrinsic<T> {
	type Error = String;

	fn try_from(value: EncodedExtrinsic) -> Result<Self, Self::Error> {
		Self::try_from(&value)
	}
}

impl<T: HasHeader + Decode> TryFrom<&EncodedExtrinsic> for Extrinsic<T> {
	type Error = String;

	fn try_from(value: &EncodedExtrinsic) -> Result<Self, Self::Error> {
		let call = T::from_call(&value.call)?;
		Ok(Self { signature: value.signature.clone(), call })
	}
}

#[cfg(test)]
pub mod test {
	/* 	#[test]
	fn test_encoding_decoding() {
		let call = SubmitData { data: vec![0, 1, 2, 3] }.to_call();

		let account_id = AccountId32([1u8; 32]);
		let signature = [1u8; 64];
		let signed = SignedExtra {
			address: MultiAddress::Id(account_id),
			signature: MultiSignature::Sr25519(signature),
			tx_extra: ExtrinsicExtra {
				era: Era::Mortal { period: 4, phase: 2 },
				nonce: 1,
				tip: 2u128,
				app_id: 3,
			},
		};

		let tx = Extrinsic {
			signature: Some(signed.clone()),
			call: Cow::Owned(call.clone()),
		};

		let encoded_tx = tx.encode();

		// Opaque Transaction
		let opaque = EncodedExtrinsic::try_from(&encoded_tx).unwrap();
		let opaque_encoded = opaque.encode();

		assert_eq!(encoded_tx, opaque_encoded);
	}

	#[test]
	fn test_serialize_deserialize() {
		let call = SubmitData { data: vec![0, 1, 2, 3] }.to_call();

		let account_id = AccountId32([1u8; 32]);
		let signature = [1u8; 64];
		let signed = SignedExtra {
			address: MultiAddress::Id(account_id),
			signature: MultiSignature::Sr25519(signature),
			tx_extra: ExtrinsicExtra {
				era: Era::Mortal { period: 4, phase: 2 },
				nonce: 1,
				tip: 2u128,
				app_id: 3,
			},
		};

		let tx = Extrinsic {
			signature: Some(signed.clone()),
			call: Cow::Owned(call.clone()),
		};

		let encoded_tx = tx.encode();
		let expected_serialized = std::format!("0x{}", const_hex::encode(&encoded_tx));

		// Transaction Serialized
		let serialized = serde_json::to_string(&tx).unwrap();
		assert_eq!(serialized.trim_matches('"'), expected_serialized);

		// Transaction Deserialized
		let tx_deserialized: Extrinsic = serde_json::from_str(&serialized).unwrap();
		assert_eq!(encoded_tx, tx_deserialized.encode());

		// Opaque Serialized
		let opaque = EncodedExtrinsic::try_from(&encoded_tx).unwrap();
		let serialized = serde_json::to_string(&opaque).unwrap();
		assert_eq!(serialized.trim_matches('"'), expected_serialized);

		// Opaque Deserialized
		let opaque_deserialized: EncodedExtrinsic = serde_json::from_str(&serialized).unwrap();
		assert_eq!(encoded_tx, opaque_deserialized.encode());
	} */
}