mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-06-13 22:11:06 +00:00
Tadeo hepperle
94 lines
3.6 KiB
Rust
94 lines
3.6 KiB
Rust
// Copyright 2019-2023 Parity Technologies (UK) Ltd.
|
|
// This file is dual-licensed as Apache-2.0 or GPL-3.0.
|
|
// see LICENSE for license details.
|
|
|
|
//! This module contains a trait which controls the parameters that must
|
|
//! be provided in order to successfully construct an extrinsic.
|
|
//! [`crate::config::DefaultExtrinsicParams`] provides a general-purpose
|
|
//! implementation of this that will work in many cases.
|
|
|
|
use crate::client::ClientBase;
|
|
|
|
use super::Config;
|
|
use alloc::string::String;
|
|
use alloc::vec::Vec;
|
|
use core::fmt::Debug;
|
|
|
|
use derive_more::Display;
|
|
|
|
/// An error that can be emitted when trying to construct an instance of [`ExtrinsicParams`],
|
|
/// encode data from the instance, or match on signed extensions.
|
|
#[derive(Display, Debug)]
|
|
#[non_exhaustive]
|
|
pub enum ExtrinsicParamsError {
|
|
/// Cannot find a type id in the metadata. The context provides some additional
|
|
/// information about the source of the error (eg the signed extension name).
|
|
#[display(fmt = "Cannot find type id '{type_id} in the metadata (context: {context})")]
|
|
MissingTypeId {
|
|
/// Type ID.
|
|
type_id: u32,
|
|
/// Some arbitrary context to help narrow the source of the error.
|
|
context: &'static str,
|
|
},
|
|
/// A signed extension in use on some chain was not provided.
|
|
#[display(
|
|
fmt = "The chain expects a signed extension with the name {_0}, but we did not provide one"
|
|
)]
|
|
UnknownSignedExtension(String),
|
|
/// Some custom error.
|
|
#[display(fmt = "Error constructing extrinsic parameters: {_0}")]
|
|
#[cfg(feature = "std")]
|
|
Custom(CustomExtrinsicParamsError),
|
|
}
|
|
|
|
/// A custom error.
|
|
#[cfg(feature = "std")]
|
|
pub type CustomExtrinsicParamsError = Box<dyn std::error::Error + Send + Sync + 'static>;
|
|
|
|
impl From<core::convert::Infallible> for ExtrinsicParamsError {
|
|
fn from(value: core::convert::Infallible) -> Self {
|
|
match value {}
|
|
}
|
|
}
|
|
|
|
#[cfg(feature = "std")]
|
|
impl From<CustomExtrinsicParamsError> for ExtrinsicParamsError {
|
|
fn from(value: CustomExtrinsicParamsError) -> Self {
|
|
ExtrinsicParamsError::Custom(value)
|
|
}
|
|
}
|
|
|
|
/// This trait allows you to configure the "signed extra" and
|
|
/// "additional" parameters that are a part of the transaction payload
|
|
/// or the signer payload respectively.
|
|
pub trait ExtrinsicParams<T: Config>: ExtrinsicParamsEncoder + Sized + 'static {
|
|
/// These parameters can be provided to the constructor along with
|
|
/// some default parameters that `subxt` understands, in order to
|
|
/// help construct your [`ExtrinsicParams`] object.
|
|
type OtherParams;
|
|
|
|
/// Construct a new instance of our [`ExtrinsicParams`].
|
|
fn new(
|
|
nonce: u64,
|
|
client: &ClientBase<T>,
|
|
other_params: Self::OtherParams,
|
|
) -> Result<Self, ExtrinsicParamsError>;
|
|
}
|
|
|
|
/// This trait is expected to be implemented for any [`ExtrinsicParams`], and
|
|
/// defines how to encode the "additional" and "extra" params. Both functions
|
|
/// are optional and will encode nothing by default.
|
|
pub trait ExtrinsicParamsEncoder: 'static {
|
|
/// This is expected to SCALE encode the "signed extra" parameters
|
|
/// to some buffer that has been provided. These are the parameters
|
|
/// which are sent along with the transaction, as well as taken into
|
|
/// account when signing the transaction.
|
|
fn encode_extra_to(&self, _v: &mut Vec<u8>) {}
|
|
|
|
/// This is expected to SCALE encode the "additional" parameters
|
|
/// to some buffer that has been provided. These parameters are _not_
|
|
/// sent along with the transaction, but are taken into account when
|
|
/// signing it, meaning the client and node must agree on their values.
|
|
fn encode_additional_to(&self, _v: &mut Vec<u8>) {}
|
|
}
|