Files
pezkuwi-subxt/prdoc/pr_1926.prdoc
T
gupnik 60c77a2e9a Adds syntax for marking calls feeless (#1926)
Fixes https://github.com/paritytech/polkadot-sdk/issues/1725

This PR adds the following changes:
1. An attribute `pallet::feeless_if` that can be optionally attached to
a call like so:
```rust
#[pallet::feeless_if(|_origin: &OriginFor<T>, something: &u32| -> bool {
	*something == 0
})]
pub fn do_something(origin: OriginFor<T>, something: u32) -> DispatchResult {
     ....
}
```
The closure passed accepts references to arguments as specified in the
call fn. It returns a boolean that denotes the conditions required for
this call to be "feeless".

2. A signed extension `SkipCheckIfFeeless<T: SignedExtension>` that
wraps a transaction payment processor such as
`pallet_transaction_payment::ChargeTransactionPayment`. It checks for
all calls annotated with `pallet::feeless_if` to see if the conditions
are met. If so, the wrapped signed extension is not called, essentially
making the call feeless.

In order to use this, you can simply replace your existing signed
extension that manages transaction payment like so:
```diff
- pallet_transaction_payment::ChargeTransactionPayment<Runtime>,
+ pallet_skip_feeless_payment::SkipCheckIfFeeless<
+	Runtime,
+	pallet_transaction_payment::ChargeTransactionPayment<Runtime>,
+ >,
```

### Todo
- [x] Tests
- [x] Docs
- [x] Prdoc

---------

Co-authored-by: Nikhil Gupta <>
Co-authored-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
Co-authored-by: Francisco Aguirre <franciscoaguirreperez@gmail.com>
Co-authored-by: Liam Aharon <liam.aharon@hotmail.com>
2023-11-13 19:14:41 +05:30

31 lines
801 B
Plaintext

title: Adds syntax for marking calls feeless
doc:
- audience: Core Dev
description: |
1. Adds an attribute `#[pallet::feeless_if]` that can be optionally attached to a `pallet::call`.
2. Adds a signed extension SkipCheckIfFeeless<T: SignedExtension> that wraps a transaction
payment processor to potentially skip payment fees for such calls.
Note that both the attribute and the signed extension are needed to make the call feeless.
migrations:
db: []
runtime: []
crates:
- name: "frame-support-procedural"
semver: minor
- name: "pallet-skip-feeless-payment"
semver: major
- pallet-example-kitchensink
semver: patch
- kitchensink-runtime
semver: major
- node-testing
semver: patch
- node-cli
semver: patch
host_functions: []