Treasury spends various asset kinds (#1333)

### Summary 

This PR introduces new dispatchables to the treasury pallet, allowing
spends of various asset types. The enhanced features of the treasury
pallet, in conjunction with the asset-rate pallet, are set up and
enabled for Westend and Rococo.

### Westend and Rococo runtimes.

Polkadot/Kusams/Rococo Treasury can accept proposals for `spends` of
various asset kinds by specifying the asset's location and ID.

#### Treasury Instance New Dispatchables:
- `spend(AssetKind, AssetBalance, Beneficiary, Option<ValidFrom>)` -
propose and approve a spend;
- `payout(SpendIndex)` - payout an approved spend or retry a failed
payout
- `check_payment(SpendIndex)` - check the status of a payout;
- `void_spend(SpendIndex)` - void previously approved spend;
> existing spend dispatchable renamed to spend_local

in this context, the `AssetKind` parameter contains the asset's location
and it's corresponding `asset_id`, for example:
`USDT` on `AssetHub`,
``` rust
location = MultiLocation(0, X1(Parachain(1000)))
asset_id = MultiLocation(0, X2(PalletInstance(50), GeneralIndex(1984)))
```

the `Beneficiary` parameter is a `MultiLocation` in the context of the
asset's location, for example
``` rust
// the Fellowship salary pallet's location / account
FellowshipSalaryPallet = MultiLocation(1, X2(Parachain(1001), PalletInstance(64)))
// or custom `AccountId`
Alice = MultiLocation(0, AccountId32(network: None, id: [1,...]))
```

the `AssetBalance` represents the amount of the `AssetKind` to be
transferred to the `Beneficiary`. For permission checks, the asset
amount is converted to the native amount and compared against the
maximum spendable amount determined by the commanding spend origin.

the `spend` dispatchable allows for batching spends with different
`ValidFrom` arguments, enabling milestone-based spending. If the
expectations tied to an approved spend are not met, it is possible to
void the spend later using the `void_spend` dispatchable.

Asset Rate Pallet provides the conversion rate from the `AssetKind` to
the native balance.

#### Asset Rate Instance Dispatchables:
- `create(AssetKind, Rate)` - initialize a conversion rate to the native
balance for the given asset
- `update(AssetKind, Rate)` - update the conversion rate to the native
balance for the given asset
- `remove(AssetKind)` - remove an existing conversion rate to the native
balance for the given asset

the pallet's dispatchables can be executed by the Root or Treasurer
origins.

### Treasury Pallet

Treasury Pallet can accept proposals for `spends` of various asset kinds
and pay them out through the implementation of the `Pay` trait.

New Dispatchables:
- `spend(Config::AssetKind, AssetBalance, Config::Beneficiary,
Option<ValidFrom>)` - propose and approve a spend;
- `payout(SpendIndex)` - payout an approved spend or retry a failed
payout;
- `check_payment(SpendIndex)` - check the status of a payout;
- `void_spend(SpendIndex)` - void previously approved spend;
> existing spend dispatchable renamed to spend_local

The parameters' types of the `spend` dispatchable exposed via the
pallet's `Config` and allows to propose and accept a spend of a certain
amount.

An approved spend can be claimed via the `payout` within the
`Config::SpendPeriod`. Clients provide an implementation of the `Pay`
trait which can pay an asset of the `AssetKind` to the `Beneficiary` in
`AssetBalance` units.

The implementation of the Pay trait might not have an immediate final
payment status, for example if implemented over `XCM` and the actual
transfer happens on a remote chain.

The `check_status` dispatchable can be executed to update the spend's
payment state and retry the `payout` if the payment has failed.

---------

Co-authored-by: joe petrowski <25483142+joepetrowski@users.noreply.github.com>
Co-authored-by: command-bot <>
This commit is contained in:
Muharem
2023-10-07 19:32:35 +02:00
committed by GitHub
parent 5a6912606a
commit cb944dc548
32 changed files with 2213 additions and 286 deletions
+165 -58
View File
@@ -18,28 +18,23 @@
//! Autogenerated weights for pallet_treasury
//!
//! THIS FILE WAS AUTO-GENERATED USING THE SUBSTRATE BENCHMARK CLI VERSION 4.0.0-dev
//! DATE: 2023-06-16, STEPS: `50`, REPEAT: `20`, LOW RANGE: `[]`, HIGH RANGE: `[]`
//! DATE: 2023-07-07, STEPS: `20`, REPEAT: `2`, LOW RANGE: `[]`, HIGH RANGE: `[]`
//! WORST CASE MAP SIZE: `1000000`
//! HOSTNAME: `runner-e8ezs4ez-project-145-concurrent-0`, CPU: `Intel(R) Xeon(R) CPU @ 2.60GHz`
//! EXECUTION: Some(Wasm), WASM-EXECUTION: Compiled, CHAIN: Some("dev"), DB CACHE: 1024
//! HOSTNAME: `cob`, CPU: `<UNKNOWN>`
//! EXECUTION: None, WASM-EXECUTION: Compiled, CHAIN: Some("dev"), DB CACHE: 1024
// Executed Command:
// ./target/production/substrate
// ./target/debug/substrate
// benchmark
// pallet
// --chain=dev
// --steps=50
// --repeat=20
// --pallet=pallet_treasury
// --no-storage-info
// --no-median-slopes
// --no-min-squares
// --steps=20
// --repeat=2
// --pallet=pallet-treasury
// --extrinsic=*
// --execution=wasm
// --wasm-execution=compiled
// --heap-pages=4096
// --output=./frame/treasury/src/weights.rs
// --header=./HEADER-APACHE2
// --output=./frame/treasury/src/._weights.rs
// --template=./.maintain/frame-weight-template.hbs
#![cfg_attr(rustfmt, rustfmt_skip)]
@@ -52,12 +47,16 @@ use core::marker::PhantomData;
/// Weight functions needed for pallet_treasury.
pub trait WeightInfo {
fn spend() -> Weight;
fn spend_local() -> Weight;
fn propose_spend() -> Weight;
fn reject_proposal() -> Weight;
fn approve_proposal(p: u32, ) -> Weight;
fn remove_approval() -> Weight;
fn on_initialize_proposals(p: u32, ) -> Weight;
fn spend() -> Weight;
fn payout() -> Weight;
fn check_status() -> Weight;
fn void_spend() -> Weight;
}
/// Weights for pallet_treasury using the Substrate node and recommended hardware.
@@ -69,12 +68,12 @@ impl<T: frame_system::Config> WeightInfo for SubstrateWeight<T> {
/// Proof: Treasury Approvals (max_values: Some(1), max_size: Some(402), added: 897, mode: MaxEncodedLen)
/// Storage: Treasury Proposals (r:0 w:1)
/// Proof: Treasury Proposals (max_values: None, max_size: Some(108), added: 2583, mode: MaxEncodedLen)
fn spend() -> Weight {
fn spend_local() -> Weight {
// Proof Size summary in bytes:
// Measured: `76`
// Estimated: `1887`
// Minimum execution time: 15_057_000 picoseconds.
Weight::from_parts(15_803_000, 1887)
// Minimum execution time: 179_000_000 picoseconds.
Weight::from_parts(190_000_000, 1887)
.saturating_add(T::DbWeight::get().reads(2_u64))
.saturating_add(T::DbWeight::get().writes(3_u64))
}
@@ -86,8 +85,8 @@ impl<T: frame_system::Config> WeightInfo for SubstrateWeight<T> {
// Proof Size summary in bytes:
// Measured: `177`
// Estimated: `1489`
// Minimum execution time: 28_923_000 picoseconds.
Weight::from_parts(29_495_000, 1489)
// Minimum execution time: 349_000_000 picoseconds.
Weight::from_parts(398_000_000, 1489)
.saturating_add(T::DbWeight::get().reads(1_u64))
.saturating_add(T::DbWeight::get().writes(2_u64))
}
@@ -99,8 +98,8 @@ impl<T: frame_system::Config> WeightInfo for SubstrateWeight<T> {
// Proof Size summary in bytes:
// Measured: `335`
// Estimated: `3593`
// Minimum execution time: 30_539_000 picoseconds.
Weight::from_parts(30_986_000, 3593)
// Minimum execution time: 367_000_000 picoseconds.
Weight::from_parts(388_000_000, 3593)
.saturating_add(T::DbWeight::get().reads(2_u64))
.saturating_add(T::DbWeight::get().writes(2_u64))
}
@@ -111,12 +110,12 @@ impl<T: frame_system::Config> WeightInfo for SubstrateWeight<T> {
/// The range of component `p` is `[0, 99]`.
fn approve_proposal(p: u32, ) -> Weight {
// Proof Size summary in bytes:
// Measured: `504 + p * (8 ±0)`
// Measured: `483 + p * (9 ±0)`
// Estimated: `3573`
// Minimum execution time: 9_320_000 picoseconds.
Weight::from_parts(12_606_599, 3573)
// Standard Error: 1_302
.saturating_add(Weight::from_parts(71_054, 0).saturating_mul(p.into()))
// Minimum execution time: 111_000_000 picoseconds.
Weight::from_parts(108_813_243, 3573)
// Standard Error: 147_887
.saturating_add(Weight::from_parts(683_216, 0).saturating_mul(p.into()))
.saturating_add(T::DbWeight::get().reads(2_u64))
.saturating_add(T::DbWeight::get().writes(1_u64))
}
@@ -126,8 +125,8 @@ impl<T: frame_system::Config> WeightInfo for SubstrateWeight<T> {
// Proof Size summary in bytes:
// Measured: `161`
// Estimated: `1887`
// Minimum execution time: 7_231_000 picoseconds.
Weight::from_parts(7_459_000, 1887)
// Minimum execution time: 71_000_000 picoseconds.
Weight::from_parts(78_000_000, 1887)
.saturating_add(T::DbWeight::get().reads(1_u64))
.saturating_add(T::DbWeight::get().writes(1_u64))
}
@@ -135,27 +134,81 @@ impl<T: frame_system::Config> WeightInfo for SubstrateWeight<T> {
/// Proof: Treasury Deactivated (max_values: Some(1), max_size: Some(16), added: 511, mode: MaxEncodedLen)
/// Storage: Treasury Approvals (r:1 w:1)
/// Proof: Treasury Approvals (max_values: Some(1), max_size: Some(402), added: 897, mode: MaxEncodedLen)
/// Storage: Treasury Proposals (r:100 w:100)
/// Storage: Treasury Proposals (r:99 w:99)
/// Proof: Treasury Proposals (max_values: None, max_size: Some(108), added: 2583, mode: MaxEncodedLen)
/// Storage: System Account (r:200 w:200)
/// Storage: System Account (r:198 w:198)
/// Proof: System Account (max_values: None, max_size: Some(128), added: 2603, mode: MaxEncodedLen)
/// Storage: Bounties BountyApprovals (r:1 w:1)
/// Proof: Bounties BountyApprovals (max_values: Some(1), max_size: Some(402), added: 897, mode: MaxEncodedLen)
/// The range of component `p` is `[0, 100]`.
/// The range of component `p` is `[0, 99]`.
fn on_initialize_proposals(p: u32, ) -> Weight {
// Proof Size summary in bytes:
// Measured: `421 + p * (251 ±0)`
// Measured: `427 + p * (251 ±0)`
// Estimated: `1887 + p * (5206 ±0)`
// Minimum execution time: 44_769_000 picoseconds.
Weight::from_parts(57_915_572, 1887)
// Standard Error: 59_484
.saturating_add(Weight::from_parts(42_343_732, 0).saturating_mul(p.into()))
// Minimum execution time: 614_000_000 picoseconds.
Weight::from_parts(498_501_558, 1887)
// Standard Error: 1_070_260
.saturating_add(Weight::from_parts(599_011_690, 0).saturating_mul(p.into()))
.saturating_add(T::DbWeight::get().reads(3_u64))
.saturating_add(T::DbWeight::get().reads((3_u64).saturating_mul(p.into())))
.saturating_add(T::DbWeight::get().writes(3_u64))
.saturating_add(T::DbWeight::get().writes((3_u64).saturating_mul(p.into())))
.saturating_add(Weight::from_parts(0, 5206).saturating_mul(p.into()))
}
/// Storage: AssetRate ConversionRateToNative (r:1 w:0)
/// Proof: AssetRate ConversionRateToNative (max_values: None, max_size: Some(36), added: 2511, mode: MaxEncodedLen)
/// Storage: Treasury SpendCount (r:1 w:1)
/// Proof: Treasury SpendCount (max_values: Some(1), max_size: Some(4), added: 499, mode: MaxEncodedLen)
/// Storage: Treasury Spends (r:0 w:1)
/// Proof: Treasury Spends (max_values: None, max_size: Some(69), added: 2544, mode: MaxEncodedLen)
fn spend() -> Weight {
// Proof Size summary in bytes:
// Measured: `140`
// Estimated: `3501`
// Minimum execution time: 214_000_000 picoseconds.
Weight::from_parts(216_000_000, 3501)
.saturating_add(T::DbWeight::get().reads(2_u64))
.saturating_add(T::DbWeight::get().writes(2_u64))
}
/// Storage: Treasury Spends (r:1 w:1)
/// Proof: Treasury Spends (max_values: None, max_size: Some(69), added: 2544, mode: MaxEncodedLen)
/// Storage: Assets Asset (r:1 w:1)
/// Proof: Assets Asset (max_values: None, max_size: Some(210), added: 2685, mode: MaxEncodedLen)
/// Storage: Assets Account (r:2 w:2)
/// Proof: Assets Account (max_values: None, max_size: Some(134), added: 2609, mode: MaxEncodedLen)
/// Storage: System Account (r:1 w:1)
/// Proof: System Account (max_values: None, max_size: Some(128), added: 2603, mode: MaxEncodedLen)
fn payout() -> Weight {
// Proof Size summary in bytes:
// Measured: `705`
// Estimated: `6208`
// Minimum execution time: 760_000_000 picoseconds.
Weight::from_parts(822_000_000, 6208)
.saturating_add(T::DbWeight::get().reads(5_u64))
.saturating_add(T::DbWeight::get().writes(5_u64))
}
/// Storage: Treasury Spends (r:1 w:1)
/// Proof: Treasury Spends (max_values: None, max_size: Some(69), added: 2544, mode: MaxEncodedLen)
fn check_status() -> Weight {
// Proof Size summary in bytes:
// Measured: `194`
// Estimated: `3534`
// Minimum execution time: 153_000_000 picoseconds.
Weight::from_parts(160_000_000, 3534)
.saturating_add(T::DbWeight::get().reads(1_u64))
.saturating_add(T::DbWeight::get().writes(1_u64))
}
/// Storage: Treasury Spends (r:1 w:1)
/// Proof: Treasury Spends (max_values: None, max_size: Some(69), added: 2544, mode: MaxEncodedLen)
fn void_spend() -> Weight {
// Proof Size summary in bytes:
// Measured: `194`
// Estimated: `3534`
// Minimum execution time: 147_000_000 picoseconds.
Weight::from_parts(181_000_000, 3534)
.saturating_add(T::DbWeight::get().reads(1_u64))
.saturating_add(T::DbWeight::get().writes(1_u64))
}
}
// For backwards compatibility and tests
@@ -166,12 +219,12 @@ impl WeightInfo for () {
/// Proof: Treasury Approvals (max_values: Some(1), max_size: Some(402), added: 897, mode: MaxEncodedLen)
/// Storage: Treasury Proposals (r:0 w:1)
/// Proof: Treasury Proposals (max_values: None, max_size: Some(108), added: 2583, mode: MaxEncodedLen)
fn spend() -> Weight {
fn spend_local() -> Weight {
// Proof Size summary in bytes:
// Measured: `76`
// Estimated: `1887`
// Minimum execution time: 15_057_000 picoseconds.
Weight::from_parts(15_803_000, 1887)
// Minimum execution time: 179_000_000 picoseconds.
Weight::from_parts(190_000_000, 1887)
.saturating_add(RocksDbWeight::get().reads(2_u64))
.saturating_add(RocksDbWeight::get().writes(3_u64))
}
@@ -183,8 +236,8 @@ impl WeightInfo for () {
// Proof Size summary in bytes:
// Measured: `177`
// Estimated: `1489`
// Minimum execution time: 28_923_000 picoseconds.
Weight::from_parts(29_495_000, 1489)
// Minimum execution time: 349_000_000 picoseconds.
Weight::from_parts(398_000_000, 1489)
.saturating_add(RocksDbWeight::get().reads(1_u64))
.saturating_add(RocksDbWeight::get().writes(2_u64))
}
@@ -196,8 +249,8 @@ impl WeightInfo for () {
// Proof Size summary in bytes:
// Measured: `335`
// Estimated: `3593`
// Minimum execution time: 30_539_000 picoseconds.
Weight::from_parts(30_986_000, 3593)
// Minimum execution time: 367_000_000 picoseconds.
Weight::from_parts(388_000_000, 3593)
.saturating_add(RocksDbWeight::get().reads(2_u64))
.saturating_add(RocksDbWeight::get().writes(2_u64))
}
@@ -208,12 +261,12 @@ impl WeightInfo for () {
/// The range of component `p` is `[0, 99]`.
fn approve_proposal(p: u32, ) -> Weight {
// Proof Size summary in bytes:
// Measured: `504 + p * (8 ±0)`
// Measured: `483 + p * (9 ±0)`
// Estimated: `3573`
// Minimum execution time: 9_320_000 picoseconds.
Weight::from_parts(12_606_599, 3573)
// Standard Error: 1_302
.saturating_add(Weight::from_parts(71_054, 0).saturating_mul(p.into()))
// Minimum execution time: 111_000_000 picoseconds.
Weight::from_parts(108_813_243, 3573)
// Standard Error: 147_887
.saturating_add(Weight::from_parts(683_216, 0).saturating_mul(p.into()))
.saturating_add(RocksDbWeight::get().reads(2_u64))
.saturating_add(RocksDbWeight::get().writes(1_u64))
}
@@ -223,8 +276,8 @@ impl WeightInfo for () {
// Proof Size summary in bytes:
// Measured: `161`
// Estimated: `1887`
// Minimum execution time: 7_231_000 picoseconds.
Weight::from_parts(7_459_000, 1887)
// Minimum execution time: 71_000_000 picoseconds.
Weight::from_parts(78_000_000, 1887)
.saturating_add(RocksDbWeight::get().reads(1_u64))
.saturating_add(RocksDbWeight::get().writes(1_u64))
}
@@ -232,25 +285,79 @@ impl WeightInfo for () {
/// Proof: Treasury Deactivated (max_values: Some(1), max_size: Some(16), added: 511, mode: MaxEncodedLen)
/// Storage: Treasury Approvals (r:1 w:1)
/// Proof: Treasury Approvals (max_values: Some(1), max_size: Some(402), added: 897, mode: MaxEncodedLen)
/// Storage: Treasury Proposals (r:100 w:100)
/// Storage: Treasury Proposals (r:99 w:99)
/// Proof: Treasury Proposals (max_values: None, max_size: Some(108), added: 2583, mode: MaxEncodedLen)
/// Storage: System Account (r:200 w:200)
/// Storage: System Account (r:198 w:198)
/// Proof: System Account (max_values: None, max_size: Some(128), added: 2603, mode: MaxEncodedLen)
/// Storage: Bounties BountyApprovals (r:1 w:1)
/// Proof: Bounties BountyApprovals (max_values: Some(1), max_size: Some(402), added: 897, mode: MaxEncodedLen)
/// The range of component `p` is `[0, 100]`.
/// The range of component `p` is `[0, 99]`.
fn on_initialize_proposals(p: u32, ) -> Weight {
// Proof Size summary in bytes:
// Measured: `421 + p * (251 ±0)`
// Measured: `427 + p * (251 ±0)`
// Estimated: `1887 + p * (5206 ±0)`
// Minimum execution time: 44_769_000 picoseconds.
Weight::from_parts(57_915_572, 1887)
// Standard Error: 59_484
.saturating_add(Weight::from_parts(42_343_732, 0).saturating_mul(p.into()))
// Minimum execution time: 614_000_000 picoseconds.
Weight::from_parts(498_501_558, 1887)
// Standard Error: 1_070_260
.saturating_add(Weight::from_parts(599_011_690, 0).saturating_mul(p.into()))
.saturating_add(RocksDbWeight::get().reads(3_u64))
.saturating_add(RocksDbWeight::get().reads((3_u64).saturating_mul(p.into())))
.saturating_add(RocksDbWeight::get().writes(3_u64))
.saturating_add(RocksDbWeight::get().writes((3_u64).saturating_mul(p.into())))
.saturating_add(Weight::from_parts(0, 5206).saturating_mul(p.into()))
}
/// Storage: AssetRate ConversionRateToNative (r:1 w:0)
/// Proof: AssetRate ConversionRateToNative (max_values: None, max_size: Some(36), added: 2511, mode: MaxEncodedLen)
/// Storage: Treasury SpendCount (r:1 w:1)
/// Proof: Treasury SpendCount (max_values: Some(1), max_size: Some(4), added: 499, mode: MaxEncodedLen)
/// Storage: Treasury Spends (r:0 w:1)
/// Proof: Treasury Spends (max_values: None, max_size: Some(69), added: 2544, mode: MaxEncodedLen)
fn spend() -> Weight {
// Proof Size summary in bytes:
// Measured: `140`
// Estimated: `3501`
// Minimum execution time: 214_000_000 picoseconds.
Weight::from_parts(216_000_000, 3501)
.saturating_add(RocksDbWeight::get().reads(2_u64))
.saturating_add(RocksDbWeight::get().writes(2_u64))
}
/// Storage: Treasury Spends (r:1 w:1)
/// Proof: Treasury Spends (max_values: None, max_size: Some(69), added: 2544, mode: MaxEncodedLen)
/// Storage: Assets Asset (r:1 w:1)
/// Proof: Assets Asset (max_values: None, max_size: Some(210), added: 2685, mode: MaxEncodedLen)
/// Storage: Assets Account (r:2 w:2)
/// Proof: Assets Account (max_values: None, max_size: Some(134), added: 2609, mode: MaxEncodedLen)
/// Storage: System Account (r:1 w:1)
/// Proof: System Account (max_values: None, max_size: Some(128), added: 2603, mode: MaxEncodedLen)
fn payout() -> Weight {
// Proof Size summary in bytes:
// Measured: `705`
// Estimated: `6208`
// Minimum execution time: 760_000_000 picoseconds.
Weight::from_parts(822_000_000, 6208)
.saturating_add(RocksDbWeight::get().reads(5_u64))
.saturating_add(RocksDbWeight::get().writes(5_u64))
}
/// Storage: Treasury Spends (r:1 w:1)
/// Proof: Treasury Spends (max_values: None, max_size: Some(69), added: 2544, mode: MaxEncodedLen)
fn check_status() -> Weight {
// Proof Size summary in bytes:
// Measured: `194`
// Estimated: `3534`
// Minimum execution time: 153_000_000 picoseconds.
Weight::from_parts(160_000_000, 3534)
.saturating_add(RocksDbWeight::get().reads(1_u64))
.saturating_add(RocksDbWeight::get().writes(1_u64))
}
/// Storage: Treasury Spends (r:1 w:1)
/// Proof: Treasury Spends (max_values: None, max_size: Some(69), added: 2544, mode: MaxEncodedLen)
fn void_spend() -> Weight {
// Proof Size summary in bytes:
// Measured: `194`
// Estimated: `3534`
// Minimum execution time: 147_000_000 picoseconds.
Weight::from_parts(181_000_000, 3534)
.saturating_add(RocksDbWeight::get().reads(1_u64))
.saturating_add(RocksDbWeight::get().writes(1_u64))
}
}