.. _module-splice-amuletrules-25638: Splice.AmuletRules ================== Templates --------- .. _type-splice-amuletrules-amuletrules-32426: **template** `AmuletRules `_ The rules governing how Amulet users can modify the Amulet state managed by the DSO party\. Signatory\: dso .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - dso - `Party `_ - * - configSchedule - :ref:`Schedule ` `Time `_ (:ref:`AmuletConfig ` :ref:`USD `) - * - isDevNet - `Bool `_ - + .. _type-splice-amuletrules-amuletrulesaddfutureamuletconfigschedule-17078: **Choice** `AmuletRules_AddFutureAmuletConfigSchedule `_ Controller\: dso Returns\: `AmuletRules_AddFutureAmuletConfigScheduleResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - newScheduleItem - (`Time `_, :ref:`AmuletConfig ` :ref:`USD `) - + .. _type-splice-amuletrules-amuletrulesadvanceopenminingrounds-86978: **Choice** `AmuletRules_AdvanceOpenMiningRounds `_ Controller\: dso Returns\: `AmuletRules_AdvanceOpenMiningRoundsResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - amuletPrice - `Decimal `_ - * - roundToArchiveCid - `ContractId `_ :ref:`OpenMiningRound ` - * - middleRoundCid - `ContractId `_ :ref:`OpenMiningRound ` - * - latestRoundCid - `ContractId `_ :ref:`OpenMiningRound ` - + .. _type-splice-amuletrules-amuletrulesbootstraprounds-81536: **Choice** `AmuletRules_Bootstrap_Rounds `_ Controller\: dso Returns\: `AmuletRules_Bootstrap_RoundsResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - amuletPrice - `Decimal `_ - * - round0Duration - `RelTime `_ - + .. _type-splice-amuletrules-amuletrulesbuymembertraffic-66391: **Choice** `AmuletRules_BuyMemberTraffic `_ Controller\: provider Returns\: `AmuletRules_BuyMemberTrafficResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - inputs - \[`TransferInput `_\] - * - context - `TransferContext `_ - * - provider - `Party `_ - * - memberId - `Text `_ - * - synchronizerId - `Text `_ - * - migrationId - `Int `_ - * - trafficAmount - `Int `_ - + .. _type-splice-amuletrules-amuletrulesclaimexpiredrewards-90526: **Choice** `AmuletRules_ClaimExpiredRewards `_ Controller\: dso Returns\: `AmuletRules_ClaimExpiredRewardsResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - closedRoundCid - `ContractId `_ :ref:`ClosedMiningRound ` - * - validatorRewardCouponCids - \[`ContractId `_ :ref:`ValidatorRewardCoupon `\] - * - appCouponCids - \[`ContractId `_ :ref:`AppRewardCoupon `\] - * - svRewardCouponCids - \[`ContractId `_ :ref:`SvRewardCoupon `\] - * - optValidatorFaucetCouponCids - `Optional `_ \[`ContractId `_ :ref:`ValidatorFaucetCoupon `\] - * - optValidatorLivenessActivityRecordCids - `Optional `_ \[`ContractId `_ :ref:`ValidatorLivenessActivityRecord `\] - + .. _type-splice-amuletrules-amuletrulescomputefees-56243: **Choice** `AmuletRules_ComputeFees `_ Compute the output fees for transfer against the given context Controller\: sender Returns\: `AmuletRules_ComputeFeesResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - context - `TransferContext `_ - * - sender - `Party `_ - * - outputs - \[`TransferOutput `_\] - + .. _type-splice-amuletrules-amuletrulescreateexternalpartysetupproposal-53882: **Choice** `AmuletRules_CreateExternalPartySetupProposal `_ Propose to host an external party The provider pre\-pays the fees for the creation of a TransferPreapproval contract on behalf of the external party when exercising this choice Controller\: validator Returns\: `AmuletRules_CreateExternalPartySetupProposalResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - context - `PaymentTransferContext `_ - * - inputs - \[`TransferInput `_\] - * - user - `Party `_ - * - validator - `Party `_ - * - preapprovalExpiresAt - `Time `_ - + .. _type-splice-amuletrules-amuletrulescreatetransferpreapproval-31932: **Choice** `AmuletRules_CreateTransferPreapproval `_ Pre\-approve incoming amulet transfers Controller\: provider, receiver Returns\: `AmuletRules_CreateTransferPreapprovalResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - context - `PaymentTransferContext `_ - * - inputs - \[`TransferInput `_\] - * - receiver - `Party `_ - * - provider - `Party `_ - * - expiresAt - `Time `_ - + .. _type-splice-amuletrules-amuletrulesdevnetfeatureapp-42587: **Choice** `AmuletRules_DevNet_FeatureApp `_ Controller\: provider Returns\: `AmuletRules_DevNet_FeatureAppResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - provider - `Party `_ - + .. _type-splice-amuletrules-amuletrulesdevnettap-82572: **Choice** `AmuletRules_DevNet_Tap `_ Controller\: receiver Returns\: `AmuletRules_DevNet_TapResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - receiver - `Party `_ - * - amount - `Decimal `_ - * - openRound - `ContractId `_ :ref:`OpenMiningRound ` - + .. _type-splice-amuletrules-amuletrulesfetch-60873: **Choice** `AmuletRules_Fetch `_ Controller\: p Returns\: `AmuletRules `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - p - `Party `_ - + .. _type-splice-amuletrules-amuletrulesmergemembertrafficcontracts-58585: **Choice** `AmuletRules_MergeMemberTrafficContracts `_ Controller\: dso Returns\: `AmuletRules_MergeMemberTrafficContractsResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - trafficCids - \[`ContractId `_ :ref:`MemberTraffic `\] - + .. _type-splice-amuletrules-amuletrulesmergeunclaimedrewards-76493: **Choice** `AmuletRules_MergeUnclaimedRewards `_ Controller\: dso Returns\: `AmuletRules_MergeUnclaimedRewardsResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - unclaimedRewardCids - \[`ContractId `_ :ref:`UnclaimedReward `\] - + .. _type-splice-amuletrules-amuletrulesminingroundarchive-33308: **Choice** `AmuletRules_MiningRound_Archive `_ Controller\: dso Returns\: `AmuletRules_MiningRound_ArchiveResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - closedRoundCid - `ContractId `_ :ref:`ClosedMiningRound ` - + .. _type-splice-amuletrules-amuletrulesminingroundclose-27964: **Choice** `AmuletRules_MiningRound_Close `_ Controller\: dso Returns\: `AmuletRules_MiningRound_CloseResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - issuingRoundCid - `ContractId `_ :ref:`IssuingMiningRound ` - + .. _type-splice-amuletrules-amuletrulesminingroundstartissuing-80649: **Choice** `AmuletRules_MiningRound_StartIssuing `_ Controller\: dso Returns\: `AmuletRules_MiningRound_StartIssuingResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - miningRoundCid - `ContractId `_ :ref:`SummarizingMiningRound ` - * - summary - :ref:`OpenMiningRoundSummary ` - + .. _type-splice-amuletrules-amuletrulesmint-76046: **Choice** `AmuletRules_Mint `_ Controller\: dso, receiver Returns\: `AmuletRules_MintResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - receiver - `Party `_ - * - amount - `Decimal `_ - * - openRound - `ContractId `_ :ref:`OpenMiningRound ` - + .. _type-splice-amuletrules-amuletrulesremovefutureamuletconfigschedule-69936: **Choice** `AmuletRules_RemoveFutureAmuletConfigSchedule `_ Controller\: dso Returns\: `AmuletRules_RemoveFutureAmuletConfigScheduleResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - scheduleTime - `Time `_ - + .. _type-splice-amuletrules-amuletrulestransfer-23235: **Choice** `AmuletRules_Transfer `_ Controller\: Set\.toList (transferControllers transfer) Returns\: `TransferResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - transfer - `Transfer `_ - * - context - `TransferContext `_ - + .. _type-splice-amuletrules-amuletrulesupdatefutureamuletconfigschedule-15159: **Choice** `AmuletRules_UpdateFutureAmuletConfigSchedule `_ Controller\: dso Returns\: `AmuletRules_UpdateFutureAmuletConfigScheduleResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - scheduleItem - (`Time `_, :ref:`AmuletConfig ` :ref:`USD `) - + **Choice** Archive Controller\: dso Returns\: () (no fields) .. _type-splice-amuletrules-externalpartysetupproposal-90414: **template** `ExternalPartySetupProposal `_ Signatory\: validator, dso .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - validator - `Party `_ - * - user - `Party `_ - * - dso - `Party `_ - * - createdAt - `Time `_ - * - preapprovalExpiresAt - `Time `_ - + **Choice** Archive Controller\: validator, dso Returns\: () (no fields) + .. _type-splice-amuletrules-externalpartysetupproposalaccept-68720: **Choice** `ExternalPartySetupProposal_Accept `_ Controller\: user Returns\: `ExternalPartySetupProposal_AcceptResult `_ (no fields) .. _type-splice-amuletrules-transferpreapproval-36220: **template** `TransferPreapproval `_ A pre\-approval by a receiver to receive Amulet from anybody\. Pre\-approvals are indexed by the SVs and served from scan for easy discovery until they expire\. The cost of providing this discovery service is charged by burning Amulet\. Receivers can either purchase and renew these pre\-approvals by themselves, or have an app provider do so for them in exchange for the app rewards for the amulet transfers completed via the managed pre\-approval\. Signatory\: receiver, provider, dso .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - dso - `Party `_ - * - receiver - `Party `_ - The receiver party * - provider - `Party `_ - The app provider that manages the pre\-approval for the receiver\. Equal to the receiver for self\-managed pre\-approvals\. * - validFrom - `Time `_ - This timestamp marks the start of the period for which fees were paid for the pre\-approval\. Preserved across renewals\. * - lastRenewedAt - `Time `_ - When the pre\-approval was last renewed\. Set equal to ``validFrom`` on creation and updated on each renewal\. * - expiresAt - `Time `_ - Provider selected timestamp defining the lifetime of the contract\. Can be extended by renewing the contract\. + **Choice** Archive Controller\: receiver, provider, dso Returns\: () (no fields) + .. _type-splice-amuletrules-transferpreapprovalcancel-70216: **Choice** `TransferPreapproval_Cancel `_ Controller\: p Returns\: `TransferPreapproval_CancelResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - p - `Party `_ - + .. _type-splice-amuletrules-transferpreapprovalexpire-84167: **Choice** `TransferPreapproval_Expire `_ Controller\: dso Returns\: `TransferPreapproval_ExpireResult `_ (no fields) + .. _type-splice-amuletrules-transferpreapprovalfetch-15083: **Choice** `TransferPreapproval_Fetch `_ Controller\: p Returns\: `TransferPreapproval `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - p - `Party `_ - + .. _type-splice-amuletrules-transferpreapprovalrenew-31244: **Choice** `TransferPreapproval_Renew `_ Controller\: provider Returns\: `TransferPreapproval_RenewResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - context - `PaymentTransferContext `_ - * - inputs - \[`TransferInput `_\] - * - newExpiresAt - `Time `_ - + .. _type-splice-amuletrules-transferpreapprovalsend-62554: **Choice** `TransferPreapproval_Send `_ Controller\: sender Returns\: `TransferPreapproval_SendResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - context - `PaymentTransferContext `_ - * - inputs - \[`TransferInput `_\] - * - amount - `Decimal `_ - * - sender - `Party `_ - Data Types ---------- .. _type-splice-amuletrules-amuletrulesaddfutureamuletconfigscheduleresult-28167: **data** `AmuletRules_AddFutureAmuletConfigScheduleResult `_ .. _constr-splice-amuletrules-amuletrulesaddfutureamuletconfigscheduleresult-43322: `AmuletRules_AddFutureAmuletConfigScheduleResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - newAmuletRules - `ContractId `_ `AmuletRules `_ - **instance** `GetField `_ \"newAmuletRules\" `AmuletRules_AddFutureAmuletConfigScheduleResult `_ (`ContractId `_ `AmuletRules `_) **instance** `SetField `_ \"newAmuletRules\" `AmuletRules_AddFutureAmuletConfigScheduleResult `_ (`ContractId `_ `AmuletRules `_) **instance** `HasExercise `_ `AmuletRules `_ `AmuletRules_AddFutureAmuletConfigSchedule `_ `AmuletRules_AddFutureAmuletConfigScheduleResult `_ **instance** `HasFromAnyChoice `_ `AmuletRules `_ `AmuletRules_AddFutureAmuletConfigSchedule `_ `AmuletRules_AddFutureAmuletConfigScheduleResult `_ **instance** `HasToAnyChoice `_ `AmuletRules `_ `AmuletRules_AddFutureAmuletConfigSchedule `_ `AmuletRules_AddFutureAmuletConfigScheduleResult `_ .. _type-splice-amuletrules-amuletrulesadvanceopenminingroundsresult-46823: **data** `AmuletRules_AdvanceOpenMiningRoundsResult `_ .. _constr-splice-amuletrules-amuletrulesadvanceopenminingroundsresult-34806: `AmuletRules_AdvanceOpenMiningRoundsResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - summarizingRoundCid - `ContractId `_ :ref:`SummarizingMiningRound ` - * - openRoundCid - `ContractId `_ :ref:`OpenMiningRound ` - **instance** `GetField `_ \"openRoundCid\" `AmuletRules_AdvanceOpenMiningRoundsResult `_ (`ContractId `_ :ref:`OpenMiningRound `) **instance** `GetField `_ \"summarizingRoundCid\" `AmuletRules_AdvanceOpenMiningRoundsResult `_ (`ContractId `_ :ref:`SummarizingMiningRound `) **instance** `SetField `_ \"openRoundCid\" `AmuletRules_AdvanceOpenMiningRoundsResult `_ (`ContractId `_ :ref:`OpenMiningRound `) **instance** `SetField `_ \"summarizingRoundCid\" `AmuletRules_AdvanceOpenMiningRoundsResult `_ (`ContractId `_ :ref:`SummarizingMiningRound `) **instance** `HasExercise `_ `AmuletRules `_ `AmuletRules_AdvanceOpenMiningRounds `_ `AmuletRules_AdvanceOpenMiningRoundsResult `_ **instance** `HasFromAnyChoice `_ `AmuletRules `_ `AmuletRules_AdvanceOpenMiningRounds `_ `AmuletRules_AdvanceOpenMiningRoundsResult `_ **instance** `HasToAnyChoice `_ `AmuletRules `_ `AmuletRules_AdvanceOpenMiningRounds `_ `AmuletRules_AdvanceOpenMiningRoundsResult `_ .. _type-splice-amuletrules-amuletrulesbootstraproundsresult-84997: **data** `AmuletRules_Bootstrap_RoundsResult `_ .. _constr-splice-amuletrules-amuletrulesbootstraproundsresult-21662: `AmuletRules_Bootstrap_RoundsResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - openMiningRoundCid - `ContractId `_ :ref:`OpenMiningRound ` - **instance** `GetField `_ \"openMiningRoundCid\" `AmuletRules_Bootstrap_RoundsResult `_ (`ContractId `_ :ref:`OpenMiningRound `) **instance** `SetField `_ \"openMiningRoundCid\" `AmuletRules_Bootstrap_RoundsResult `_ (`ContractId `_ :ref:`OpenMiningRound `) **instance** `HasExercise `_ `AmuletRules `_ `AmuletRules_Bootstrap_Rounds `_ `AmuletRules_Bootstrap_RoundsResult `_ **instance** `HasFromAnyChoice `_ `AmuletRules `_ `AmuletRules_Bootstrap_Rounds `_ `AmuletRules_Bootstrap_RoundsResult `_ **instance** `HasToAnyChoice `_ `AmuletRules `_ `AmuletRules_Bootstrap_Rounds `_ `AmuletRules_Bootstrap_RoundsResult `_ .. _type-splice-amuletrules-amuletrulesbuymembertrafficresult-65734: **data** `AmuletRules_BuyMemberTrafficResult `_ .. _constr-splice-amuletrules-amuletrulesbuymembertrafficresult-62493: `AmuletRules_BuyMemberTrafficResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - round - :ref:`Round ` - * - summary - `TransferSummary `_ - * - amuletPaid - `Decimal `_ - * - purchasedTraffic - `ContractId `_ :ref:`MemberTraffic ` - * - senderChangeAmulet - `Optional `_ (`ContractId `_ :ref:`Amulet `) - **instance** `Eq `_ `AmuletRules_BuyMemberTrafficResult `_ **instance** `Show `_ `AmuletRules_BuyMemberTrafficResult `_ **instance** `GetField `_ \"amuletPaid\" `AmuletRules_BuyMemberTrafficResult `_ `Decimal `_ **instance** `GetField `_ \"purchasedTraffic\" `AmuletRules_BuyMemberTrafficResult `_ (`ContractId `_ :ref:`MemberTraffic `) **instance** `GetField `_ \"round\" `AmuletRules_BuyMemberTrafficResult `_ :ref:`Round ` **instance** `GetField `_ \"senderChangeAmulet\" `AmuletRules_BuyMemberTrafficResult `_ (`Optional `_ (`ContractId `_ :ref:`Amulet `)) **instance** `GetField `_ \"summary\" `AmuletRules_BuyMemberTrafficResult `_ `TransferSummary `_ **instance** `SetField `_ \"amuletPaid\" `AmuletRules_BuyMemberTrafficResult `_ `Decimal `_ **instance** `SetField `_ \"purchasedTraffic\" `AmuletRules_BuyMemberTrafficResult `_ (`ContractId `_ :ref:`MemberTraffic `) **instance** `SetField `_ \"round\" `AmuletRules_BuyMemberTrafficResult `_ :ref:`Round ` **instance** `SetField `_ \"senderChangeAmulet\" `AmuletRules_BuyMemberTrafficResult `_ (`Optional `_ (`ContractId `_ :ref:`Amulet `)) **instance** `SetField `_ \"summary\" `AmuletRules_BuyMemberTrafficResult `_ `TransferSummary `_ **instance** `HasExercise `_ `AmuletRules `_ `AmuletRules_BuyMemberTraffic `_ `AmuletRules_BuyMemberTrafficResult `_ **instance** `HasFromAnyChoice `_ `AmuletRules `_ `AmuletRules_BuyMemberTraffic `_ `AmuletRules_BuyMemberTrafficResult `_ **instance** `HasToAnyChoice `_ `AmuletRules `_ `AmuletRules_BuyMemberTraffic `_ `AmuletRules_BuyMemberTrafficResult `_ .. _type-splice-amuletrules-amuletrulesclaimexpiredrewardsresult-1315: **data** `AmuletRules_ClaimExpiredRewardsResult `_ .. _constr-splice-amuletrules-amuletrulesclaimexpiredrewardsresult-54946: `AmuletRules_ClaimExpiredRewardsResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - unclaimedRewardCid - `Optional `_ (`ContractId `_ :ref:`UnclaimedReward `) - **instance** `GetField `_ \"unclaimedRewardCid\" `AmuletRules_ClaimExpiredRewardsResult `_ (`Optional `_ (`ContractId `_ :ref:`UnclaimedReward `)) **instance** `SetField `_ \"unclaimedRewardCid\" `AmuletRules_ClaimExpiredRewardsResult `_ (`Optional `_ (`ContractId `_ :ref:`UnclaimedReward `)) **instance** `HasExercise `_ `AmuletRules `_ `AmuletRules_ClaimExpiredRewards `_ `AmuletRules_ClaimExpiredRewardsResult `_ **instance** `HasFromAnyChoice `_ `AmuletRules `_ `AmuletRules_ClaimExpiredRewards `_ `AmuletRules_ClaimExpiredRewardsResult `_ **instance** `HasToAnyChoice `_ `AmuletRules `_ `AmuletRules_ClaimExpiredRewards `_ `AmuletRules_ClaimExpiredRewardsResult `_ .. _type-splice-amuletrules-amuletrulescomputefeesresult-44934: **data** `AmuletRules_ComputeFeesResult `_ .. _constr-splice-amuletrules-amuletrulescomputefeesresult-49467: `AmuletRules_ComputeFeesResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - fees - \[`Decimal `_\] - **instance** `GetField `_ \"fees\" `AmuletRules_ComputeFeesResult `_ \[`Decimal `_\] **instance** `SetField `_ \"fees\" `AmuletRules_ComputeFeesResult `_ \[`Decimal `_\] **instance** `HasExercise `_ `AmuletRules `_ `AmuletRules_ComputeFees `_ `AmuletRules_ComputeFeesResult `_ **instance** `HasFromAnyChoice `_ `AmuletRules `_ `AmuletRules_ComputeFees `_ `AmuletRules_ComputeFeesResult `_ **instance** `HasToAnyChoice `_ `AmuletRules `_ `AmuletRules_ComputeFees `_ `AmuletRules_ComputeFeesResult `_ .. _type-splice-amuletrules-amuletrulescreateexternalpartysetupproposalresult-7515: **data** `AmuletRules_CreateExternalPartySetupProposalResult `_ .. _constr-splice-amuletrules-amuletrulescreateexternalpartysetupproposalresult-29120: `AmuletRules_CreateExternalPartySetupProposalResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - proposalCid - `ContractId `_ `ExternalPartySetupProposal `_ - * - user - `Party `_ - * - validator - `Party `_ - * - transferResult - `TransferResult `_ - * - amuletPaid - `Decimal `_ - **instance** `Eq `_ `AmuletRules_CreateExternalPartySetupProposalResult `_ **instance** `Show `_ `AmuletRules_CreateExternalPartySetupProposalResult `_ **instance** `GetField `_ \"amuletPaid\" `AmuletRules_CreateExternalPartySetupProposalResult `_ `Decimal `_ **instance** `GetField `_ \"proposalCid\" `AmuletRules_CreateExternalPartySetupProposalResult `_ (`ContractId `_ `ExternalPartySetupProposal `_) **instance** `GetField `_ \"transferResult\" `AmuletRules_CreateExternalPartySetupProposalResult `_ `TransferResult `_ **instance** `GetField `_ \"user\" `AmuletRules_CreateExternalPartySetupProposalResult `_ `Party `_ **instance** `GetField `_ \"validator\" `AmuletRules_CreateExternalPartySetupProposalResult `_ `Party `_ **instance** `SetField `_ \"amuletPaid\" `AmuletRules_CreateExternalPartySetupProposalResult `_ `Decimal `_ **instance** `SetField `_ \"proposalCid\" `AmuletRules_CreateExternalPartySetupProposalResult `_ (`ContractId `_ `ExternalPartySetupProposal `_) **instance** `SetField `_ \"transferResult\" `AmuletRules_CreateExternalPartySetupProposalResult `_ `TransferResult `_ **instance** `SetField `_ \"user\" `AmuletRules_CreateExternalPartySetupProposalResult `_ `Party `_ **instance** `SetField `_ \"validator\" `AmuletRules_CreateExternalPartySetupProposalResult `_ `Party `_ **instance** `HasExercise `_ `AmuletRules `_ `AmuletRules_CreateExternalPartySetupProposal `_ `AmuletRules_CreateExternalPartySetupProposalResult `_ **instance** `HasFromAnyChoice `_ `AmuletRules `_ `AmuletRules_CreateExternalPartySetupProposal `_ `AmuletRules_CreateExternalPartySetupProposalResult `_ **instance** `HasToAnyChoice `_ `AmuletRules `_ `AmuletRules_CreateExternalPartySetupProposal `_ `AmuletRules_CreateExternalPartySetupProposalResult `_ .. _type-splice-amuletrules-amuletrulescreatetransferpreapprovalresult-96401: **data** `AmuletRules_CreateTransferPreapprovalResult `_ .. _constr-splice-amuletrules-amuletrulescreatetransferpreapprovalresult-40608: `AmuletRules_CreateTransferPreapprovalResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - transferPreapprovalCid - `ContractId `_ `TransferPreapproval `_ - * - transferResult - `TransferResult `_ - * - amuletPaid - `Decimal `_ - **instance** `Eq `_ `AmuletRules_CreateTransferPreapprovalResult `_ **instance** `Show `_ `AmuletRules_CreateTransferPreapprovalResult `_ **instance** `GetField `_ \"amuletPaid\" `AmuletRules_CreateTransferPreapprovalResult `_ `Decimal `_ **instance** `GetField `_ \"transferPreapprovalCid\" `AmuletRules_CreateTransferPreapprovalResult `_ (`ContractId `_ `TransferPreapproval `_) **instance** `GetField `_ \"transferResult\" `AmuletRules_CreateTransferPreapprovalResult `_ `TransferResult `_ **instance** `SetField `_ \"amuletPaid\" `AmuletRules_CreateTransferPreapprovalResult `_ `Decimal `_ **instance** `SetField `_ \"transferPreapprovalCid\" `AmuletRules_CreateTransferPreapprovalResult `_ (`ContractId `_ `TransferPreapproval `_) **instance** `SetField `_ \"transferResult\" `AmuletRules_CreateTransferPreapprovalResult `_ `TransferResult `_ **instance** `HasExercise `_ `AmuletRules `_ `AmuletRules_CreateTransferPreapproval `_ `AmuletRules_CreateTransferPreapprovalResult `_ **instance** `HasFromAnyChoice `_ `AmuletRules `_ `AmuletRules_CreateTransferPreapproval `_ `AmuletRules_CreateTransferPreapprovalResult `_ **instance** `HasToAnyChoice `_ `AmuletRules `_ `AmuletRules_CreateTransferPreapproval `_ `AmuletRules_CreateTransferPreapprovalResult `_ .. _type-splice-amuletrules-amuletrulesdevnetfeatureappresult-75066: **data** `AmuletRules_DevNet_FeatureAppResult `_ .. _constr-splice-amuletrules-amuletrulesdevnetfeatureappresult-18203: `AmuletRules_DevNet_FeatureAppResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - featuredAppRightCid - `ContractId `_ :ref:`FeaturedAppRight ` - **instance** `GetField `_ \"featuredAppRightCid\" `AmuletRules_DevNet_FeatureAppResult `_ (`ContractId `_ :ref:`FeaturedAppRight `) **instance** `SetField `_ \"featuredAppRightCid\" `AmuletRules_DevNet_FeatureAppResult `_ (`ContractId `_ :ref:`FeaturedAppRight `) **instance** `HasExercise `_ `AmuletRules `_ `AmuletRules_DevNet_FeatureApp `_ `AmuletRules_DevNet_FeatureAppResult `_ **instance** `HasFromAnyChoice `_ `AmuletRules `_ `AmuletRules_DevNet_FeatureApp `_ `AmuletRules_DevNet_FeatureAppResult `_ **instance** `HasToAnyChoice `_ `AmuletRules `_ `AmuletRules_DevNet_FeatureApp `_ `AmuletRules_DevNet_FeatureAppResult `_ .. _type-splice-amuletrules-amuletrulesdevnettapresult-1845: **data** `AmuletRules_DevNet_TapResult `_ .. _constr-splice-amuletrules-amuletrulesdevnettapresult-50542: `AmuletRules_DevNet_TapResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - amuletSum - :ref:`AmuletCreateSummary ` (`ContractId `_ :ref:`Amulet `) - **instance** `GetField `_ \"amuletSum\" `AmuletRules_DevNet_TapResult `_ (:ref:`AmuletCreateSummary ` (`ContractId `_ :ref:`Amulet `)) **instance** `SetField `_ \"amuletSum\" `AmuletRules_DevNet_TapResult `_ (:ref:`AmuletCreateSummary ` (`ContractId `_ :ref:`Amulet `)) **instance** `HasExercise `_ `AmuletRules `_ `AmuletRules_DevNet_Tap `_ `AmuletRules_DevNet_TapResult `_ **instance** `HasFromAnyChoice `_ `AmuletRules `_ `AmuletRules_DevNet_Tap `_ `AmuletRules_DevNet_TapResult `_ **instance** `HasToAnyChoice `_ `AmuletRules `_ `AmuletRules_DevNet_Tap `_ `AmuletRules_DevNet_TapResult `_ .. _type-splice-amuletrules-amuletrulesmergemembertrafficcontractsresult-2448: **data** `AmuletRules_MergeMemberTrafficContractsResult `_ .. _constr-splice-amuletrules-amuletrulesmergemembertrafficcontractsresult-32033: `AmuletRules_MergeMemberTrafficContractsResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - mergedTrafficCid - `ContractId `_ :ref:`MemberTraffic ` - **instance** `GetField `_ \"mergedTrafficCid\" `AmuletRules_MergeMemberTrafficContractsResult `_ (`ContractId `_ :ref:`MemberTraffic `) **instance** `SetField `_ \"mergedTrafficCid\" `AmuletRules_MergeMemberTrafficContractsResult `_ (`ContractId `_ :ref:`MemberTraffic `) **instance** `HasExercise `_ `AmuletRules `_ `AmuletRules_MergeMemberTrafficContracts `_ `AmuletRules_MergeMemberTrafficContractsResult `_ **instance** `HasFromAnyChoice `_ `AmuletRules `_ `AmuletRules_MergeMemberTrafficContracts `_ `AmuletRules_MergeMemberTrafficContractsResult `_ **instance** `HasToAnyChoice `_ `AmuletRules `_ `AmuletRules_MergeMemberTrafficContracts `_ `AmuletRules_MergeMemberTrafficContractsResult `_ .. _type-splice-amuletrules-amuletrulesmergeunclaimedrewardsresult-41840: **data** `AmuletRules_MergeUnclaimedRewardsResult `_ .. _constr-splice-amuletrules-amuletrulesmergeunclaimedrewardsresult-46793: `AmuletRules_MergeUnclaimedRewardsResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - unclaimedRewardCid - `ContractId `_ :ref:`UnclaimedReward ` - **instance** `GetField `_ \"unclaimedRewardCid\" `AmuletRules_MergeUnclaimedRewardsResult `_ (`ContractId `_ :ref:`UnclaimedReward `) **instance** `SetField `_ \"unclaimedRewardCid\" `AmuletRules_MergeUnclaimedRewardsResult `_ (`ContractId `_ :ref:`UnclaimedReward `) **instance** `HasExercise `_ `AmuletRules `_ `AmuletRules_MergeUnclaimedRewards `_ `AmuletRules_MergeUnclaimedRewardsResult `_ **instance** `HasFromAnyChoice `_ `AmuletRules `_ `AmuletRules_MergeUnclaimedRewards `_ `AmuletRules_MergeUnclaimedRewardsResult `_ **instance** `HasToAnyChoice `_ `AmuletRules `_ `AmuletRules_MergeUnclaimedRewards `_ `AmuletRules_MergeUnclaimedRewardsResult `_ .. _type-splice-amuletrules-amuletrulesminingroundarchiveresult-65797: **data** `AmuletRules_MiningRound_ArchiveResult `_ .. _constr-splice-amuletrules-amuletrulesminingroundarchiveresult-73420: `AmuletRules_MiningRound_ArchiveResult `_ **instance** `HasExercise `_ `AmuletRules `_ `AmuletRules_MiningRound_Archive `_ `AmuletRules_MiningRound_ArchiveResult `_ **instance** `HasFromAnyChoice `_ `AmuletRules `_ `AmuletRules_MiningRound_Archive `_ `AmuletRules_MiningRound_ArchiveResult `_ **instance** `HasToAnyChoice `_ `AmuletRules `_ `AmuletRules_MiningRound_Archive `_ `AmuletRules_MiningRound_ArchiveResult `_ .. _type-splice-amuletrules-amuletrulesminingroundcloseresult-67441: **data** `AmuletRules_MiningRound_CloseResult `_ .. _constr-splice-amuletrules-amuletrulesminingroundcloseresult-19004: `AmuletRules_MiningRound_CloseResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - closedRoundCid - `ContractId `_ :ref:`ClosedMiningRound ` - **instance** `GetField `_ \"closedRoundCid\" `AmuletRules_MiningRound_CloseResult `_ (`ContractId `_ :ref:`ClosedMiningRound `) **instance** `SetField `_ \"closedRoundCid\" `AmuletRules_MiningRound_CloseResult `_ (`ContractId `_ :ref:`ClosedMiningRound `) **instance** `HasExercise `_ `AmuletRules `_ `AmuletRules_MiningRound_Close `_ `AmuletRules_MiningRound_CloseResult `_ **instance** `HasFromAnyChoice `_ `AmuletRules `_ `AmuletRules_MiningRound_Close `_ `AmuletRules_MiningRound_CloseResult `_ **instance** `HasToAnyChoice `_ `AmuletRules `_ `AmuletRules_MiningRound_Close `_ `AmuletRules_MiningRound_CloseResult `_ .. _type-splice-amuletrules-amuletrulesminingroundstartissuingresult-26220: **data** `AmuletRules_MiningRound_StartIssuingResult `_ .. _constr-splice-amuletrules-amuletrulesminingroundstartissuingresult-95691: `AmuletRules_MiningRound_StartIssuingResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - issuingRoundCid - `ContractId `_ :ref:`IssuingMiningRound ` - **instance** `GetField `_ \"issuingRoundCid\" `AmuletRules_MiningRound_StartIssuingResult `_ (`ContractId `_ :ref:`IssuingMiningRound `) **instance** `SetField `_ \"issuingRoundCid\" `AmuletRules_MiningRound_StartIssuingResult `_ (`ContractId `_ :ref:`IssuingMiningRound `) **instance** `HasExercise `_ `AmuletRules `_ `AmuletRules_MiningRound_StartIssuing `_ `AmuletRules_MiningRound_StartIssuingResult `_ **instance** `HasFromAnyChoice `_ `AmuletRules `_ `AmuletRules_MiningRound_StartIssuing `_ `AmuletRules_MiningRound_StartIssuingResult `_ **instance** `HasToAnyChoice `_ `AmuletRules `_ `AmuletRules_MiningRound_StartIssuing `_ `AmuletRules_MiningRound_StartIssuingResult `_ .. _type-splice-amuletrules-amuletrulesmintresult-5311: **data** `AmuletRules_MintResult `_ .. _constr-splice-amuletrules-amuletrulesmintresult-82812: `AmuletRules_MintResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - amuletSum - :ref:`AmuletCreateSummary ` (`ContractId `_ :ref:`Amulet `) - **instance** `GetField `_ \"amuletSum\" `AmuletRules_MintResult `_ (:ref:`AmuletCreateSummary ` (`ContractId `_ :ref:`Amulet `)) **instance** `SetField `_ \"amuletSum\" `AmuletRules_MintResult `_ (:ref:`AmuletCreateSummary ` (`ContractId `_ :ref:`Amulet `)) **instance** `HasExercise `_ `AmuletRules `_ `AmuletRules_Mint `_ `AmuletRules_MintResult `_ **instance** `HasFromAnyChoice `_ `AmuletRules `_ `AmuletRules_Mint `_ `AmuletRules_MintResult `_ **instance** `HasToAnyChoice `_ `AmuletRules `_ `AmuletRules_Mint `_ `AmuletRules_MintResult `_ .. _type-splice-amuletrules-amuletrulesremovefutureamuletconfigscheduleresult-69237: **data** `AmuletRules_RemoveFutureAmuletConfigScheduleResult `_ .. _constr-splice-amuletrules-amuletrulesremovefutureamuletconfigscheduleresult-56166: `AmuletRules_RemoveFutureAmuletConfigScheduleResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - newAmuletRules - `ContractId `_ `AmuletRules `_ - **instance** `GetField `_ \"newAmuletRules\" `AmuletRules_RemoveFutureAmuletConfigScheduleResult `_ (`ContractId `_ `AmuletRules `_) **instance** `SetField `_ \"newAmuletRules\" `AmuletRules_RemoveFutureAmuletConfigScheduleResult `_ (`ContractId `_ `AmuletRules `_) **instance** `HasExercise `_ `AmuletRules `_ `AmuletRules_RemoveFutureAmuletConfigSchedule `_ `AmuletRules_RemoveFutureAmuletConfigScheduleResult `_ **instance** `HasFromAnyChoice `_ `AmuletRules `_ `AmuletRules_RemoveFutureAmuletConfigSchedule `_ `AmuletRules_RemoveFutureAmuletConfigScheduleResult `_ **instance** `HasToAnyChoice `_ `AmuletRules `_ `AmuletRules_RemoveFutureAmuletConfigSchedule `_ `AmuletRules_RemoveFutureAmuletConfigScheduleResult `_ .. _type-splice-amuletrules-amuletrulesupdatefutureamuletconfigscheduleresult-96070: **data** `AmuletRules_UpdateFutureAmuletConfigScheduleResult `_ .. _constr-splice-amuletrules-amuletrulesupdatefutureamuletconfigscheduleresult-12117: `AmuletRules_UpdateFutureAmuletConfigScheduleResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - newAmuletRules - `ContractId `_ `AmuletRules `_ - **instance** `GetField `_ \"newAmuletRules\" `AmuletRules_UpdateFutureAmuletConfigScheduleResult `_ (`ContractId `_ `AmuletRules `_) **instance** `SetField `_ \"newAmuletRules\" `AmuletRules_UpdateFutureAmuletConfigScheduleResult `_ (`ContractId `_ `AmuletRules `_) **instance** `HasExercise `_ `AmuletRules `_ `AmuletRules_UpdateFutureAmuletConfigSchedule `_ `AmuletRules_UpdateFutureAmuletConfigScheduleResult `_ **instance** `HasFromAnyChoice `_ `AmuletRules `_ `AmuletRules_UpdateFutureAmuletConfigSchedule `_ `AmuletRules_UpdateFutureAmuletConfigScheduleResult `_ **instance** `HasToAnyChoice `_ `AmuletRules `_ `AmuletRules_UpdateFutureAmuletConfigSchedule `_ `AmuletRules_UpdateFutureAmuletConfigScheduleResult `_ .. _type-splice-amuletrules-apptransfercontext-68083: **data** `AppTransferContext `_ .. _constr-splice-amuletrules-apptransfercontext-19128: `AppTransferContext `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - amuletRules - `ContractId `_ `AmuletRules `_ - * - openMiningRound - `ContractId `_ :ref:`OpenMiningRound ` - * - featuredAppRight - `Optional `_ (`ContractId `_ :ref:`FeaturedAppRight `) - **instance** `Eq `_ `AppTransferContext `_ **instance** `Show `_ `AppTransferContext `_ **instance** `GetField `_ \"amuletRules\" `AppTransferContext `_ (`ContractId `_ `AmuletRules `_) **instance** `GetField `_ \"featuredAppRight\" `AppTransferContext `_ (`Optional `_ (`ContractId `_ :ref:`FeaturedAppRight `)) **instance** `GetField `_ \"openMiningRound\" `AppTransferContext `_ (`ContractId `_ :ref:`OpenMiningRound `) **instance** `SetField `_ \"amuletRules\" `AppTransferContext `_ (`ContractId `_ `AmuletRules `_) **instance** `SetField `_ \"featuredAppRight\" `AppTransferContext `_ (`Optional `_ (`ContractId `_ :ref:`FeaturedAppRight `)) **instance** `SetField `_ \"openMiningRound\" `AppTransferContext `_ (`ContractId `_ :ref:`OpenMiningRound `) .. _type-splice-amuletrules-balancechange-24411: **data** `BalanceChange `_ .. _constr-splice-amuletrules-balancechange-6762: `BalanceChange `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - changeToInitialAmountAsOfRoundZero - `Decimal `_ - The change to the total balance introduced by this balance change, normalized to round zero, i\.e\., a amulet created in round 3 is treated as a amulet created in round 0 with a higher initial amount\. * - changeToHoldingFeesRate - `Decimal `_ - The change of total holding fees introduced by this balance change\. **instance** `Eq `_ `BalanceChange `_ **instance** `Additive `_ `BalanceChange `_ **instance** `Show `_ `BalanceChange `_ **instance** `GetField `_ \"balanceChanges\" `TransferSummary `_ (`Map `_ `Party `_ `BalanceChange `_) **instance** `GetField `_ \"changeToHoldingFeesRate\" `BalanceChange `_ `Decimal `_ **instance** `GetField `_ \"changeToInitialAmountAsOfRoundZero\" `BalanceChange `_ `Decimal `_ **instance** `SetField `_ \"balanceChanges\" `TransferSummary `_ (`Map `_ `Party `_ `BalanceChange `_) **instance** `SetField `_ \"changeToHoldingFeesRate\" `BalanceChange `_ `Decimal `_ **instance** `SetField `_ \"changeToInitialAmountAsOfRoundZero\" `BalanceChange `_ `Decimal `_ .. _type-splice-amuletrules-createdamulet-4205: **data** `CreatedAmulet `_ .. _constr-splice-amuletrules-transferresultamulet-871: `TransferResultAmulet `_ (`ContractId `_ :ref:`Amulet `) .. _constr-splice-amuletrules-transferresultlockedamulet-28147: `TransferResultLockedAmulet `_ (`ContractId `_ :ref:`LockedAmulet `) .. _constr-splice-amuletrules-extcreatedamulet-9390: `ExtCreatedAmulet `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - dummyUnitField - () - Extension constructor (and field) to work around the current lack of upgrading for variants in Daml 3\.0 **instance** `Eq `_ `CreatedAmulet `_ **instance** `Ord `_ `CreatedAmulet `_ **instance** `Show `_ `CreatedAmulet `_ **instance** `GetField `_ \"createdAmulets\" `TransferResult `_ \[`CreatedAmulet `_\] **instance** `GetField `_ \"dummyUnitField\" `CreatedAmulet `_ () **instance** `SetField `_ \"createdAmulets\" `TransferResult `_ \[`CreatedAmulet `_\] **instance** `SetField `_ \"dummyUnitField\" `CreatedAmulet `_ () .. _type-splice-amuletrules-externalpartysetupproposalacceptresult-45221: **data** `ExternalPartySetupProposal_AcceptResult `_ .. _constr-splice-amuletrules-externalpartysetupproposalacceptresult-28452: `ExternalPartySetupProposal_AcceptResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - validatorRightCid - `ContractId `_ :ref:`ValidatorRight ` - * - transferPreapprovalCid - `ContractId `_ `TransferPreapproval `_ - **instance** `Eq `_ `ExternalPartySetupProposal_AcceptResult `_ **instance** `Show `_ `ExternalPartySetupProposal_AcceptResult `_ **instance** `GetField `_ \"transferPreapprovalCid\" `ExternalPartySetupProposal_AcceptResult `_ (`ContractId `_ `TransferPreapproval `_) **instance** `GetField `_ \"validatorRightCid\" `ExternalPartySetupProposal_AcceptResult `_ (`ContractId `_ :ref:`ValidatorRight `) **instance** `SetField `_ \"transferPreapprovalCid\" `ExternalPartySetupProposal_AcceptResult `_ (`ContractId `_ `TransferPreapproval `_) **instance** `SetField `_ \"validatorRightCid\" `ExternalPartySetupProposal_AcceptResult `_ (`ContractId `_ :ref:`ValidatorRight `) **instance** `HasExercise `_ `ExternalPartySetupProposal `_ `ExternalPartySetupProposal_Accept `_ `ExternalPartySetupProposal_AcceptResult `_ **instance** `HasFromAnyChoice `_ `ExternalPartySetupProposal `_ `ExternalPartySetupProposal_Accept `_ `ExternalPartySetupProposal_AcceptResult `_ **instance** `HasToAnyChoice `_ `ExternalPartySetupProposal `_ `ExternalPartySetupProposal_Accept `_ `ExternalPartySetupProposal_AcceptResult `_ .. _type-splice-amuletrules-invalidtransfer-45437: **data** `InvalidTransfer `_ .. _constr-splice-amuletrules-invalidtransfer-25400: `InvalidTransfer `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - reason - `InvalidTransferReason `_ - **instance** `Eq `_ `InvalidTransfer `_ **instance** `Show `_ `InvalidTransfer `_ **instance** `HasFromAnyException `_ `InvalidTransfer `_ **instance** `HasMessage `_ `InvalidTransfer `_ **instance** `HasThrow `_ `InvalidTransfer `_ **instance** `HasToAnyException `_ `InvalidTransfer `_ **instance** `GetField `_ \"reason\" `InvalidTransfer `_ `InvalidTransferReason `_ **instance** `SetField `_ \"reason\" `InvalidTransfer `_ `InvalidTransferReason `_ .. _type-splice-amuletrules-invalidtransferreason-16587: **data** `InvalidTransferReason `_ .. _constr-splice-amuletrules-itrinsufficientfunds-49975: `ITR_InsufficientFunds `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - missingAmount - `Decimal `_ - .. _constr-splice-amuletrules-itrunknownsynchronizer-472: `ITR_UnknownSynchronizer `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - synchronizerId - `Text `_ - .. _constr-splice-amuletrules-itrinsufficienttopupamount-60775: `ITR_InsufficientTopupAmount `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - requestedTopupAmount - `Int `_ - * - minTopupAmount - `Int `_ - .. _constr-splice-amuletrules-itrother-36638: `ITR_Other `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - description - `Text `_ - .. _constr-splice-amuletrules-extinvalidtransferreason-71060: `ExtInvalidTransferReason `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - dummyUnitField - () - Extension constructor (and field) to work around the current lack of upgrading for variants in Daml 3\.0 **instance** `Eq `_ `InvalidTransferReason `_ **instance** `Show `_ `InvalidTransferReason `_ **instance** `GetField `_ \"description\" `InvalidTransferReason `_ `Text `_ **instance** `GetField `_ \"dummyUnitField\" `InvalidTransferReason `_ () **instance** `GetField `_ \"minTopupAmount\" `InvalidTransferReason `_ `Int `_ **instance** `GetField `_ \"missingAmount\" `InvalidTransferReason `_ `Decimal `_ **instance** `GetField `_ \"reason\" `InvalidTransfer `_ `InvalidTransferReason `_ **instance** `GetField `_ \"reason\" :ref:`TransferCommandResult ` `InvalidTransferReason `_ **instance** `GetField `_ \"requestedTopupAmount\" `InvalidTransferReason `_ `Int `_ **instance** `GetField `_ \"synchronizerId\" `InvalidTransferReason `_ `Text `_ **instance** `SetField `_ \"description\" `InvalidTransferReason `_ `Text `_ **instance** `SetField `_ \"dummyUnitField\" `InvalidTransferReason `_ () **instance** `SetField `_ \"minTopupAmount\" `InvalidTransferReason `_ `Int `_ **instance** `SetField `_ \"missingAmount\" `InvalidTransferReason `_ `Decimal `_ **instance** `SetField `_ \"reason\" `InvalidTransfer `_ `InvalidTransferReason `_ **instance** `SetField `_ \"reason\" :ref:`TransferCommandResult ` `InvalidTransferReason `_ **instance** `SetField `_ \"requestedTopupAmount\" `InvalidTransferReason `_ `Int `_ **instance** `SetField `_ \"synchronizerId\" `InvalidTransferReason `_ `Text `_ .. _type-splice-amuletrules-paymenttransfercontext-72190: **data** `PaymentTransferContext `_ .. _constr-splice-amuletrules-paymenttransfercontext-9413: `PaymentTransferContext `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - amuletRules - `ContractId `_ `AmuletRules `_ - * - context - `TransferContext `_ - **instance** `Eq `_ `PaymentTransferContext `_ **instance** `Show `_ `PaymentTransferContext `_ **instance** `GetField `_ \"amuletRules\" `PaymentTransferContext `_ (`ContractId `_ `AmuletRules `_) **instance** `GetField `_ \"context\" `AmuletRules_CreateExternalPartySetupProposal `_ `PaymentTransferContext `_ **instance** `GetField `_ \"context\" `AmuletRules_CreateTransferPreapproval `_ `PaymentTransferContext `_ **instance** `GetField `_ \"context\" `PaymentTransferContext `_ `TransferContext `_ **instance** `GetField `_ \"context\" `TransferPreapproval_Renew `_ `PaymentTransferContext `_ **instance** `GetField `_ \"context\" `TransferPreapproval_Send `_ `PaymentTransferContext `_ **instance** `GetField `_ \"context\" :ref:`TransferCommand_Send ` `PaymentTransferContext `_ **instance** `SetField `_ \"amuletRules\" `PaymentTransferContext `_ (`ContractId `_ `AmuletRules `_) **instance** `SetField `_ \"context\" `AmuletRules_CreateExternalPartySetupProposal `_ `PaymentTransferContext `_ **instance** `SetField `_ \"context\" `AmuletRules_CreateTransferPreapproval `_ `PaymentTransferContext `_ **instance** `SetField `_ \"context\" `PaymentTransferContext `_ `TransferContext `_ **instance** `SetField `_ \"context\" `TransferPreapproval_Renew `_ `PaymentTransferContext `_ **instance** `SetField `_ \"context\" `TransferPreapproval_Send `_ `PaymentTransferContext `_ **instance** `SetField `_ \"context\" :ref:`TransferCommand_Send ` `PaymentTransferContext `_ .. _type-splice-amuletrules-preprocessedtransferoutput-12209: **data** `PreprocessedTransferOutput `_ .. _constr-splice-amuletrules-preprocessedtransferoutput-93914: `PreprocessedTransferOutput `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - owner - `Party `_ - Owner of the output * - outputFee - `Decimal `_ - Fee charged to create this output * - amount - `Decimal `_ - Amount of amulet held by this output (after deducting fees) * - lock - `Optional `_ :ref:`TimeLock ` - Whether to lock the amulet or not **instance** `Eq `_ `PreprocessedTransferOutput `_ **instance** `Show `_ `PreprocessedTransferOutput `_ **instance** `GetField `_ \"amount\" `PreprocessedTransferOutput `_ `Decimal `_ **instance** `GetField `_ \"lock\" `PreprocessedTransferOutput `_ (`Optional `_ :ref:`TimeLock `) **instance** `GetField `_ \"outputFee\" `PreprocessedTransferOutput `_ `Decimal `_ **instance** `GetField `_ \"owner\" `PreprocessedTransferOutput `_ `Party `_ **instance** `SetField `_ \"amount\" `PreprocessedTransferOutput `_ `Decimal `_ **instance** `SetField `_ \"lock\" `PreprocessedTransferOutput `_ (`Optional `_ :ref:`TimeLock `) **instance** `SetField `_ \"outputFee\" `PreprocessedTransferOutput `_ `Decimal `_ **instance** `SetField `_ \"owner\" `PreprocessedTransferOutput `_ `Party `_ .. _type-splice-amuletrules-rewardsissuanceconfig-37252: **data** `RewardsIssuanceConfig `_ An easy way to configure ``exucuteTransfer`` wrt what rewards to issue\. We currently only use two configurations\: but all of the options in here make sense, so we keep them\. .. _constr-splice-amuletrules-rewardsissuanceconfig-46673: `RewardsIssuanceConfig `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - issueAppRewards - `Bool `_ - * - issueValidatorRewards - `Bool `_ - **instance** `GetField `_ \"issueAppRewards\" `RewardsIssuanceConfig `_ `Bool `_ **instance** `GetField `_ \"issueValidatorRewards\" `RewardsIssuanceConfig `_ `Bool `_ **instance** `SetField `_ \"issueAppRewards\" `RewardsIssuanceConfig `_ `Bool `_ **instance** `SetField `_ \"issueValidatorRewards\" `RewardsIssuanceConfig `_ `Bool `_ .. _type-splice-amuletrules-transfer-72721: **data** `Transfer `_ Representation of a batch transfer\. .. _constr-splice-amuletrules-transfer-1214: `Transfer `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - sender - `Party `_ - * - provider - `Party `_ - * - inputs - \[`TransferInput `_\] - * - outputs - \[`TransferOutput `_\] - **instance** `Eq `_ `Transfer `_ **instance** `Ord `_ `Transfer `_ **instance** `Show `_ `Transfer `_ **instance** `GetField `_ \"inputs\" `Transfer `_ \[`TransferInput `_\] **instance** `GetField `_ \"outputs\" `Transfer `_ \[`TransferOutput `_\] **instance** `GetField `_ \"provider\" `Transfer `_ `Party `_ **instance** `GetField `_ \"sender\" `Transfer `_ `Party `_ **instance** `GetField `_ \"transfer\" `AmuletRules_Transfer `_ `Transfer `_ **instance** `SetField `_ \"inputs\" `Transfer `_ \[`TransferInput `_\] **instance** `SetField `_ \"outputs\" `Transfer `_ \[`TransferOutput `_\] **instance** `SetField `_ \"provider\" `Transfer `_ `Party `_ **instance** `SetField `_ \"sender\" `Transfer `_ `Party `_ **instance** `SetField `_ \"transfer\" `AmuletRules_Transfer `_ `Transfer `_ .. _type-splice-amuletrules-transfercontext-68991: **data** `TransferContext `_ Contracts that need to be passed in to a Transfer so that we can reference them by contract id instead of by key\. .. _constr-splice-amuletrules-transfercontext-56806: `TransferContext `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - openMiningRound - `ContractId `_ :ref:`OpenMiningRound ` - * - issuingMiningRounds - `Map `_ :ref:`Round ` (`ContractId `_ :ref:`IssuingMiningRound `) - * - validatorRights - `Map `_ `Party `_ (`ContractId `_ :ref:`ValidatorRight `) - Map from user to ValidatorRight contract\. * - featuredAppRight - `Optional `_ (`ContractId `_ :ref:`FeaturedAppRight `) - Optional proof that the provider is a featured app provider\. **instance** `Eq `_ `TransferContext `_ **instance** `Show `_ `TransferContext `_ **instance** `GetField `_ \"context\" `AmuletRules_BuyMemberTraffic `_ `TransferContext `_ **instance** `GetField `_ \"context\" `AmuletRules_ComputeFees `_ `TransferContext `_ **instance** `GetField `_ \"context\" `AmuletRules_Transfer `_ `TransferContext `_ **instance** `GetField `_ \"context\" `PaymentTransferContext `_ `TransferContext `_ **instance** `GetField `_ \"featuredAppRight\" `TransferContext `_ (`Optional `_ (`ContractId `_ :ref:`FeaturedAppRight `)) **instance** `GetField `_ \"issuingMiningRounds\" `TransferContext `_ (`Map `_ :ref:`Round ` (`ContractId `_ :ref:`IssuingMiningRound `)) **instance** `GetField `_ \"openMiningRound\" `TransferContext `_ (`ContractId `_ :ref:`OpenMiningRound `) **instance** `GetField `_ \"validatorRights\" `TransferContext `_ (`Map `_ `Party `_ (`ContractId `_ :ref:`ValidatorRight `)) **instance** `SetField `_ \"context\" `AmuletRules_BuyMemberTraffic `_ `TransferContext `_ **instance** `SetField `_ \"context\" `AmuletRules_ComputeFees `_ `TransferContext `_ **instance** `SetField `_ \"context\" `AmuletRules_Transfer `_ `TransferContext `_ **instance** `SetField `_ \"context\" `PaymentTransferContext `_ `TransferContext `_ **instance** `SetField `_ \"featuredAppRight\" `TransferContext `_ (`Optional `_ (`ContractId `_ :ref:`FeaturedAppRight `)) **instance** `SetField `_ \"issuingMiningRounds\" `TransferContext `_ (`Map `_ :ref:`Round ` (`ContractId `_ :ref:`IssuingMiningRound `)) **instance** `SetField `_ \"openMiningRound\" `TransferContext `_ (`ContractId `_ :ref:`OpenMiningRound `) **instance** `SetField `_ \"validatorRights\" `TransferContext `_ (`Map `_ `Party `_ (`ContractId `_ :ref:`ValidatorRight `)) .. _type-splice-amuletrules-transfercontextsummary-99392: **data** `TransferContextSummary `_ .. _constr-splice-amuletrules-transfercontextsummary-98359: `TransferContextSummary `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - featuredAppProvider - `Optional `_ `Party `_ - * - config - :ref:`TransferConfig ` :ref:`Amulet ` - * - openRound - :ref:`OpenMiningRound ` - * - issuingMiningRounds - `Map `_ :ref:`Round ` :ref:`IssuingMiningRound ` - * - validatorRights - `Map `_ `Party `_ (`ContractId `_ :ref:`ValidatorRight `) - **instance** `Eq `_ `TransferContextSummary `_ **instance** `Show `_ `TransferContextSummary `_ **instance** `GetField `_ \"config\" `TransferContextSummary `_ (:ref:`TransferConfig ` :ref:`Amulet `) **instance** `GetField `_ \"featuredAppProvider\" `TransferContextSummary `_ (`Optional `_ `Party `_) **instance** `GetField `_ \"issuingMiningRounds\" `TransferContextSummary `_ (`Map `_ :ref:`Round ` :ref:`IssuingMiningRound `) **instance** `GetField `_ \"openRound\" `TransferContextSummary `_ :ref:`OpenMiningRound ` **instance** `GetField `_ \"validatorRights\" `TransferContextSummary `_ (`Map `_ `Party `_ (`ContractId `_ :ref:`ValidatorRight `)) **instance** `SetField `_ \"config\" `TransferContextSummary `_ (:ref:`TransferConfig ` :ref:`Amulet `) **instance** `SetField `_ \"featuredAppProvider\" `TransferContextSummary `_ (`Optional `_ `Party `_) **instance** `SetField `_ \"issuingMiningRounds\" `TransferContextSummary `_ (`Map `_ :ref:`Round ` :ref:`IssuingMiningRound `) **instance** `SetField `_ \"openRound\" `TransferContextSummary `_ :ref:`OpenMiningRound ` **instance** `SetField `_ \"validatorRights\" `TransferContextSummary `_ (`Map `_ `Party `_ (`ContractId `_ :ref:`ValidatorRight `)) .. _type-splice-amuletrules-transferinput-61796: **data** `TransferInput `_ An individual input for a batch transfer\. .. _constr-splice-amuletrules-inputapprewardcoupon-60885: `InputAppRewardCoupon `_ (`ContractId `_ :ref:`AppRewardCoupon `) .. _constr-splice-amuletrules-inputvalidatorrewardcoupon-18692: `InputValidatorRewardCoupon `_ (`ContractId `_ :ref:`ValidatorRewardCoupon `) .. _constr-splice-amuletrules-inputsvrewardcoupon-94444: `InputSvRewardCoupon `_ (`ContractId `_ :ref:`SvRewardCoupon `) .. _constr-splice-amuletrules-inputamulet-35826: `InputAmulet `_ (`ContractId `_ :ref:`Amulet `) .. _constr-splice-amuletrules-exttransferinput-5819: `ExtTransferInput `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - dummyUnitField - () - Extension constructor (and field) to work around the current lack of upgrading for variants in Daml 3\.0 * - optInputValidatorFaucetCoupon - `Optional `_ (`ContractId `_ :ref:`ValidatorFaucetCoupon `) - Added in CIP\-3\. Optional validator faucet coupon input into this transfer\. .. _constr-splice-amuletrules-inputvalidatorlivenessactivityrecord-59154: `InputValidatorLivenessActivityRecord `_ (`ContractId `_ :ref:`ValidatorLivenessActivityRecord `) **instance** `Eq `_ `TransferInput `_ **instance** `Ord `_ `TransferInput `_ **instance** `Show `_ `TransferInput `_ **instance** `GetField `_ \"dummyUnitField\" `TransferInput `_ () **instance** `GetField `_ \"inputs\" `AmuletRules_BuyMemberTraffic `_ \[`TransferInput `_\] **instance** `GetField `_ \"inputs\" `AmuletRules_CreateExternalPartySetupProposal `_ \[`TransferInput `_\] **instance** `GetField `_ \"inputs\" `AmuletRules_CreateTransferPreapproval `_ \[`TransferInput `_\] **instance** `GetField `_ \"inputs\" `Transfer `_ \[`TransferInput `_\] **instance** `GetField `_ \"inputs\" `TransferPreapproval_Renew `_ \[`TransferInput `_\] **instance** `GetField `_ \"inputs\" `TransferPreapproval_Send `_ \[`TransferInput `_\] **instance** `GetField `_ \"inputs\" :ref:`TransferCommand_Send ` \[`TransferInput `_\] **instance** `GetField `_ \"optInputValidatorFaucetCoupon\" `TransferInput `_ (`Optional `_ (`ContractId `_ :ref:`ValidatorFaucetCoupon `)) **instance** `SetField `_ \"dummyUnitField\" `TransferInput `_ () **instance** `SetField `_ \"inputs\" `AmuletRules_BuyMemberTraffic `_ \[`TransferInput `_\] **instance** `SetField `_ \"inputs\" `AmuletRules_CreateExternalPartySetupProposal `_ \[`TransferInput `_\] **instance** `SetField `_ \"inputs\" `AmuletRules_CreateTransferPreapproval `_ \[`TransferInput `_\] **instance** `SetField `_ \"inputs\" `Transfer `_ \[`TransferInput `_\] **instance** `SetField `_ \"inputs\" `TransferPreapproval_Renew `_ \[`TransferInput `_\] **instance** `SetField `_ \"inputs\" `TransferPreapproval_Send `_ \[`TransferInput `_\] **instance** `SetField `_ \"inputs\" :ref:`TransferCommand_Send ` \[`TransferInput `_\] **instance** `SetField `_ \"optInputValidatorFaucetCoupon\" `TransferInput `_ (`Optional `_ (`ContractId `_ :ref:`ValidatorFaucetCoupon `)) .. _type-splice-amuletrules-transferinputssummary-46693: **data** `TransferInputsSummary `_ .. _constr-splice-amuletrules-transferinputssummary-65268: `TransferInputsSummary `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - totalAmuletAmount - `Decimal `_ - * - totalAppRewardAmount - `Decimal `_ - * - totalValidatorRewardAmount - `Decimal `_ - * - totalValidatorFaucetAmount - `Decimal `_ - Note that the validator faucet amount does not need to be optional in this type, as it is not stored on the ledger\. * - totalSvRewardAmount - `Decimal `_ - * - totalHoldingFees - `Decimal `_ - * - amountArchivedAsOfRoundZero - `Decimal `_ - * - changeToHoldingFeesRate - `Decimal `_ - **instance** `Eq `_ `TransferInputsSummary `_ **instance** `Show `_ `TransferInputsSummary `_ **instance** `GetField `_ \"amountArchivedAsOfRoundZero\" `TransferInputsSummary `_ `Decimal `_ **instance** `GetField `_ \"changeToHoldingFeesRate\" `TransferInputsSummary `_ `Decimal `_ **instance** `GetField `_ \"totalAmuletAmount\" `TransferInputsSummary `_ `Decimal `_ **instance** `GetField `_ \"totalAppRewardAmount\" `TransferInputsSummary `_ `Decimal `_ **instance** `GetField `_ \"totalHoldingFees\" `TransferInputsSummary `_ `Decimal `_ **instance** `GetField `_ \"totalSvRewardAmount\" `TransferInputsSummary `_ `Decimal `_ **instance** `GetField `_ \"totalValidatorFaucetAmount\" `TransferInputsSummary `_ `Decimal `_ **instance** `GetField `_ \"totalValidatorRewardAmount\" `TransferInputsSummary `_ `Decimal `_ **instance** `SetField `_ \"amountArchivedAsOfRoundZero\" `TransferInputsSummary `_ `Decimal `_ **instance** `SetField `_ \"changeToHoldingFeesRate\" `TransferInputsSummary `_ `Decimal `_ **instance** `SetField `_ \"totalAmuletAmount\" `TransferInputsSummary `_ `Decimal `_ **instance** `SetField `_ \"totalAppRewardAmount\" `TransferInputsSummary `_ `Decimal `_ **instance** `SetField `_ \"totalHoldingFees\" `TransferInputsSummary `_ `Decimal `_ **instance** `SetField `_ \"totalSvRewardAmount\" `TransferInputsSummary `_ `Decimal `_ **instance** `SetField `_ \"totalValidatorFaucetAmount\" `TransferInputsSummary `_ `Decimal `_ **instance** `SetField `_ \"totalValidatorRewardAmount\" `TransferInputsSummary `_ `Decimal `_ .. _type-splice-amuletrules-transferoutput-70512: **data** `TransferOutput `_ An individual output for a batch transfer\. .. _constr-splice-amuletrules-transferoutput-68311: `TransferOutput `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - receiver - `Party `_ - The receiver who will own the created output amulet\. * - receiverFeeRatio - `Decimal `_ - The ratio of the output fee paid from receiver's output amount\. 1\.0 means the whole fee is deducted from the specified output amount, 0\.0 the whole fee is deducted from the sender's input balance\. If a receiver's fee is not covered by the specified output amount, the transfer is aborted\. * - amount - `Decimal `_ - The amount of amulet to receive, before deducting the receiver's part of the output fee\. * - lock - `Optional `_ :ref:`TimeLock ` - The lock to be added, if any\. **instance** `Eq `_ `TransferOutput `_ **instance** `Ord `_ `TransferOutput `_ **instance** `Show `_ `TransferOutput `_ **instance** `GetField `_ \"amount\" `TransferOutput `_ `Decimal `_ **instance** `GetField `_ \"lock\" `TransferOutput `_ (`Optional `_ :ref:`TimeLock `) **instance** `GetField `_ \"outputs\" `AmuletRules_ComputeFees `_ \[`TransferOutput `_\] **instance** `GetField `_ \"outputs\" `Transfer `_ \[`TransferOutput `_\] **instance** `GetField `_ \"receiver\" `TransferOutput `_ `Party `_ **instance** `GetField `_ \"receiverFeeRatio\" `TransferOutput `_ `Decimal `_ **instance** `SetField `_ \"amount\" `TransferOutput `_ `Decimal `_ **instance** `SetField `_ \"lock\" `TransferOutput `_ (`Optional `_ :ref:`TimeLock `) **instance** `SetField `_ \"outputs\" `AmuletRules_ComputeFees `_ \[`TransferOutput `_\] **instance** `SetField `_ \"outputs\" `Transfer `_ \[`TransferOutput `_\] **instance** `SetField `_ \"receiver\" `TransferOutput `_ `Party `_ **instance** `SetField `_ \"receiverFeeRatio\" `TransferOutput `_ `Decimal `_ .. _type-splice-amuletrules-transferoutputssummary-22405: **type** `TransferOutputsSummary `_ \= \[`PreprocessedTransferOutput `_\] .. _type-splice-amuletrules-transferpreapprovalcancelresult-51361: **data** `TransferPreapproval_CancelResult `_ .. _constr-splice-amuletrules-transferpreapprovalcancelresult-83086: `TransferPreapproval_CancelResult `_ **instance** `Eq `_ `TransferPreapproval_CancelResult `_ **instance** `Show `_ `TransferPreapproval_CancelResult `_ **instance** `HasExercise `_ `TransferPreapproval `_ `TransferPreapproval_Cancel `_ `TransferPreapproval_CancelResult `_ **instance** `HasFromAnyChoice `_ `TransferPreapproval `_ `TransferPreapproval_Cancel `_ `TransferPreapproval_CancelResult `_ **instance** `HasToAnyChoice `_ `TransferPreapproval `_ `TransferPreapproval_Cancel `_ `TransferPreapproval_CancelResult `_ .. _type-splice-amuletrules-transferpreapprovalexpireresult-89274: **data** `TransferPreapproval_ExpireResult `_ .. _constr-splice-amuletrules-transferpreapprovalexpireresult-36569: `TransferPreapproval_ExpireResult `_ (no fields) **instance** `Eq `_ `TransferPreapproval_ExpireResult `_ **instance** `Show `_ `TransferPreapproval_ExpireResult `_ **instance** `HasExercise `_ `TransferPreapproval `_ `TransferPreapproval_Expire `_ `TransferPreapproval_ExpireResult `_ **instance** `HasFromAnyChoice `_ `TransferPreapproval `_ `TransferPreapproval_Expire `_ `TransferPreapproval_ExpireResult `_ **instance** `HasToAnyChoice `_ `TransferPreapproval `_ `TransferPreapproval_Expire `_ `TransferPreapproval_ExpireResult `_ .. _type-splice-amuletrules-transferpreapprovalrenewresult-23849: **data** `TransferPreapproval_RenewResult `_ .. _constr-splice-amuletrules-transferpreapprovalrenewresult-61232: `TransferPreapproval_RenewResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - transferPreapprovalCid - `ContractId `_ `TransferPreapproval `_ - * - transferResult - `TransferResult `_ - * - receiver - `Party `_ - * - provider - `Party `_ - * - amuletPaid - `Decimal `_ - **instance** `Eq `_ `TransferPreapproval_RenewResult `_ **instance** `Show `_ `TransferPreapproval_RenewResult `_ **instance** `GetField `_ \"amuletPaid\" `TransferPreapproval_RenewResult `_ `Decimal `_ **instance** `GetField `_ \"provider\" `TransferPreapproval_RenewResult `_ `Party `_ **instance** `GetField `_ \"receiver\" `TransferPreapproval_RenewResult `_ `Party `_ **instance** `GetField `_ \"transferPreapprovalCid\" `TransferPreapproval_RenewResult `_ (`ContractId `_ `TransferPreapproval `_) **instance** `GetField `_ \"transferResult\" `TransferPreapproval_RenewResult `_ `TransferResult `_ **instance** `SetField `_ \"amuletPaid\" `TransferPreapproval_RenewResult `_ `Decimal `_ **instance** `SetField `_ \"provider\" `TransferPreapproval_RenewResult `_ `Party `_ **instance** `SetField `_ \"receiver\" `TransferPreapproval_RenewResult `_ `Party `_ **instance** `SetField `_ \"transferPreapprovalCid\" `TransferPreapproval_RenewResult `_ (`ContractId `_ `TransferPreapproval `_) **instance** `SetField `_ \"transferResult\" `TransferPreapproval_RenewResult `_ `TransferResult `_ **instance** `HasExercise `_ `TransferPreapproval `_ `TransferPreapproval_Renew `_ `TransferPreapproval_RenewResult `_ **instance** `HasFromAnyChoice `_ `TransferPreapproval `_ `TransferPreapproval_Renew `_ `TransferPreapproval_RenewResult `_ **instance** `HasToAnyChoice `_ `TransferPreapproval `_ `TransferPreapproval_Renew `_ `TransferPreapproval_RenewResult `_ .. _type-splice-amuletrules-transferpreapprovalsendresult-68419: **data** `TransferPreapproval_SendResult `_ .. _constr-splice-amuletrules-transferpreapprovalsendresult-67472: `TransferPreapproval_SendResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - result - `TransferResult `_ - **instance** `Eq `_ `TransferPreapproval_SendResult `_ **instance** `Show `_ `TransferPreapproval_SendResult `_ **instance** `GetField `_ \"result\" `TransferPreapproval_SendResult `_ `TransferResult `_ **instance** `SetField `_ \"result\" `TransferPreapproval_SendResult `_ `TransferResult `_ **instance** `HasExercise `_ `TransferPreapproval `_ `TransferPreapproval_Send `_ `TransferPreapproval_SendResult `_ **instance** `HasFromAnyChoice `_ `TransferPreapproval `_ `TransferPreapproval_Send `_ `TransferPreapproval_SendResult `_ **instance** `HasToAnyChoice `_ `TransferPreapproval `_ `TransferPreapproval_Send `_ `TransferPreapproval_SendResult `_ .. _type-splice-amuletrules-transferresult-93164: **data** `TransferResult `_ .. _constr-splice-amuletrules-transferresult-68399: `TransferResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - round - :ref:`Round ` - Round for which this transfer was registered\. * - summary - `TransferSummary `_ - Summary of amount input and outputs, and fees paid\. * - createdAmulets - \[`CreatedAmulet `_\] - References to the created output amulets\. * - senderChangeAmulet - `Optional `_ (`ContractId `_ :ref:`Amulet `) - Optional reference to the amulet for the change returned to the sender\. Only created if there was some change to be returned after deducting the fee for returning change\. **instance** `Eq `_ `TransferResult `_ **instance** `Show `_ `TransferResult `_ **instance** `GetField `_ \"createdAmulets\" `TransferResult `_ \[`CreatedAmulet `_\] **instance** `GetField `_ \"result\" `TransferPreapproval_SendResult `_ `TransferResult `_ **instance** `GetField `_ \"result\" :ref:`TransferCommandResult ` `TransferResult `_ **instance** `GetField `_ \"round\" `TransferResult `_ :ref:`Round ` **instance** `GetField `_ \"senderChangeAmulet\" `TransferResult `_ (`Optional `_ (`ContractId `_ :ref:`Amulet `)) **instance** `GetField `_ \"summary\" `TransferResult `_ `TransferSummary `_ **instance** `GetField `_ \"transferResult\" `AmuletRules_CreateExternalPartySetupProposalResult `_ `TransferResult `_ **instance** `GetField `_ \"transferResult\" `AmuletRules_CreateTransferPreapprovalResult `_ `TransferResult `_ **instance** `GetField `_ \"transferResult\" `TransferPreapproval_RenewResult `_ `TransferResult `_ **instance** `SetField `_ \"createdAmulets\" `TransferResult `_ \[`CreatedAmulet `_\] **instance** `SetField `_ \"result\" `TransferPreapproval_SendResult `_ `TransferResult `_ **instance** `SetField `_ \"result\" :ref:`TransferCommandResult ` `TransferResult `_ **instance** `SetField `_ \"round\" `TransferResult `_ :ref:`Round ` **instance** `SetField `_ \"senderChangeAmulet\" `TransferResult `_ (`Optional `_ (`ContractId `_ :ref:`Amulet `)) **instance** `SetField `_ \"summary\" `TransferResult `_ `TransferSummary `_ **instance** `SetField `_ \"transferResult\" `AmuletRules_CreateExternalPartySetupProposalResult `_ `TransferResult `_ **instance** `SetField `_ \"transferResult\" `AmuletRules_CreateTransferPreapprovalResult `_ `TransferResult `_ **instance** `SetField `_ \"transferResult\" `TransferPreapproval_RenewResult `_ `TransferResult `_ **instance** `HasExercise `_ `AmuletRules `_ `AmuletRules_Transfer `_ `TransferResult `_ **instance** `HasFromAnyChoice `_ `AmuletRules `_ `AmuletRules_Transfer `_ `TransferResult `_ **instance** `HasToAnyChoice `_ `AmuletRules `_ `AmuletRules_Transfer `_ `TransferResult `_ .. _type-splice-amuletrules-transfersummary-17366: **data** `TransferSummary `_ Summary of input and output amounts and fees paid\. This summary is intended to be used together with the ``Transfer`` specification used to initiate the transfer when displaying a transaction summary\. Its fields are intended to provide shortcuts for key numbers that are complex to compute off\-ledger\. All amounts are denominated in Splice\. .. _constr-splice-amuletrules-transfersummary-72851: `TransferSummary `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - inputAppRewardAmount - `Decimal `_ - Total amount of app reward coupon issunace input into this transfer\. * - inputValidatorRewardAmount - `Decimal `_ - Total amount of validator rewards coupon issuance input into this transfer\. * - inputSvRewardAmount - `Decimal `_ - Total amount of SV reward coupon issuance input into this transfer\. * - inputAmuletAmount - `Decimal `_ - Total input amount of amulet input into this transfer, before deducting holding fees\. * - balanceChanges - `Map `_ `Party `_ `BalanceChange `_ - Balance changes per party * - holdingFees - `Decimal `_ - Holding fees paid by the sender on their input amulets\. * - outputFees - \[`Decimal `_\] - Fees paid for the individual output amulets in the order they were specified\. * - senderChangeFee - `Decimal `_ - Fee charged for returning change to the sender, which is the smaller of the left\-over balance after paying for all outputs or one amulet create fee\. In case the left\-over balance after paying for all outputs is smaller than a create fee, all of that balance is consumed by the fee for returning change, and no actual amulet is created for the sender, i\.e\., the ``senderChangeAmount`` is zero\. The transfer does though succeed\. For transfers that do not allow returning change to the sender, the left\-over balance after paying for all outputs must be zero, and thus the ``senderChangeFee`` must be zero as well\. * - senderChangeAmount - `Decimal `_ - The final amount of amulet returned to the sender after paying for all outputs and fees\. If it is zero, then no amulet is created for the sender\. * - amuletPrice - `Decimal `_ - The amulet price at the round this transfer was executed\. * - inputValidatorFaucetAmount - `Optional `_ `Decimal `_ - Added in CIP\-3\. Total amount of validator faucet coupon issuance input into this transfer\. **instance** `Eq `_ `TransferSummary `_ **instance** `Show `_ `TransferSummary `_ **instance** `GetField `_ \"amuletPrice\" `TransferSummary `_ `Decimal `_ **instance** `GetField `_ \"balanceChanges\" `TransferSummary `_ (`Map `_ `Party `_ `BalanceChange `_) **instance** `GetField `_ \"holdingFees\" `TransferSummary `_ `Decimal `_ **instance** `GetField `_ \"inputAmuletAmount\" `TransferSummary `_ `Decimal `_ **instance** `GetField `_ \"inputAppRewardAmount\" `TransferSummary `_ `Decimal `_ **instance** `GetField `_ \"inputSvRewardAmount\" `TransferSummary `_ `Decimal `_ **instance** `GetField `_ \"inputValidatorFaucetAmount\" `TransferSummary `_ (`Optional `_ `Decimal `_) **instance** `GetField `_ \"inputValidatorRewardAmount\" `TransferSummary `_ `Decimal `_ **instance** `GetField `_ \"outputFees\" `TransferSummary `_ \[`Decimal `_\] **instance** `GetField `_ \"senderChangeAmount\" `TransferSummary `_ `Decimal `_ **instance** `GetField `_ \"senderChangeFee\" `TransferSummary `_ `Decimal `_ **instance** `GetField `_ \"summary\" `AmuletRules_BuyMemberTrafficResult `_ `TransferSummary `_ **instance** `GetField `_ \"summary\" `TransferResult `_ `TransferSummary `_ **instance** `SetField `_ \"amuletPrice\" `TransferSummary `_ `Decimal `_ **instance** `SetField `_ \"balanceChanges\" `TransferSummary `_ (`Map `_ `Party `_ `BalanceChange `_) **instance** `SetField `_ \"holdingFees\" `TransferSummary `_ `Decimal `_ **instance** `SetField `_ \"inputAmuletAmount\" `TransferSummary `_ `Decimal `_ **instance** `SetField `_ \"inputAppRewardAmount\" `TransferSummary `_ `Decimal `_ **instance** `SetField `_ \"inputSvRewardAmount\" `TransferSummary `_ `Decimal `_ **instance** `SetField `_ \"inputValidatorFaucetAmount\" `TransferSummary `_ (`Optional `_ `Decimal `_) **instance** `SetField `_ \"inputValidatorRewardAmount\" `TransferSummary `_ `Decimal `_ **instance** `SetField `_ \"outputFees\" `TransferSummary `_ \[`Decimal `_\] **instance** `SetField `_ \"senderChangeAmount\" `TransferSummary `_ `Decimal `_ **instance** `SetField `_ \"senderChangeFee\" `TransferSummary `_ `Decimal `_ **instance** `SetField `_ \"summary\" `AmuletRules_BuyMemberTrafficResult `_ `TransferSummary `_ **instance** `SetField `_ \"summary\" `TransferResult `_ `TransferSummary `_ Functions --------- .. _function-splice-amuletrules-transfercontrollers-28233: `transferControllers `_ \: `Transfer `_ \-\> `Set `_ `Party `_ The controllers for a transfer\. .. _function-splice-amuletrules-scaleamuletconfig-83157: `scaleAmuletConfig `_ \: `Decimal `_ \-\> :ref:`AmuletConfig ` :ref:`USD ` \-\> :ref:`AmuletConfig ` :ref:`Amulet ` .. _function-splice-amuletrules-computefees-86753: `computeFees `_ \: `Party `_ \-\> `TransferContext `_ \-\> `Party `_ \-\> \[`TransferOutput `_\] \-\> `Update `_ \[`Decimal `_\] .. _function-splice-amuletrules-computeoutputfee-59788: `computeOutputFee `_ \: :ref:`TransferConfig ` :ref:`Amulet ` \-\> `Party `_ \-\> `TransferOutput `_ \-\> `Decimal `_ .. _function-splice-amuletrules-checktransferconstraints-43087: `checkTransferConstraints `_ \: `Transfer `_ \-\> `TransferSummary `_ \-\> :ref:`TransferConfig ` :ref:`Amulet ` \-\> `Either `_ `InvalidTransferReason `_ () .. _function-splice-amuletrules-executetransfer-52573: `executeTransfer `_ \: `RewardsIssuanceConfig `_ \-\> `TransferContext `_ \-\> `Party `_ \-\> `Transfer `_ \-\> `Update `_ `TransferResult `_ Execute a transfer\. .. _function-splice-amuletrules-summarizeandvalidatecontext-19960: `summarizeAndValidateContext `_ \: `TransferContext `_ \-\> `Party `_ \-\> `Transfer `_ \-\> `Update `_ `TransferContextSummary `_ .. _function-splice-amuletrules-getvalidatorright-23495: `getValidatorRight `_ \: `TransferContextSummary `_ \-\> `Party `_ \-\> `Update `_ (`ContractId `_ :ref:`ValidatorRight `) .. _function-splice-amuletrules-getissuingmininground-54647: `getIssuingMiningRound `_ \: `TransferContextSummary `_ \-\> :ref:`Round ` \-\> `Update `_ :ref:`IssuingMiningRound ` .. _function-splice-amuletrules-summarizeandconsumeinputs-14652: `summarizeAndConsumeInputs `_ \: `TransferContextSummary `_ \-\> `Party `_ \-\> `Party `_ \-\> \[`TransferInput `_\] \-\> `Update `_ `TransferInputsSummary `_ .. _function-splice-amuletrules-dedupoutputlockholders-88329: `dedupOutputLockHolders `_ \: `TransferOutput `_ \-\> `TransferOutput `_ Deduplicate lock\-holders to store them and charge for them at most once .. _function-splice-amuletrules-preprocessoutputs-54475: `preprocessOutputs `_ \: :ref:`TransferConfig ` :ref:`Amulet ` \-\> `Party `_ \-\> \[`TransferOutput `_\] \-\> `Update `_ `TransferOutputsSummary `_ .. _function-splice-amuletrules-summarizetransfer-82621: `summarizeTransfer `_ \: `Party `_ \-\> :ref:`OpenMiningRound ` \-\> :ref:`TransferConfig ` :ref:`Amulet ` \-\> `TransferInputsSummary `_ \-\> `TransferOutputsSummary `_ \-\> `Update `_ `TransferSummary `_ .. _function-splice-amuletrules-issuerewards-17863: `issueRewards `_ \: `RewardsIssuanceConfig `_ \-\> `TransferContextSummary `_ \-\> `Party `_ \-\> `Party `_ \-\> `TransferSummary `_ \-\> `Update `_ () .. _function-splice-amuletrules-createtransferoutputs-14910: `createTransferOutputs `_ \: :ref:`OpenMiningRound ` \-\> :ref:`TransferConfig ` :ref:`Amulet ` \-\> `Party `_ \-\> `Party `_ \-\> `TransferSummary `_ \-\> `TransferOutputsSummary `_ \-\> `Update `_ (\[`CreatedAmulet `_\], `Optional `_ (`ContractId `_ :ref:`Amulet `)) .. _function-splice-amuletrules-scalefees-202: `scaleFees `_ \: `Decimal `_ \-\> :ref:`TransferConfig ` :ref:`USD ` \-\> :ref:`TransferConfig ` :ref:`Amulet ` Scale the 'AmuletConfig' such that the fees charged are scaled by the same scale factor\. .. _function-splice-amuletrules-transferconfigamuletfromopenround-39144: `transferConfigAmuletFromOpenRound `_ \: :ref:`OpenMiningRound ` \-\> :ref:`TransferConfig ` :ref:`Amulet ` .. _function-splice-amuletrules-validatebuymembertrafficinputs-62954: `validateBuyMemberTrafficInputs `_ \: :ref:`AmuletConfig ` :ref:`USD ` \-\> `Text `_ \-\> `Int `_ \-\> `Either `_ `InvalidTransferReason `_ () .. _function-splice-amuletrules-computesynchronizerfees-53837: `computeSynchronizerFees `_ \: `Party `_ \-\> `Int `_ \-\> `AmuletRules `_ \-\> `TransferContext `_ \-\> `Update `_ (`Decimal `_, `Decimal `_) Computing synchronizer fees .. _function-splice-amuletrules-exerciseapptransfer-15159: `exerciseAppTransfer `_ \: `AppTransferContext `_ \-\> `Transfer `_ \-\> `Update `_ `TransferResult `_ .. _function-splice-amuletrules-exercisepaymenttransfer-78288: `exercisePaymentTransfer `_ \: `PaymentTransferContext `_ \-\> `Transfer `_ \-\> `Update `_ `TransferResult `_ .. _function-splice-amuletrules-exercisecomputefees-35831: `exerciseComputeFees `_ \: `PaymentTransferContext `_ \-\> `Party `_ \-\> \[`TransferOutput `_\] \-\> `Update `_ \[`Decimal `_\] .. _function-splice-amuletrules-amulettransfercontext-70307: `amuletTransferContext `_ \: `ContractId `_ :ref:`OpenMiningRound ` \-\> `Optional `_ (`ContractId `_ :ref:`FeaturedAppRight `) \-\> `TransferContext `_ Helper to construct transfer context with only amulet inputs .. _function-splice-amuletrules-mkinputvalidatorfaucetcoupon-66284: `mkInputValidatorFaucetCoupon `_ \: `ContractId `_ :ref:`ValidatorFaucetCoupon ` \-\> `TransferInput `_ Smart constructor for inputing validator faucet coupons into a transfer\. .. _function-splice-amuletrules-computetransferpreapprovalfee-40643: `computeTransferPreapprovalFee `_ \: `RelTime `_ \-\> :ref:`AmuletConfig ` :ref:`USD ` \-\> `TransferContext `_ \-\> `Party `_ \-\> `Update `_ (`Decimal `_, `Decimal `_) .. _function-splice-amuletrules-splitandburn-28460: `splitAndBurn `_ \: `Party `_ \-\> `Decimal `_ \-\> \[`TransferInput `_\] \-\> `TransferContext `_ \-\> `Party `_ \-\> `Update `_ `TransferResult `_