.. _module-splice-decentralizedsynchronizer-23863: Splice.DecentralizedSynchronizer ================================ Types and contracts for managing synchronizer fees Templates --------- .. _type-splice-decentralizedsynchronizer-membertraffic-74049: **template** `MemberTraffic `_ The state of the extra synchronizer traffic purchases of a sequencer sv\. Signatory\: dso .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - dso - `Party `_ - * - memberId - `Text `_ - The id of the sequencer member (participant or mediator) for which traffic has been purchased * - synchronizerId - `Text `_ - The id of the synchronizer for which this contract tracks purchased extra traffic * - migrationId - `Int `_ - The migration id of the synchronizer for which this contract tracks purchased extra traffic * - totalPurchased - `Int `_ - The number of bytes of extra traffic purchased * - numPurchases - `Int `_ - Number of times extra traffic has been purchased * - amuletSpent - `Decimal `_ - Total Amulet spent on extra traffic * - usdSpent - `Decimal `_ - Total USD spent on extra traffic + **Choice** Archive Controller\: dso Returns\: () (no fields) Data Types ---------- .. _type-splice-decentralizedsynchronizer-amuletdecentralizedsynchronizerconfig-15126: **data** `AmuletDecentralizedSynchronizerConfig `_ The configuration of the logical concept of a decentralized synchronizer, which consists over its lifetime of a series of actual synchronizers, which are introduced for handling the (rare) occasions of switching to a new synchronizer protocol version\. .. _constr-splice-decentralizedsynchronizer-amuletdecentralizedsynchronizerconfig-80511: `AmuletDecentralizedSynchronizerConfig `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - requiredSynchronizers - `Set `_ `Text `_ - The synchronizer\-ids of all synchronizers that Amulet and ANS users should be connected to\. * - activeSynchronizer - `Text `_ - The synchronizer\-id of the synchronizer on which the SVs accepts transactions involving the AmuletRules and related contracts, which must be one of the ``requiredSynchronizers``\. * - fees - `SynchronizerFeesConfig `_ - The fees charged for using the decentralized synchronizer\. We use the same fees across all active decentralized synchronizers\. **instance** `Eq `_ `AmuletDecentralizedSynchronizerConfig `_ **instance** `Show `_ `AmuletDecentralizedSynchronizerConfig `_ **instance** `GetField `_ \"activeSynchronizer\" `AmuletDecentralizedSynchronizerConfig `_ `Text `_ **instance** `GetField `_ \"decentralizedSynchronizer\" (:ref:`AmuletConfig ` unit) `AmuletDecentralizedSynchronizerConfig `_ **instance** `GetField `_ \"fees\" `AmuletDecentralizedSynchronizerConfig `_ `SynchronizerFeesConfig `_ **instance** `GetField `_ \"requiredSynchronizers\" `AmuletDecentralizedSynchronizerConfig `_ (`Set `_ `Text `_) **instance** `SetField `_ \"activeSynchronizer\" `AmuletDecentralizedSynchronizerConfig `_ `Text `_ **instance** `SetField `_ \"decentralizedSynchronizer\" (:ref:`AmuletConfig ` unit) `AmuletDecentralizedSynchronizerConfig `_ **instance** `SetField `_ \"fees\" `AmuletDecentralizedSynchronizerConfig `_ `SynchronizerFeesConfig `_ **instance** `SetField `_ \"requiredSynchronizers\" `AmuletDecentralizedSynchronizerConfig `_ (`Set `_ `Text `_) .. _type-splice-decentralizedsynchronizer-baseratetrafficlimits-64372: **data** `BaseRateTrafficLimits `_ The limits defining the free base rate delivered by the synchronizer\. It defines the base rate as allowing at most burstAmount of sequencing traffic within a window of burstWindow seconds\. .. _constr-splice-decentralizedsynchronizer-baseratetrafficlimits-1937: `BaseRateTrafficLimits `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - burstAmount - `Int `_ - The total burstAmount in bytes of sequencing traffic delivered over the burstWindow * - burstWindow - `RelTime `_ - Time window within which the burstAmount must not be exceeded **instance** `Eq `_ `BaseRateTrafficLimits `_ **instance** `Show `_ `BaseRateTrafficLimits `_ **instance** `GetField `_ \"baseRateTrafficLimits\" `SynchronizerFeesConfig `_ `BaseRateTrafficLimits `_ **instance** `GetField `_ \"burstAmount\" `BaseRateTrafficLimits `_ `Int `_ **instance** `GetField `_ \"burstWindow\" `BaseRateTrafficLimits `_ `RelTime `_ **instance** `SetField `_ \"baseRateTrafficLimits\" `SynchronizerFeesConfig `_ `BaseRateTrafficLimits `_ **instance** `SetField `_ \"burstAmount\" `BaseRateTrafficLimits `_ `Int `_ **instance** `SetField `_ \"burstWindow\" `BaseRateTrafficLimits `_ `RelTime `_ .. _type-splice-decentralizedsynchronizer-formembertraffic-62879: **data** `ForMemberTraffic `_ .. _constr-splice-decentralizedsynchronizer-formembertraffic-24640: `ForMemberTraffic `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - dso - `Party `_ - * - memberId - `Text `_ - * - synchronizerId - `Text `_ - * - migrationId - `Int `_ - **instance** `Eq `_ `ForMemberTraffic `_ **instance** `Show `_ `ForMemberTraffic `_ **instance** `GetField `_ \"dso\" `ForMemberTraffic `_ `Party `_ **instance** `GetField `_ \"memberId\" `ForMemberTraffic `_ `Text `_ **instance** `GetField `_ \"migrationId\" `ForMemberTraffic `_ `Int `_ **instance** `GetField `_ \"synchronizerId\" `ForMemberTraffic `_ `Text `_ **instance** `SetField `_ \"dso\" `ForMemberTraffic `_ `Party `_ **instance** `SetField `_ \"memberId\" `ForMemberTraffic `_ `Text `_ **instance** `SetField `_ \"migrationId\" `ForMemberTraffic `_ `Int `_ **instance** `SetField `_ \"synchronizerId\" `ForMemberTraffic `_ `Text `_ **instance** HasCheckedFetch `MemberTraffic `_ `ForMemberTraffic `_ .. _type-splice-decentralizedsynchronizer-synchronizerfeesconfig-12142: **data** `SynchronizerFeesConfig `_ Synchronizer fees related configuration to be tracked on the DsoRules contract .. _constr-splice-decentralizedsynchronizer-synchronizerfeesconfig-16293: `SynchronizerFeesConfig `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - baseRateTrafficLimits - `BaseRateTrafficLimits `_ - Configuration limits for base rate traffic * - extraTrafficPrice - `Decimal `_ - The price of extra traffic denominated in $/MB * - readVsWriteScalingFactor - `Int `_ - How much the sending of a message to its recipient costs in terms of bytes written to the synchronizer\. This factor is specified in parts per 10,000 (or per 10 mille) We charge for sending messages depending on the number of recipients, as delivering the message incurs a cost as well, albeit usually a much smaller one than the cost of a write\. * - minTopupAmount - `Int `_ - The minimum amount of extra traffic (in bytes) that must be bought when buying extra traffic\. This ensures that the SVs can amortize the cost of executing that transaction\. **instance** `Eq `_ `SynchronizerFeesConfig `_ **instance** `Show `_ `SynchronizerFeesConfig `_ **instance** `GetField `_ \"baseRateTrafficLimits\" `SynchronizerFeesConfig `_ `BaseRateTrafficLimits `_ **instance** `GetField `_ \"extraTrafficPrice\" `SynchronizerFeesConfig `_ `Decimal `_ **instance** `GetField `_ \"fees\" `AmuletDecentralizedSynchronizerConfig `_ `SynchronizerFeesConfig `_ **instance** `GetField `_ \"minTopupAmount\" `SynchronizerFeesConfig `_ `Int `_ **instance** `GetField `_ \"readVsWriteScalingFactor\" `SynchronizerFeesConfig `_ `Int `_ **instance** `SetField `_ \"baseRateTrafficLimits\" `SynchronizerFeesConfig `_ `BaseRateTrafficLimits `_ **instance** `SetField `_ \"extraTrafficPrice\" `SynchronizerFeesConfig `_ `Decimal `_ **instance** `SetField `_ \"fees\" `AmuletDecentralizedSynchronizerConfig `_ `SynchronizerFeesConfig `_ **instance** `SetField `_ \"minTopupAmount\" `SynchronizerFeesConfig `_ `Int `_ **instance** `SetField `_ \"readVsWriteScalingFactor\" `SynchronizerFeesConfig `_ `Int `_ Functions --------- .. _function-splice-decentralizedsynchronizer-validamuletdecentralizedsynchronizerconfig-57759: `validAmuletDecentralizedSynchronizerConfig `_ \: `AmuletDecentralizedSynchronizerConfig `_ \-\> `Bool `_ .. _function-splice-decentralizedsynchronizer-initialmembertraffic-49736: `initialMemberTraffic `_ \: `Party `_ \-\> `Text `_ \-\> `Text `_ \-\> `Int `_ \-\> `MemberTraffic `_