Skip to content

Commit

Permalink
Add warning about using divulged contracts in pruning doc (#9883)
Browse files Browse the repository at this point in the history
[docs] Add warning about using divulged contracts to the pruning doc

CHANGELOG_BEGIN
[ledger api] Add warning about incompatibility between pruning and
divulged contracts to pruning docs.
CHANGELOG_END
  • Loading branch information
gerolf-da authored Jun 3, 2021
1 parent 3dee3d0 commit 2da94c3
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/source/ops/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,11 @@ Still, Daml applications may be affected in the following ways:
- Command deduplication and command tracker retention should always configured in such a way, that the associated windows don't overlap with the pruning window, so that their operation is unaffected by pruning.
- Pruning may affect the behavior of Ledger API calls that allow to read data from the ledger: see the next sub-section for more information about API impacts.

.. warning::
Participants may know of contracts for which they don't know the current activeness status. This happens through :ref:`divulgence <da-model-divulgence>` where a party learns of the existence of a contract without being guaranteed to ever see its archival. Such contracts are pruned by the feature described on this page as not doing so could easily lead to an ever growing participant state.

During command submission, parties can currently resolve the contract ids of divulged contracts. This is mutually incompatible with the pruning behaviour described above. Daml code that may end up running on pruned participants should therefore never rely on that behaviour.

How the Daml Ledger API is affected
-----------------------------------

Expand Down

0 comments on commit 2da94c3

Please sign in to comment.