Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add warning about using divulged contracts in pruning doc #9883

Merged
merged 3 commits into from
Jun 3, 2021
Merged

Add warning about using divulged contracts in pruning doc #9883

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1e9f178
Add warning about using divulged contracts in pruning doc
gerolf-da Jun 2, 2021
97cbee4
Update docs/source/ops/index.rst
gerolf-da Jun 2, 2021
a1ae1ad
Update docs/source/ops/index.rst
gerolf-da Jun 2, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/source/ops/index.rst
View file
Open in desktop
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