The Daml smart contract language
Go to file
Gary Verhaegen 525c4d605a
prepare playground for perf testing (#4520)
* prepare playground for perf testing

The goal of this commit is to provide me with a playground to test out
various GCP machine configurations and assess what impact they have on
build performance. I need separate pools for that as changing the
machine type requires a machine restart, which would be disruptive to
any running job if I did that in the existing pools.

The first commit in this PR does the following:

- Deactivate Bazel caching.
- Create two new machine groups (of size 1) for Linux and Windows pools.
- Disable all jobs that are not building the project on Linux or
  Windows.
- Change the Linux and Windows jobs to use the new pools.

The plan is for me to manually change the machine types in the new pool
and rerun the build repeatedly. Once I believe I have the information I
need, the expected end result for this PR is only a change to the
machine type (or no change at all if the current machine size is already
optimal). All other changes will be undone and the additional pools will
be destroyed.

Note: as of the opening of this PR, the two new pools have not been
created yet at the Azure level (this is a separate, manual step not
managed by Terraform) and the Terraform files have not been applied.

See corresponding PR (#4520) for full details. The gist of it is:
- We need at least 28GB of memory to build at all, 30 is better.
- Additional memory beyond 30GB does not seem to provide any benefit.
- CPU speed matters more than number of CPU cores, but both help.

CHANGELOG_BEGIN
CHANGELOG_END
2020-03-27 20:14:54 +01:00
.github check for changelog (#3963) 2020-01-07 17:19:50 +01:00
.vscode open-sourcing daml 2019-04-04 09:33:38 +01:00
3rdparty update copyright notices to 2020 (#3939) 2020-01-02 21:21:13 +01:00
bazel_tools replace DAML Authors with DA in copyright headers (#5228) 2020-03-27 01:26:10 +01:00
build-scripts replace DAML Authors with DA in copyright headers (#5228) 2020-03-27 01:26:10 +01:00
ci replace DAML Authors with DA in copyright headers (#5228) 2020-03-27 01:26:10 +01:00
compiler DAML-LF: redesign absolute contract ids (#5207) 2020-03-27 19:07:42 +01:00
daml-assistant New command: daml ledger fetch-dar (#5225) 2020-03-27 18:04:14 +00:00
daml-lf DAML-LF: redesign absolute contract ids (#5207) 2020-03-27 19:07:42 +01:00
daml-script DAML-LF: redesign absolute contract ids (#5207) 2020-03-27 19:07:42 +01:00
dev-env replace DAML Authors with DA in copyright headers (#5228) 2020-03-27 01:26:10 +01:00
docs Fix template name in multiparty agreement docs (#5255) 2020-03-27 16:34:57 +00:00
extractor replace DAML Authors with DA in copyright headers (#5228) 2020-03-27 01:26:10 +01:00
ghc-lib update copyright notices to 2020 (#3939) 2020-01-02 21:21:13 +01:00
infra replace DAML Authors with DA in copyright headers (#5228) 2020-03-27 01:26:10 +01:00
language-support DAML-LF: redesign absolute contract ids (#5207) 2020-03-27 19:07:42 +01:00
ledger DAML-LF: redesign absolute contract ids (#5207) 2020-03-27 19:07:42 +01:00
ledger-api replace DAML Authors with DA in copyright headers (#5228) 2020-03-27 01:26:10 +01:00
ledger-service DAML-LF: redesign absolute contract ids (#5207) 2020-03-27 19:07:42 +01:00
libs_python replace DAML Authors with DA in copyright headers (#5228) 2020-03-27 01:26:10 +01:00
libs-haskell Move SDK installation to a tasty resource (#5238) 2020-03-27 11:59:41 +01:00
libs-scala replace DAML Authors with DA in copyright headers (#5228) 2020-03-27 01:26:10 +01:00
navigator DAML-LF: redesign absolute contract ids (#5207) 2020-03-27 19:07:42 +01:00
nix replace DAML Authors with DA in copyright headers (#5228) 2020-03-27 01:26:10 +01:00
oss-compliance replace DAML Authors with DA in copyright headers (#5228) 2020-03-27 01:26:10 +01:00
release replace DAML Authors with DA in copyright headers (#5228) 2020-03-27 01:26:10 +01:00
replacements replace DAML Authors with DA in copyright headers (#5228) 2020-03-27 01:26:10 +01:00
rules_daml replace DAML Authors with DA in copyright headers (#5228) 2020-03-27 01:26:10 +01:00
scala-protoc-plugins replace DAML Authors with DA in copyright headers (#5228) 2020-03-27 01:26:10 +01:00
templates replace DAML Authors with DA in copyright headers (#5228) 2020-03-27 01:26:10 +01:00
triggers DAML-LF: redesign absolute contract ids (#5207) 2020-03-27 19:07:42 +01:00
.bazelignore Add other node_modules to bazelignore (#4150) 2020-01-22 09:50:32 +00:00
.bazelrc docs cron: more reliable checksums (#4102) 2020-01-20 16:21:34 +01:00
.dadew Get openssl from msys2 (#5063) 2020-03-18 13:09:03 +01:00
.dockerignore open-sourcing daml 2019-04-04 09:33:38 +01:00
.envrc open-sourcing daml 2019-04-04 09:33:38 +01:00
.gitattributes Remove unreleased.rst (#3547) 2019-11-20 15:16:57 +00:00
.gitignore ledger-on-sql: Migrate tables using Flyway. (#4232) 2020-01-28 16:16:23 +00:00
.hie-bios Update rules_haskell (#4751) 2020-03-13 16:49:34 +01:00
.hlint.yaml replace DAML Authors with DA in copyright headers (#5228) 2020-03-27 01:26:10 +01:00
.mergify.yml replace DAML Authors with DA in copyright headers (#5228) 2020-03-27 01:26:10 +01:00
.scalafmt.conf Revert "Adopt trailingCommas option in scalafmt (#4214)" (#4257) 2020-01-29 11:43:35 +00:00
.sha256 Improve performance of stakeholder retrieval from SQL (#3207) 2019-10-28 14:16:21 +01:00
.watchmanconfig open-sourcing daml 2019-04-04 09:33:38 +01:00
azure-cron.yml replace DAML Authors with DA in copyright headers (#5228) 2020-03-27 01:26:10 +01:00
azure-pipelines.yml replace DAML Authors with DA in copyright headers (#5228) 2020-03-27 01:26:10 +01:00
BAZEL-bash.md add Bazel bash help (#2223) 2019-07-19 15:31:45 +00:00
bazel-haskell-deps.bzl replace DAML Authors with DA in copyright headers (#5228) 2020-03-27 01:26:10 +01:00
BAZEL-haskell.md Remove bzip2 library (#5105) 2020-03-20 15:05:33 +01:00
bazel-java-deps.bzl replace DAML Authors with DA in copyright headers (#5228) 2020-03-27 01:26:10 +01:00
BAZEL-JVM.md Document @unpinned_maven//:pin (#3288) 2019-10-30 11:19:01 +01:00
BAZEL.md Remove unused //compiler/daml-licenses and //:notices-gen (#5221) 2020-03-26 17:33:11 +00:00
BUILD damlc validate-dar (#4654) 2020-02-27 14:26:14 +00:00
build.ps1 stop producing/publishing the Bazel execution logs (#4527) 2020-02-14 14:34:01 +01:00
build.sh replace DAML Authors with DA in copyright headers (#5228) 2020-03-27 01:26:10 +01:00
CHANGELOG Move unreleased user-facing features to its own file (#1762) 2019-06-19 16:32:03 +02:00
CODE_OF_CONDUCT.md open-sourcing daml 2019-04-04 09:33:38 +01:00
CODEOWNERS Add CODEOWNERS for libs-scala (#5204) 2020-03-26 08:56:40 +00:00
CONTRIBUTING.md Document way to check added changelog entries (#3958) 2020-01-08 11:25:40 +00:00
COPY replace DAML Authors with DA in copyright headers (#5228) 2020-03-27 01:26:10 +01:00
daml-logo.png #2785 add daml_logo.png for README (#2787) 2019-09-06 09:35:32 +02:00
deps.bzl replace DAML Authors with DA in copyright headers (#5228) 2020-03-27 01:26:10 +01:00
dotfiles open-sourcing daml 2019-04-04 09:33:38 +01:00
fmt.sh replace DAML Authors with DA in copyright headers (#5228) 2020-03-27 01:26:10 +01:00
LATEST Release: 2020-03-25. (#5188) 2020-03-25 18:15:29 +01:00
LICENSE update copyright notices to 2020 (#3939) 2020-01-02 21:21:13 +01:00
maven_install.json Sandbox: Configurable metrics output. (#5113) 2020-03-23 10:59:13 +00:00
NOTICES remove MissingH (#3948) 2020-01-06 14:36:14 +01:00
package.json language: add daml-react package to ts libraries (#4259) 2020-01-29 15:37:47 +01:00
README.md update copyright notices to 2020 (#3939) 2020-01-02 21:21:13 +01:00
release.sh replace DAML Authors with DA in copyright headers (#5228) 2020-03-27 01:26:10 +01:00
report-std-change.sh replace DAML Authors with DA in copyright headers (#5228) 2020-03-27 01:26:10 +01:00
SECURITY.md Create SECURITY.md (#1357) 2019-05-31 08:58:21 +01:00
stack-snapshot.yaml replace DAML Authors with DA in copyright headers (#5228) 2020-03-27 01:26:10 +01:00
tsconfig.json open-sourcing daml 2019-04-04 09:33:38 +01:00
unreleased.rst replace DAML Authors with DA in copyright headers (#5228) 2020-03-27 01:26:10 +01:00
unreleased.sh replace DAML Authors with DA in copyright headers (#5228) 2020-03-27 01:26:10 +01:00
Upgrading.md Replace Hazel by stack_snapshot (#2743) 2019-11-22 14:24:08 +00:00
WORKSPACE Consistently replace zip by bazel_tools zipper (#5215) 2020-03-26 17:38:03 +01:00
workspace_status.sh replace DAML Authors with DA in copyright headers (#5228) 2020-03-27 01:26:10 +01:00
yarn.lock Bump acorn from 6.1.1 to 6.4.1 (#5006) 2020-03-16 12:26:08 +01:00

DAML logo

Download License Build

Copyright 2020 Digital Asset (Switzerland) GmbH and/or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0

Welcome to the DAML repository!

This repository hosts all code for the DAML smart contract language and SDK, originally created by Digital Asset. DAML is an open-source smart contract language for building future-proof distributed applications on a safe, privacy-aware runtime. The DAML SDK is a set of tools to help you develop applications based on DAML.

Using DAML

To download DAML, follow the installation instructions. Once installed, to try it out, follow the quickstart guide.

If you have questions about how to use DAML or how to build DAML-based solutions, please ask them on StackOverflow using the daml tag.

Contributing to DAML

We warmly welcome contributions. If you are looking for ideas on how to contribute, please browse our issues. To build and test DAML:

1. Clone this repository

git clone git@github.com:digital-asset/daml.git
cd daml

2. Set up the development dependencies

Our builds require various development dependencies (e.g. Java, Bazel, Python), provided by a tool called dev-env.

Linux and Mac

On Linux and Mac dev-env can be installed with:

  1. Install Nix by running: bash <(curl https://nixos.org/nix/install)
  2. Enter dev-env by running: eval "$(dev-env/bin/dade assist)"

If you don't want to enter dev-env manually each time using eval "$(dev-env/bin/dade assist)", you can also install direnv. This repo already provides a .envrc file, with an option to add more in a .envrc.private file.

Windows

On Windows you need to enable long file paths by running the following command in an admin powershell:

Set-ItemProperty -Path 'HKLM:\SYSTEM\CurrentControlSet\Control\FileSystem' -Name LongPathsEnabled -Type DWord -Value 1

Then start dev-env from PowerShell with:

.\dev-env\windows\bin\dadew.ps1 install
.\dev-env\windows\bin\dadew.ps1 sync
.\dev-env\windows\bin\dadew.ps1 enable

In all new PowerShell processes started, you need to repeat the enable step.

3. First build and test

We have a single script to build most targets and run the tests. On Linux and Mac run ./build.sh. On Windows run .\build.ps1. Note that these scripts may take over an hour the first time.

To just build do bazel build //..., and to just test do bazel test //.... To read more about Bazel and how to use it, see the Bazel site.

On Mac if building is causing trouble complaining about missing nix packages, you can try first running nix-build -A tools -A cached nix repeatedly until it completes without error.

4. Installing a local copy

On Linux and Mac run daml-sdk-head which installs a version of the SDK with version number 0.0.0. Set the version: field in any DAML project to 0.0.0 and it will use the locally installed one.

On Windows:

bazel build //release:sdk-release-tarball
tar -vxf .\bazel-bin\release\sdk-release-tarball.tar.gz
cd sdk-*
daml\daml.exe install . --activate

That should tell you what to put in the path, something along the lines of C:\Users\admin\AppData\Roaming\daml\bin. Note that the Windows build is not yet fully functional.

Caching: build speed and disk space considerations

Bazel has a lot of nice properties, but they come at the cost of frequently rebuilding "the world". To make that bearable, we make extensive use of caching. Most artifacts should be cached in our CDN, which is configured in .bazelrc in this project.

However, even then, you may end up spending a lot of time (and bandwidth!) downloading artifacts from the CDN. To alleviate that, by default, our build will create a subfolder .bazel-cache in this project and keep an on-disk cache. This can take about 10GB at the time of writing.

To disable the disk cache, remove the following lines:

build:linux --disk_cache=.bazel-cache
build:darwin --disk_cache=.bazel-cache

from the .bazelrc file.

If you work with multiple copies of this repository, you can point all of them to the same disk cache by overwriting these configs in either a .bazelrc.local file in each copy, or a ~/.bazelrc file in your home directory.

Haskell profiling builds

To build Haskell executables with profiling enabled, pass -c dbg to Bazel, e.g. bazel build -c dbg damlc. If you want to build the whole SDK with profiling enabled use daml-sdk-head --profiling.