Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add live data page for Node-to-Client (N2C) feature #245

Merged
merged 3 commits into from
Oct 21, 2024
Merged

Add live data page for Node-to-Client (N2C) feature #245

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8e484bf
Add live data page for Node-to-Client (N2C) feature
satran004 Oct 21, 2024
1f01958
Update description for local_drep_dist field
satran004 Oct 21, 2024
a6a7ca0
Update descriptions for hard fork and treasury withdrawals fields
satran004 Oct 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/pages/_meta.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"docker": "Run with Docker Compose",
"schema": "Schema",
"build_run": "Build & Run",
"live_n2c_data": "Live data from Node",
"applications": {
"title": "Applications"
},
Expand Down
27 changes: 27 additions & 0 deletions docs/pages/live_n2c_data.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Live Data from Cardano Node through N2C

Ledger Sync main application can be configured to read live data from a Cardano node through the Node-to-Client (N2C) connection.
This feature allows storing the current data directly from the Cardano node in the Ledger Sync database.

The live data from the Cardano Node are stored in separate tables prefixed with `local_`.

This support is only enabled if N2C settings are configured in the `application.properties` file or `.env` file (for Docker Compose setup).
To configure N2C settings, you can refer to [N2C configuration section](docker#configuring-n2c-node-to-client---optional)

## Live or Local Tables

The live data from the Cardano Node are stored in separate tables prefixed with `local_`. The live data are stored with the current epoch
number, so if the data is available for a previous epoch, it can be retrieved from the database.

Currently, the following tables are supported to store live data from the Cardano Node:

| Table Name | Description |
|--------------------------------|-----------------------------------------------------------------------------|
| `local_epoch_param` | Stores the current epoch parameters fetched from the Cardano node. |
| `local_constitution` | Stores the current constitution fetched from the Cardano node. |
| `local_committee` | Stores the current committee fetched from the Cardano node. |
| `local_committee_member` | Stores the current committee members fetched from the Cardano node. |
| `local_drep_dist` | Stores the current DRep distribution fetched from the Cardano node. |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we change "DRep distribution" to "DRep stake distribution" for more clarity?

| `local_gov_action_proposal_status` | Stores the current governance action proposal status fetched from the Cardano node. |
| `local_hard_fork_initiation` | Stores the current hard fork initiation fetched from the Cardano node. |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

now it's good but should we change to "Stores the enacted hard fork initiation actions fetched from the Cardano node." or if we describe it in the context of live data, it could be 'Stores the most recently enacted action for initiating hark fork" or something for more clarity....

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense. Let me change that.

| `local_treasury_withdrawal` | Stores the current treasury withdrawal fetched from the Cardano node. |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Similar to local_hard_fork_initiation

Loading