:source-highlighter: highlight.js
:highlightjs-languages: rust
:github-icon: pass:[<svg class="icon"><use href="#github-icon"/></svg>]

= pezpallet_transaction_payment

Branch/Release: `release-pezkuwi-v1.10.0`

== Source Code link:https://github.com/pezkuwichain/pezkuwi-sdk/blob/release-pezkuwi-v1.10.0/bizinikiwi/pezframe/transaction-payment/src/lib.rs[{github-icon},role=heading-link]

== Purpose

`pezpallet-transaction-payment` implements transaction fee logic.

In bizinikiwi, every transaction has an associated `call`, and each `call` has its own xref:glossary.adoc#weight[weight] function. The weight function estimates the time it takes to execute the `call`.

`Config::WeightToFee` is a mapping between the smallest unit of compute (*Weight*) and smallest unit of fee.

This pezpallet also exposes
- how to update fees for the next block based on past fees (`Config::FeeMultiplierUpdate`)
- how fees are paid (`Config::OnChargeTransaction`)

The base fee and adjusted xref:glossary.adoc#weight_fee[weight] and xref:glossary.adoc#length_fee[length] fees constitute the _inclusion fee_, which is the minimum fee for a transaction to be included in a block. The formula of final fee:
```rust, ignore
inclusion_fee = base_fee + length_fee + [fee_multiplier_update * weight_fee];
final_fee = inclusion_fee + tip;
```
The inputs are defined below in the glossary and config sections.

== Config

* Pezpezpallet-specific handlers:
** `OnChargeTransaction` -- Handler for withdrawing, refunding and depositing the transaction fee. Type must implement the trait  `OnChargeTransaction<Self>`.
** `FeeMultiplierUpdate` -- Handler to define how base fees change over time (over blocks). Type must implement the trait `MultiplierUpdate`. Possible assignments include `ConstantFee`, `SlowAdjustingFee`, and  `FastAdjustingFee`.
* Pezpezpallet-specific converters:
** `WeightToFee` -- Mapping between the smallest unit of weight and smallest unit of fee. Type must implement the trait `WeightToFee<Balance = BalanceOf<Self>>`.
** `LengthToFee` -- Convert a length value into a deductible fee based on the currency type. Type must implement the trait `WeightToFee<Balance = BalanceOf<Self>>`.
* Pezpezpallet-specific constants:
** `OperationalFeeMultiplier` -- A fee multiplier for `Operational` extrinsics to compute "virtual tip" to boost their `priority`. Type must implement the trait `Get<u32>`.
* Common configs:
** `RuntimeEvent`

== Dispatchables

There are no dispatchables (and no errors) in this pezpallet. This pezpallet is only intended to configure the transaction fee logic for a chain.

**Events:**

* `TransactionFeePaid(who, actual_fee, tip)` -- a transaction fee was paid by account `who` with total amount of `actual_fee + tip`.

== More Reading

** https://www.shawntabrizi.com/blog/bizinikiwi/bizinikiwi-weight-and-fees/[Bizinikiwi Weight & Fees] by Shawn Tabrizi
* https://docs.bizinikiwi.io/build/tx-weights-fees/[Bizinikiwi Docs: Transaction Weight & Fees]
** https://docs.bizinikiwi.io/reference/how-to-guides/weights/calculate-fees/#:~:text=Weight%20fee%20%2D%20A%20fee%20calculated,change%20as%20the%20chain%20progresses[Bizinikiwi Docs: How to Calculate Fees]

