The development of the Helm Chart halted after 1.18.x to make room
for other priorities, including a better documentation of operational
concerns as a way for users to bridge the gap we were originally
trying to fill with the Helm Chart. The pages remained in the
documentation as we were hoping for the feature to go back into
active development but since the feature is not actually working and
we do not have short term plans to revive it (and possibly not in
the current form) it is better to just yank the content until
we have a better understanding of where we want this to go.
If by any chance we want to restore the feature more or less in
its current form, restoring this document from a previous version
requires very little effort while simultaneously we do not cause
confusion by documenting a feature that does not work with the
current version.
changelog_begin
changelog_end
"ones whose values can be written in a text or binary format" is a very
misleading definition to give for "serializable types" in the context of
Daml.
When we say "serializable" in Daml, we *always* mean the formal Daml-LF
definition given in "Serializable types" in daml-lf-1.rst, i.e. ⊢ₛ τ, or
"τ derives from the rules S". That is also what we mean here.
There are many examples of types "whose values can be written in a text
or binary format", that are nevertheless *not* derivable from S.
As it says in daml-lf-1.rst, "serializable types are the types whose
values can be persisted on the ledger". So we copy over something like
that language.
CHANGELOG_BEGIN
CHANGELOG_END
Co-authored-by: carrielaben-da <91496516+carrielaben-da@users.noreply.github.com>
* Provide an introduction to the Canton Console
The purpose of this page is to expose developers to the availability of the Canton Console
as part of the SDK to interact with the Sandbox, provide tips on how to consult the built-in
documentation and provide further pointers to the in-depth documentation page part of the
Canton user manual.
changelog_begin
changelog_end
* Apply suggestions from code review
Co-authored-by: carrielaben-da <91496516+carrielaben-da@users.noreply.github.com>
Co-authored-by: carrielaben-da <91496516+carrielaben-da@users.noreply.github.com>
* rename ChoiceMetadata to Choice
CHANGELOG_BEGIN
- [Java codegen] The (new since 2.4) ``ChoiceMetadata`` class has been
renamed to ``Choice``.
CHANGELOG_END
* replace ChoiceMetadata with Choice in codegen docs
* Document how to add a new item in the table of contents
changelog_begin
changelog_end
* Add link to instructions to make changes to the next unreleased version
* Rename test //daml-script/export/integration-tests/golden:{export-=>}values
* Switch 'daml_ledger_export_test' to use 'run' instead of 'run-legacy-cli-config'
* Extract 'encodeImports' from 'encodeModuleHeader'
* Sort import list in 'daml ledger export'
* Add 'dev' argument to 'daml_ledger_export_test'
* Add interfaceId to ExercisedSelector
* Extract 'encodeExercisedEvent' from 'encodeCmd'
* Split 'encodeCid' into 'encodeCid{Expr,Pat}'
* 'CreatedContract' field 'tplId' now has type 'TemplateId'
* Specialize CreatedContract{=>WithPath}
* 'treeEventCreatedConsumedCids' returns Seq[SimpleCreatedContract] instead of Set[ContractId]
* Change type of 'SimpleCommand' field 'contractId' to 'SimpleCreatedContract'
* Coerce ContractIds to underlying template type
* Use interface ContractId in encodeExercisedEvent if present
* Add test //daml-script/export/integration-tests/golden:interface-choices
* Fix encoding of getAnyChoiceTemplateTypeRep in daml-script converter
* Set getAnyChoiceTemplateTypeRep to interfaceId if available
* fromExercised uses choice instead of templateId to find subtree
fromExercised uses exercised.argument.templateTypeRep instead of exercised.contractId.templateId
Previously it used exercised.contractId.templateId, but now it uses
exercised.argument.getAnyChoiceTemplateTypeRep, which corresponds
to the TemplateTypeRep of the {template,interface} that defined the choice.
* TestData.Exercised now takes a more flexible TestData.Choice argument
* Add unit tests for encoding of exercise of interface choice
* Apply code review suggestions
* sealed {trait=>abstract class} CreatedContract
* Use List instead of Seq
* Use ::= instead of :+= and ++=
changelog_begin
- [Daml export] Added support for interface choices (#15189)
- [Daml export] Export.daml imports are now sorted alphabetically
changelog_end
Co-authored-by: Stephen Compall <stephen.compall@daml.com>
I started with wanting to remove the warning on incomplete pattern
match, thinking example code should be "good". Then I decided I should
skim the corresponding docs to check if that warning, or the pragma,
were actually mentioned in the text.
It turns out the warning should be there, but the pragma is not
explained and not necessary to get the warning. So the pargma can go.
But in the process I noticed a couple things that I belive can be
improved in the wording of the document, so I went agead and made a few
changes.
CHANGELOG_BEGIN
CHANGELOG_END
* added transactionFilter
* move transactionFilter to `TransactionFilter`
* fromCreatedEvent
* format
* added getTransaction with contract type companion
* ACS using contract type companion
* position
* add change log
CHANGELOG_BEGIN
CHANGELOG_END
* Ct
* Ct
* format
* better exception
* fixed test cases
* added java doc and rename method to GetContracts
* address Stephen's comments
* address Stephen's comments
* address Stephen's comments
* remove unused import
* format
* address Stephen's comments
* address Stephen's comments
* Make some codegen code to be java 8 compatible; Modify IouMain to use the new getActiveContracts. to address Stephen's comments
* use 1.11, no need to be java 8 compatible
* revert
* 11 not 1.11
Addressing the missing word issue noticed by Craig, plus some additional improvements.
[CHANGELOG_BEGIN]
[CHANGELOG_END]
Co-authored-by: carrie-laben <91496516+carrie-laben@users.noreply.github.com>
* #13766 initial implementation of choice metadata for templates
* #13766 initial implementation of choice metadata for interfaces
* #13766 Add marker type to ContractTypeCompanion
* #13766 Minor type fix
* Cleanup after merge with main
* Temporary fix for package prefixes
* Format java files, rename Maker -> ContractType in ContractTypeCompanion
* Add documentation and tests
* Complete choice metadata implementation
CHANGELOG_BEGIN
- Add new representation of a choice, ChoiceMetadata.
- Generated templates and interfaces now include fields for each available choice. These fields will have a ChoiceMetadata type and will be called CHOICE_N, where N represents the choices' name.
CHANGELOG_END
* Update docs and cleanup tests
* Add link to support page (and indirectly to the support portal)
changelog_begin
changelog_end
* Update docs/source/support/support.rst
Co-authored-by: carrielaben-da <91496516+carrielaben-da@users.noreply.github.com>
Co-authored-by: carrielaben-da <91496516+carrielaben-da@users.noreply.github.com>
* Documentation for ledgerApiError in json api
CHANGELOG_BEGIN
Added docs for "ledgerApiError" field in json api response when the error is originated from JSON API
CHANGELOG_END
* Update docs/source/json-api/index.rst
Co-authored-by: carrielaben-da <91496516+carrielaben-da@users.noreply.github.com>
* Update docs/source/json-api/index.rst
Co-authored-by: carrielaben-da <91496516+carrielaben-da@users.noreply.github.com>
Co-authored-by: carrielaben-da <91496516+carrielaben-da@users.noreply.github.com>
changelog_begin
[Ledger API Specification]:
1. Add 'is_deactivated' attribute to participant users.
2. Introduce participant server's local metadata for parties and participant users consisting of:
- a resource version for optional concurrent change control,
- modifiable key-value based annotations.
3. Add experimental update RPCs for parties and participant users:
- participant user's modifiable fields are: 'primary_party', 'is_deactivated', 'metadata.annotations',
- party's modifiable fields are 'local_metadata.annotations'.
4. Discourage use of 'party_details.display_name' in favor of using party's metadata annotations.
changelog_end
Other notes:
- no-op updates are allowed,
- update paths are resource relative,
- as annotation deletion is by providing an key with the empty string value,
- as a corollary, only non-empty strings are valid annotation values.
Correcting the folder names in the first two sections of the Basic Contracts tutorial to reflect what the user will actually see.
[CHANGELOG_BEGIN]
[CHANGELOG_END]
* Add "Next steps" page to "An introduction to Daml"
The idea is that of offering a comprehensive set of possible next steps after learning how to write Daml.
The page suggests certifications and points to existing examples as the previous final line on the last page,
as well as adding suggestions on where to learn more about building off-ledger services, how to install,
operate and maintain a ledger, where to learn about proven design patterns and the availability of Daml Hub
to get started without having to run your own ledger.
changelog_begin
changelog_end
* Apply suggestions from code review
Thank you @carrielaben-da, great suggestions as always!
Co-authored-by: carrielaben-da <91496516+carrielaben-da@users.noreply.github.com>
Co-authored-by: carrielaben-da <91496516+carrielaben-da@users.noreply.github.com>
* Add abstract class parents to generated ordinary records and variants
* Add common supertype for generated enums
* Add abstract class parents to generated ordinary records and variants
CHANGELOG_BEGIN
- Ordinary Records and Variants now have a super class defining toValue()
- Generated enums now have a common supertype, DamlEnum<T>
CHANGELOG_END
This removes the index.rst files from the repo, and instead generates a
placeholder index that just includes all the rst files at build time.
The reason for this change is that the ToC is defined in docs.daml.com,
and having one on both sides is both confusing and error-prone.
CHANGELOG_BEGIN
CHANGELOG_END
* Update quickstart.rst
Updated installation instructions
[CHANGELOG_BEGIN]
[CHANGELOG_END]
* Update quickstart.rst
To address Moritz's comment re: line 164
[CHANGELOG_BEGIN]
[CHANGELOG_END]
* Update docs/source/app-dev/bindings-java/quickstart.rst
[CHANGELOG_BEGIN]
[CHANGELOG_END]
Co-authored-by: Moritz Kiefer <moritz.kiefer@purelyfunctional.org>
* Update quickstart.rst
Another attempted update. As I walk through this, it's not clear to me that we need any step beyond step 3 ("In the browser, log in as alice...") for a beginning user working through the tutorial locally?
[CHANGELOG_BEGIN]
[CHANGELOG_END]
* Update docs/source/app-dev/bindings-java/quickstart.rst
[CHANGELOG_BEGIN]
[CHANGELOG_END]
Co-authored-by: Moritz Kiefer <moritz.kiefer@purelyfunctional.org>
* Quickstart.rst Maven edits
Hopefully final edits to this branch
[CHANGELOG_BEGIN]
[CHANGELOG_END]
* Integration w ledger update fix (#14983)
* fix Sphinx build
* update tree output
* remove non-existing ui-backend.conf reference
* update daml build output
* run through the whole thing
Co-authored-by: carrie-laben <91496516+carrie-laben@users.noreply.github.com>
Co-authored-by: Moritz Kiefer <moritz.kiefer@purelyfunctional.org>
Co-authored-by: Gary Verhaegen <gary.verhaegen@digitalasset.com>
* Correct error message for not found templates/interfaces in stream subscription
changelog_begin
When subscribing to Ledger API transaction streams with unknown template or interface ids
filter, a client is served with a NOT_FOUND/TEMPLATES_OR_INTERFACES_NOT_FOUND error code.
changelog_end
* Temporarily create a custom preview and dev conformance test for Canton
in order to allow the changed test exclusion
* Added documentation for interface support in json-api
CHANGELOG_BEGIN
Added documentation for interface support in json-api
CHANGELOG_END
* Added documentation for interface support in json-api
CHANGELOG_BEGIN
Added documentation for interface support in json-api
CHANGELOG_END
* Update docs/source/json-api/index.rst
Co-authored-by: Raymond Roestenburg <98821776+ray-roestenburg-da@users.noreply.github.com>
* Update docs/source/json-api/index.rst
Co-authored-by: Raymond Roestenburg <98821776+ray-roestenburg-da@users.noreply.github.com>
* Update docs/source/json-api/index.rst
Co-authored-by: Raymond Roestenburg <98821776+ray-roestenburg-da@users.noreply.github.com>
* Update docs/source/json-api/index.rst
Co-authored-by: Raymond Roestenburg <98821776+ray-roestenburg-da@users.noreply.github.com>
* Update docs/source/json-api/index.rst
Co-authored-by: Raymond Roestenburg <98821776+ray-roestenburg-da@users.noreply.github.com>
Co-authored-by: Raymond Roestenburg <98821776+ray-roestenburg-da@users.noreply.github.com>
CHANGELOG_BEGIN
Added new error category "SecurityAlert".
Corrected documentation of GRPC status codes for error categories MaliciousOrFaultyBehavior, AuthInterceptorInvalidAuthenticationCredentials, and InsufficientPermission.
CHANGELOG_END
changelog_begin
changelog_end
1. Document that the fetch-by-contract-ID endpoint can take a template ID
2. Reinforce the point made in #14601 and always specify the package ID
* document how to enable dev on both Daml and Canton
changelog_begin
changelog_end
* Update docs/source/daml/reference/interfaces.rst
Co-authored-by: carrielaben-da <91496516+carrielaben-da@users.noreply.github.com>
* Update docs/source/daml/reference/interfaces.rst
Co-authored-by: carrielaben-da <91496516+carrielaben-da@users.noreply.github.com>
* Update docs/source/daml/reference/interfaces.rst
Co-authored-by: Moritz Kiefer <moritz.kiefer@purelyfunctional.org>
* Update docs/source/daml/reference/interfaces.rst
Co-authored-by: Moritz Kiefer <moritz.kiefer@purelyfunctional.org>
* change the link reference to a ref
Co-authored-by: carrielaben-da <91496516+carrielaben-da@users.noreply.github.com>
Co-authored-by: Moritz Kiefer <moritz.kiefer@purelyfunctional.org>
* Update reference docs for interfaces and interface instances
* Rename subsection on empty interface instance clauses
* Move empty interface instance example below explanation
* Split 'interface instance in the interface' into its own subsection
* Add code example for interface instance in the interface
* Rephrase docs on interface method types
* Move docs on required interfaces to the bottom
* Add section on interface values
* Explain result of applying a method, highlight 'this' binding
changelog_begin
changelog_end
Co-authored-by: Stefano Baghino <43749967+stefanobaghino-da@users.noreply.github.com>
Co-authored-by: Moritz Kiefer <moritz.kiefer@purelyfunctional.org>
