API Reference

Classes

Main classes provided by the package

Ledger

An append-only record of contract state changes.

Functions

Utility functions

sign()

Sign a contract with the named scheme.

summarize()

Group contracts by name for one jurisdiction.

Constants

Module-level constants and data

Signature()

Special typing form to define literal types (a.k.a. value types).

Type Aliases

Type alias definitions

Clause

A contract clause, possibly nested

ContractId

An opaque identifier for a single contract

Jurisdiction

A supported governing jurisdiction, as an ISO-ish region code

Key

A lookup keyed by either str or bytes, but not a mix of the two

Named

Contracts keyed by name, where the key type is bounded by str

Pair

Two values of the same type, e.g. a counterparty pair

Row

A heterogeneous ledger row: a leading column plus any number of others

Validator

Any predicate, however it is called