.. _module-splice-fees-99189: Splice.Fees =========== Utility functions for different kinds of fees\. Data Types ---------- .. _type-splice-fees-expiringamount-39537: **data** `ExpiringAmount `_ .. _constr-splice-fees-expiringamount-68564: `ExpiringAmount `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - initialAmount - `Decimal `_ - * - createdAt - :ref:`Round ` - * - ratePerRound - `RatePerRound `_ - **instance** `Eq `_ `ExpiringAmount `_ **instance** `Ord `_ `ExpiringAmount `_ **instance** `Show `_ `ExpiringAmount `_ **instance** `GetField `_ \"amount\" :ref:`Amulet ` `ExpiringAmount `_ **instance** `GetField `_ \"createdAt\" `ExpiringAmount `_ :ref:`Round ` **instance** `GetField `_ \"initialAmount\" `ExpiringAmount `_ `Decimal `_ **instance** `GetField `_ \"ratePerRound\" `ExpiringAmount `_ `RatePerRound `_ **instance** `SetField `_ \"amount\" :ref:`Amulet ` `ExpiringAmount `_ **instance** `SetField `_ \"createdAt\" `ExpiringAmount `_ :ref:`Round ` **instance** `SetField `_ \"initialAmount\" `ExpiringAmount `_ `Decimal `_ **instance** `SetField `_ \"ratePerRound\" `ExpiringAmount `_ `RatePerRound `_ .. _type-splice-fees-fixedfee-53985: **data** `FixedFee `_ A fixed fee independent of the action being taken\. TODO(M3\-90)\: check whether this name matches usage in financial terms, it probably isn't\. Should it be 'flat\-fee', 'constantfee', \.\.\. ??? .. _constr-splice-fees-fixedfee-53900: `FixedFee `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - fee - `Decimal `_ - **instance** `Eq `_ `FixedFee `_ **instance** `Ord `_ `FixedFee `_ **instance** `Show `_ `FixedFee `_ **instance** `GetField `_ \"createFee\" (:ref:`TransferConfig ` unit) `FixedFee `_ **instance** `GetField `_ \"fee\" `FixedFee `_ `Decimal `_ **instance** `GetField `_ \"lockHolderFee\" (:ref:`TransferConfig ` unit) `FixedFee `_ **instance** `SetField `_ \"createFee\" (:ref:`TransferConfig ` unit) `FixedFee `_ **instance** `SetField `_ \"fee\" `FixedFee `_ `Decimal `_ **instance** `SetField `_ \"lockHolderFee\" (:ref:`TransferConfig ` unit) `FixedFee `_ .. _type-splice-fees-rateperround-90570: **data** `RatePerRound `_ .. _constr-splice-fees-rateperround-75691: `RatePerRound `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - rate - `Decimal `_ - **instance** `Eq `_ `RatePerRound `_ **instance** `Ord `_ `RatePerRound `_ **instance** `Show `_ `RatePerRound `_ **instance** `GetField `_ \"holdingFee\" (:ref:`TransferConfig ` unit) `RatePerRound `_ **instance** `GetField `_ \"rate\" `RatePerRound `_ `Decimal `_ **instance** `GetField `_ \"ratePerRound\" `ExpiringAmount `_ `RatePerRound `_ **instance** `SetField `_ \"holdingFee\" (:ref:`TransferConfig ` unit) `RatePerRound `_ **instance** `SetField `_ \"rate\" `RatePerRound `_ `Decimal `_ **instance** `SetField `_ \"ratePerRound\" `ExpiringAmount `_ `RatePerRound `_ .. _type-splice-fees-steppedrate-36691: **data** `SteppedRate `_ A rate defined as a piecewise linear function, e\.g\., \`SteppedRate 0\.01 \[(100\.0, 0\.001), (1000\.0, 0\.0001), (1000000, 0\.00001)\] corresponds to 1% of the first 100, 0\.1% between 100 and 1000, 0\.01% between 1000 and 1000000 and 0\.001% for everything above that\. .. _constr-splice-fees-steppedrate-72856: `SteppedRate `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - initialRate - `Decimal `_ - * - steps - \[(`Decimal `_, `Decimal `_)\] - **instance** `Eq `_ `SteppedRate `_ **instance** `Ord `_ `SteppedRate `_ **instance** `Show `_ `SteppedRate `_ **instance** `GetField `_ \"initialRate\" `SteppedRate `_ `Decimal `_ **instance** `GetField `_ \"steps\" `SteppedRate `_ \[(`Decimal `_, `Decimal `_)\] **instance** `GetField `_ \"transferFee\" (:ref:`TransferConfig ` unit) `SteppedRate `_ **instance** `SetField `_ \"initialRate\" `SteppedRate `_ `Decimal `_ **instance** `SetField `_ \"steps\" `SteppedRate `_ \[(`Decimal `_, `Decimal `_)\] **instance** `SetField `_ \"transferFee\" (:ref:`TransferConfig ` unit) `SteppedRate `_ Functions --------- .. _function-splice-fees-reltimetomicros-80866: `relTimeToMicros `_ \: `RelTime `_ \-\> `Decimal `_ .. _function-splice-fees-microsperday-26445: `microsPerDay `_ \: `Decimal `_ .. _function-splice-fees-reltimetodays-39078: `relTimeToDays `_ \: `RelTime `_ \-\> `Decimal `_ .. _function-splice-fees-daystoreltime-342: `daysToRelTime `_ \: `Decimal `_ \-\> `RelTime `_ .. _function-splice-fees-chargerateperround-14136: `chargeRatePerRound `_ \: `RatePerRound `_ \-\> :ref:`RelRound ` \-\> `Decimal `_ .. _function-splice-fees-scalerateperround-96257: `scaleRatePerRound `_ \: `Decimal `_ \-\> `RatePerRound `_ \-\> `RatePerRound `_ Scale a round rate such that ALL s r dt\. s \* chargeRatePerRound r dt \= chargeRatePerRound (s ``scaleRatePerRound`` r) dt .. _function-splice-fees-scalefixedfee-12994: `scaleFixedFee `_ \: `Decimal `_ \-\> `FixedFee `_ \-\> `FixedFee `_ .. _function-splice-fees-validsteppedrate-82534: `validSteppedRate `_ \: `SteppedRate `_ \-\> `Bool `_ .. _function-splice-fees-chargesteppedrate-67705: `chargeSteppedRate `_ \: `SteppedRate `_ \-\> `Decimal `_ \-\> `Decimal `_ .. _function-splice-fees-gochargesteppedrate-62505: `goChargeSteppedRate `_ \: (`Decimal `_, `Decimal `_, `Decimal `_) \-\> \[(`Decimal `_, `Decimal `_)\] \-\> `Decimal `_ .. _function-splice-fees-scalesteppedrate-86486: `scaleSteppedRate `_ \: `Decimal `_ \-\> `SteppedRate `_ \-\> `SteppedRate `_ Scale a fixed\-plus\-variable rate such that ALL s r q\. s \* chargeSteppedRate r (q/s) \= chargeSteppedRate (s ``scaleSteppedRate`` r) q .. _function-splice-fees-validexpiringamount-89306: `validExpiringAmount `_ \: `ExpiringAmount `_ \-\> `Bool `_ .. _function-splice-fees-actualamount-22453: `actualAmount `_ \: :ref:`Round ` \-\> `ExpiringAmount `_ \-\> `Decimal `_ .. _function-splice-fees-expiringamount-85661: `expiringAmount `_ \: `RatePerRound `_ \-\> `Decimal `_ \-\> :ref:`Round ` \-\> `ExpiringAmount `_ Smart constructor for an expiring amount\. .. _function-splice-fees-getvalueasofround0-94025: `getValueAsOfRound0 `_ \: `ExpiringAmount `_ \-\> `Decimal `_