Welcome to Your XYB Ledger Environment
Once your Ledger environment has been provisioned by the XYB infrastructure team, you're ready to begin interacting with your dedicated financial ledger instance. This article will help you understand what’s included, what tools are available to you, and how to begin working with your environment.
What You’ll Receive
After provisioning, you will receive the following from the XYB team:
1. A Hosted Ledger Endpoint
This is your live instance of the Ledger service, hosted in your designated region.
Example:
https://cac-ledger-svc.gtm-prod.euw1.aws.xyb.io
This endpoint allows you to:
Connect to the Ledger using the CLI tool
Integrate programmatically via secure API requests
Register agents, define roles, and configure operational flows
2. The Ledger CLI Tool (luca)
luca)A command-line tool packaged as a JAR file that allows you to:
Configure and introspect your environment
Create roles, agents, and cohorts
Transition the service between operational states (e.g., BOOTSTRAPPING → MASTERING)
You will receive a download link to the CLI file:
curl -L -o luca-cli.jar "https://download.xyb.co/release/luca-cli/..."Learn how to install and set up the CLI.
3. Messaging Configuration
If your integration uses event-based messaging, you’ll receive:
Kafka topic names (for async request/response workflows)
OR
HTTP endpoints (for synchronous messaging)
These channels allow you to send and receive transaction requests in real time.
4. API Access & Authentication (If Applicable)
If you intend to integrate with the Ledger via REST APIs, you’ll need to:
Generate a cryptographic key pair (public/private)
Register your public key with XYB
Use your private key to sign JWTs for authenticated API calls
Learn how to authenticate API requests
5. Console Access (UI)
You’ll also receive credentials for accessing the Ledger Console - a web-based dashboard that lets you:
Perform administrative operations via an intuitive interface
What You Can Do Next
Install the CLI tool Set up your CLI wrapper and verify connectivity.
Note: Some CLI actions (like managing agents or interacting via API) require JWT-based authentication.
Define roles and agents Assign access controls to specific agents for different operations.
(Optional) Set up messaging channels Configure Kafka or HTTP endpoints to send/receive transaction requests.
Last updated