Skip to content

Commit 738c598

Browse files
committed
Prepare Changelog and schema for sancho-3-0-0
1 parent 213f4d4 commit 738c598

File tree

2 files changed

+37
-20
lines changed

2 files changed

+37
-20
lines changed

cardano-db-sync/CHANGELOG.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,13 @@ Some useful links (adjust the numbers to the correct tag):
1818

1919
In the schema docs, you can search for `13.2` or `Conway` for schema changes from the previous official release.
2020

21-
### sancho-next
22-
- Renamed table governance_action to gov_action_proposal
23-
- Replaced new_committee.quorum to new_committee.quorum_nominator and new_committee.quorum_denominator
24-
- always_abstain and always_no_confidence drep_hash entries now have a null `raw` value and the unique key changed
25-
- governance_action.description now uses the json format
26-
- new offchain capabilites for voting anchor
27-
- add a constitution table
21+
### sancho-3.0.0
22+
- Renamed table `governance_action` to `gov_action_proposal`
23+
- Replaced `new_committee.quorum` to `new_committee.quorum_nominator` and `new_committee.quorum_denominator`
24+
- `always_abstain` and `always_no_confidence` `drep_hash` entries now have a null `raw` value and the unique key changed
25+
- `governance_action.description` now uses the json format
26+
- Added new offchain capabilites for voting anchor: the `off_chain_vote_data` and `off_chain_vote_fetch_error` are now populated
27+
- Added a constitution table
2828

2929
### sancho-2.3.0
3030
- is compatible with node 8.7-pre

doc/schema.md

Lines changed: 30 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Schema Documentation for cardano-db-sync
22

3-
Schema version: 13.2.0.0 (from branch **kderme/update-node-8-7** which may not accurately reflect the version number)
3+
Schema version: 13.2.0.0 (from branch **kderme/sancho-3-0-0** which may not accurately reflect the version number)
44
**Note:** This file is auto-generated from the documentation in cardano-db/src/Cardano/Db/Schema.hs by the command `cabal run -- gen-schema-docs doc/schema.md`. This document should only be updated during the release process and updated on the release branch.
55

66
### `schema_version`
@@ -835,9 +835,9 @@ A table for every Anchor that appears on Governance Actions. These are pointers
835835
| `data_hash` | blob | A hash of the contents of the metadata URL |
836836
| `url` | varchar | A URL to a JSON payload of metadata |
837837

838-
### `governance_action`
838+
### `gov_action_proposal`
839839

840-
A table for proposed GovernanceAction, aka ProposalProcedure, GovAction or GovProposal. At most one of the ratified/enacted/dropped/expired epoch field can be non-null, indicating the current state of the proposal. This table may be referenced by TreasuryWithdrawal or NewCommittee. New in 13.2-Conway.
840+
A table for proposed GovActionProposal, aka ProposalProcedure, GovAction or GovProposal. At most one of the ratified/enacted/dropped/expired epoch field can be non-null, indicating the current state of the proposal. This table may be referenced by TreasuryWithdrawal or NewCommittee. New in 13.2-Conway.
841841

842842
* Primary Id: `id`
843843

@@ -846,12 +846,13 @@ A table for proposed GovernanceAction, aka ProposalProcedure, GovAction or GovPr
846846
| `id` | integer (64) | |
847847
| `tx_id` | integer (64) | The Tx table index of the tx that includes this certificate. |
848848
| `index` | integer (64) | The index of this proposal procedure within its transaction. |
849+
| `prev_gov_action_proposal` | integer (64) | The previous related GovActionProposal. This is null for |
849850
| `deposit` | lovelace | The deposit amount payed for this proposal. |
850851
| `return_address` | integer (64) | The StakeAddress index of the reward address to receive the deposit when it is repaid. |
851852
| `expiration` | word31type | Shows the epoch at which this governance action will expire. |
852853
| `voting_anchor_id` | integer (64) | The Anchor table index related to this proposal. |
853854
| `type` | govactiontype | Can be one of ParameterChange, HardForkInitiation, TreasuryWithdrawals, NoConfidence, NewCommittee, NewConstitution, InfoAction |
854-
| `description` | string | A Text describing the content of this GovernanceAction in a readable way. |
855+
| `description` | string | A Text describing the content of this GovActionProposal in a readable way. |
855856
| `param_proposal` | integer (64) | If this is a param proposal action, this has the index of the param_proposal table. |
856857
| `ratified_epoch` | word31type | If not null, then this proposal has been ratified at the specfied epoch. TODO: This is currently always null. |
857858
| `enacted_epoch` | word31type | If not null, then this proposal has been enacted at the specfied epoch. |
@@ -860,31 +861,45 @@ A table for proposed GovernanceAction, aka ProposalProcedure, GovAction or GovPr
860861

861862
### `treasury_withdrawal`
862863

863-
A table for all treasury withdrawals proposed on a GovernanceAction. New in 13.2-Conway.
864+
A table for all treasury withdrawals proposed on a GovActionProposal. New in 13.2-Conway.
864865

865866
* Primary Id: `id`
866867

867868
| Column name | Type | Description |
868869
|-|-|-|
869870
| `id` | integer (64) | |
870-
| `governance_action_id` | integer (64) | The GovernanceAction table index for this withdrawal.Multiple TreasuryWithdrawal may reference the same GovernanceAction. |
871+
| `gov_action_proposal_id` | integer (64) | The GovActionProposal table index for this withdrawal.Multiple TreasuryWithdrawal may reference the same GovActionProposal. |
871872
| `stake_address_id` | integer (64) | The address that benefits from this withdrawal. |
872873
| `amount` | lovelace | The amount for this withdrawl. |
873874

874875
### `new_committee`
875876

876-
A table for new committee proposed on a GovernanceAction. New in 13.2-Conway.
877+
A table for new committee proposed on a GovActionProposal. New in 13.2-Conway.
877878

878879
* Primary Id: `id`
879880

880881
| Column name | Type | Description |
881882
|-|-|-|
882883
| `id` | integer (64) | |
883-
| `governance_action_id` | integer (64) | The GovernanceAction table index for this new committee. |
884-
| `quorum` | double | The proposed quorum. |
884+
| `gov_action_proposal_id` | integer (64) | The GovActionProposal table index for this new committee. |
885+
| `quorum_nominator` | integer (64) | The proposed quorum nominator. |
886+
| `quorum_denominator` | integer (64) | The proposed quorum denominator. |
885887
| `deleted_members` | string | The removed members of the committee. This is now given in a text as a description, but may change. TODO: Conway. |
886888
| `added_members` | string | The new members of the committee. This is now given in a text as a description, but may change. TODO: Conway. |
887889

890+
### `constitution`
891+
892+
A table for constitutiona attached to a GovActionProposal. New in 13.2-Conway.
893+
894+
* Primary Id: `id`
895+
896+
| Column name | Type | Description |
897+
|-|-|-|
898+
| `id` | integer (64) | |
899+
| `gov_action_proposal_id` | integer (64) | The GovActionProposal table index for this constitution. |
900+
| `voting_anchor_id` | integer (64) | The ConstitutionVotingAnchor table index for this constitution. |
901+
| `script_hash` | hash28type | The Script Hash. It's associated script may not be already inserted in the script table. |
902+
888903
### `voting_procedure`
889904

890905
A table for voting procedures, aka GovVote. A Vote can be Yes No or Abstain. New in 13.2-Conway.
@@ -896,7 +911,7 @@ A table for voting procedures, aka GovVote. A Vote can be Yes No or Abstain. New
896911
| `id` | integer (64) | |
897912
| `tx_id` | integer (64) | The Tx table index of the tx that includes this VotingProcedure. |
898913
| `index` | integer (32) | The index of this VotingProcedure within this transaction. |
899-
| `governance_action_id` | integer (64) | The index of the GovernanceAction that this vote targets. |
914+
| `gov_action_proposal_id` | integer (64) | The index of the GovActionProposal that this vote targets. |
900915
| `voter_role` | voterrole | The role of the voter. Can be one of ConstitutionalCommittee, DRep, SPO. |
901916
| `committee_voter` | blob | |
902917
| `drep_voter` | integer (64) | |
@@ -949,9 +964,9 @@ A table containing pool offchain data fetch errors.
949964
| `fetch_error` | string | The text of the error. |
950965
| `retry_count` | word31type | The number of retries. |
951966

952-
### `off_chain_voting_data`
967+
### `off_chain_vote_data`
953968

954-
The table with the offchain metadata related to Vote Anchors. New in 13.2-Conway.
969+
The table with the offchain metadata related to Vote Anchors. It accepts metadata in a more lenient way than what's decribed in CIP-100. New in 13.2-Conway.
955970

956971
* Primary Id: `id`
957972

@@ -962,8 +977,9 @@ The table with the offchain metadata related to Vote Anchors. New in 13.2-Conway
962977
| `hash` | blob | The hash of the offchain data. |
963978
| `json` | jsonb | The payload as JSON. |
964979
| `bytes` | bytea | The raw bytes of the payload. |
980+
| `warning` | string | A warning that occured while validating the metadata. |
965981

966-
### `off_chain_voting_fetch_error`
982+
### `off_chain_vote_fetch_error`
967983

968984
Errors while fetching or validating offchain Voting Anchor metadata. New in 13.2-Conway.
969985

@@ -974,6 +990,7 @@ Errors while fetching or validating offchain Voting Anchor metadata. New in 13.2
974990
| `id` | integer (64) | |
975991
| `voting_anchor_id` | integer (64) | The VotingAnchor table index this offchain fetch error refers. |
976992
| `fetch_error` | string | The text of the error. |
993+
| `fetch_time` | timestamp | |
977994
| `retry_count` | word31type | The number of retries. |
978995

979996
### `reserved_pool_ticker`

0 commit comments

Comments
 (0)