Commit Graph

1327 Commits

Author SHA1 Message Date
carrielaben-da
0c80d346df
Delete tools.rst (#15752)
Removing the "Developer Tools" TOC, which is not used in the new 2.5 TOC
2022-12-01 10:41:23 +01:00
Lois Kilberg
989142a0db
fix numbered lists (#15730)
Added blank lines in two places before numbered lists so that they will be recognized as lists.

[CHANGELOG_BEGIN]
[CHANGELOG_END]
2022-11-30 14:21:13 -05:00
katmurp
9522017c98
fixing a few 404s (#15684)
* fixing a few 404s

* redoing links to be relative

* Update command-deduplication.rst

Removing broken link.

* removing the line
2022-11-30 18:51:44 +01:00
Miklos
d867747b57
Document HTTP-JSON APIs [PLEN-57] (#15660) 2022-11-30 10:37:04 +00:00
Gary Verhaegen
5d693d88e1
remove toc in writing-daml (#15723) 2022-11-30 10:33:57 +00:00
Raymond Roestenburg (Actually RayRoestenburg)
4a554ac28e
Fixes from review in #15721. (#15729) 2022-11-29 20:55:28 +01:00
Raymond Roestenburg (Actually RayRoestenburg)
272e50acdd
Initial custom views documentation. (#15721)
* Initial custom views documentation.

* Update docs/source/app-dev/custom-views/index.rst

Co-authored-by: Stephen Compall <stephen.compall@daml.com>

* Update docs/source/app-dev/custom-views/index.rst

Co-authored-by: Stephen Compall <stephen.compall@daml.com>

* Minor change for closer rendering of ``Batch``es.

Co-authored-by: Stephen Compall <stephen.compall@daml.com>
2022-11-28 21:23:55 +00:00
Gary Verhaegen
f6a5838039
docs: remove redundant toc (#15718) 2022-11-28 20:08:29 +01:00
mziolekda
4c1600a6e6
bump ledger api version to 2.2 (#15713)
* bump ledger api version to 2.2

* Update document link
2022-11-28 17:20:45 +01:00
Gary Verhaegen
e8e9f5dc36
fix gsg on node 18 (#15373)
CHANGELOG_BEGIN
CHANGELOG_END
2022-11-28 11:52:47 +01:00
nickchapman-da
6e379dbd5a
[script] update doc for daml-script/interfaces (#15683)
* update reference doc (doc-comments in Script.daml) for daml-script/interfaces

* small english fixes

* update user doc and example for daml-script/interfaces

* build/test ScriptExample.daml at 1.15

* dont show party in interface info message

* fix for: //daml-script/export/integration-tests/golden:matches-docs-test

* disable failing integration test
2022-11-28 08:18:44 +00:00
Carl Pulley
898d8cbf88
Quick fixes to stablise trigger behaviour (#15700)
CHANGELOG_BEGIN
* [Triggers] Revert changes for in-flight rate limit controls
CHANGELOG_END
2022-11-25 14:00:44 +01:00
Gary Verhaegen
b749828b43
update & pin puppeteer dependencies for gsg test (#15584)
Not that I relish the added flakiness on CI, but I want to be able to
run those tests locally.
2022-11-25 00:23:56 +01:00
Gary Verhaegen
46a4804672
bump nix (#15628)
Partly because the current version is from February (of this year,
fortunately), and partly because I need a more recent one to bump node
to 18 and fix the GSG for that.
2022-11-24 14:29:09 +00:00
Gary Verhaegen
4f1fe79016
fix preview (#15675) 2022-11-24 14:43:28 +01:00
Remy
752b4cfb63
[Doc] update configuration of Interface (#15690) 2022-11-24 12:06:02 +00:00
mziolekda
a02c30440a
remove deprecated warnings everywhere [DPP-1281] (#15661)
* remove deprecated warnings in /ledger

* update generated documentation
2022-11-24 12:05:08 +00:00
Carl Pulley
36c93bfaa6
Add throttle and rate-limit documentation for triggers
* fixes #15676

CHANGELOG_BEGIN
CHANGELOG_END
2022-11-24 12:03:34 +00:00
fayi-da
448c184258
Remove overloaded methods in command client (#15519)
* Remove overloaded methods in CommandClient

* Remove overloaded methods in CommandClient

* Revert destructive changes to command client

* Add config for command client methods

* Add stubs for new submit methods in CommandClient

* Formatting

* create() should be static

* Add sample deprecation

* params on builder methods don't need to be optional. Add some javadoc notes

* Add tests for submitAndWait

* Add tests for submitAndWait

* Add implementation for submitAndWaitFor* methods

* Update tests

* Refactor CommandSubmissionClient

* Deprecate overloaded methods in CommandClient

* Update deprecated method use

* Lint

* Cleanup deprecated use

* Update required params

* CommandClientConfig -> CommandsBuilder

* Formatting

* Rename CommandsBuilder -> CommandsSubmission

* Delete deprecated tests

* Rename withParty(String) -> withActAs(String)

* Formatting

* Refactor SubmitRequest.java

* Refactor SubmitRequest.java

* Refactor SubmitAndWaitRequest and SubmitCommandsRequest

* Move CommandsSubmission to the java-bindings package and refactor dependencies accordingly

* todos for horrible casting

* Update language-support/java/bindings-rxjava/src/test/scala/com/daml/ledger/rxjava/grpc/CommandClientImplTest.scala

Co-authored-by: Stefano Baghino <43749967+stefanobaghino-da@users.noreply.github.com>

* make CommandsSubmission final

* e.t.c -> etc

* Remove use of singleton list for actAs

* Return unmodifiable lists in CommandsSubmission

* Cleanup SubmitCommandsRequest

* Formatting

* Update tests for SubmitCommandsRequest

* PR comments

* Use toCommands() in HasCommands

* Reorder constructor params

* Rename params and commandsSubmission -> submission

* Cleanup docs

* Update docs

* Update docs

* Cleanup test util

Co-authored-by: Stefano Baghino <43749967+stefanobaghino-da@users.noreply.github.com>
2022-11-23 16:10:06 +01:00
Ratko Veprek
32b45966ad
Unified error category malicious or faulty with security alert (#15649)
Before this change, we had two error categories that were meant for the same purpose: malicious or faulty and security alert. Now, they have been merged together. As malicious or faulty was misunderstood and sometimes used instead of "SystemInternalAssumptionViolation", we've dropped that term.

Related to canton 10981
2022-11-22 14:05:06 +01:00
davidrichards-da
7c19a058d3
Adding the Python bindings to the docs (#15601)
* Adding the Python bindings to the docs

Adding support for the Python bindings to the docs.
Adding a page on the Python bindings.
Adding references to them where appropriate.

* Update docs/source/app-dev/bindings-python.rst

Co-authored-by: katmurp <117752519+katmurp@users.noreply.github.com>

* Adding the phrase "(formerly known as DAZL)"

Adding the phrase "(formerly known as DAZL)" when the Python bindings are referenced for the first time on a page.

* Adding the python bindings into the TOC

Adding the python bindings into the TOC in the building applications section below Java Bindings and above Daml Script .

Co-authored-by: katmurp <117752519+katmurp@users.noreply.github.com>
2022-11-17 20:53:25 +00:00
Stephen Compall
41110887f4
document serializability in the Templates reference doc (#15566)
* Apply suggestions from code review

* unnumber, reword non-serializable examples

- suggested by @katmurp; thanks

Co-authored-by: katmurp <117752519+katmurp@users.noreply.github.com>
2022-11-15 14:46:47 -05:00
Stephen Compall
297412e42c
document intended scale, use case contour of JSON API (#15413)
* remove redundant query-store config block doc

* clean up json-api config doc

* shorter explanation of schema version

* section on query store performance

* emphasize that JSON API isn't magic

* a bit more on scaling

* small intro note about intended applications

* some thoughts on the limits of scaling

* make all the versions indirect

- suggested by @carrielaben-da; thanks

* replace JSON API with HTTP JSON API service

- suggested by @stefanobaghino-da

Co-authored-by: carrielaben-da <91496516+carrielaben-da@users.noreply.github.com>
2022-11-15 18:59:32 +00:00
carrielaben-da
4e647fe068
Add High Level Intro and Architecture (#15449)
* Add High Level Intro and Architecture

High level intro content covering multi-party apps, Daml, and the Canton ledger.

* Update docs/source/high-level-intro.rst

Per Stefano's suggestion

[CHANGELOG_BEGIN]
[CHANGELOG_END]

Co-authored-by: Stefano Baghino <43749967+stefanobaghino-da@users.noreply.github.com>

* Update high-level-intro.rst

Implementing Stefano's suggestions.

[CHANGELOG_BEGIN]
[CHANGELOG_END]

* fix ref

* fix toc ref

Co-authored-by: carrie-laben <91496516+carrie-laben@users.noreply.github.com>
Co-authored-by: Stefano Baghino <43749967+stefanobaghino-da@users.noreply.github.com>
Co-authored-by: Gary Verhaegen <gary.verhaegen@digitalasset.com>
2022-11-14 15:30:30 -04:00
carrielaben-da
8cfd7a7d61
Adding an intro for the Create Daml App section (#15388)
* Adding an intro for the Create Daml App section

Part of the High-Level Introductory Content addition

[CHANGELOG_BEGIN]
[CHANGELOG_END]

* Update docs/source/daml/considerations.rst

Co-authored-by: Stefano Baghino <43749967+stefanobaghino-da@users.noreply.github.com>

* Update docs/source/daml/considerations.rst

Co-authored-by: Stefano Baghino <43749967+stefanobaghino-da@users.noreply.github.com>

* Update docs/source/daml/considerations.rst

Co-authored-by: Stefano Baghino <43749967+stefanobaghino-da@users.noreply.github.com>

* Update docs/source/daml/considerations.rst

Co-authored-by: Stefano Baghino <43749967+stefanobaghino-da@users.noreply.github.com>

* Update docs/source/daml/considerations.rst

Co-authored-by: Stefano Baghino <43749967+stefanobaghino-da@users.noreply.github.com>

* Update docs/source/daml/considerations.rst

Co-authored-by: Stefano Baghino <43749967+stefanobaghino-da@users.noreply.github.com>

* fix intro link

Co-authored-by: carrie-laben <91496516+carrie-laben@users.noreply.github.com>
Co-authored-by: Stefano Baghino <43749967+stefanobaghino-da@users.noreply.github.com>
Co-authored-by: Gary Verhaegen <gary.verhaegen@digitalasset.com>
2022-11-14 11:57:44 -04:00
katmurp
60e5378757
Revert "set up analytics for research purposes (#15548)" (#15558)
This reverts commit 7c2a38a1f7.
2022-11-14 12:30:11 +01:00
mziolekda
60ab087e71
Fix copy pasta in ErrorCategory (#15543)
* Fix copy pasta in ErrorCategory

* update documentation
2022-11-14 08:39:57 +01:00
katmurp
7c2a38a1f7
set up analytics for research purposes (#15548)
* set up analytics for research purposes

* missing % in expression
2022-11-11 16:15:36 +01:00
tudor-da
346bb48904
Extract Ledger API error definitions in //ledger/ledger-api-errors [DPP-1269] (#15439)
* Extract Ledger API error definitions in //ledger/error-definitions

changelog_begin
SERVICE_INTERNAL_ERROR error code is created in CommonErrors and replaces the usage of LEDGER_API_INTERNAL_ERROR in ledger-api-client (as a fix).
changelog_end

* Tests in //ledger/error do not depend on //ledger/ledger-api-errors

* Remove unused dependency from //ledger/error

changelog_begin
changelog_end

* Address Martino's comment
2022-11-07 17:24:43 +01:00
Stephen Compall
2d2f645fdd
split JSON API production setup doc to separate documents (#15409)
* split JSON API production setup doc to separate documents

CHANGELOG_BEGIN
CHANGELOG_END

* remove json-api and production-setup TOCs

- properly placed in digital-asset/docs.daml.com#55

- suggested by @garyverhaegen-da; thanks
2022-11-04 15:33:11 -04:00
Stefano Baghino
5d6a0355a3
Specify that parties are allocated only if necessary (#15441)
Makes the behavior of `daml ledger allocate-parties` more explicit
2022-11-04 12:53:03 +00:00
Stefano Baghino
4957838e7b
Drop comments about 0.x when talking about upgrades (#15419)
The comments refer to 0.x and can be misleading for 2.x users
(since the default is not 1.8 anymore and have not been for a
long time at this point). Furthermore, I am also relatively
sure that 1.8 is not even an option at all for 2.x users.

changelog_begin
changelog_end
2022-11-02 09:58:52 -04:00
Gary Verhaegen
216f9f4775
gsg test: pin puppeteer (#15422)
Somehow our setup doesn't work with puppeteer 19+.

CHANGELOG_BEGIN
- GSG: Several TypeScript warnings have been fixed in the final "Testing
  Your Web App" section of the Getting Started Guide. The
  `create-daml-app` template includes an updated `config.ts` file, and the
  documentation page as been updated to pin the `puppeteer` version to a
  known-working one and tweak the `index.test.ts` file.
CHANGELOG_END
2022-11-02 14:46:01 +01:00
Moisés Ackerman
a33127599e
Add coerceInterfaceContractId : (...) => ContractId i -> ContractId j (#15405)
* Replace '1.dev only'=>'Daml-LF >= 1.15' in docs for interface functions

* Define coerceInterfaceContractId

* Test coerceInterfaceContractId in InterfaceContractDoesNotImplementInterface

* Test coerceInterfaceContractId in InterfaceConversions

* Add entry for coerceInterfaceContractId in interface reference docs

* update *.EXPECTED.desugared-daml files

changelog_begin
- [Daml Standard Library] Added function ``coerceInterfaceContractId``
changelog_end
2022-11-02 10:48:12 +00:00
Chun Lok Ling
b77a4552d1
Use typed acstransaction streams in quickstart java examples (#15363)
* Added new method using contractUtil instead of filter so that creation of filter is not necessary in IouMain.

* public fields instead of private fields with getters

* delete getContracts

* var

* move ContractUtil to java binding

* to String

* update doc

* address comments

* address comment

* add change log

CHANGELOG_BEGIN
change quickstart java example to use typed acs stream and transaction.
CHANGELOG_END

* rename to response

* format

* update line number
2022-11-01 19:22:12 +00:00
Carl Pulley
b1e5caaf62
Trigger documentation for interfaces
CHANGELOG_BEGIN
CHANGELOG_END
2022-11-01 14:59:41 +00:00
Wallace Kelly
1ff7062bc6
Correct number of steps for creating new feature (#15387)
* Correct number of steps for creating new feature

* Add change log entry

changelog_begin
changelog_end
2022-10-31 17:27:35 +00:00
Stefano Baghino
1b726fe841
Expand the reference for the TypeScript library (#15361)
* Expand the reference for the TypeScript library

The content is more or less there, I expanded some explanations and added a
reference to `create-daml-app`.

changelog_begin
changelog_end

* Fix link

* Update docs/source/app-dev/bindings-ts/index.rst

Co-authored-by: carrielaben-da <91496516+carrielaben-da@users.noreply.github.com>

* Update docs/source/app-dev/bindings-ts/index.rst

Co-authored-by: carrielaben-da <91496516+carrielaben-da@users.noreply.github.com>

* Update docs/source/app-dev/bindings-ts/index.rst

Co-authored-by: carrielaben-da <91496516+carrielaben-da@users.noreply.github.com>

Co-authored-by: Jennifer Whyte <42810081+jwhyte-da@users.noreply.github.com>
Co-authored-by: carrielaben-da <91496516+carrielaben-da@users.noreply.github.com>
2022-10-28 16:22:55 -04:00
Stefano Baghino
96fb3be3e3
Add intro page for off-ledger automation with Daml (#15362)
* Add intro page for off-ledger automation with Daml

This is meant as a page to introduce Daml Script (as an off-ledger automation
tool) and Daml Triggers. This will require this page to be added to the
table of contents in the appropriate place in a separate PR in the
documentation repository.

changelog_begin
changelog_end

* Apply suggestions from code review

Co-authored-by: carrielaben-da <91496516+carrielaben-da@users.noreply.github.com>

* Rephrase, reformat

Co-authored-by: carrielaben-da <91496516+carrielaben-da@users.noreply.github.com>
2022-10-26 16:02:13 +00:00
Moisés Ackerman
2bcb7a432e
Define price in 'Intro: Exceptions' using template parameter instead of local let (#15358)
This fixes #15256

changelog_begin
changelog_end
2022-10-26 15:43:56 +00:00
Chun Lok Ling
fd9676754c
Add Update<R> to exercise and create method result types in Java codegen (#15193)
* pre

* address Stephen's comments

* get command from Update<R>

* to public

* generateDeprecatedFlattenedStaticExerciseByKeyMethod

* Ensure interface generation uses package prefixes

CHANGELOG_BEGIN
- [BUGFIX] Interface generation now respects package prefixes argument. This means generated interfaces will now be placed in the right subpackages.
CHANGELOG_END

* packagePrefixes

* fix what exercise* returning update breaks

* doc

* format

* WIP

* address comments

* compile

* added 2 utility methods in CommandClient for getting the result of submitted commands to demonstrate value of Update R

* address some comments

* update line number

* rename

* fold for create and exercise cases

* move transaction logic to fold

* revert config

* argTypeDecoder

* add internal api doc

* rename to Choice

* quickstart doc

* use update

* address comment

* address comment on compactability issue

* move abstract static class FoldUpdate<Z>  to Update<>

* change command clients to use List<? extends HasCommands> instead of List<Command>

* move fold to update

* compare commands

* Update docs/source/app-dev/bindings-java/quickstart.rst

Co-authored-by: Raymond Roestenburg <98821776+ray-roestenburg-da@users.noreply.github.com>

* address comments

* address comments

* add changelog

CHANGELOG_BEGIN
- [Java codegen] Replace return type to Update<R> of exercise and create methods in Java codegen
CHANGELOG_END

Co-authored-by: Fayi Femi-Balogun <fayimora.femibalogun@digitalasset.com>
Co-authored-by: Raymond Roestenburg <98821776+ray-roestenburg-da@users.noreply.github.com>
2022-10-26 14:53:06 +01:00
carrielaben-da
6777267bb7
Removing Chapter Numbers From Daml/Intro (#15353)
This allows additional chapters to be added in the future without disrupting existing pages.

[CHANGELOG_BEGIN]
[CHANGELOG_END]

Co-authored-by: carrie-laben <91496516+carrie-laben@users.noreply.github.com>
2022-10-26 09:40:26 -04:00
Rafael Guglielmetti
45be0c6cfa
Enable interfaces on protocol version 4 (#15320)
CHANGELOG_BEGIN
CHANGELOG_END
2022-10-26 12:00:01 +02:00
Moisés Ackerman
484c40acb5
Update "Reference: Daml Packages" (#15324)
* Remove mention of FunctionalDependencies as data-dependencies caveat

FunctionalDependencies in data-dependencies have been supported since #7698

changelog_begin
changelog_end

* Remove mention of advanced type system features as data-dependencies caveat

module DA.Generics and language extension DeriveGeneric have long been removed
from the language, and I couldn't think of other similar "advanced type
system features" that work for plain dependencies but not for data-dependencies.

* Extend list of data dependable extensions
2022-10-26 11:56:29 +02:00
Stefano Baghino
0e995f27a7
Remove outdated docs referring to 1.18.x features (#15337)
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
2022-10-25 15:48:25 +02:00
Stephen Compall
c8adc54ad9
do not use the external definition of "serializable" (#15328)
"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>
2022-10-24 18:33:45 -04:00
Stefano Baghino
7aaec19fd9
Link main Canton console doc from intro (#15313)
changelog_begin
changelog_end

Follow up to https://github.com/digital-asset/daml/pull/15292#discussion_r1001459934
2022-10-21 15:36:45 +00:00
Rafael Guglielmetti
5a16aa76f6
Small changes in interoperable ledgers doc (#15307)
CHANGELOG_BEGIN
CHANGELOG_END
2022-10-21 13:34:13 +00:00
Stefano Baghino
ec3aea29ca
Replace old logo in 404 screen (#15308)
Mostly copied from `//templates/create-daml-app/ui/public/daml.svg` with
tweaks to center it like the old logo.

changelog_begin
changelog_end
2022-10-21 15:33:58 +02:00
Stefano Baghino
c217883c51
Provide an introduction to the Canton Console (#15292)
* 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>
2022-10-21 13:12:36 +00:00