From 8e484bfc30ce386d2f057b4d13a0327753491235 Mon Sep 17 00:00:00 2001 From: Satya Date: Mon, 21 Oct 2024 15:35:57 +0800 Subject: [PATCH 1/3] Add live data page for Node-to-Client (N2C) feature Added documentation for live data integration with Cardano Node using N2C. --- docs/pages/_meta.json | 1 + docs/pages/live_n2c_data.mdx | 27 +++++++++++++++++++++++++++ 2 files changed, 28 insertions(+) create mode 100644 docs/pages/live_n2c_data.mdx diff --git a/docs/pages/_meta.json b/docs/pages/_meta.json index 8ad8a14c..7c856ecc 100644 --- a/docs/pages/_meta.json +++ b/docs/pages/_meta.json @@ -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" }, diff --git a/docs/pages/live_n2c_data.mdx b/docs/pages/live_n2c_data.mdx new file mode 100644 index 00000000..8e4fc5b0 --- /dev/null +++ b/docs/pages/live_n2c_data.mdx @@ -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. | +| `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. | +| `local_treasury_withdrawal` | Stores the current treasury withdrawal fetched from the Cardano node. | From 1f0195858d986a5522ab0af8225f9e20ddfcce03 Mon Sep 17 00:00:00 2001 From: Satya Date: Mon, 21 Oct 2024 16:01:49 +0800 Subject: [PATCH 2/3] Update description for local_drep_dist field --- docs/pages/live_n2c_data.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/pages/live_n2c_data.mdx b/docs/pages/live_n2c_data.mdx index 8e4fc5b0..26117039 100644 --- a/docs/pages/live_n2c_data.mdx +++ b/docs/pages/live_n2c_data.mdx @@ -21,7 +21,7 @@ Currently, the following tables are supported to store live data from the Cardan | `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. | +| `local_drep_dist` | Stores the current DRep stake distribution fetched from the Cardano node. | | `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. | | `local_treasury_withdrawal` | Stores the current treasury withdrawal fetched from the Cardano node. | From a6a7ca06940260bed976da98cd1c9a356b8b8077 Mon Sep 17 00:00:00 2001 From: Satya Date: Mon, 21 Oct 2024 16:16:00 +0800 Subject: [PATCH 3/3] Update descriptions for hard fork and treasury withdrawals fields --- docs/pages/live_n2c_data.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/pages/live_n2c_data.mdx b/docs/pages/live_n2c_data.mdx index 26117039..460b1141 100644 --- a/docs/pages/live_n2c_data.mdx +++ b/docs/pages/live_n2c_data.mdx @@ -23,5 +23,5 @@ Currently, the following tables are supported to store live data from the Cardan | `local_committee_member` | Stores the current committee members fetched from the Cardano node. | | `local_drep_dist` | Stores the current DRep stake distribution fetched from the Cardano node. | | `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. | -| `local_treasury_withdrawal` | Stores the current treasury withdrawal fetched from the Cardano node. | +| `local_hard_fork_initiation` | Stores the most recently enacted hard fork initiation fetched from the Cardano node. | +| `local_treasury_withdrawal` |Stores the most recently enacted treasury withdrawals fetched from the Cardano node.|