Merge pull request #122 from blockfrost/1000101/2308/readme

chore: maintenance (update blockfrost packages + readme)

CHANGELOG.md

@@ -12,13 +12,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Flake now exports NixOS module
 
 ### Changed
+
 - support defining a postgres password in config or env
+- new custom index on `redeemer` table to README
+- bump blockfrost-utils to 2.7.1
+- bump blockfrost-tests to 1.9.2
+- CI to run on Node 18
 
 ### Fixed
 
 - nixpkgs updated to latest `nixos-23.05`
 - NodeJS updated to `18.16.1`
-- blockfrost-utils updated to `2.6.2`
+- README config example
+- shell.nix default to Node 18
 
 ## [1.6.0] - 2023-06-28
 

README.md

@@ -55,7 +55,7 @@ If you are using an authenticated db connection that requires a password, you'd
   dbSync: {
     host: 'cdbsync-dev.mydomain.com',
     user: 'username',
-    database: 'password',
+    database: 'dbname',
     // Optionally define a password
     password: 'randomstringthatissolongandpowerfulthatnoonecanguess'
   },
@@ -75,7 +75,7 @@ These values are `BLOCKFROST_CONFIG_SERVER_PORT`, `BLOCKFROST_CONFIG_SERVER_DEBU
 
 #### Token registry
 
-Blockfrost Backend uses token registry to provide off-chain metadata for native assets (eg. number of decimals). [The token registry](https://developers.cardano.org/docs/native-tokens/token-registry/cardano-token-registry/) operated by Cardano Foundation and hosted at https://tokens.cardano.org is used by default. You can use self-hosted registry by setting `tokenRegistryUrl` in the config file.
+Blockfrost Backend uses token registry to provide off-chain metadata for native assets (eg. number of decimals). [The token registry](https://developers.cardano.org/docs/native-tokens/token-registry/cardano-token-registry/) operated by Cardano Foundation and hosted at <https://tokens.cardano.org> is used by default. You can use self-hosted registry by setting `tokenRegistryUrl` in the config file.
 
 #### Indices
 
@@ -95,6 +95,7 @@ CREATE INDEX IF NOT EXISTS bf_idx_tx_hash ON tx USING HASH (encode(hash, 'hex'))
 CREATE UNIQUE INDEX IF NOT EXISTS bf_u_idx_epoch_stake_epoch_and_id ON epoch_stake (epoch_no, id);
 CREATE INDEX IF NOT EXISTS bf_idx_reference_tx_in_tx_in_id ON reference_tx_in (tx_in_id);
 CREATE INDEX IF NOT EXISTS bf_idx_collateral_tx_in_tx_in_id ON collateral_tx_in (tx_in_id);
+CREATE INDEX IF NOT EXISTS bf_idx_redeemer_script_hash ON redeemer USING HASH (encode(script_hash, 'hex'));
 ```
 
 ### Docker

flake.nix

@@ -6,9 +6,9 @@
   outputs = { self, nixpkgs }:
     let
       lib = nixpkgs.lib;
-      supportedSystems = [ 
+      supportedSystems = [
         "x86_64-linux"
-        "x86_64-darwin" 
+        "x86_64-darwin"
       ];
       forAllSystems = f: lib.genAttrs supportedSystems (system: f system);
       legacyPkgs = nixpkgs.legacyPackages;
@@ -25,13 +25,13 @@
       packages = forAllSystems (system: {
         inherit (default.${system}) blockfrost-backend-ryo;
         dockerImage =
-        let
-          configs = legacyPkgs.${system}.runCommand "app-configs" { }
-          ''
-            mkdir -p $out/app
-            cp -a ${self.packages.${system}.blockfrost-backend-ryo}/libexec/source/config $out/app/config
-          '';
-        in
+          let
+            configs = legacyPkgs.${system}.runCommand "app-configs" { }
+              ''
+                mkdir -p $out/app
+                cp -a ${self.packages.${system}.blockfrost-backend-ryo}/libexec/source/config $out/app/config
+              '';
+          in
           legacyPkgs.${system}.dockerTools.buildImage {
             name = "backend-ryo";
             copyToRoot = [ configs ];
@@ -58,7 +58,7 @@
       overlays.default = final: prev: {
         inherit (self.packages.${prev.system}) blockfrost-backend-ryo;
       };
-      nixosModules.default = {pkgs, ...}: {
+      nixosModules.default = { pkgs, ... }: {
         imports = [ ./nixos-module.nix ];
         nixpkgs.overlays = [ self.overlays.default ];
       };

package.json

@@ -25,7 +25,7 @@
   },
   "dependencies": {
     "@blockfrost/blockfrost-js": "5.2.0",
-    "@blockfrost/blockfrost-utils": "2.6.2",
+    "@blockfrost/blockfrost-utils": "2.7.1",
     "@blockfrost/openapi": "0.1.58",
     "@emurgo/cardano-serialization-lib-nodejs": "11.3.0",
     "@emurgo/cip14-js": "^3.0.1",
@@ -47,7 +47,7 @@
     "rimraf": "^4.3.1"
   },
   "devDependencies": {
-    "@blockfrost/blockfrost-tests": "1.8.1",
+    "@blockfrost/blockfrost-tests": "1.9.2",
     "@esbuild/darwin-x64": "npm:0.16.17",
     "@esbuild/linux-x64": "npm:0.16.17",
     "@types/config": "3.3.0",

yarn.lock

@@ -218,17 +218,17 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@blockfrost/blockfrost-tests@npm:1.8.1":
-  version: 1.8.1
-  resolution: "@blockfrost/blockfrost-tests@npm:1.8.1"
+"@blockfrost/blockfrost-tests@npm:1.9.2":
+  version: 1.9.2
+  resolution: "@blockfrost/blockfrost-tests@npm:1.9.2"
   dependencies:
-    "@blockfrost/openapi": ^0.1.57
+    "@blockfrost/openapi": 0.1.59
     expect: ^29.3.1
     form-data: ^4.0.0
     jdenticon: ^3.2.0
     jest-extended: ^3.1.0
     node-match-path: ^0.6.3
-  checksum: 920e9e6139b96ab8ece2c7bb76a199b7c4f89f4754d22cdb08419115f68dd81bc891857ecdaf96c1fde2da9182fc29dc88f2aafce6b8c391cb2c2cfa458cafbc
+  checksum: 4553508a636e022747c6f4217c76eb874e092e3e63cafc904f3a19d97ec17171bb3a14368d3c380925229bc8ea1a9434e00231402c2d5e2ca012b208655d5628
   languageName: node
   linkType: hard
 
@@ -243,9 +243,9 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@blockfrost/blockfrost-utils@npm:2.6.2":
-  version: 2.6.2
-  resolution: "@blockfrost/blockfrost-utils@npm:2.6.2"
+"@blockfrost/blockfrost-utils@npm:2.7.1":
+  version: 2.7.1
+  resolution: "@blockfrost/blockfrost-utils@npm:2.7.1"
   dependencies:
     "@emurgo/cardano-serialization-lib-nodejs": ^11.4.0
     bech32: ^2.0.0
@@ -254,7 +254,7 @@ __metadata:
     pm2: ^5.3.0
     prom-client: ^14.2.0
     yaml: ^2.3.1
-  checksum: 6e8b00e9e0fd05177db8ff14f1c2d326acf69ede063438e47e6e0a7dd047cab09368812490e5b0416b5d66342b0718312a82817513e996591ec7035e26a9632f
+  checksum: 2f24289fcad64b24dc5d6e3ad46bb8d90ea41c25b205c93661f95b2e149c48f336c35541c7dfe331db7a87cc2ea931bb9230eee67f202dbd641f05c51aa976f8
   languageName: node
   linkType: hard
 
@@ -279,14 +279,14 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@blockfrost/openapi@npm:^0.1.57":
-  version: 0.1.57
-  resolution: "@blockfrost/openapi@npm:0.1.57"
+"@blockfrost/openapi@npm:0.1.59":
+  version: 0.1.59
+  resolution: "@blockfrost/openapi@npm:0.1.59"
   dependencies:
-    "@redocly/cli": ^1.0.0-beta.123
+    ajv: ^8.11.2
     cbor: ^8.1.0
     yaml: ^2.2.1
-  checksum: 4bc4fa9952817b6fa0758db063867d40db3f82e41c75a91179908212c7291cc66ea5e45728a09de717d522d71c27526d47953a8e8d613df6674836b94ef450a9
+  checksum: 8846c0bb7e09388aa79a23795e602304ddd8d17eb8335509330988c3a51063a6e06ec5a0d3278c5ba145f69da2a673913b8aeebae68a99f37b59ebdb2ec3a978
   languageName: node
   linkType: hard
 
@@ -1760,7 +1760,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"ajv@npm:^8.12.0":
+"ajv@npm:^8.11.2, ajv@npm:^8.12.0":
   version: 8.12.0
   resolution: "ajv@npm:8.12.0"
   dependencies:
@@ -2208,8 +2208,8 @@ __metadata:
   resolution: "blockfrost-backend-ryo@workspace:."
   dependencies:
     "@blockfrost/blockfrost-js": 5.2.0
-    "@blockfrost/blockfrost-tests": 1.8.1
-    "@blockfrost/blockfrost-utils": 2.6.2
+    "@blockfrost/blockfrost-tests": 1.9.2
+    "@blockfrost/blockfrost-utils": 2.7.1
     "@blockfrost/openapi": 0.1.58
     "@emurgo/cardano-serialization-lib-nodejs": 11.3.0
     "@emurgo/cip14-js": ^3.0.1