Skip to main content

high-level Ledger API client for DAML ledgers

Project description

dazl

License

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

Rich Python bindings for accessing Ledger API-based applications.

Documentation

The user documentation is available online here.

Installation

If you just want to use the library, you can install it locally with pip:

pip install --user dazl

Requirements

  • Python 3.6+
  • GNU Make
  • Poetry for build/dependency management
  • DAML SDK

Examples

All of the examples below assume you imported dazl, and are running a ledger with the default scenario generated with daml new.

Connect to the ledger and submit a single command:

with dazl.simple_client('http://localhost:6865', 'Alice') as client:
    contract = { 'issuer' : 'Alice', 'owner' : 'Alice', 'name' : 'hello world!' }
    client.ready()
    client.submit_create('Main.Asset', contract)

Connect to the ledger as a single party, print all contracts, and close:

with dazl.simple_client('http://localhost:6865', 'Alice') as client:
    # wait for the ACS to be fully read
    client.ready()
    contract_dict = client.find_active('*')
print(contract_dict)

Connect to the ledger using asynchronous callbacks:

from dazl.model.reading import ReadyEvent
network = dazl.Network()
network.set_config(url='http://localhost:6865')

alice = network.aio_party('Alice')

@alice.ledger_ready()
async def onReady(event: ReadyEvent):
  contracts = await event.acs_find_one('Main.Asset')
  print(contracts)

network.run_until_complete()

Building locally

You will need to have Poetry installed, and the dependencies fetched using poetry install. Then do:

make build

If you see errors about incompatible python versions, switch your environment to python3 using poetry env use python3, for instance.

Building Documentation

The above command will build documentation in the root docs/ dir. Committing this into source control and pushing to github will cause github-pages to be updated.

Tests

Tests in dazl are written using pytest. You can run them by doing:

make test

Project details


Release history Release notifications | RSS feed

This version

7.3.5

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dazl-7.3.5.tar.gz (246.2 kB view hashes)

Uploaded Source

Built Distribution

dazl-7.3.5-py3-none-any.whl (349.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page