Skip to content

Commit 8dea321

Browse files
committed
sqlc: improve table-level doc comments for supply tables
Refined documentation comments for the tables supply_commit_transitions and supply_update_events to improve clarity.
1 parent 8abbe1e commit 8dea321

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

tapdb/sqlc/migrations/000040_asset_commit.up.sql

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,10 @@ CREATE TABLE supply_commit_state_machines (
7676
latest_commitment_id BIGINT REFERENCES supply_commitments(commit_id)
7777
);
7878

79-
-- Table tracking a pending state transition for a state machine.
79+
-- Table tracking an in-progress transition from one supply commitment to a
80+
-- newer one. A transition represents the process of creating a new on-chain
81+
-- supply commitment that succeeds a prior version, which remains valid as a
82+
-- historical record.
8083
CREATE TABLE supply_commit_transitions (
8184
transition_id INTEGER PRIMARY KEY,
8285

@@ -102,7 +105,11 @@ CREATE TABLE supply_commit_transitions (
102105
creation_time BIGINT NOT NULL
103106
);
104107

105-
-- Table storing individual update events associated with a pending transition.
108+
-- Table recording supply update events associated with a pending supply
109+
-- commitment transition. A transition is the process of creating a newer
110+
-- on-chain supply commitment that follows a previous one. Update events are
111+
-- asset group supply-specific events handled by the supply commitment state
112+
-- machine.
106113
CREATE TABLE supply_update_events (
107114
event_id INTEGER PRIMARY KEY,
108115

0 commit comments

Comments
 (0)