mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-04-26 16:57:58 +00:00
49b6dfd2e5
* Cargo.lock after merge * Restore scale-info feature * Fully qualify TypeInfo derive * Skip PendingSwap T * Add missing skip_type_params attr * metadata docs features * Reduce pallet event attribute to struct * Cargo.lock * Update frame/balances/src/tests_composite.rs Co-authored-by: Guillaume Thiolliere <gui.thiolliere@gmail.com> * Line widths check * Cargo.lock * Add scale-info/std * Update frame/system/src/lib.rs Co-authored-by: Guillaume Thiolliere <gui.thiolliere@gmail.com> * Use `skip_type_params` to remove `TypeInfo` requirements on checks * Revert "Remove unused Call metadata stuff" This reverts commit 41311f85 * Skip BalanceSwapAction type parameter * Remove unused event metadata macro * Update frame-metadata * Update primitives/npos-elections/compact/src/codec.rs Co-authored-by: Guillaume Thiolliere <gui.thiolliere@gmail.com> * Manual TypeInfo for Header * Remove TypeInfo requirement for consts in BoundedVec etc. * Another TypeInfo bound removed * review: fix indentation * TypeInfo impls for Identity types * Add some todos to add custom TypeInfo impls * Update frame/support/procedural/src/pallet/expand/pallet_struct.rs Co-authored-by: Guillaume Thiolliere <gui.thiolliere@gmail.com> * Add some todos to add custom TypeInfo impls * Add a test for manual Data TypeInfo impl * Add custom TypeInfo impl for Vote * Era custom TypeInfo crimes * Revert finality-grandpa version to 0.14.z * review: renamed module to pallet_constants_metadata * New line at end of file * Add missing scale-info/std * Update frame/support/src/storage/types/mod.rs Co-authored-by: Guillaume Thiolliere <gui.thiolliere@gmail.com> * Remove StorageEntryType::Map unused flag * Add missing scale-info dependency after merge * SignedExtension::AdditionalSigned metadata * Update frame-metadata, use abbreviated docs and args fields * Update frame/example/Cargo.toml Co-authored-by: Keith Yeung <kungfukeith11@gmail.com> * Add scale_info/std and remove unused scale-info dependency * Remove scale-info dependency * Remove treasury pallet::metadata * Remove redundant Event test * Add back scale-info as dev dependency * fix error metadata when no error defined in decl_module * Add Module3 to tests * Fix metadata test * Add docs feature to frame-support test * WIP fixing pallet metadata test * Remove redundant FunctionMetadata, FunctionArgumentMetadata as per https://github.com/paritytech/frame-metadata/pull/20 * Use main branch of frame-metadata * Use patch of scale-info for latest changes * Use latest patched scale-info * Manual TypeInfo for DigestItem * Manual TypeInfo for DigestItem * Update scale-info * Skip __Ignore variants for Error, depends on https://github.com/paritytech/scale-info/pull/117 * Named fields for FRAME v2 pallet Call variants * Named fields for FRAME v1 pallet Call variants * Add missing scale-info dependency * WIP expand benchmark call variant * fix benchmark with new function create a new function for each variant of a pallet call. This function is called by benchmarking macro in order not to break call creation with unnamed argument * fix tests * more fix * Fix staking tests * Fix offchain workers calls * Cherry pick rustfmt.toml from master * cargo +nightly-2021-06-22 fmt --all * Update to new call variant structs * More call variant struct updates * Remove unused import * More call variant structs * More call variant structs * Even more call variant structs * Mooar variant structs * Evermore variant structs * Call variant structs ad infinitum * Fmt * More call variants * Last call variant * Call variants all done? * Fix SS58Prefix type * Potential workaround for BitFlags<IdentityFields> TypeInfo * Enable docs capturing for Call, Event, and Error types * Fix IdentityFields TypeInfo * Remove metadata-docs feature * Add capture_docs = true for legacy Call, Event and Error types * Fmt * Fix metadata test type * Update benchmarks with call struct variants * Fmt * More test fixes * Fmt * Fix benches * Use latest capture_docs attr * Latest scale_info * Fmt * review: change &Vec to &[] * Remove pallet metadata attr * review: remove commented out test code * review: skip_type_params trailing comma suggestion * Update to scale-info 0.10.0 * Update construct_runtime ui tests, different because of metadata TypeInfo impls * Add some TypeInfo derives for UI tests * Update storage ensure span ui stderrs * Update call argument bound ui tests Possibly changed because change from tuple to struct variants? * Add scale-info dev dependency * Update to latest finality-grandpa release * review: missing newline * review: missing scale-info/std * review: remove duplicate scale-info/std * review: remove fully qualified TypeInfo * review: add missing scale-info/std * review: remove unnecessary imports. * Fmt * Use crates.io RC version of frame-metadata * Remove scale-info/std because it is a dev dependency * Add missing scale_info dev-dependency for test * Delete empty metadata folder * Fix sp_std import * review: improve manual UncheckedExtrinsic TypeInfo impl * review: use full scale-info for dev-dependency * Remove DefaultByteGetter impl * review: derive TypeInfo for generic header * Fmt * Update primitives/runtime/src/generic/unchecked_extrinsic.rs Co-authored-by: Keith Yeung <kungfukeith11@gmail.com> * Update primitives/runtime/src/generic/unchecked_extrinsic.rs Co-authored-by: Keith Yeung <kungfukeith11@gmail.com> * Update bin/node/executor/Cargo.toml Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com> * Update frame/identity/src/types.rs Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com> * Update frame/support/src/dispatch.rs Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com> * Remove redundant derive * Simplify scale-info dependency * Strip underscore prefix from call variant struct names * Another underscore field * More underscore fields * Another underscore field * Update to frame-metadata 14.0.0-rc.2 with combined StorageEntryType::Map * Fmt * Revert weights formatting * Fix up some tests * Fix up some tests for StorageEntryTypeMetadata * scale-info dev dependency * Fix test error * Add missing TypeInfo derives * Add back missing scale-info dependency * Add back missing scale-info dependency * Fix npos compact impls * Cargo.lock * Fmt * Fix errors * Fmt * Fix renamed raw_solution field * Fix error * Fmt * Fix some benchmarks * Fmt * Stray R * Fix * Add missing TypeInfos * ui test fix * Fix line widths * Revert "ui test fix" This reverts commit 2d15ec058a216e3f92d713f1174603a2bb1eac65. * Upgrade to scale-info 0.11.0 * Revert "Upgrade to scale-info 0.11.0" This reverts commit 047bb179085a0059c36cd20ab405f55cf0867e28. * Add Runtime type * Update to scale-info 0.12 * Update to scale-info 1.0 * Update frame-metadata to version 14.0.0 * Patch finality-grandpa until release available * Fix metadata tests * Fix metadata tests * Fmt * Remove patched finality-grandpa * Fix tests, use scale_info imports * Fix pallet tests * Add BlockNumber TypeInfo bound * ui test fix * Cargo.lock * Remove pallet metadata * Cargo.lock * Add missing scale-info dependency * Remove pallet event metadata * Fix error * Fix collective errors * Semicolol * Fmt * Remove another metadata attribute * Add new variant to custom digest TypeInfo * Fmt * Cargo.lock from master * Remove comma lol * Fix example call error * Fix example call error properly Co-authored-by: Guillaume Thiolliere <gui.thiolliere@gmail.com> Co-authored-by: Keith Yeung <kungfukeith11@gmail.com> Co-authored-by: Shawn Tabrizi <shawntabrizi@gmail.com> Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com>
735 lines
26 KiB
Rust
735 lines
26 KiB
Rust
// This file is part of Substrate.
|
|
|
|
// Copyright (C) 2019-2021 Parity Technologies (UK) Ltd.
|
|
// 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.
|
|
|
|
//! # Multisig pallet
|
|
//! A pallet for doing multisig dispatch.
|
|
//!
|
|
//! - [`Config`]
|
|
//! - [`Call`]
|
|
//!
|
|
//! ## Overview
|
|
//!
|
|
//! This pallet contains functionality for multi-signature dispatch, a (potentially) stateful
|
|
//! operation, allowing multiple signed
|
|
//! origins (accounts) to coordinate and dispatch a call from a well-known origin, derivable
|
|
//! deterministically from the set of account IDs and the threshold number of accounts from the
|
|
//! set that must approve it. In the case that the threshold is just one then this is a stateless
|
|
//! operation. This is useful for multisig wallets where cryptographic threshold signatures are
|
|
//! not available or desired.
|
|
//!
|
|
//! ## Interface
|
|
//!
|
|
//! ### Dispatchable Functions
|
|
//!
|
|
//! * `as_multi` - Approve and if possible dispatch a call from a composite origin formed from a
|
|
//! number of signed origins.
|
|
//! * `approve_as_multi` - Approve a call from a composite origin.
|
|
//! * `cancel_as_multi` - Cancel a call from a composite origin.
|
|
//!
|
|
//! [`Call`]: ./enum.Call.html
|
|
//! [`Config`]: ./trait.Config.html
|
|
|
|
// Ensure we're `no_std` when compiling for Wasm.
|
|
#![cfg_attr(not(feature = "std"), no_std)]
|
|
|
|
mod benchmarking;
|
|
mod tests;
|
|
pub mod weights;
|
|
|
|
use codec::{Decode, Encode};
|
|
use frame_support::{
|
|
dispatch::{
|
|
DispatchErrorWithPostInfo, DispatchResult, DispatchResultWithPostInfo, PostDispatchInfo,
|
|
},
|
|
ensure,
|
|
traits::{Currency, Get, ReservableCurrency},
|
|
weights::{GetDispatchInfo, Weight},
|
|
RuntimeDebug,
|
|
};
|
|
use frame_system::{self as system, RawOrigin};
|
|
use scale_info::TypeInfo;
|
|
use sp_io::hashing::blake2_256;
|
|
use sp_runtime::{
|
|
traits::{Dispatchable, Zero},
|
|
DispatchError,
|
|
};
|
|
use sp_std::prelude::*;
|
|
pub use weights::WeightInfo;
|
|
|
|
pub use pallet::*;
|
|
|
|
type BalanceOf<T> =
|
|
<<T as Config>::Currency as Currency<<T as frame_system::Config>::AccountId>>::Balance;
|
|
/// Just a bunch of bytes, but they should decode to a valid `Call`.
|
|
pub type OpaqueCall = Vec<u8>;
|
|
|
|
/// A global extrinsic index, formed as the extrinsic index within a block, together with that
|
|
/// block's height. This allows a transaction in which a multisig operation of a particular
|
|
/// composite was created to be uniquely identified.
|
|
#[derive(Copy, Clone, Eq, PartialEq, Encode, Decode, Default, RuntimeDebug, TypeInfo)]
|
|
pub struct Timepoint<BlockNumber> {
|
|
/// The height of the chain at the point in time.
|
|
height: BlockNumber,
|
|
/// The index of the extrinsic at the point in time.
|
|
index: u32,
|
|
}
|
|
|
|
/// An open multisig operation.
|
|
#[derive(Clone, Eq, PartialEq, Encode, Decode, Default, RuntimeDebug, TypeInfo)]
|
|
pub struct Multisig<BlockNumber, Balance, AccountId> {
|
|
/// The extrinsic when the multisig operation was opened.
|
|
when: Timepoint<BlockNumber>,
|
|
/// The amount held in reserve of the `depositor`, to be returned once the operation ends.
|
|
deposit: Balance,
|
|
/// The account who opened it (i.e. the first to approve it).
|
|
depositor: AccountId,
|
|
/// The approvals achieved so far, including the depositor. Always sorted.
|
|
approvals: Vec<AccountId>,
|
|
}
|
|
|
|
type CallHash = [u8; 32];
|
|
|
|
enum CallOrHash {
|
|
Call(OpaqueCall, bool),
|
|
Hash([u8; 32]),
|
|
}
|
|
|
|
#[frame_support::pallet]
|
|
pub mod pallet {
|
|
use super::*;
|
|
use frame_support::pallet_prelude::*;
|
|
use frame_system::pallet_prelude::*;
|
|
|
|
#[pallet::config]
|
|
pub trait Config: frame_system::Config {
|
|
/// The overarching event type.
|
|
type Event: From<Event<Self>> + IsType<<Self as frame_system::Config>::Event>;
|
|
|
|
/// The overarching call type.
|
|
type Call: Parameter
|
|
+ Dispatchable<Origin = Self::Origin, PostInfo = PostDispatchInfo>
|
|
+ GetDispatchInfo
|
|
+ From<frame_system::Call<Self>>;
|
|
|
|
/// The currency mechanism.
|
|
type Currency: ReservableCurrency<Self::AccountId>;
|
|
|
|
/// The base amount of currency needed to reserve for creating a multisig execution or to
|
|
/// store a dispatch call for later.
|
|
///
|
|
/// This is held for an additional storage item whose value size is
|
|
/// `4 + sizeof((BlockNumber, Balance, AccountId))` bytes and whose key size is
|
|
/// `32 + sizeof(AccountId)` bytes.
|
|
#[pallet::constant]
|
|
type DepositBase: Get<BalanceOf<Self>>;
|
|
|
|
/// The amount of currency needed per unit threshold when creating a multisig execution.
|
|
///
|
|
/// This is held for adding 32 bytes more into a pre-existing storage value.
|
|
#[pallet::constant]
|
|
type DepositFactor: Get<BalanceOf<Self>>;
|
|
|
|
/// The maximum amount of signatories allowed in the multisig.
|
|
#[pallet::constant]
|
|
type MaxSignatories: Get<u16>;
|
|
|
|
/// Weight information for extrinsics in this pallet.
|
|
type WeightInfo: WeightInfo;
|
|
}
|
|
|
|
#[pallet::pallet]
|
|
#[pallet::generate_store(pub(super) trait Store)]
|
|
pub struct Pallet<T>(_);
|
|
|
|
/// The set of open multisig operations.
|
|
#[pallet::storage]
|
|
pub type Multisigs<T: Config> = StorageDoubleMap<
|
|
_,
|
|
Twox64Concat,
|
|
T::AccountId,
|
|
Blake2_128Concat,
|
|
[u8; 32],
|
|
Multisig<T::BlockNumber, BalanceOf<T>, T::AccountId>,
|
|
>;
|
|
|
|
#[pallet::storage]
|
|
pub type Calls<T: Config> =
|
|
StorageMap<_, Identity, [u8; 32], (OpaqueCall, T::AccountId, BalanceOf<T>)>;
|
|
|
|
#[pallet::error]
|
|
pub enum Error<T> {
|
|
/// Threshold must be 2 or greater.
|
|
MinimumThreshold,
|
|
/// Call is already approved by this signatory.
|
|
AlreadyApproved,
|
|
/// Call doesn't need any (more) approvals.
|
|
NoApprovalsNeeded,
|
|
/// There are too few signatories in the list.
|
|
TooFewSignatories,
|
|
/// There are too many signatories in the list.
|
|
TooManySignatories,
|
|
/// The signatories were provided out of order; they should be ordered.
|
|
SignatoriesOutOfOrder,
|
|
/// The sender was contained in the other signatories; it shouldn't be.
|
|
SenderInSignatories,
|
|
/// Multisig operation not found when attempting to cancel.
|
|
NotFound,
|
|
/// Only the account that originally created the multisig is able to cancel it.
|
|
NotOwner,
|
|
/// No timepoint was given, yet the multisig operation is already underway.
|
|
NoTimepoint,
|
|
/// A different timepoint was given to the multisig operation that is underway.
|
|
WrongTimepoint,
|
|
/// A timepoint was given, yet no multisig operation is underway.
|
|
UnexpectedTimepoint,
|
|
/// The maximum weight information provided was too low.
|
|
MaxWeightTooLow,
|
|
/// The data to be stored is already stored.
|
|
AlreadyStored,
|
|
}
|
|
|
|
#[pallet::event]
|
|
#[pallet::generate_deposit(pub(super) fn deposit_event)]
|
|
pub enum Event<T: Config> {
|
|
/// A new multisig operation has begun. \[approving, multisig, call_hash\]
|
|
NewMultisig(T::AccountId, T::AccountId, CallHash),
|
|
/// A multisig operation has been approved by someone.
|
|
/// \[approving, timepoint, multisig, call_hash\]
|
|
MultisigApproval(T::AccountId, Timepoint<T::BlockNumber>, T::AccountId, CallHash),
|
|
/// A multisig operation has been executed. \[approving, timepoint, multisig, call_hash\]
|
|
MultisigExecuted(
|
|
T::AccountId,
|
|
Timepoint<T::BlockNumber>,
|
|
T::AccountId,
|
|
CallHash,
|
|
DispatchResult,
|
|
),
|
|
/// A multisig operation has been cancelled. \[cancelling, timepoint, multisig, call_hash\]
|
|
MultisigCancelled(T::AccountId, Timepoint<T::BlockNumber>, T::AccountId, CallHash),
|
|
}
|
|
|
|
#[pallet::hooks]
|
|
impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {}
|
|
|
|
#[pallet::call]
|
|
impl<T: Config> Pallet<T> {
|
|
/// Immediately dispatch a multi-signature call using a single approval from the caller.
|
|
///
|
|
/// The dispatch origin for this call must be _Signed_.
|
|
///
|
|
/// - `other_signatories`: The accounts (other than the sender) who are part of the
|
|
/// multi-signature, but do not participate in the approval process.
|
|
/// - `call`: The call to be executed.
|
|
///
|
|
/// Result is equivalent to the dispatched result.
|
|
///
|
|
/// # <weight>
|
|
/// O(Z + C) where Z is the length of the call and C its execution weight.
|
|
/// -------------------------------
|
|
/// - DB Weight: None
|
|
/// - Plus Call Weight
|
|
/// # </weight>
|
|
#[pallet::weight({
|
|
let dispatch_info = call.get_dispatch_info();
|
|
(
|
|
T::WeightInfo::as_multi_threshold_1(call.using_encoded(|c| c.len() as u32))
|
|
.saturating_add(dispatch_info.weight)
|
|
// AccountData for inner call origin accountdata.
|
|
.saturating_add(T::DbWeight::get().reads_writes(1, 1)),
|
|
dispatch_info.class,
|
|
)
|
|
})]
|
|
pub fn as_multi_threshold_1(
|
|
origin: OriginFor<T>,
|
|
other_signatories: Vec<T::AccountId>,
|
|
call: Box<<T as Config>::Call>,
|
|
) -> DispatchResultWithPostInfo {
|
|
let who = ensure_signed(origin)?;
|
|
let max_sigs = T::MaxSignatories::get() as usize;
|
|
ensure!(!other_signatories.is_empty(), Error::<T>::TooFewSignatories);
|
|
let other_signatories_len = other_signatories.len();
|
|
ensure!(other_signatories_len < max_sigs, Error::<T>::TooManySignatories);
|
|
let signatories = Self::ensure_sorted_and_insert(other_signatories, who)?;
|
|
|
|
let id = Self::multi_account_id(&signatories, 1);
|
|
|
|
let call_len = call.using_encoded(|c| c.len());
|
|
let result = call.dispatch(RawOrigin::Signed(id).into());
|
|
|
|
result
|
|
.map(|post_dispatch_info| {
|
|
post_dispatch_info
|
|
.actual_weight
|
|
.map(|actual_weight| {
|
|
T::WeightInfo::as_multi_threshold_1(call_len as u32)
|
|
.saturating_add(actual_weight)
|
|
})
|
|
.into()
|
|
})
|
|
.map_err(|err| match err.post_info.actual_weight {
|
|
Some(actual_weight) => {
|
|
let weight_used = T::WeightInfo::as_multi_threshold_1(call_len as u32)
|
|
.saturating_add(actual_weight);
|
|
let post_info = Some(weight_used).into();
|
|
let error = err.error.into();
|
|
DispatchErrorWithPostInfo { post_info, error }
|
|
},
|
|
None => err,
|
|
})
|
|
}
|
|
|
|
/// Register approval for a dispatch to be made from a deterministic composite account if
|
|
/// approved by a total of `threshold - 1` of `other_signatories`.
|
|
///
|
|
/// If there are enough, then dispatch the call.
|
|
///
|
|
/// Payment: `DepositBase` will be reserved if this is the first approval, plus
|
|
/// `threshold` times `DepositFactor`. It is returned once this dispatch happens or
|
|
/// is cancelled.
|
|
///
|
|
/// The dispatch origin for this call must be _Signed_.
|
|
///
|
|
/// - `threshold`: The total number of approvals for this dispatch before it is executed.
|
|
/// - `other_signatories`: The accounts (other than the sender) who can approve this
|
|
/// dispatch. May not be empty.
|
|
/// - `maybe_timepoint`: If this is the first approval, then this must be `None`. If it is
|
|
/// not the first approval, then it must be `Some`, with the timepoint (block number and
|
|
/// transaction index) of the first approval transaction.
|
|
/// - `call`: The call to be executed.
|
|
///
|
|
/// NOTE: Unless this is the final approval, you will generally want to use
|
|
/// `approve_as_multi` instead, since it only requires a hash of the call.
|
|
///
|
|
/// Result is equivalent to the dispatched result if `threshold` is exactly `1`. Otherwise
|
|
/// on success, result is `Ok` and the result from the interior call, if it was executed,
|
|
/// may be found in the deposited `MultisigExecuted` event.
|
|
///
|
|
/// # <weight>
|
|
/// - `O(S + Z + Call)`.
|
|
/// - Up to one balance-reserve or unreserve operation.
|
|
/// - One passthrough operation, one insert, both `O(S)` where `S` is the number of
|
|
/// signatories. `S` is capped by `MaxSignatories`, with weight being proportional.
|
|
/// - One call encode & hash, both of complexity `O(Z)` where `Z` is tx-len.
|
|
/// - One encode & hash, both of complexity `O(S)`.
|
|
/// - Up to one binary search and insert (`O(logS + S)`).
|
|
/// - I/O: 1 read `O(S)`, up to 1 mutate `O(S)`. Up to one remove.
|
|
/// - One event.
|
|
/// - The weight of the `call`.
|
|
/// - Storage: inserts one item, value size bounded by `MaxSignatories`, with a deposit
|
|
/// taken for its lifetime of `DepositBase + threshold * DepositFactor`.
|
|
/// -------------------------------
|
|
/// - DB Weight:
|
|
/// - Reads: Multisig Storage, [Caller Account], Calls (if `store_call`)
|
|
/// - Writes: Multisig Storage, [Caller Account], Calls (if `store_call`)
|
|
/// - Plus Call Weight
|
|
/// # </weight>
|
|
#[pallet::weight({
|
|
let s = other_signatories.len() as u32;
|
|
let z = call.len() as u32;
|
|
|
|
T::WeightInfo::as_multi_create(s, z)
|
|
.max(T::WeightInfo::as_multi_create_store(s, z))
|
|
.max(T::WeightInfo::as_multi_approve(s, z))
|
|
.max(T::WeightInfo::as_multi_complete(s, z))
|
|
.saturating_add(*max_weight)
|
|
})]
|
|
pub fn as_multi(
|
|
origin: OriginFor<T>,
|
|
threshold: u16,
|
|
other_signatories: Vec<T::AccountId>,
|
|
maybe_timepoint: Option<Timepoint<T::BlockNumber>>,
|
|
call: OpaqueCall,
|
|
store_call: bool,
|
|
max_weight: Weight,
|
|
) -> DispatchResultWithPostInfo {
|
|
let who = ensure_signed(origin)?;
|
|
Self::operate(
|
|
who,
|
|
threshold,
|
|
other_signatories,
|
|
maybe_timepoint,
|
|
CallOrHash::Call(call, store_call),
|
|
max_weight,
|
|
)
|
|
}
|
|
|
|
/// Register approval for a dispatch to be made from a deterministic composite account if
|
|
/// approved by a total of `threshold - 1` of `other_signatories`.
|
|
///
|
|
/// Payment: `DepositBase` will be reserved if this is the first approval, plus
|
|
/// `threshold` times `DepositFactor`. It is returned once this dispatch happens or
|
|
/// is cancelled.
|
|
///
|
|
/// The dispatch origin for this call must be _Signed_.
|
|
///
|
|
/// - `threshold`: The total number of approvals for this dispatch before it is executed.
|
|
/// - `other_signatories`: The accounts (other than the sender) who can approve this
|
|
/// dispatch. May not be empty.
|
|
/// - `maybe_timepoint`: If this is the first approval, then this must be `None`. If it is
|
|
/// not the first approval, then it must be `Some`, with the timepoint (block number and
|
|
/// transaction index) of the first approval transaction.
|
|
/// - `call_hash`: The hash of the call to be executed.
|
|
///
|
|
/// NOTE: If this is the final approval, you will want to use `as_multi` instead.
|
|
///
|
|
/// # <weight>
|
|
/// - `O(S)`.
|
|
/// - Up to one balance-reserve or unreserve operation.
|
|
/// - One passthrough operation, one insert, both `O(S)` where `S` is the number of
|
|
/// signatories. `S` is capped by `MaxSignatories`, with weight being proportional.
|
|
/// - One encode & hash, both of complexity `O(S)`.
|
|
/// - Up to one binary search and insert (`O(logS + S)`).
|
|
/// - I/O: 1 read `O(S)`, up to 1 mutate `O(S)`. Up to one remove.
|
|
/// - One event.
|
|
/// - Storage: inserts one item, value size bounded by `MaxSignatories`, with a deposit
|
|
/// taken for its lifetime of `DepositBase + threshold * DepositFactor`.
|
|
/// ----------------------------------
|
|
/// - DB Weight:
|
|
/// - Read: Multisig Storage, [Caller Account]
|
|
/// - Write: Multisig Storage, [Caller Account]
|
|
/// # </weight>
|
|
#[pallet::weight({
|
|
let s = other_signatories.len() as u32;
|
|
|
|
T::WeightInfo::approve_as_multi_create(s)
|
|
.max(T::WeightInfo::approve_as_multi_approve(s))
|
|
.max(T::WeightInfo::approve_as_multi_complete(s))
|
|
.saturating_add(*max_weight)
|
|
})]
|
|
pub fn approve_as_multi(
|
|
origin: OriginFor<T>,
|
|
threshold: u16,
|
|
other_signatories: Vec<T::AccountId>,
|
|
maybe_timepoint: Option<Timepoint<T::BlockNumber>>,
|
|
call_hash: [u8; 32],
|
|
max_weight: Weight,
|
|
) -> DispatchResultWithPostInfo {
|
|
let who = ensure_signed(origin)?;
|
|
Self::operate(
|
|
who,
|
|
threshold,
|
|
other_signatories,
|
|
maybe_timepoint,
|
|
CallOrHash::Hash(call_hash),
|
|
max_weight,
|
|
)
|
|
}
|
|
|
|
/// Cancel a pre-existing, on-going multisig transaction. Any deposit reserved previously
|
|
/// for this operation will be unreserved on success.
|
|
///
|
|
/// The dispatch origin for this call must be _Signed_.
|
|
///
|
|
/// - `threshold`: The total number of approvals for this dispatch before it is executed.
|
|
/// - `other_signatories`: The accounts (other than the sender) who can approve this
|
|
/// dispatch. May not be empty.
|
|
/// - `timepoint`: The timepoint (block number and transaction index) of the first approval
|
|
/// transaction for this dispatch.
|
|
/// - `call_hash`: The hash of the call to be executed.
|
|
///
|
|
/// # <weight>
|
|
/// - `O(S)`.
|
|
/// - Up to one balance-reserve or unreserve operation.
|
|
/// - One passthrough operation, one insert, both `O(S)` where `S` is the number of
|
|
/// signatories. `S` is capped by `MaxSignatories`, with weight being proportional.
|
|
/// - One encode & hash, both of complexity `O(S)`.
|
|
/// - One event.
|
|
/// - I/O: 1 read `O(S)`, one remove.
|
|
/// - Storage: removes one item.
|
|
/// ----------------------------------
|
|
/// - DB Weight:
|
|
/// - Read: Multisig Storage, [Caller Account], Refund Account, Calls
|
|
/// - Write: Multisig Storage, [Caller Account], Refund Account, Calls
|
|
/// # </weight>
|
|
#[pallet::weight(T::WeightInfo::cancel_as_multi(other_signatories.len() as u32))]
|
|
pub fn cancel_as_multi(
|
|
origin: OriginFor<T>,
|
|
threshold: u16,
|
|
other_signatories: Vec<T::AccountId>,
|
|
timepoint: Timepoint<T::BlockNumber>,
|
|
call_hash: [u8; 32],
|
|
) -> DispatchResult {
|
|
let who = ensure_signed(origin)?;
|
|
ensure!(threshold >= 2, Error::<T>::MinimumThreshold);
|
|
let max_sigs = T::MaxSignatories::get() as usize;
|
|
ensure!(!other_signatories.is_empty(), Error::<T>::TooFewSignatories);
|
|
ensure!(other_signatories.len() < max_sigs, Error::<T>::TooManySignatories);
|
|
let signatories = Self::ensure_sorted_and_insert(other_signatories, who.clone())?;
|
|
|
|
let id = Self::multi_account_id(&signatories, threshold);
|
|
|
|
let m = <Multisigs<T>>::get(&id, call_hash).ok_or(Error::<T>::NotFound)?;
|
|
ensure!(m.when == timepoint, Error::<T>::WrongTimepoint);
|
|
ensure!(m.depositor == who, Error::<T>::NotOwner);
|
|
|
|
let err_amount = T::Currency::unreserve(&m.depositor, m.deposit);
|
|
debug_assert!(err_amount.is_zero());
|
|
<Multisigs<T>>::remove(&id, &call_hash);
|
|
Self::clear_call(&call_hash);
|
|
|
|
Self::deposit_event(Event::MultisigCancelled(who, timepoint, id, call_hash));
|
|
Ok(())
|
|
}
|
|
}
|
|
}
|
|
|
|
impl<T: Config> Pallet<T> {
|
|
/// Derive a multi-account ID from the sorted list of accounts and the threshold that are
|
|
/// required.
|
|
///
|
|
/// NOTE: `who` must be sorted. If it is not, then you'll get the wrong answer.
|
|
pub fn multi_account_id(who: &[T::AccountId], threshold: u16) -> T::AccountId {
|
|
let entropy = (b"modlpy/utilisuba", who, threshold).using_encoded(blake2_256);
|
|
T::AccountId::decode(&mut &entropy[..]).unwrap_or_default()
|
|
}
|
|
|
|
fn operate(
|
|
who: T::AccountId,
|
|
threshold: u16,
|
|
other_signatories: Vec<T::AccountId>,
|
|
maybe_timepoint: Option<Timepoint<T::BlockNumber>>,
|
|
call_or_hash: CallOrHash,
|
|
max_weight: Weight,
|
|
) -> DispatchResultWithPostInfo {
|
|
ensure!(threshold >= 2, Error::<T>::MinimumThreshold);
|
|
let max_sigs = T::MaxSignatories::get() as usize;
|
|
ensure!(!other_signatories.is_empty(), Error::<T>::TooFewSignatories);
|
|
let other_signatories_len = other_signatories.len();
|
|
ensure!(other_signatories_len < max_sigs, Error::<T>::TooManySignatories);
|
|
let signatories = Self::ensure_sorted_and_insert(other_signatories, who.clone())?;
|
|
|
|
let id = Self::multi_account_id(&signatories, threshold);
|
|
|
|
// Threshold > 1; this means it's a multi-step operation. We extract the `call_hash`.
|
|
let (call_hash, call_len, maybe_call, store) = match call_or_hash {
|
|
CallOrHash::Call(call, should_store) => {
|
|
let call_hash = blake2_256(&call);
|
|
let call_len = call.len();
|
|
(call_hash, call_len, Some(call), should_store)
|
|
},
|
|
CallOrHash::Hash(h) => (h, 0, None, false),
|
|
};
|
|
|
|
// Branch on whether the operation has already started or not.
|
|
if let Some(mut m) = <Multisigs<T>>::get(&id, call_hash) {
|
|
// Yes; ensure that the timepoint exists and agrees.
|
|
let timepoint = maybe_timepoint.ok_or(Error::<T>::NoTimepoint)?;
|
|
ensure!(m.when == timepoint, Error::<T>::WrongTimepoint);
|
|
|
|
// Ensure that either we have not yet signed or that it is at threshold.
|
|
let mut approvals = m.approvals.len() as u16;
|
|
// We only bother with the approval if we're below threshold.
|
|
let maybe_pos = m.approvals.binary_search(&who).err().filter(|_| approvals < threshold);
|
|
// Bump approvals if not yet voted and the vote is needed.
|
|
if maybe_pos.is_some() {
|
|
approvals += 1;
|
|
}
|
|
|
|
// We only bother fetching/decoding call if we know that we're ready to execute.
|
|
let maybe_approved_call = if approvals >= threshold {
|
|
Self::get_call(&call_hash, maybe_call.as_ref().map(|c| c.as_ref()))
|
|
} else {
|
|
None
|
|
};
|
|
|
|
if let Some((call, call_len)) = maybe_approved_call {
|
|
// verify weight
|
|
ensure!(call.get_dispatch_info().weight <= max_weight, Error::<T>::MaxWeightTooLow);
|
|
|
|
// Clean up storage before executing call to avoid an possibility of reentrancy
|
|
// attack.
|
|
<Multisigs<T>>::remove(&id, call_hash);
|
|
Self::clear_call(&call_hash);
|
|
T::Currency::unreserve(&m.depositor, m.deposit);
|
|
|
|
let result = call.dispatch(RawOrigin::Signed(id.clone()).into());
|
|
Self::deposit_event(Event::MultisigExecuted(
|
|
who,
|
|
timepoint,
|
|
id,
|
|
call_hash,
|
|
result.map(|_| ()).map_err(|e| e.error),
|
|
));
|
|
Ok(get_result_weight(result)
|
|
.map(|actual_weight| {
|
|
T::WeightInfo::as_multi_complete(
|
|
other_signatories_len as u32,
|
|
call_len as u32,
|
|
)
|
|
.saturating_add(actual_weight)
|
|
})
|
|
.into())
|
|
} else {
|
|
// We cannot dispatch the call now; either it isn't available, or it is, but we
|
|
// don't have threshold approvals even with our signature.
|
|
|
|
// Store the call if desired.
|
|
let stored = if let Some(data) = maybe_call.filter(|_| store) {
|
|
Self::store_call_and_reserve(
|
|
who.clone(),
|
|
&call_hash,
|
|
data,
|
|
BalanceOf::<T>::zero(),
|
|
)?;
|
|
true
|
|
} else {
|
|
false
|
|
};
|
|
|
|
if let Some(pos) = maybe_pos {
|
|
// Record approval.
|
|
m.approvals.insert(pos, who.clone());
|
|
<Multisigs<T>>::insert(&id, call_hash, m);
|
|
Self::deposit_event(Event::MultisigApproval(who, timepoint, id, call_hash));
|
|
} else {
|
|
// If we already approved and didn't store the Call, then this was useless and
|
|
// we report an error.
|
|
ensure!(stored, Error::<T>::AlreadyApproved);
|
|
}
|
|
|
|
let final_weight = if stored {
|
|
T::WeightInfo::as_multi_approve_store(
|
|
other_signatories_len as u32,
|
|
call_len as u32,
|
|
)
|
|
} else {
|
|
T::WeightInfo::as_multi_approve(other_signatories_len as u32, call_len as u32)
|
|
};
|
|
// Call is not made, so the actual weight does not include call
|
|
Ok(Some(final_weight).into())
|
|
}
|
|
} else {
|
|
// Not yet started; there should be no timepoint given.
|
|
ensure!(maybe_timepoint.is_none(), Error::<T>::UnexpectedTimepoint);
|
|
|
|
// Just start the operation by recording it in storage.
|
|
let deposit = T::DepositBase::get() + T::DepositFactor::get() * threshold.into();
|
|
|
|
// Store the call if desired.
|
|
let stored = if let Some(data) = maybe_call.filter(|_| store) {
|
|
Self::store_call_and_reserve(who.clone(), &call_hash, data, deposit)?;
|
|
true
|
|
} else {
|
|
T::Currency::reserve(&who, deposit)?;
|
|
false
|
|
};
|
|
|
|
<Multisigs<T>>::insert(
|
|
&id,
|
|
call_hash,
|
|
Multisig {
|
|
when: Self::timepoint(),
|
|
deposit,
|
|
depositor: who.clone(),
|
|
approvals: vec![who.clone()],
|
|
},
|
|
);
|
|
Self::deposit_event(Event::NewMultisig(who, id, call_hash));
|
|
|
|
let final_weight = if stored {
|
|
T::WeightInfo::as_multi_create_store(other_signatories_len as u32, call_len as u32)
|
|
} else {
|
|
T::WeightInfo::as_multi_create(other_signatories_len as u32, call_len as u32)
|
|
};
|
|
// Call is not made, so the actual weight does not include call
|
|
Ok(Some(final_weight).into())
|
|
}
|
|
}
|
|
|
|
/// Place a call's encoded data in storage, reserving funds as appropriate.
|
|
///
|
|
/// We store `data` here because storing `call` would result in needing another `.encode`.
|
|
///
|
|
/// Returns a `bool` indicating whether the data did end up being stored.
|
|
fn store_call_and_reserve(
|
|
who: T::AccountId,
|
|
hash: &[u8; 32],
|
|
data: OpaqueCall,
|
|
other_deposit: BalanceOf<T>,
|
|
) -> DispatchResult {
|
|
ensure!(!Calls::<T>::contains_key(hash), Error::<T>::AlreadyStored);
|
|
let deposit = other_deposit +
|
|
T::DepositBase::get() +
|
|
T::DepositFactor::get() * BalanceOf::<T>::from(((data.len() + 31) / 32) as u32);
|
|
T::Currency::reserve(&who, deposit)?;
|
|
Calls::<T>::insert(&hash, (data, who, deposit));
|
|
Ok(())
|
|
}
|
|
|
|
/// Attempt to decode and return the call, provided by the user or from storage.
|
|
fn get_call(
|
|
hash: &[u8; 32],
|
|
maybe_known: Option<&[u8]>,
|
|
) -> Option<(<T as Config>::Call, usize)> {
|
|
maybe_known.map_or_else(
|
|
|| {
|
|
Calls::<T>::get(hash).and_then(|(data, ..)| {
|
|
Decode::decode(&mut &data[..]).ok().map(|d| (d, data.len()))
|
|
})
|
|
},
|
|
|data| Decode::decode(&mut &data[..]).ok().map(|d| (d, data.len())),
|
|
)
|
|
}
|
|
|
|
/// Attempt to remove a call from storage, returning any deposit on it to the owner.
|
|
fn clear_call(hash: &[u8; 32]) {
|
|
if let Some((_, who, deposit)) = Calls::<T>::take(hash) {
|
|
T::Currency::unreserve(&who, deposit);
|
|
}
|
|
}
|
|
|
|
/// The current `Timepoint`.
|
|
pub fn timepoint() -> Timepoint<T::BlockNumber> {
|
|
Timepoint {
|
|
height: <system::Pallet<T>>::block_number(),
|
|
index: <system::Pallet<T>>::extrinsic_index().unwrap_or_default(),
|
|
}
|
|
}
|
|
|
|
/// Check that signatories is sorted and doesn't contain sender, then insert sender.
|
|
fn ensure_sorted_and_insert(
|
|
other_signatories: Vec<T::AccountId>,
|
|
who: T::AccountId,
|
|
) -> Result<Vec<T::AccountId>, DispatchError> {
|
|
let mut signatories = other_signatories;
|
|
let mut maybe_last = None;
|
|
let mut index = 0;
|
|
for item in signatories.iter() {
|
|
if let Some(last) = maybe_last {
|
|
ensure!(last < item, Error::<T>::SignatoriesOutOfOrder);
|
|
}
|
|
if item <= &who {
|
|
ensure!(item != &who, Error::<T>::SenderInSignatories);
|
|
index += 1;
|
|
}
|
|
maybe_last = Some(item);
|
|
}
|
|
signatories.insert(index, who);
|
|
Ok(signatories)
|
|
}
|
|
}
|
|
|
|
/// Return the weight of a dispatch call result as an `Option`.
|
|
///
|
|
/// Will return the weight regardless of what the state of the result is.
|
|
fn get_result_weight(result: DispatchResultWithPostInfo) -> Option<Weight> {
|
|
match result {
|
|
Ok(post_info) => post_info.actual_weight,
|
|
Err(err) => err.post_info.actual_weight,
|
|
}
|
|
}
|