Skip to content

Commit

Permalink
Fix incorrect documentation of XcmMetadata::fee_factor (#1360)
Browse files Browse the repository at this point in the history
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
  • Loading branch information
maltekliemann and mergify[bot] authored Aug 27, 2024
1 parent 6868482 commit ae0afe9
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions primitives/src/types.rs
Original file line number Diff line number Diff line change
Expand Up @@ -167,10 +167,13 @@ pub struct CustomMetadata {
TypeInfo,
)]
pub struct XcmMetadata {
/// The factor used to determine the fee.
/// It is multiplied by the fee that would have been paid in native currency, so it represents
/// the ratio `native_price / other_asset_price`. It is a fixed point decimal number containing
/// as many fractional decimals as the asset it is used for contains.
/// The factor used to determine the fee of the foreign asset.
///
/// In the fee calculations, the factor is multiplied by the fee that would have been paid in
/// native currency, so it represents the ratio between the price of the native currency and the
/// foreign asset, or, equivalently, the value of the trading pair (native currency)/(foreign
/// asset). The factor is a fixed point decimal number with ten decimals.
///
/// Should be updated regularly.
pub fee_factor: Option<Balance>,
}

0 comments on commit ae0afe9

Please sign in to comment.