canton-proto 0.3.2

Generated Canton Ledger API v2 gRPC types and client stubs (internal to the SDK).
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101

//! Generated Canton Ledger API v2 gRPC types and client stubs.
//!
//! This crate is internal SDK plumbing: the modules mirror the proto package
//! tree (`com.daml.ledger.api.v2` and friends, plus `google.rpc`). Generated
//! code is not held to the workspace lint set.
//!
//! # Stability policy
//!
//! The generated types are **exempt from the SDK's SemVer guarantees**: their
//! shape is owned by the wire protocol, not this SDK. They track the vendored
//! `.proto` files, which are **pinned to a Canton release** (currently 3.5.7)
//! and re-vendored when the supported Canton range moves — such re-vendoring
//! (and `prost`/`tonic` major bumps) may change these types in any release.
//! Client crates expose these wire types on the **dynamic** command path
//! (re-exported as `canton_ledger::proto` and friends); treat that surface as
//! *protocol-stable* (stable while the pinned Canton release line is stable)
//! rather than *SemVer-stable*. The hand-written SDK types (`Config`, `Error`,
//! builders, clients) carry the SemVer promise. For typed payloads generated
//! from a DAR, use `canton-codegen` with the `canton-daml` runtime instead.
#![allow(missing_docs, clippy::all, clippy::pedantic, clippy::nursery)]
#![allow(clippy::large_enum_variant, clippy::doc_lazy_continuation)]
#![allow(rustdoc::all)]

/// `google.rpc` types imported by the Ledger API (e.g. `Status` in completions).
pub mod google {
    pub mod rpc {
        tonic::include_proto!("google.rpc");
    }
}

/// The canonical gRPC health-checking service (`grpc.health.v1`), which Canton
/// serves on the Ledger API port for node health probes.
pub mod grpc {
    pub mod health {
        pub mod v1 {
            tonic::include_proto!("grpc.health.v1");
        }
    }
}

/// ScalaPB custom-options types imported by the Canton admin-api protos.
pub mod scalapb {
    tonic::include_proto!("scalapb");
}

/// The Canton / Daml proto package tree (`com.daml.*` Ledger API and
/// `com.digitalasset.canton.*` admin API).
pub mod com {
    pub mod daml {
        pub mod ledger {
            pub mod api {
                pub mod v2 {
                    tonic::include_proto!("com.daml.ledger.api.v2");

                    pub mod admin {
                        tonic::include_proto!("com.daml.ledger.api.v2.admin");
                    }

                    pub mod interactive {
                        tonic::include_proto!("com.daml.ledger.api.v2.interactive");

                        pub mod transaction {
                            pub mod v1 {
                                tonic::include_proto!(
                                    "com.daml.ledger.api.v2.interactive.transaction.v1"
                                );
                            }
                        }
                    }

                    pub mod testing {
                        tonic::include_proto!("com.daml.ledger.api.v2.testing");
                    }
                }
            }
        }
    }

    /// Canton admin-api proto tree (topology read service + its dependencies).
    pub mod digitalasset {
        pub mod canton {
            pub mod crypto {
                pub mod v30 {
                    tonic::include_proto!("com.digitalasset.canton.crypto.v30");
                }
            }
            pub mod protocol {
                pub mod v30 {
                    tonic::include_proto!("com.digitalasset.canton.protocol.v30");
                }
            }
            pub mod topology {
                pub mod admin {
                    pub mod v30 {
                        tonic::include_proto!("com.digitalasset.canton.topology.admin.v30");
                    }
                }
            }
        }
    }
}