.. _module-splice-issuance-46787: Splice.Issuance =============== Amulet rewards issuance configuration and computation\. Data Types ---------- .. _type-splice-issuance-issuanceconfig-93012: **data** `IssuanceConfig `_ .. _constr-splice-issuance-issuanceconfig-42917: `IssuanceConfig `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - amuletToIssuePerYear - `Decimal `_ - * - validatorRewardPercentage - `Decimal `_ - * - appRewardPercentage - `Decimal `_ - * - validatorRewardCap - `Decimal `_ - * - featuredAppRewardCap - `Decimal `_ - * - unfeaturedAppRewardCap - `Decimal `_ - * - optValidatorFaucetCap - `Optional `_ `Decimal `_ - Maximal amount in $ for the per\-validator issuance of validator faucet coupons; Introduced as part of CIP\-3\. Defaults to 2\.85 USD\. **instance** `Eq `_ `IssuanceConfig `_ **instance** `Show `_ `IssuanceConfig `_ **instance** `GetField `_ \"amuletToIssuePerYear\" `IssuanceConfig `_ `Decimal `_ **instance** `GetField `_ \"appRewardPercentage\" `IssuanceConfig `_ `Decimal `_ **instance** `GetField `_ \"featuredAppRewardCap\" `IssuanceConfig `_ `Decimal `_ **instance** `GetField `_ \"issuanceConfig\" :ref:`OpenMiningRound ` `IssuanceConfig `_ **instance** `GetField `_ \"issuanceConfig\" :ref:`SummarizingMiningRound ` `IssuanceConfig `_ **instance** `GetField `_ \"issuanceCurve\" (:ref:`AmuletConfig ` unit) (:ref:`Schedule ` `RelTime `_ `IssuanceConfig `_) **instance** `GetField `_ \"optValidatorFaucetCap\" `IssuanceConfig `_ (`Optional `_ `Decimal `_) **instance** `GetField `_ \"unfeaturedAppRewardCap\" `IssuanceConfig `_ `Decimal `_ **instance** `GetField `_ \"validatorRewardCap\" `IssuanceConfig `_ `Decimal `_ **instance** `GetField `_ \"validatorRewardPercentage\" `IssuanceConfig `_ `Decimal `_ **instance** `SetField `_ \"amuletToIssuePerYear\" `IssuanceConfig `_ `Decimal `_ **instance** `SetField `_ \"appRewardPercentage\" `IssuanceConfig `_ `Decimal `_ **instance** `SetField `_ \"featuredAppRewardCap\" `IssuanceConfig `_ `Decimal `_ **instance** `SetField `_ \"issuanceConfig\" :ref:`OpenMiningRound ` `IssuanceConfig `_ **instance** `SetField `_ \"issuanceConfig\" :ref:`SummarizingMiningRound ` `IssuanceConfig `_ **instance** `SetField `_ \"issuanceCurve\" (:ref:`AmuletConfig ` unit) (:ref:`Schedule ` `RelTime `_ `IssuanceConfig `_) **instance** `SetField `_ \"optValidatorFaucetCap\" `IssuanceConfig `_ (`Optional `_ `Decimal `_) **instance** `SetField `_ \"unfeaturedAppRewardCap\" `IssuanceConfig `_ `Decimal `_ **instance** `SetField `_ \"validatorRewardCap\" `IssuanceConfig `_ `Decimal `_ **instance** `SetField `_ \"validatorRewardPercentage\" `IssuanceConfig `_ `Decimal `_ .. _type-splice-issuance-issuancetranche-71318: **data** `IssuanceTranche `_ .. _constr-splice-issuance-issuancetranche-27573: `IssuanceTranche `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - rewardsToIssue - `Decimal `_ - Total amulets to issue as rewards in this tranche * - issuancePerCoupon - `Decimal `_ - Issuence per reward coupon for this tranche * - unclaimedRewards - `Decimal `_ - Amulets to issue in this tranche that were not claimed **instance** `GetField `_ \"issuancePerCoupon\" `IssuanceTranche `_ `Decimal `_ **instance** `GetField `_ \"rewardsToIssue\" `IssuanceTranche `_ `Decimal `_ **instance** `GetField `_ \"unclaimedRewards\" `IssuanceTranche `_ `Decimal `_ **instance** `SetField `_ \"issuancePerCoupon\" `IssuanceTranche `_ `Decimal `_ **instance** `SetField `_ \"rewardsToIssue\" `IssuanceTranche `_ `Decimal `_ **instance** `SetField `_ \"unclaimedRewards\" `IssuanceTranche `_ `Decimal `_ .. _type-splice-issuance-issuingroundparameters-47575: **data** `IssuingRoundParameters `_ Parameters to use in a round that issues amulet as rewards for collected coupons\. .. _constr-splice-issuance-issuingroundparameters-60486: `IssuingRoundParameters `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - issuancePerValidatorRewardCoupon - `Decimal `_ - * - issuancePerFeaturedAppRewardCoupon - `Decimal `_ - * - issuancePerUnfeaturedAppRewardCoupon - `Decimal `_ - * - issuancePerSvRewardCoupon - `Decimal `_ - * - unclaimedAppRewards - `Decimal `_ - * - unclaimedValidatorRewards - `Decimal `_ - * - unclaimedSvRewards - `Decimal `_ - Can be non\-zero due to rounding, or no SV having had the chance to claim their coupons\. * - issuancePerValidatorFaucetCoupon - `Decimal `_ - **instance** `Eq `_ `IssuingRoundParameters `_ **instance** `Show `_ `IssuingRoundParameters `_ **instance** `GetField `_ \"issuancePerFeaturedAppRewardCoupon\" `IssuingRoundParameters `_ `Decimal `_ **instance** `GetField `_ \"issuancePerSvRewardCoupon\" `IssuingRoundParameters `_ `Decimal `_ **instance** `GetField `_ \"issuancePerUnfeaturedAppRewardCoupon\" `IssuingRoundParameters `_ `Decimal `_ **instance** `GetField `_ \"issuancePerValidatorFaucetCoupon\" `IssuingRoundParameters `_ `Decimal `_ **instance** `GetField `_ \"issuancePerValidatorRewardCoupon\" `IssuingRoundParameters `_ `Decimal `_ **instance** `GetField `_ \"unclaimedAppRewards\" `IssuingRoundParameters `_ `Decimal `_ **instance** `GetField `_ \"unclaimedSvRewards\" `IssuingRoundParameters `_ `Decimal `_ **instance** `GetField `_ \"unclaimedValidatorRewards\" `IssuingRoundParameters `_ `Decimal `_ **instance** `SetField `_ \"issuancePerFeaturedAppRewardCoupon\" `IssuingRoundParameters `_ `Decimal `_ **instance** `SetField `_ \"issuancePerSvRewardCoupon\" `IssuingRoundParameters `_ `Decimal `_ **instance** `SetField `_ \"issuancePerUnfeaturedAppRewardCoupon\" `IssuingRoundParameters `_ `Decimal `_ **instance** `SetField `_ \"issuancePerValidatorFaucetCoupon\" `IssuingRoundParameters `_ `Decimal `_ **instance** `SetField `_ \"issuancePerValidatorRewardCoupon\" `IssuingRoundParameters `_ `Decimal `_ **instance** `SetField `_ \"unclaimedAppRewards\" `IssuingRoundParameters `_ `Decimal `_ **instance** `SetField `_ \"unclaimedSvRewards\" `IssuingRoundParameters `_ `Decimal `_ **instance** `SetField `_ \"unclaimedValidatorRewards\" `IssuingRoundParameters `_ `Decimal `_ .. _type-splice-issuance-openminingroundsummary-90943: **data** `OpenMiningRoundSummary `_ A summary of total reward coupons issued against a specific open mining round\. .. _constr-splice-issuance-openminingroundsummary-16618: `OpenMiningRoundSummary `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - totalValidatorRewardCoupons - `Decimal `_ - * - totalFeaturedAppRewardCoupons - `Decimal `_ - * - totalUnfeaturedAppRewardCoupons - `Decimal `_ - * - totalSvRewardWeight - `Int `_ - * - optTotalValidatorFaucetCoupons - `Optional `_ `Int `_ - Introduced as part of CIP\-3\. **instance** `Eq `_ `OpenMiningRoundSummary `_ **instance** `Show `_ `OpenMiningRoundSummary `_ **instance** `GetField `_ \"optTotalValidatorFaucetCoupons\" `OpenMiningRoundSummary `_ (`Optional `_ `Int `_) **instance** `GetField `_ \"summary\" :ref:`AmuletRules_MiningRound_StartIssuing ` `OpenMiningRoundSummary `_ **instance** `GetField `_ \"totalFeaturedAppRewardCoupons\" `OpenMiningRoundSummary `_ `Decimal `_ **instance** `GetField `_ \"totalSvRewardWeight\" `OpenMiningRoundSummary `_ `Int `_ **instance** `GetField `_ \"totalUnfeaturedAppRewardCoupons\" `OpenMiningRoundSummary `_ `Decimal `_ **instance** `GetField `_ \"totalValidatorRewardCoupons\" `OpenMiningRoundSummary `_ `Decimal `_ **instance** `SetField `_ \"optTotalValidatorFaucetCoupons\" `OpenMiningRoundSummary `_ (`Optional `_ `Int `_) **instance** `SetField `_ \"summary\" :ref:`AmuletRules_MiningRound_StartIssuing ` `OpenMiningRoundSummary `_ **instance** `SetField `_ \"totalFeaturedAppRewardCoupons\" `OpenMiningRoundSummary `_ `Decimal `_ **instance** `SetField `_ \"totalSvRewardWeight\" `OpenMiningRoundSummary `_ `Int `_ **instance** `SetField `_ \"totalUnfeaturedAppRewardCoupons\" `OpenMiningRoundSummary `_ `Decimal `_ **instance** `SetField `_ \"totalValidatorRewardCoupons\" `OpenMiningRoundSummary `_ `Decimal `_ Functions --------- .. _function-splice-issuance-getvalidatorfaucetcap-50474: `getValidatorFaucetCap `_ \: `IssuanceConfig `_ \-\> `Decimal `_ Getter with the right default value for the validator faucet cap\. Use this consistently instead of accessing the field directly\. .. _function-splice-issuance-validissuancecurve-81463: `validIssuanceCurve `_ \: :ref:`Schedule ` `RelTime `_ `IssuanceConfig `_ \-\> `Bool `_ .. _function-splice-issuance-validissuanceconfig-25363: `validIssuanceConfig `_ \: `IssuanceConfig `_ \-\> `Bool `_ .. _function-splice-issuance-gettotalvalidatorfaucetcoupons-98130: `getTotalValidatorFaucetCoupons `_ \: `OpenMiningRoundSummary `_ \-\> `Int `_ .. _function-splice-issuance-validateopenminingroundsummary-65797: `validateOpenMiningRoundSummary `_ \: `CanAssert `_ m \=\> `OpenMiningRoundSummary `_ \-\> m () .. _function-splice-issuance-computeissuingroundparameters-5863: `computeIssuingRoundParameters `_ \: `RelTime `_ \-\> `Decimal `_ \-\> `IssuanceConfig `_ \-\> `OpenMiningRoundSummary `_ \-\> `IssuingRoundParameters `_ .. _function-splice-issuance-computeissuancetranche-10230: `computeIssuanceTranche `_ \: `Decimal `_ \-\> `Decimal `_ \-\> `Decimal `_ \-\> `IssuanceTranche `_ ``computeIssuanceTranche rewardsToIssue capPerCoupon totalCoupons`` computes parameters that issue as many rewards per coupon as possible up to a maximum of ``capPerCoupon`` amulets\.