Function shuffle_transaction_builder::framework::encode_update_exchange_rate_script_function
source · pub fn encode_update_exchange_rate_script_function(
currency: TypeTag,
sliding_nonce: u64,
new_exchange_rate_numerator: u64,
new_exchange_rate_denominator: u64
) -> TransactionPayload
Expand description
Summary
Update the rough on-chain exchange rate between a specified currency and XDX (as a conversion to micro-XDX). The transaction can only be sent by the Treasury Compliance account. After this transaction the updated exchange rate will be used for normalization of gas prices, and for dual attestation checking.
Technical Description
Updates the on-chain exchange rate from the given Currency
to micro-XDX. The exchange rate
is given by new_exchange_rate_numerator/new_exchange_rate_denominator
.
Parameters
Name | Type | Description |
---|---|---|
Currency | Type | The Move type for the Currency whose exchange rate is being updated. Currency must be an already-registered currency on-chain. |
tc_account | signer | The signer of the sending account of this transaction. Must be the Treasury Compliance account. |
sliding_nonce | u64 | The sliding_nonce (see: SlidingNonce ) to be used for the transaction. |
new_exchange_rate_numerator | u64 | The numerator for the new to micro-XDX exchange rate for Currency . |
new_exchange_rate_denominator | u64 | The denominator for the new to micro-XDX exchange rate for Currency . |
Common Abort Conditions
Error Category | Error Reason | Description |
---|---|---|
Errors::NOT_PUBLISHED | SlidingNonce::ESLIDING_NONCE | A SlidingNonce resource is not published under tc_account . |
Errors::INVALID_ARGUMENT | SlidingNonce::ENONCE_TOO_OLD | The sliding_nonce is too old and it’s impossible to determine if it’s duplicated or not. |
Errors::INVALID_ARGUMENT | SlidingNonce::ENONCE_TOO_NEW | The sliding_nonce is too far in the future. |
Errors::INVALID_ARGUMENT | SlidingNonce::ENONCE_ALREADY_RECORDED | The sliding_nonce has been previously recorded. |
Errors::REQUIRES_ADDRESS | CoreAddresses::ETREASURY_COMPLIANCE | tc_account is not the Treasury Compliance account. |
Errors::REQUIRES_ROLE | Roles::ETREASURY_COMPLIANCE | tc_account is not the Treasury Compliance account. |
Errors::INVALID_ARGUMENT | FixedPoint32::EDENOMINATOR | new_exchange_rate_denominator is zero. |
Errors::INVALID_ARGUMENT | FixedPoint32::ERATIO_OUT_OF_RANGE | The quotient is unrepresentable as a FixedPoint32 . |
Errors::LIMIT_EXCEEDED | FixedPoint32::ERATIO_OUT_OF_RANGE | The quotient is unrepresentable as a FixedPoint32 . |
Related Scripts
TreasuryComplianceScripts::update_dual_attestation_limit
TreasuryComplianceScripts::update_minting_ability