Commit Graph

50 Commits

Author SHA1 Message Date
Gerolf Seitz
cc7af93afc
[docs] Remove link to the #daml-contributors (#9928)
CHANGELOG_BEGIN
CHANGELOG_END
2021-06-10 22:16:39 +02:00
Sofia Faro
2d49939360
Fix the notion of transaction equivalence in the ledger model for exceptions. (#9850)
* Fix the notion of transaction equivalence in the ledger model for exceptions.

@andreaslochbihler-da found that our normalization rules don't normalize rollbacks across exercises, which our notion of transaction equivalence expects them to. For example, the transactions

```
rollback [ exercise [ rollback [ create ]]]
```

and

```
rollback [ exercise [ create ] ]
```

are considered equivalent under the old definition, but do not normalize to each other.

This PR is one possible solution, where we keep our current normalization rules but change the definition of transaction equivalence. In particular, instead of just requiring that the set of rolled back actions to be the same, we require that the set of "rollback roots" be the same, where a "rollback root" is an action that has a rollback node as its parent. This prevents normalization across exercises because that would eliminate some rollback roots.

The idea here is that the set of "rollback roots" encodes the set of "rolled back actions" relative to each action's subtree, unlike before where we only looked at the set of "rolled back actions" relative to the whole transaction. The set of "rollback roots" encodes all that information, but with a simple definition.

A completely different solution is to introduce new normalization rules that work across exercise nodes. Unfortunately these rules would be non-local, and that seems very difficult to do correctly & efficiently.

Part of #8020

changelog_begin
changelog_end

* rollback root -> rollback child
2021-06-01 16:14:53 +01:00
Sofia Faro
a0373c4855
Ledger model section on transaction normalization. (#9816)
* Ledger model section on transaction normalization.

changelog_begin
changelog_end

* update diagrams

* Review comments
2021-05-28 11:50:46 +00:00
Sofia Faro
3209188fcc
Add a ledger model page for exceptions. (#9396)
* Add a ledger model page for exceptions.

This page describes the changes to the ledger model as part of the exceptions feature. The changes should be kept separate for now, but once exceptions are stable and out for a while, they should probably be incorporated into the rest of the daml ledger model.

Part of #8020. **This PR is to be merged only when we start releasing exceptions.**

changelog_begin

- [docs] The Daml ledger model has been updated to describe the changes introduced by the new exceptions feature. See  here: https://docs.daml.com/concepts/ledger-model/ledger-exceptions.html

changelog_end

* Apply suggestions from code review

Co-authored-by: Ognjen Maric <ognjen.maric@digitalasset.com>

* Round 2

* Fix and simplify "after" relation!

* Easy fixes

* Diagrams for structure and integrity sections.

* Add missing diagrams :)

* clarify consistency section

* Authorization.

* Editing.

* fix label reference

Co-authored-by: Ognjen Maric <ognjen.maric@digitalasset.com>
2021-05-19 09:43:18 +00:00
Moritz Kiefer
0303017343
Delete "testing with scenarios" section (#9360)
This is superseded by
https://docs.daml.com/daml/intro/2_DamlScript.html which seems much
nicer and I don’t see what we gain by having both.

fixes #8839

changelog_begin
changelog_end
2021-04-08 14:50:33 +02:00
Andreas Lochbihler
00bffd2281
correct the causaility definition for non-stakeholder actors and choice observers (#8892)
CHANGELOG_BEGIN
aligned the formal causality guarantees for non-stakeholder actors and choice observers to the given examples
CHANGELOG_END
2021-02-19 10:16:07 +01:00
Shaul Kfir
94262e9f9a
Fix docs typo in local-ledger.rst (#8825)
CHANGELOG_BEGIN
CHANGELOG_END
2021-02-12 08:50:36 +01:00
Stefano Baghino
2dbeb7e27c
Fix typos in docs (#8761)
Originally reported in https://discuss.daml.com/t/my-feedback-on-daml-in-general-and-documentation-as-a-non-coder/2043

Standardise (sic) to US English spelling. ;-)

Typos

acessToken -> accessToken
assignement -> assignment
calulated -> calculated
certicates -> certificates
comitted -> committed
commited -> committed
conctract -> contract
corrseponding -> corresponding
couteroffer -> counteroffer
Decmial -> Decimal
desireable -> desirable (archaic)
Distpute -> Dispute
encoutered -> encountered
enviroment -> environment
Exercse -> Exercise
exeuction -> execution
familiarise -> familiarize (British spelling)
fistName -> firstName
follwing -> following
fullfil -> fulfill (fulfil would be British spelling)
intepretation -> interpretation
leger -> ledger
lookupBeyKey -> lookupByKey
Messsaging -> Messaging
mimick -> mimic
Modelling -> Modeling (British spelling)
occured -> occurred
Partipant -> Participant
partiuclarly -> particularly
possibiy -> possibly
PostreSQL -> PostgreSQL
preceed -> precede
preceeding -> preceding
preferrable -> preferable
programatically -> programmatically
prohibitied -> prohibited
readyness -> readiness
Readyness -> Readiness
resepond -> respond
similiar -> similar
snipppets -> snippets
somone -> someone
succintly -> succinctly
transacion -> transaction
transfering -> transferring
transferrable -> transferable

I was surprised by the last two.

I hope this commit message does not contain any typo.

changelog_begin
changelog_end
2021-02-04 19:44:15 +01:00
Sofia Faro
c1a736efd1
Add choice observers in the ledger model. (#8576)
* Add choice observers in the ledger model.

To keep the distinction between "observer" and "choice observer"
clear I'm trying to always refer to the former as "contract observer".

The section on divulgence should probably be reworked to favor choice
observers at some point, but I'm not sure how to do that.

changelog_begin
changelog_end

* s/observer/contract observer

* Separate out the choice observer case of informees

* apply suggestion from @oggy-

* specifying choice observers in DAML contract model
2021-01-20 13:16:45 +00:00
arne-da
b398a55780
Fixing typos in documentation (#8163)
CHANGELOG_BEGIN
Fixed minor typos in documentation
CHANGELOG_END
2021-01-12 13:11:12 +01:00
Ognjen Maric
7171cb38fa
Allow multiple requesters for a commit in the ledger model (#8471)
CHANGELOG_BEGIN
- Adjust the ledger model to account for multi-party submissions
CHANGELOG_END
2021-01-12 11:49:52 +00:00
Richard Kapolnai
592e794adf
Doc minor issues (#8451)
* fix typos in docs
CHANGELOG_BEGIN
CHANGELOG_END

* minor corrections

* revert a change

* update structure doc based on comments
2021-01-11 15:52:43 +01:00
Bernhard Elsner
cda93db944
Daml case and logo (#8433)
* Replace many occurrences of DAML with Daml

* Update docs logo

* A few more CLI occurrences

CHANGELOG_BEGIN
- Change DAML capitalization and docs logo
CHANGELOG_END

* Fix some over-eager replacements

* A few mor occurrences in md files

* Address comments in *.proto files

* Change case in comments and strings in .ts files

* Revert changes to frozen proto files

* Also revert LF 1.11

* Update get-daml.sh

* Update windows installer

* Include .py files

* Include comments in .daml files

* More instances in the assistant CLI

* some more help texts
2021-01-08 12:50:15 +00:00
Moritz Kiefer
df35aed5bb
Remove Navigator console (#8392)
* Remove Navigator console

This was a labs feature so we can remove it without a deprecation
cycle. It doesn’t have any known users and is almost completely
superseded by DAML REPL.

@bame-da agreed to the removal.

This also has the nice side effect of eliminating 1 of our 2
dependencies that were not Scala 2.13 compatible.

changelog_begin

- [Navigator Console] The labs feature Navigator Console has been
  removed. Users are encouraged to use DAML REPL instead.

changelog_end

* Kill Navigator database docs completely

changelog_begin
changelog_end
2021-01-05 13:20:48 +01:00
Gary Verhaegen
a925f0174c
update copyright notices for 2021 (#8257)
* update copyright notices for 2021

To be merged on 2021-01-01.

CHANGELOG_BEGIN
CHANGELOG_END

* patch-bazel-windows & da-ghc-lib
2021-01-01 19:49:51 +01:00
Richard Kapolnai
239f4df945
Link concepts "gRPC Ledger API" and "Ledger API" in glossary for #8029. (#8051)
* Link concepts "gRPC Ledger API" and "Ledger API" in glossary for #8029.
CHANGELOG_BEGIN
CHANGELOG_END

* remove gRPC Ledger API which was in the wrong place

* rephrase alternative names

Co-authored-by: Bernhard Elsner <40762178+bame-da@users.noreply.github.com>

Co-authored-by: Bernhard Elsner <40762178+bame-da@users.noreply.github.com>
2020-11-25 16:28:33 +01:00
Richard Kapolnai
f3caa5919d
rename "gRPC API" to "gRPC Ledger API" (#8046)
* rename "gRPC API" to "gRPC Ledger API"
an incremental step towards #8029
changelog_begin
changelog_end

* fix section underline
2020-11-24 16:34:07 +01:00
nickchapman-da
6a745ed1fa
Support choice observers in 1.dev (#7922)
* Adapt to new desugaring for choice observers.

update hash of ghc patch.

changelog_begin
changelog_end

update ghc patch to final version

update stack-snapshot hashes for ghc-lib(-parser)

update stackage_snapshot.json, following `bazel run @stackage-unpinned//:pin`

expose Optional constructors for desugared code to use

adapt LFConversion to expect a 4-tuple for a desugared choice def/sig

update LFConversion for choice-observers

first example using new choice observer syntax.

fix scala type checker to have correct scoping rules for choice-observers

remove comment from example which says it is broken

improve variable names

improve tests for choice-observer clause

only test choice-observers SINCE 1.dev

add jq queries for choice observeres

make positive statement in jq test which checks choice obserers are present

test behaviour of choice observers

squash me

typo

* test more choice-observer divulgence

* Update documention for choice observers.

changelog_begin
Support choice observers in 1.dev
changelog_end

* fix docs build

* fix daml docs choice-observers example

* address comments: rewording text

* annotate choices observers as early-access in documention

* split out documentation code-snippets which require --target=1.dev

* final tweaks to documentation text
2020-11-18 19:51:15 +00:00
Bernhard Elsner
df1dee2397
Replace occurrances of DAML SDK in the docs with appropriate new terms (#7739)
* Replace occurrances of DAML SDK in the docs with appropriate new terms

CHANGELOG_BEGIN
CHANGELOG_END

* Apply suggestions from code review

Revert two renamings.

* Fix broken internal link
2020-10-21 12:03:00 +00:00
Richard Kapolnai
40c1cd5893
Check closing quotes (#7528)
* Missing closing quote in docs
CHANGELOG_BEGIN
CHANGELOG_END

* add Bash script to check missing quotes in docs
CHANGELOG_BEGIN
CHANGELOG_END

* add whitelist

* fix comment

* add CI job
CHANGELOG_BEGIN
CHANGELOG_END

* add CI job to azure pipeline

* use devenv in azure-pipelines.yml

Co-authored-by: Gary Verhaegen <gary.verhaegen@digitalasset.com>

* remove unnecessary yml

* fix quotes in Bifunctor.daml

* add check to BUILD.bazel with extended whitelist

* refactor: call bash script from BUILD.bazel

* Revert "use devenv in azure-pipelines.yml"

This reverts commit 28ab2c70fb.

* Revert "add CI job to azure pipeline"

This reverts commit 0eaa5188fe.

* filter whitelist in output too

* Update docs/scripts/check-closing-quotes.sh.whitelist

Co-authored-by: Bernhard Elsner <40762178+bame-da@users.noreply.github.com>

* fix Bifunctor.daml quotes

* Update docs/scripts/check-closing-quotes.sh.whitelist

Co-authored-by: Bernhard Elsner <40762178+bame-da@users.noreply.github.com>

* use ~ instead of ` for section titles

* rename to allowlist

* revert Bifunctor quote changes back to 3 backticks

* fix filename

* Remove line breaks in quotes (#7550)

* remove line breaks in quotes
CHANGELOG_BEGIN
CHANGELOG_END

* remove line breaks in quotes
CHANGELOG_BEGIN
CHANGELOG_END

* README: avoid line breaks

* merge rename

* revert: use triple backticks in Bifunctor

Co-authored-by: Gary Verhaegen <gary.verhaegen@digitalasset.com>
Co-authored-by: Bernhard Elsner <40762178+bame-da@users.noreply.github.com>
2020-10-02 14:53:10 +02:00
Richard Kapolnai
70196083c3
Replace "contract instance" with "contract" in docs folder (#4873)
* Replace "contract instance" with "contract" in docs folder
CHANGELOG_BEGIN
CHANGELOG_END

* remove contract instance in docs/source/concepts/glossary.rst

* Remove contract instance explanation docs/source/concepts/glossary.rst

* Update docs/source/concepts/glossary.rst

* Replace contract-contract-instance label ref with contract

* Remove redundant naming
2020-10-02 13:55:56 +02:00
Martin Huschenbett
2236a949b6
Docs: Minor improvements to ledger structure (#7357)
CHANGELOG_BEGIN
CHANGELOG_END
2020-09-09 13:15:25 +02:00
Andreas Lochbihler
74986b9035
Causality and interoperability documentation (#6920)
CHANGELOG_BEGIN
Add documentation for the ordering guarantees on the Ledger API
and for causal consistency with interoperable ledgers
CHANGELOG_END

Co-authored-by: Ognjen Maric <ognjen.maric@digitalasset.com>
Co-authored-by: Bernhard Elsner <40762178+bame-da@users.noreply.github.com>
2020-08-17 16:15:55 +02:00
Leonid Rozenberg
2887c30c83
Stop prefacing templates, choices and controller with DAML. (#7110)
It seems redundant and breaks the reading flow.

CHANGELOG_BEGIN
CHANGELOG_END
2020-08-17 08:45:46 +02:00
Stefano Baghino
fefc72f2df
Fix references to authentication in the docs (#6858)
* Fix references to authentication in the docs

Fixes #6855

changelog_begin
changelog_end

* Fix broken links and missing references

* Address https://github.com/digital-asset/daml/pull/6858#discussion_r460675037

* Apply suggestions from code review

Co-authored-by: Gerolf Seitz <gerolf.seitz@daml.com>

* Removing useless anchors left over from previous pass

* Fix broken links

Co-authored-by: Gerolf Seitz <gerolf.seitz@daml.com>
2020-07-27 09:31:24 +00:00
Robert Autenrieth
1074736316
Add time model documentation (#6705)
* Update existing docs, removing references to old time model
* Add detailed time model docs
* Rename ledger effective time to ledger time

CHANGELOG_BEGIN
CHANGELOG_END
2020-07-17 17:54:26 +02:00
Gary Verhaegen
8176fb0c8d
fix the the typo (#6723)
```
s/the the /the /
```

CHANGELOG_BEGIN
CHANGELOG_END
2020-07-14 16:55:33 +00:00
Moritz Kiefer
77609c6189
Fix link to replicated committer topology (#6361)
Sphinx is hard

changelog_begin
changelog_end
2020-06-16 08:40:07 +00:00
Andreas Lochbihler
172e913520
fix definition of actors for fetch in ledger model (#5734)
CHANGELOG_BEGIN
CHANGELOG_END
2020-04-27 13:39:36 +02:00
Sofia Faro
ab93435442
Split standard library docs up one page per module. (#5636)
* One module per page in stdlib docs.

changelog_begin

- [DAML Docs] The standard library docs have been split up per module.

changelog_end

* Adjust stdlib annotations

* Update compiler/damlc/daml-stdlib-src/DA/Generics.daml

Co-Authored-By: Moritz Kiefer <moritz.kiefer@purelyfunctional.org>

* Update compiler/damlc/base-rst-index-template.rst

Co-Authored-By: Moritz Kiefer <moritz.kiefer@purelyfunctional.org>

* Move to daml/stdlib

* Update daml-doc tests

* Remove the Module prefix in the index/toctree

Co-authored-by: Moritz Kiefer <moritz.kiefer@purelyfunctional.org>
2020-04-22 13:23:46 +01:00
Zbigniew Czapran
dab1ae778f
Small fix in formatting to be consistent with other parts (#5504)
Create and Exercise keywords are usually emboldened in the docs.

CHANGELOG_BEGIN
CHANGELOG_END
2020-04-09 11:36:44 +02:00
Gerolf Seitz
a2d785e3ee
Use com.daml as root package (#5343)
Packages com.digitalasset.daml and com.daml have been unified under com.daml

Ledger API and DAML-LF DEV protos have also been moved from `com/digitalasset`
to `com/daml` on the file system.
Protos for already released DAML LF versions (1.6, 1.7, 1.8) stay in the
package `com.digitalasset`.

CHANGELOG_BEGIN
[SDK] All Java and Scala packages starting with
``com.digitalasset.daml`` and ``com.digitalasset`` are now consolidated
under ``com.daml``. Simply changing imports should be enough to
migrate your code.
CHANGELOG_END
2020-04-05 19:49:57 +02:00
Gary Verhaegen
1872c668a5
replace DAML Authors with DA in copyright headers (#5228)
Change requested by Manoj.

CHANGELOG_BEGIN
CHANGELOG_END
2020-03-27 01:26:10 +01:00
Bernhard Elsner
757e0e841b
Remove references to DA Ledgers, DA Platform and similar from docs (#4690)
* Remove references to DA Ledgers, DA Platform and similar from docs

* Some additional amendments

CHANGELOG_BEGIN
CHANGELOG_END
2020-03-13 13:02:11 +01:00
Robin Krom
0e046d9eca
docs: new recommend path architecture documentation (#4795)
CHANGELOG_BEGIN
CHANGELOG_END
2020-03-09 12:15:37 +01:00
Shayne Fletcher
66dd112960
Remove pragma 'daml 1.2' (#4702)
changelog_begin
- The pragma 'daml 1.2' is now optional.
changelog_end
2020-02-26 13:17:45 -05:00
Andrew J. Stone
cfd300c336
Fix doc inconsistency regarding party reference (#4337)
In the integrity concepts, a party is defined as `C`, but referenced
later as `A`. As the rest of the docs use `A` for the party and `C` for
the contract, this seems to be a mistake. This corrects that
inconsistency.

This commit also clarifies a sentence and fixes a typo.

CHANGELOG_BEGIN
CHANGELOG_END
2020-02-02 11:10:11 +01:00
anticlimactic
4978901f71 Fixed typo in glossary.rst (#4063)
CHANGELOG_BEGIN
CHANGELOG_END
2020-01-22 14:29:46 +01:00
Stefano Baghino
8edd16396d
Improvements to glossary (#4146)
CHANGELOG_BEGIN
[Documentation] Improved glossary
CHANGELOG_END
2020-01-21 17:18:02 +01:00
Gary Verhaegen
878429e3bf
update copyright notices to 2020 (#3939)
copyright update 2020

* update template
* run script: `dade-copyright-headers update .`
* update script
* manual adjustments
* exclude frozen proto files from further header checks (by adding NO_AUTO_COPYRIGHT files)
2020-01-02 21:21:13 +01:00
Robert Autenrieth
a827040e4c
Add authentication docs (#3661)
* Add authentication docs

* Use anonymous references

* Update obsolete info on authentication

* Improve authentication intro
2019-12-04 14:51:19 +01:00
Ognjen Maric
48174c8ee4
Fixed a stale reference to a MustPaint contract (#3613) 2019-11-25 16:29:32 +01:00
Miklos
a7ae9c5fba
Improve DAML SDK documentation (#3509)
Improved DAML SDK documentation, focusing on quickstart guide:
- Corrected typos.
- Corrected some broken links.
- Made sample code formatting consistent (variable naming, comments).

Co-Authored-By: Samir Talwar <samir.talwar@digitalasset.com>
2019-11-20 14:57:57 +01:00
Gerolf Seitz
5592092cc7
Remove DAML-on-X IndexServer and Reference Server (#3108)
It is not needed anymore and can therefore be deleted.
2019-10-08 11:47:21 +02:00
Ognjen Maric
c71237b4c1
Identity and package management (#2532)
* Identity and package management

* Apply suggestions from code review

Co-Authored-By: Bernhard Elsner <40762178+bame-da@users.noreply.github.com>

* Bernhard's comments

* Simon's comments

* Update license

* Oh noes - I broked teh linkz!
2019-08-19 19:09:29 +02:00
Gary Verhaegen
99ea93168d
update copyright notices (#2499) 2019-08-13 17:23:03 +01:00
Andreas Lochbihler
0dee127b03 document contract keys in the ledger model (#2144)
* document contract keys in the ledger model

* address small comments by Beth and Ognjen

* restructure key consistency and authorization

* address Ognjen's second round of comments

* Apply suggestions from code review

Co-Authored-By: Beth Aitman <bethaitman@users.noreply.github.com>
2019-07-19 11:57:28 +00:00
Beth Aitman
29299d55e9 Docs fixes based on Mopinion feedback (#1973)
* Remove old introduction page

* Add PATH instruction links

* Changes based on quickskstart feedback

* Small fixes

* Fix link
2019-07-02 14:39:45 +00:00
Beth Aitman
b902003e76 Glossary for SDK (#1557)
* Fix formatting issue

* Add outline of glossary

* Actually add glossary

Starting stuff

Interim stage

Add more glossary details

* Finishing off detail

* Link everything up
2019-06-12 14:38:50 +00:00
Digital Asset GmbH
05e691f558 open-sourcing daml 2019-04-04 09:33:38 +01:00