feat(cip1694): preparatory work

package.json

@@ -26,7 +26,7 @@
   "dependencies": {
     "@blockfrost/blockfrost-js": "5.4.0",
     "@blockfrost/blockfrost-utils": "2.8.0",
-    "@blockfrost/openapi": "0.1.60",
+    "@blockfrost/openapi": "0.1.61-beta.0",
     "@emurgo/cardano-serialization-lib-nodejs": "11.5.0",
     "@emurgo/cip14-js": "^3.0.1",
     "@fastify/cors": "^8.3.0",

src/routes/governance/dreps/hash/index.ts

@@ -1,23 +1,22 @@
 import { FastifyInstance, FastifyRequest } from 'fastify';
-import * as QueryTypes from '../../../../types/queries/blocks.js';
-import * as ResponseTypes from '../../../../types/responses/blocks.js';
+import * as QueryTypes from '../../../../types/queries/governance.js';
+import * as ResponseTypes from '../../../../types/responses/governance.js';
 import { getDbSync } from '../../../../utils/database.js';
 import { handle404 } from '../../../../utils/error-handler.js';
 import { SQLQuery } from '../../../../sql/index.js';
-import { DrepRequestParameters } from '../../../../types/queries/governance.js';
 
 async function route(fastify: FastifyInstance) {
   fastify.route({
     url: '/governance/dreps/:hash',
     method: 'GET',
     // TODO: add schema when available
     // schema: getSchemaForEndpoint('/governance/dreps/{hash}'),
-    handler: async (request: FastifyRequest<DrepRequestParameters>, reply) => {
+    handler: async (request: FastifyRequest<QueryTypes.RequestParametersDRepID>, reply) => {
       const clientDbSync = await getDbSync(fastify);
 
-      const { rows }: { rows: ResponseTypes.Block[] } = await clientDbSync.query<QueryTypes.Block>(
-        SQLQuery.get('governance_dreps_details'),
-        [request.params.hash],
+      const { rows }: { rows: ResponseTypes.DRepsDrepID } = await clientDbSync.query<QueryTypes.DRepsDrepID>(
+        SQLQuery.get('governance_dreps_drep_id'),
+        [request.params.drep_id],
       );
 
       clientDbSync.release();

src/routes/governance/dreps/index.ts

@@ -1,22 +1,21 @@
 import { FastifyInstance, FastifyRequest } from 'fastify';
 import { SQLQuery } from '../../../sql/index.js';
-import * as QueryTypes from '../../../types/queries/epochs.js';
-import * as ResponseTypes from '../../../types/responses/epochs.js';
+import * as QueryTypes from '../../../types/queries/governance.js';
+import * as ResponseTypes from '../../../types/responses/governance.js';
 import { getDbSync } from '../../../utils/database.js';
-import { DrepRequestParameters } from '../../../types/queries/governance.js';
+import { getSchemaForEndpoint } from '@blockfrost/openapi';
 
 async function route(fastify: FastifyInstance) {
   fastify.route({
     url: '/governance/dreps',
     method: 'GET',
-    // TODO: add schema when available
-    // schema: getSchemaForEndpoint('/epochs/latest'),
-    handler: async (request: FastifyRequest<DrepRequestParameters>, reply) => {
+    schema: getSchemaForEndpoint('/governance/dreps'),
+    handler: async (request: FastifyRequest<QueryTypes.RequestParameters>, reply) => {
       const clientDbSync = await getDbSync(fastify);
 
       try {
-        const { rows }: { rows: ResponseTypes.Epoch[] } =
-          await clientDbSync.query<QueryTypes.Epoch>(SQLQuery.get('governance_dreps'), [
+        const { rows }: { rows: ResponseTypes.DReps } =
+          await clientDbSync.query<QueryTypes.DReps>(SQLQuery.get('governance_dreps'), [
             request.query.order,
             request.query.count,
             request.query.page,

src/sql/index.ts

@@ -88,8 +88,10 @@ const QUERY_FILES = {
   epochs_number_stakes_pool_id_unpaged: 'epochs/unpaged/epochs_number_stakes_pool_id.sql',
   epochs_pool_404: 'epochs/epochs_pool_404.sql',
   governance_dreps: 'governance/dreps.sql',
-  governance_dreps_details: 'governance/dreps_detail.sql',
-  governance_dreps_distribution: 'governance/dreps_distribution.sql',
+  governance_dreps_drep_id: 'governance/dreps_drep_id.sql',
+  governance_dreps_drep_id_delegators: 'governance/dreps_drep_id_delegators.sql',
+  governance_dreps_drep_id_metadata: 'governance/dreps_drep_id_metadata.sql',
+  governance_dreps_drep_id_updates: 'governance/dreps_drep_id_updates.sql',
   metadata_txs_labels: 'metadata/metadata_txs_labels.sql',
   metadata_txs_labels_unpaged: 'metadata/unpaged/metadata_txs_labels.sql',
   metadata_txs_labels_label: 'metadata/metadata_txs_labels_label.sql',

src/types/queries/governance.ts

@@ -1,12 +1,33 @@
 import { Order } from '../common.js';
 
-export interface DrepRequestParameters {
+export interface RequestParameters {
+  Querystring: {
+    count: number;
+    page: number;
+    order: Order;
+  };
+}
+export interface RequestParametersDRepID {
   Params: {
-    hash: string;
+    drep_id: string;
   };
   Querystring: {
     count: number;
     page: number;
     order: Order;
   };
 }
+
+export interface DReps {
+  drep_id: string;
+  hex: string;
+}
+
+export interface DRepsDrepID {
+  drep_id: string;
+  hex: string;
+  amount: string;
+  active: boolean;
+  active_epoch: number | null;
+  has_script: boolean;
+}

src/types/responses/governance.ts

@@ -0,0 +1,9 @@
+import type { OpenApiResponseTypes } from '../openapi-wrapper';
+
+export type DReps = OpenApiResponseTypes['drep_content'];
+export type DRepsDrepID = OpenApiResponseTypes['drep_details_content'];
+export type DRepsDrepIDMetadata = OpenApiResponseTypes['drep_metadata'];
+export type DRepsDrepIDUpdates = OpenApiResponseTypes['drep_updates'];
+export type DRepsDrepIDDelegators = OpenApiResponseTypes['drep_delegators'];
+
+

yarn-project.nix

@@ -144,7 +144,7 @@ cacheEntries = {
 "JSONStream@npm:1.3.5" = { filename = "JSONStream-npm-1.3.5-1987f2e6dd-2605fa1242.zip"; sha512 = "2605fa124260c61bad38bb65eba30d2f72216a78e94d0ab19b11b4e0327d572b8d530c0c9cc3b0764f727ad26d39e00bf7ebad57781ca6368394d73169c59e46"; };
 "eslint-plugin-prettier@npm:5.0.0" = { filename = "eslint-plugin-prettier-npm-5.0.0-2f21113cba-84e88744b9.zip"; sha512 = "84e88744b9050f2d5ef31b94e85294dda16f3a53c2449f9d33eac8ae6264889b459bf35a68e438fb6b329c2a1d6491aac4bfa00d86317e7009de3dad0311bec6"; };
 "supertest@npm:6.3.3" = { filename = "supertest-npm-6.3.3-2e2b5bc83a-38239e517f.zip"; sha512 = "38239e517f7ba62b7a139a79c5c48d55f8d67b5ff4b6e51d5b07732ca8bbc4a28ffa1b10916fbb403dd013a054dbf028edc5850057d9a43aecbff439d494673e"; };
-"@blockfrost/openapi@npm:0.1.60" = { filename = "@blockfrost-openapi-npm-0.1.60-64f77da01a-2ab66de532.zip"; sha512 = "2ab66de532917fef3f1e88ab0cbb4259f79ba9b73fd865cd815f1e836d596de4394ece2914bd8b5ac8f0d38a7f7e11226a6a21ec298a4becf4d273e40abb08f4"; };
+"@blockfrost/openapi@npm:0.1.61-beta.0" = { filename = "@blockfrost-openapi-npm-0.1.61-beta.0-32e9de66b5-d8041d9159.zip"; sha512 = "d8041d9159784111a639810d8297f5787608eabd6dcdf0d9b3648f8f8c7ce0598ca3cc6afb0a8fa99ce51e5176ca187f264839a4fdf7a2fa0d888a796d8a7064"; };
 "@types/pg@npm:8.10.2" = { filename = "@types-pg-npm-8.10.2-de8ade0e64-49da89f64c.zip"; sha512 = "49da89f64cec1bd12a3fbc0c72b17d685c2fee579726a529f62fcab395dbc5696d80455073409947a577164b3c53a90181a331e4a5d9357679f724d4ce37f4b9"; };
 "axios@npm:1.5.0" = { filename = "axios-npm-1.5.0-35a845e191-e7405a5dbb.zip"; sha512 = "e7405a5dbbea97760d0e6cd58fecba311b0401ddb4a8efbc4108f5537da9b3f278bde566deb777935a960beec4fa18e7b8353881f2f465e4f2c0e949fead35be"; };
 "@types/express@npm:4.17.17" = { filename = "@types-express-npm-4.17.17-46fe8173db-0196dacc27.zip"; sha512 = "0196dacc275ac3ce89d7364885cb08e7fb61f53ca101f65886dbf1daf9b7eb05c0943e2e4bbd01b0cc5e50f37e0eea7e4cbe97d0304094411ac73e1b7998f4da"; };
@@ -162,15 +162,15 @@ cacheEntries = {
 "@blockfrost/blockfrost-js@npm:5.4.0" = { filename = "@blockfrost-blockfrost-js-npm-5.4.0-32c36ce5a9-76bdd7e1b4.zip"; sha512 = "76bdd7e1b4d5b386db0db66be648123b22d03808b66f42f85bf0899cc67170922cec6b9b289fd797db1a27c752b20c931a7586f5b4a0bdce2c2c07599c2bc4eb"; };
 "@blockfrost/blockfrost-tests@npm:1.10.0" = { filename = "@blockfrost-blockfrost-tests-npm-1.10.0-51b0cc8326-8cfb3d6ef5.zip"; sha512 = "8cfb3d6ef52f6f5a6da0e2f8ad5088c39e3c1546ee7f3147ab923860364101d17d589e22d5b80a0c78efeb43df59cb77271b15718a1bc7a251167dd24ca04afd"; };
 "@blockfrost/blockfrost-utils@npm:2.8.0" = { filename = "@blockfrost-blockfrost-utils-npm-2.8.0-7809fac5e3-f46163e55d.zip"; sha512 = "f46163e55d2ad686efcf8eadd9d10a320ba866acb75a829620eed9ccbe356ad2b53e29e36ead37a8b6eb62a38ac4d97c959a3fbc3d9994b6f2fdd2274a38bc08"; };
-"yaml@npm:2.2.1" = { filename = "yaml-npm-2.2.1-b7f7f5e84d-84f68cbe46.zip"; sha512 = "84f68cbe462d5da4e7ded4a8bded949ffa912bc264472e5a684c3d45b22d8f73a3019963a32164023bdf3d83cfb6f5b58ff7b2b10ef5b717c630f40bd6369a23"; };
+"yaml@npm:2.3.4" = { filename = "yaml-npm-2.3.4-8bb6dc2c0d-e6d1dae1c6.zip"; sha512 = "e6d1dae1c6383bcc8ba11796eef3b8c02d5082911c6723efeeb5ba50fc8e881df18d645e64de68e421b577296000bea9c75d6d9097c2f6699da3ae0406c030d8"; };
 "mnemonist@npm:0.39.5" = { filename = "mnemonist-npm-0.39.5-cbd4ee161e-6669d687a4.zip"; sha512 = "6669d687a434226924b2c84ee6eb7ce7d0f83dfc5caad8bcc164c73c0c11fb6d43cbe32636e710f068046f4b40a56c3032532554e93e02640aafc6ca3dd222e6"; };
 "@types/node@npm:14.14.28" = { filename = "@types-node-npm-14.14.28-f643c75c74-a8dcec1fc4.zip"; sha512 = "a8dcec1fc45a8c1573f519d33d1d017562432f939a5ec2fd6f71343a51085b2c5d105db1186086cd1bba9abf95e80c7538ef2eb459e8719d48b77458eb19be64"; };
 "pg-protocol@npm:1.5.0" = { filename = "pg-protocol-npm-1.5.0-390f8d9ed8-b839d12caf.zip"; sha512 = "b839d12cafe942ef9cbc5b13c174eb2356804fb4fe8ead8279f46a36be90722d19a91409955beb8a3d5301639c44854e49749de4aef02dc361fee3e2a61fb1e4"; };
 "@types/superagent@npm:4.1.10" = { filename = "@types-superagent-npm-4.1.10-56c7076140-19bef11de0.zip"; sha512 = "19bef11de02b0d319459d3993612637a95005ba8f2ca18b370253bb379aa0c38fdf7cff461a6d9258e9e8ef4495b7b04b8f7f4284998305b77eccc8e05ef2750"; };
 "follow-redirects@npm:1.15.2" = { filename = "follow-redirects-npm-1.15.2-1ec1dd82be-faa66059b6.zip"; sha512 = "faa66059b66358ba65c234c2f2a37fcec029dc22775f35d9ad6abac56003268baf41e55f9ee645957b32c7d9f62baf1f0b906e68267276f54ec4b4c597c2b190"; };
 "proxy-from-env@npm:1.1.0" = { filename = "proxy-from-env-npm-1.1.0-c13d07f26b-ed7fcc2ba0.zip"; sha512 = "ed7fcc2ba0a33404958e34d95d18638249a68c430e30fcb6c478497d72739ba64ce9810a24f53a7d921d0c065e5b78e3822759800698167256b04659366ca4d4"; };
 "prettier-linter-helpers@npm:1.0.0" = { filename = "prettier-linter-helpers-npm-1.0.0-6925131a7e-00ce8011cf.zip"; sha512 = "00ce8011cf6430158d27f9c92cfea0a7699405633f7f1d4a45f07e21bf78e99895911cbcdc3853db3a824201a7c745bd49bfea8abd5fb9883e765a90f74f8392"; };
-"cbor@npm:8.1.0" = { filename = "cbor-npm-8.1.0-c1a4d6266a-a90338435d.zip"; sha512 = "a90338435dc7b45cc01461af979e3bb6ddd4f2a08584c437586039cd5f2235014c06e49d664295debbfb3514d87b2f06728092ab6aa6175e2e85e9cd7dc0c1fd"; };
+"cbor@npm:9.0.1" = { filename = "cbor-npm-9.0.1-3a5a6b7751-42333ac3d4.zip"; sha512 = "42333ac3d42cc3f6fcc7a529e68417a2dd8099eda43ca4be1304cdc5bc7494efe058e2db8a3d3b46ae60d69c7331ea813c22dbd019c4ac592d23e599d72bbcc9"; };
 "blake2b@npm:2.1.3" = { filename = "blake2b-npm-2.1.3-b5b61ec9ad-e652234249.zip"; sha512 = "e652234249cbdb3345488d52b5e76e8572b8e5333f3f0d5e716772b7c5d2142f433c3fe86130e92117329532e1d1235cdaa89f40bbca27a8ae528bef428241ef"; };
 "@sentry/node@npm:7.69.0" = { filename = "@sentry-node-npm-7.69.0-5b1090f2f6-97210ced96.zip"; sha512 = "97210ced968a3d968fd9d93e67e1f3c9613b99b223f87fad944e6e94db40ebc10a7c339c848e0529c5ded69f94f1f689b4a6df1da4df1aad6663a752ac591d03"; };
 "@types/qs@npm:6.9.7" = { filename = "@types-qs-npm-6.9.7-4a3e6ca0d0-7fd6f9c250.zip"; sha512 = "7fd6f9c25053e9b5bb6bc9f9f76c1d89e6c04f7707a7ba0e44cc01f17ef5284adb82f230f542c2d5557d69407c9a40f0f3515e8319afd14e1e16b5543ac6cdba"; };
@@ -295,6 +295,7 @@ cacheEntries = {
 "make-error@npm:1.3.6" = { filename = "make-error-npm-1.3.6-ccb85d9458-b86e5e0e25.zip"; sha512 = "b86e5e0e25f7f777b77fabd8e2cbf15737972869d852a22b7e73c17623928fccb826d8e46b9951501d3f20e51ad74ba8c59ed584f610526a48f8ccf88aaec402"; };
 "v8-compile-cache-lib@npm:3.0.1" = { filename = "v8-compile-cache-lib-npm-3.0.1-4886071ece-78089ad549.zip"; sha512 = "78089ad549e21bcdbfca10c08850022b22024cdcc2da9b168bcf5a73a6ed7bf01a9cebb9eac28e03cd23a684d81e0502797e88f3ccd27a32aeab1cfc44c39da0"; };
 "yn@npm:3.1.1" = { filename = "yn-npm-3.1.1-8ad4259784-2c487b0e14.zip"; sha512 = "2c487b0e149e746ef48cda9f8bad10fc83693cd69d7f9dcd8be4214e985de33a29c9e24f3c0d6bcf2288427040a8947406ab27f7af67ee9456e6b84854f02dd6"; };
+"yaml@npm:2.2.1" = { filename = "yaml-npm-2.2.1-b7f7f5e84d-84f68cbe46.zip"; sha512 = "84f68cbe462d5da4e7ded4a8bded949ffa912bc264472e5a684c3d45b22d8f73a3019963a32164023bdf3d83cfb6f5b58ff7b2b10ef5b717c630f40bd6369a23"; };
 "pg-int8@npm:1.0.1" = { filename = "pg-int8-npm-1.0.1-5cd67f3e22-a1e3a05a69.zip"; sha512 = "a1e3a05a69005ddb73e5f324b6b4e689868a447c5fa280b44cd4d04e6916a344ac289e0b8d2695d66e8e89a7fba023affb9e0e94778770ada5df43f003d664c9"; };
 "pg-numeric@npm:1.0.2" = { filename = "pg-numeric-npm-1.0.2-9026ec3427-8899f8200c.zip"; sha512 = "8899f8200caa1744439a8778a9eb3ceefb599d893e40a09eef84ee0d4c151319fd416634a6c0fc7b7db4ac268710042da5be700b80ef0de716fe089b8652c84f"; };
 "postgres-array@npm:3.0.2" = { filename = "postgres-array-npm-3.0.2-da6a3f1fed-5955f9dffe.zip"; sha512 = "5955f9dffeb6fa960c1a0b04fd4b2ba16813ddb636934ad26f902e4d76a91c0b743dcc6edc4cffc52deba7d547505e0020adea027c1d50a774f989cf955420d1"; };
@@ -323,6 +324,7 @@ cacheEntries = {
 "strip-json-comments@npm:3.1.1" = { filename = "strip-json-comments-npm-3.1.1-dcb2324823-492f73e272.zip"; sha512 = "492f73e27268f9b1c122733f28ecb0e7e8d8a531a6662efbd08e22cccb3f9475e90a1b82cab06a392f6afae6d2de636f977e231296400d0ec5304ba70f166443"; };
 "@sinonjs/commons@npm:2.0.0" = { filename = "@sinonjs-commons-npm-2.0.0-3716f24f20-5023ba17ed.zip"; sha512 = "5023ba17edf2b85ed58262313b8e9b59e23c6860681a9af0200f239fe939e2b79736d04a260e8270ddd57196851dde3ba754d7230be5c5234e777ae2ca8af137"; };
 "@cspotcode/source-map-support@npm:0.8.1" = { filename = "@cspotcode-source-map-support-npm-0.8.1-964f2de99d-5718f26708.zip"; sha512 = "5718f267085ed8edb3e7ef210137241775e607ee18b77d95aa5bd7514f47f5019aa2d82d96b3bf342ef7aa890a346fa1044532ff7cc3009e7d24fce3ce6200fa"; };
+"cbor@npm:8.1.0" = { filename = "cbor-npm-8.1.0-c1a4d6266a-a90338435d.zip"; sha512 = "a90338435dc7b45cc01461af979e3bb6ddd4f2a08584c437586039cd5f2235014c06e49d664295debbfb3514d87b2f06728092ab6aa6175e2e85e9cd7dc0c1fd"; };
 "assert-options@npm:0.8.1" = { filename = "assert-options-npm-0.8.1-ed3051eefd-aaf86a9c6a.zip"; sha512 = "aaf86a9c6a330e43172544ce2cc2b59bf8b4338dd0933d852e9b7efbae7b801944671e7dd6cc172d0dcfc88713009d88dca56cc34c8d4ba7fc5aeb1cf3e9bcef"; };
 "pg-minify@npm:1.6.3" = { filename = "pg-minify-npm-1.6.3-fef1d2601d-5b9868f2b9.zip"; sha512 = "5b9868f2b90b9629455db6e13c35b1228b65803bbf9fc1a02d49fe147b55bb20eed53d368bf8f9f8127a2e740697b20702702e58f4846d9f5f3749d840a14c99"; };
 "spex@npm:3.3.0" = { filename = "spex-npm-3.3.0-833f63faad-c2797eae65.zip"; sha512 = "c2797eae658e0f97b92775a9a87cd6d615e87693b4d5abfd3120543391e3eeab2755ab101489752f3ff47c1e0623737a604c5411e8f9bca7714d4e0427c182c0"; };

yarn.lock

@@ -136,14 +136,14 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@blockfrost/openapi@npm:0.1.60":
-  version: 0.1.60
-  resolution: "@blockfrost/openapi@npm:0.1.60"
+"@blockfrost/openapi@npm:0.1.61-beta.0":
+  version: 0.1.61-beta.0
+  resolution: "@blockfrost/openapi@npm:0.1.61-beta.0"
   dependencies:
-    ajv: ^8.11.2
-    cbor: ^8.1.0
-    yaml: ^2.2.1
-  checksum: 2ab66de532917fef3f1e88ab0cbb4259f79ba9b73fd865cd815f1e836d596de4394ece2914bd8b5ac8f0d38a7f7e11226a6a21ec298a4becf4d273e40abb08f4
+    ajv: ^8.12.0
+    cbor: ^9.0.1
+    yaml: ^2.3.4
+  checksum: d8041d9159784111a639810d8297f5787608eabd6dcdf0d9b3648f8f8c7ce0598ca3cc6afb0a8fa99ce51e5176ca187f264839a4fdf7a2fa0d888a796d8a7064
   languageName: node
   linkType: hard
 
@@ -1956,7 +1956,7 @@ __metadata:
     "@blockfrost/blockfrost-js": 5.4.0
     "@blockfrost/blockfrost-tests": 1.10.0
     "@blockfrost/blockfrost-utils": 2.8.0
-    "@blockfrost/openapi": 0.1.60
+    "@blockfrost/openapi": 0.1.61-beta.0
     "@emurgo/cardano-serialization-lib-nodejs": 11.5.0
     "@emurgo/cip14-js": ^3.0.1
     "@esbuild/darwin-x64": "npm:0.16.17"
@@ -2235,6 +2235,15 @@ __metadata:
   languageName: node
   linkType: hard
 
+"cbor@npm:^9.0.1":
+  version: 9.0.1
+  resolution: "cbor@npm:9.0.1"
+  dependencies:
+    nofilter: ^3.1.0
+  checksum: 42333ac3d42cc3f6fcc7a529e68417a2dd8099eda43ca4be1304cdc5bc7494efe058e2db8a3d3b46ae60d69c7331ea813c22dbd019c4ac592d23e599d72bbcc9
+  languageName: node
+  linkType: hard
+
 "chai@npm:^4.3.7":
   version: 4.3.7
   resolution: "chai@npm:4.3.7"
@@ -9355,6 +9364,13 @@ resolve@^1.10.0:
   languageName: node
   linkType: hard
 
+"yaml@npm:^2.3.4":
+  version: 2.3.4
+  resolution: "yaml@npm:2.3.4"
+  checksum: e6d1dae1c6383bcc8ba11796eef3b8c02d5082911c6723efeeb5ba50fc8e881df18d645e64de68e421b577296000bea9c75d6d9097c2f6699da3ae0406c030d8
+  languageName: node
+  linkType: hard
+
 "yamljs@npm:0.3.0":
   version: 0.3.0
   resolution: "yamljs@npm:0.3.0"