Add withdrawal to proposal list incl schema

cardano-community · Jul 31, 2024 · 940cc77 · 940cc77
1 parent 8d134f9
commit 940cc77
Show file tree

Hide file tree

Showing 6 changed files with 89 additions and 21 deletions.
diff --git a/files/grest/rpc/governance/proposal_list.sql b/files/grest/rpc/governance/proposal_list.sql
@@ -16,9 +16,10 @@ RETURNS TABLE (
   meta_url text,
   meta_hash text,
   meta_json jsonb,
-  comment text,
-  language text,
-  is_valid boolean
+  meta_comment text,
+  meta_language text,
+  meta_is_valid boolean,
+  withdrawal jsonb
 )
 LANGUAGE sql STABLE
 AS $$
@@ -39,13 +40,25 @@ AS $$
     va.url AS meta_url,
     ENCODE(va.data_hash, 'hex') AS meta_hash,
     ocvd.json AS meta_json,
-    ocvd.comment AS comment,
-    ocvd.language AS language,
-    ocvd.is_valid AS is_valid
+    ocvd.comment AS meta_comment,
+    ocvd.language AS meta_language,
+    ocvd.is_valid AS meta_is_valid,
+    CASE WHEN tw.id IS NULL THEN NULL
+    ELSE
+      JSONB_BUILD_OBJECT(
+        'stake_address', (
+          SELECT sa2.view
+          FROM stake_address AS sa2
+          WHERE sa2.id = tw.stake_address_id
+        ),
+        'amount', tw.amount::text
+      )
+    END AS withdrawal
   FROM public.gov_action_proposal AS gap
     INNER JOIN public.tx ON gap.tx_id = tx.id
     INNER JOIN public.block AS b ON tx.block_id = b.id
     INNER JOIN public.stake_address AS sa ON gap.return_address = sa.id
+    LEFT JOIN public.treasury_withdrawal AS tw ON gap.id = tw.gov_action_proposal_id
     LEFT JOIN public.voting_anchor AS va ON gap.voting_anchor_id = va.id
     LEFT JOIN public.off_chain_vote_data AS ocvd ON va.id = ocvd.voting_anchor_id
   ORDER BY

diff --git a/specs/results/koiosapi-guild.yaml b/specs/results/koiosapi-guild.yaml
@@ -5167,12 +5167,23 @@ components:
             $ref: "#/components/schemas/drep_metadata/items/properties/hash"
           meta_json:
             $ref: "#/components/schemas/drep_metadata/items/properties/json"
-          comment:
+          meta_comment:
             $ref: "#/components/schemas/drep_metadata/items/properties/comment"
-          language:
+          meta_language:
             $ref: "#/components/schemas/drep_metadata/items/properties/language"
-          is_valid:
+          meta_is_valid:
             $ref: "#/components/schemas/drep_metadata/items/properties/is_valid"
+          withdrawal:
+            type:
+              - object
+              - 'null'
+            description: If not null, The amount withdrawn from treasury into stake address by this this proposal
+            properties:
+              stake_address:
+                $ref: "#/components/schemas/account_history/items/properties/stake_address"
+              amount:
+                type: string
+                example: "31235800000"
     proposal_votes:
       type: array
       description: List of all votes cast on specified governance action

diff --git a/specs/results/koiosapi-mainnet.yaml b/specs/results/koiosapi-mainnet.yaml
@@ -5167,12 +5167,23 @@ components:
             $ref: "#/components/schemas/drep_metadata/items/properties/hash"
           meta_json:
             $ref: "#/components/schemas/drep_metadata/items/properties/json"
-          comment:
+          meta_comment:
             $ref: "#/components/schemas/drep_metadata/items/properties/comment"
-          language:
+          meta_language:
             $ref: "#/components/schemas/drep_metadata/items/properties/language"
-          is_valid:
+          meta_is_valid:
             $ref: "#/components/schemas/drep_metadata/items/properties/is_valid"
+          withdrawal:
+            type:
+              - object
+              - 'null'
+            description: If not null, The amount withdrawn from treasury into stake address by this this proposal
+            properties:
+              stake_address:
+                $ref: "#/components/schemas/account_history/items/properties/stake_address"
+              amount:
+                type: string
+                example: "31235800000"
     proposal_votes:
       type: array
       description: List of all votes cast on specified governance action

diff --git a/specs/results/koiosapi-preprod.yaml b/specs/results/koiosapi-preprod.yaml
@@ -5167,12 +5167,23 @@ components:
             $ref: "#/components/schemas/drep_metadata/items/properties/hash"
           meta_json:
             $ref: "#/components/schemas/drep_metadata/items/properties/json"
-          comment:
+          meta_comment:
             $ref: "#/components/schemas/drep_metadata/items/properties/comment"
-          language:
+          meta_language:
             $ref: "#/components/schemas/drep_metadata/items/properties/language"
-          is_valid:
+          meta_is_valid:
             $ref: "#/components/schemas/drep_metadata/items/properties/is_valid"
+          withdrawal:
+            type:
+              - object
+              - 'null'
+            description: If not null, The amount withdrawn from treasury into stake address by this this proposal
+            properties:
+              stake_address:
+                $ref: "#/components/schemas/account_history/items/properties/stake_address"
+              amount:
+                type: string
+                example: "31235800000"
     proposal_votes:
       type: array
       description: List of all votes cast on specified governance action

diff --git a/specs/results/koiosapi-preview.yaml b/specs/results/koiosapi-preview.yaml
@@ -5167,12 +5167,23 @@ components:
             $ref: "#/components/schemas/drep_metadata/items/properties/hash"
           meta_json:
             $ref: "#/components/schemas/drep_metadata/items/properties/json"
-          comment:
+          meta_comment:
             $ref: "#/components/schemas/drep_metadata/items/properties/comment"
-          language:
+          meta_language:
             $ref: "#/components/schemas/drep_metadata/items/properties/language"
-          is_valid:
+          meta_is_valid:
             $ref: "#/components/schemas/drep_metadata/items/properties/is_valid"
+          withdrawal:
+            type:
+              - object
+              - 'null'
+            description: If not null, The amount withdrawn from treasury into stake address by this this proposal
+            properties:
+              stake_address:
+                $ref: "#/components/schemas/account_history/items/properties/stake_address"
+              amount:
+                type: string
+                example: "31235800000"
     proposal_votes:
       type: array
       description: List of all votes cast on specified governance action

diff --git a/specs/templates/4-api-schemas.yaml b/specs/templates/4-api-schemas.yaml
@@ -2466,12 +2466,23 @@ schemas:
             $ref: "#/components/schemas/drep_metadata/items/properties/hash"
           meta_json:
             $ref: "#/components/schemas/drep_metadata/items/properties/json"
-          comment:
+          meta_comment:
             $ref: "#/components/schemas/drep_metadata/items/properties/comment"
-          language:
+          meta_language:
             $ref: "#/components/schemas/drep_metadata/items/properties/language"
-          is_valid:
+          meta_is_valid:
             $ref: "#/components/schemas/drep_metadata/items/properties/is_valid"
+          withdrawal:
+            type:
+              - object
+              - 'null'
+            description: If not null, The amount withdrawn from treasury into stake address by this this proposal
+            properties:
+              stake_address:
+                $ref: "#/components/schemas/account_history/items/properties/stake_address"
+              amount:
+                type: string
+                example: "31235800000"
     proposal_votes:
       type: array
       description: List of all votes cast on specified governance action