LEARN · DOCUMENTATION
Documentation
Pages from 29 sources, kept in sync: the official Canton Network and Digital Asset docs, documentation from teams building on Canton, and readmes from their code. Search all of it, or start from a path below.
3,253pages
synced 3h ago29 sources
Ecosystem
Package Manager
Package Manager The Package Manager tab connects a validator to CatalyX Package Manager (CPM) and shows the live status of its onboarding. The Package Manager tab connects…
Ecosystem
Validator CRD User Guide
Validator CRD User Guide Catalyst uses the operator pattern with Custom Resource Definitions. The same operations availa…
Ecosystem
Sandbox Mode
…andbox mode lets any signed-in user create their own DevNet validator from the CatalyX UI by entering a name. The platform fills in the network details. Sandbox mode is an optional…
Ecosystem
Create a Validator
Create a Validator A validator is declared as a single Validator custom resource. You apply it, and the operator provisions every…
Ecosystem
Validator CRD User Guide
Validator CRD User Guide Catalyst uses the operator pattern with Custom Resource Definitions. The same operations availa…
Ecosystem
Prerequisites
… Prometheus Operator A ServiceMonitor so Prometheus scrapes validator component metrics automatically. External Secrets Operator Sourcing the platform's Ke
Ecosystem
Integrations
Integrations The Integrations section of the validator details showcases the integrations with other applications. Each integration is a tab in the Integrations sect…
Ecosystem
Parties
…ternal party is, what multi-hosting means, and the complete onboarding and approval workflow — see External & Multi-Host Parties. {% endhint %} Header actions | Button | Opens | | …
Ecosystem
External & Multi-Host Parties
… %} *** Onboarding an external party Start from Parties → Onboard External Party on the validator. {% stepper %} {% step %} Iden…
Ecosystem
Release Notes
… the 2.0 line. It adds sandbox mode, which creates a DevNet validator from a name only, BitGo as a second Wallet Gateway signing provider, and advanced configuration for the Partic…
Ecosystem
Platform Installation
…n Keycloak client. From 2.0.1 the API authenticates to each validator with that validator's backend client, so the secret is no longer read. {% endhint %} {% endstep %} {% step %} …
Ecosystem
Troubleshooting
… it a configuration problem or a runtime problem? Check the validator's Ready condition on the Status tab. * InvalidSpec — configuration. The message names the field. Nothing else …
Ecosystem
Identity Dumps & Database Backups
…tity dumps, database backups, and what each one recovers. A validator has two kinds of state, and they need different protection. State Where it lives Protected by Node identity — …
Ecosystem
Registration Guide
…ails. 3. Log in to your Canton Node – Log in to your Canton validator node and install the CPM DAR file to complete the installation. {% hint style="success" %} CPM never stores or…
Ecosystem
Status & Specification
…& Specification The conditions the operator posted, and the validator's configuration as applied. Status is what the operator reports, Specification is what you asked for. Status M…
Ecosystem
Validator Backups and Identity Dumps
Validator Backups and Identity Dumps How to configure scheduled backups and identity dumps for validator nodes in Cataly…
Ecosystem
Release Notes
…e managed through a dedicated Notifications tab. * Improved Onboarding Experience The onboarding flow has been simplified to reduce friction, including: * Removal of initial billin…
Ecosystem
Participant & Keys
…info" %} Waiting for is the single most useful field during onboarding. A participant that sits here for a long time is usually waiting on the synchronizer or on network onboarding…
Ecosystem
Users & Rights
…ociated with one or more parties and is registered with the validator app, so a person can sign in to the Canton Wallet. For more depth on the party/user model, refer the the Canto…
Ecosystem
Create Validator with Integrated Keycloak
Create Validator with Integrated Keycloak {% hint style="info" %} This guide is for the Default authentication option with inte…
Ecosystem
Create Validator with Custom Identity Provider
Create Validator with Custom Identity Provider {% hint style="info" %} The alternative to this approach is using Integrated Key…
Ecosystem
Users & Wallet Users
…edger API. Wallet Users Wallet UI users registered with the validator app, so a person can sign in to the Canton Wallet. Neither creates an account in your identity provider. Both …
Ecosystem
Key Management Service (KMS)
Key Management Service (KMS) Hold the Canton participant's operational keys in an external key management service. By default a Canton participant generates its operational keys an…
Ecosystem
Validator Management with Integrated Keycloak
Validator Management with Integrated Keycloak This page explains how to use Catalyst to create and deploy Validators on …
Ecosystem
Version 2.0
…tion: Install the CAT-BM operator, API, and UI with Helm. - Validator CRD Reference: Every field on the Validator custom resource, with types and defa
Ecosystem
Validator Management with Custom Identity Provider
Validator Management with Custom Identity Provider This page explains how to create a Canton Validator using an external…
Ecosystem
Parties & Users
… * Access the Wallet UI. This process is commonly used when onboarding a new customer, validator user, or application participant. Prerequisites Before starting, ensure you have: *…
Ecosystem
FAQ
… procedure depends on your deployment. Why can't I create a validator from the UI? By design. A validator is a Validator custom resource, so creating one is a Kubernetes apply — wh…
Ecosystem
Platform and Canton Network Upgrades
…e CAT-BM platform, and upgrading Canton Network protocol or validator components. There are two independent upgrade tracks, and it helps to keep them separate. Track Changes Mechan…
Ecosystem
Validator Upgrade Policy and Release Schedule
Validator Upgrade Policy and Release Schedule CatalyX's policy and process for validator node upgrades, release validati…
Showing 1 to 30 of 34Search all sources →