@substrate/api-sidecar 19.0.2 → 19.2.0

package/build/src/types/responses/index.d.ts

@@ -30,6 +30,7 @@ export * from './PalletErrorsItem';
 export * from './PalletEvents';
 export * from './PalletEventsItem';
 export * from './PalletNominationPools';
+export * from './PalletOnGoingReferenda';
 export * from './PalletStakingProgress';
 export * from './PalletStakingValidators';
 export * from './PalletStorage';

package/build/src/types/responses/index.js

@@ -1,5 +1,5 @@
 "use strict";
-// Copyright 2017-2023 Parity Technologies (UK) Ltd.
+// Copyright 2017-2024 Parity Technologies (UK) Ltd.
 // This file is part of Substrate API Sidecar.
 //
 // Substrate API Sidecar is free software: you can redistribute it and/or modify
@@ -61,6 +61,7 @@ __exportStar(require("./PalletErrorsItem"), exports);
 __exportStar(require("./PalletEvents"), exports);
 __exportStar(require("./PalletEventsItem"), exports);
 __exportStar(require("./PalletNominationPools"), exports);
+__exportStar(require("./PalletOnGoingReferenda"), exports);
 __exportStar(require("./PalletStakingProgress"), exports);
 __exportStar(require("./PalletStakingValidators"), exports);
 __exportStar(require("./PalletStorage"), exports);

package/build/src/types/responses/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/types/responses/index.ts"],"names":[],"mappings":";AAAA,oDAAoD;AACpD,8CAA8C;AAC9C,EAAE;AACF,gFAAgF;AAChF,uEAAuE;AACvE,oEAAoE;AACpE,sCAAsC;AACtC,EAAE;AACF,kEAAkE;AAClE,iEAAiE;AACjE,gEAAgE;AAChE,+CAA+C;AAC/C,EAAE;AACF,oEAAoE;AACpE,wEAAwE;;;;;;;;;;;;;;;;AAExE,kDAAgC;AAChC,uDAAqC;AACrC,mDAAiC;AACjC,sDAAoC;AACpC,qDAAmC;AACnC,uDAAqC;AACrC,0DAAwC;AACxC,uDAAqC;AACrC,2CAAyB;AACzB,uCAAqB;AACrB,0CAAwB;AACxB,6CAA2B;AAC3B,qDAAmC;AACnC,+CAA6B;AAC7B,8CAA4B;AAC5B,kDAAgC;AAChC,gDAA8B;AAC9B,iDAA+B;AAC/B,gDAA8B;AAC9B,wDAAsC;AACtC,gDAA8B;AAC9B,2CAAyB;AACzB,0DAAwC;AACxC,oDAAkC;AAClC,wDAAsC;AACtC,wDAAsC;AACtC,4DAA0C;AAC1C,iDAA+B;AAC/B,qDAAmC;AACnC,iDAA+B;AAC/B,qDAAmC;AACnC,0DAAwC;AACxC,0DAAwC;AACxC,4DAA0C;AAC1C,kDAAgC;AAChC,sDAAoC;AACpC,0CAAwB;AACxB,2CAAyB;AACzB,+CAA6B;AAC7B,gDAA8B;AAC9B,kDAAgC;AAChC,kDAAgC;AAChC,+DAA6C;AAC7C,mDAAiC;AACjC,+DAA6C;AAC7C,iEAA+C;AAC/C,sDAAoC;AACpC,wDAAsC;AACtC,oDAAkC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/types/responses/index.ts"],"names":[],"mappings":";AAAA,oDAAoD;AACpD,8CAA8C;AAC9C,EAAE;AACF,gFAAgF;AAChF,uEAAuE;AACvE,oEAAoE;AACpE,sCAAsC;AACtC,EAAE;AACF,kEAAkE;AAClE,iEAAiE;AACjE,gEAAgE;AAChE,+CAA+C;AAC/C,EAAE;AACF,oEAAoE;AACpE,wEAAwE;;;;;;;;;;;;;;;;AAExE,kDAAgC;AAChC,uDAAqC;AACrC,mDAAiC;AACjC,sDAAoC;AACpC,qDAAmC;AACnC,uDAAqC;AACrC,0DAAwC;AACxC,uDAAqC;AACrC,2CAAyB;AACzB,uCAAqB;AACrB,0CAAwB;AACxB,6CAA2B;AAC3B,qDAAmC;AACnC,+CAA6B;AAC7B,8CAA4B;AAC5B,kDAAgC;AAChC,gDAA8B;AAC9B,iDAA+B;AAC/B,gDAA8B;AAC9B,wDAAsC;AACtC,gDAA8B;AAC9B,2CAAyB;AACzB,0DAAwC;AACxC,oDAAkC;AAClC,wDAAsC;AACtC,wDAAsC;AACtC,4DAA0C;AAC1C,iDAA+B;AAC/B,qDAAmC;AACnC,iDAA+B;AAC/B,qDAAmC;AACnC,0DAAwC;AACxC,2DAAyC;AACzC,0DAAwC;AACxC,4DAA0C;AAC1C,kDAAgC;AAChC,sDAAoC;AACpC,0CAAwB;AACxB,2CAAyB;AACzB,+CAA6B;AAC7B,gDAA8B;AAC9B,kDAAgC;AAChC,kDAAgC;AAChC,+DAA6C;AAC7C,mDAAiC;AACjC,+DAA6C;AAC7C,iEAA+C;AAC/C,sDAAoC;AACpC,wDAAsC;AACtC,oDAAkC"}

package/build/src/types/sidecar-config/CONFIG.d.ts

@@ -17,5 +17,11 @@ export declare enum CONFIG {
     WRITE = "WRITE",
     WRITE_PATH = "WRITE_PATH",
     WRITE_MAX_FILE_SIZE = "WRITE_MAX_FILE_SIZE",
-    WRITE_MAX_FILES = "WRITE_MAX_FILES"
+    WRITE_MAX_FILES = "WRITE_MAX_FILES",
+    ENABLED = "ENABLED",
+    LOKI_HOST = "LOKI_HOST",
+    PROM_PORT = "PROM_PORT",
+    PROM_HOST = "PROM_HOST",
+    LOKI_PORT = "LOKI_PORT",
+    INCLUDE_QUERYPARAMS = "INCLUDE_QUERYPARAMS"
 }

package/build/src/types/sidecar-config/CONFIG.js

@@ -37,5 +37,11 @@ var CONFIG;
     CONFIG["WRITE_PATH"] = "WRITE_PATH";
     CONFIG["WRITE_MAX_FILE_SIZE"] = "WRITE_MAX_FILE_SIZE";
     CONFIG["WRITE_MAX_FILES"] = "WRITE_MAX_FILES";
+    CONFIG["ENABLED"] = "ENABLED";
+    CONFIG["LOKI_HOST"] = "LOKI_HOST";
+    CONFIG["PROM_PORT"] = "PROM_PORT";
+    CONFIG["PROM_HOST"] = "PROM_HOST";
+    CONFIG["LOKI_PORT"] = "LOKI_PORT";
+    CONFIG["INCLUDE_QUERYPARAMS"] = "INCLUDE_QUERYPARAMS";
 })(CONFIG || (exports.CONFIG = CONFIG = {}));
 //# sourceMappingURL=CONFIG.js.map

package/build/src/types/sidecar-config/CONFIG.js.map

@@ -1 +1 @@
-{"version":3,"file":"CONFIG.js","sourceRoot":"","sources":["../../../../src/types/sidecar-config/CONFIG.ts"],"names":[],"mappings":";AAAA,oDAAoD;AACpD,8CAA8C;AAC9C,EAAE;AACF,gFAAgF;AAChF,uEAAuE;AACvE,oEAAoE;AACpE,sCAAsC;AACtC,EAAE;AACF,kEAAkE;AAClE,iEAAiE;AACjE,gEAAgE;AAChE,+CAA+C;AAC/C,EAAE;AACF,oEAAoE;AACpE,wEAAwE;;;AAExE;;GAEG;AACH,IAAY,MAiBX;AAjBD,WAAY,MAAM;IACjB,iCAAuB,CAAA;IACvB,uBAAa,CAAA;IACb,mDAAyC,CAAA;IACzC,qBAAW,CAAA;IACX,yBAAe,CAAA;IACf,uBAAa,CAAA;IACb,mCAAyB,CAAA;IACzB,mCAAyB,CAAA;IACzB,uCAA6B,CAAA;IAC7B,qCAA2B,CAAA;IAC3B,mCAAyB,CAAA;IACzB,yBAAe,CAAA;IACf,yBAAe,CAAA;IACf,mCAAyB,CAAA;IACzB,qDAA2C,CAAA;IAC3C,6CAAmC,CAAA;AACpC,CAAC,EAjBW,MAAM,sBAAN,MAAM,QAiBjB"}
+{"version":3,"file":"CONFIG.js","sourceRoot":"","sources":["../../../../src/types/sidecar-config/CONFIG.ts"],"names":[],"mappings":";AAAA,oDAAoD;AACpD,8CAA8C;AAC9C,EAAE;AACF,gFAAgF;AAChF,uEAAuE;AACvE,oEAAoE;AACpE,sCAAsC;AACtC,EAAE;AACF,kEAAkE;AAClE,iEAAiE;AACjE,gEAAgE;AAChE,+CAA+C;AAC/C,EAAE;AACF,oEAAoE;AACpE,wEAAwE;;;AAExE;;GAEG;AACH,IAAY,MAuBX;AAvBD,WAAY,MAAM;IACjB,iCAAuB,CAAA;IACvB,uBAAa,CAAA;IACb,mDAAyC,CAAA;IACzC,qBAAW,CAAA;IACX,yBAAe,CAAA;IACf,uBAAa,CAAA;IACb,mCAAyB,CAAA;IACzB,mCAAyB,CAAA;IACzB,uCAA6B,CAAA;IAC7B,qCAA2B,CAAA;IAC3B,mCAAyB,CAAA;IACzB,yBAAe,CAAA;IACf,yBAAe,CAAA;IACf,mCAAyB,CAAA;IACzB,qDAA2C,CAAA;IAC3C,6CAAmC,CAAA;IACnC,6BAAmB,CAAA;IACnB,iCAAuB,CAAA;IACvB,iCAAuB,CAAA;IACvB,iCAAuB,CAAA;IACvB,iCAAuB,CAAA;IACvB,qDAA2C,CAAA;AAC5C,CAAC,EAvBW,MAAM,sBAAN,MAAM,QAuBjB"}

package/build/src/types/sidecar-config/MODULES.d.ts

@@ -4,5 +4,6 @@
 export declare enum MODULES {
     EXPRESS = "EXPRESS",
     SUBSTRATE = "SUBSTRATE",
-    LOG = "LOG"
+    LOG = "LOG",
+    METRICS = "METRICS"
 }

package/build/src/types/sidecar-config/MODULES.js

@@ -24,5 +24,6 @@ var MODULES;
     MODULES["EXPRESS"] = "EXPRESS";
     MODULES["SUBSTRATE"] = "SUBSTRATE";
     MODULES["LOG"] = "LOG";
+    MODULES["METRICS"] = "METRICS";
 })(MODULES || (exports.MODULES = MODULES = {}));
 //# sourceMappingURL=MODULES.js.map

package/build/src/types/sidecar-config/MODULES.js.map

@@ -1 +1 @@
-{"version":3,"file":"MODULES.js","sourceRoot":"","sources":["../../../../src/types/sidecar-config/MODULES.ts"],"names":[],"mappings":";AAAA,oDAAoD;AACpD,8CAA8C;AAC9C,EAAE;AACF,gFAAgF;AAChF,uEAAuE;AACvE,oEAAoE;AACpE,sCAAsC;AACtC,EAAE;AACF,kEAAkE;AAClE,iEAAiE;AACjE,gEAAgE;AAChE,+CAA+C;AAC/C,EAAE;AACF,oEAAoE;AACpE,wEAAwE;;;AAExE;;GAEG;AACH,IAAY,OAIX;AAJD,WAAY,OAAO;IAClB,8BAAmB,CAAA;IACnB,kCAAuB,CAAA;IACvB,sBAAW,CAAA;AACZ,CAAC,EAJW,OAAO,uBAAP,OAAO,QAIlB"}
+{"version":3,"file":"MODULES.js","sourceRoot":"","sources":["../../../../src/types/sidecar-config/MODULES.ts"],"names":[],"mappings":";AAAA,oDAAoD;AACpD,8CAA8C;AAC9C,EAAE;AACF,gFAAgF;AAChF,uEAAuE;AACvE,oEAAoE;AACpE,sCAAsC;AACtC,EAAE;AACF,kEAAkE;AAClE,iEAAiE;AACjE,gEAAgE;AAChE,+CAA+C;AAC/C,EAAE;AACF,oEAAoE;AACpE,wEAAwE;;;AAExE;;GAEG;AACH,IAAY,OAKX;AALD,WAAY,OAAO;IAClB,8BAAmB,CAAA;IACnB,kCAAuB,CAAA;IACvB,sBAAW,CAAA;IACX,8BAAmB,CAAA;AACpB,CAAC,EALW,OAAO,uBAAP,OAAO,QAKlB"}

package/build/src/types/sidecar-config/SidecarConfig.d.ts

@@ -5,6 +5,7 @@ export interface ISidecarConfig {
     EXPRESS: ISidecarConfigExpress;
     SUBSTRATE: ISidecarConfigSubstrate;
     LOG: ISidecarConfigLog;
+    METRICS: ISidecarConfigMetrics;
 }
 interface ISidecarConfigSubstrate {
     URL: string;
@@ -28,4 +29,12 @@ interface ISidecarConfigLog {
     WRITE_MAX_FILE_SIZE: number;
     WRITE_MAX_FILES: number;
 }
+interface ISidecarConfigMetrics {
+    ENABLED: boolean;
+    PROM_HOST: string;
+    PROM_PORT: number;
+    LOKI_HOST: string;
+    LOKI_PORT: number;
+    INCLUDE_QUERYPARAMS: boolean;
+}
 export {};

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "19.0.2",
+  "version": "19.2.0",
   "name": "@substrate/api-sidecar",
   "description": "REST service that makes it easy to interact with blockchain nodes built using Substrate's FRAME framework.",
   "homepage": "https://github.com/paritytech/substrate-api-sidecar#readme",
@@ -50,25 +50,26 @@
     "test:test-release": "yarn build:scripts && node scripts/build/runYarnPack.js"
   },
   "dependencies": {
-    "@polkadot/api": "^12.0.1",
-    "@polkadot/api-contract": "^12.0.1",
-    "@polkadot/util-crypto": "^12.6.2",
+    "@polkadot/api": "^13.2.1",
+    "@polkadot/api-contract": "^13.2.1",
+    "@polkadot/util-crypto": "^13.1.1",
     "@substrate/calc": "^0.3.1",
     "argparse": "^2.0.1",
-    "confmgr": "^1.0.10",
-    "express": "^4.19.2",
+    "confmgr": "^1.1.0",
+    "express": "^4.21.0",
     "express-winston": "^4.2.0",
     "http-errors": "^2.0.0",
-    "lru-cache": "^10.2.2",
-    "prom-client": "^15.1.2",
+    "lru-cache": "^11.0.1",
+    "prom-client": "^15.1.3",
     "rxjs": "^7.8.1",
-    "winston": "^3.13.0"
+    "winston": "^3.14.2",
+    "winston-loki": "^6.1.2"
   },
   "devDependencies": {
     "@substrate/dev": "^0.7.1",
     "@types/argparse": "2.0.16",
     "@types/express": "^4.17.21",
-    "@types/express-serve-static-core": "^4.19.1",
+    "@types/express-serve-static-core": "^4.19.5",
     "@types/http-errors": "2.0.4",
     "@types/lru-cache": "^7.10.10",
     "@types/morgan": "1.9.9",

package/build/src/util/metrics.d.ts

@@ -1,21 +0,0 @@
-import client from 'prom-client';
-export declare const httpErrorCounter: client.Counter<string>;
-interface IAppConfiguration {
-    port: number;
-    host: string;
-}
-export default class Metrics_App {
-    private app;
-    private readonly port;
-    private readonly host;
-    /**
-     * @param appConfig configuration for app.
-     */
-    constructor({ host }: IAppConfiguration);
-    listen(): void;
-    /**
-     * Mount the metrics endpoint.
-     */
-    private metricsEndpoint;
-}
-export {};

package/build/src/util/metrics.js

@@ -1,49 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.httpErrorCounter = void 0;
-const express_1 = __importDefault(require("express"));
-const prom_client_1 = __importDefault(require("prom-client"));
-const Log_1 = require("../logging/Log");
-const parseArgs_1 = require("../parseArgs");
-exports.httpErrorCounter = new prom_client_1.default.Counter({
-    name: 'sas_http_errors',
-    help: 'Number of HTTP Errors',
-});
-class Metrics_App {
-    /**
-     * @param appConfig configuration for app.
-     */
-    constructor({ host }) {
-        const args = (0, parseArgs_1.parseArgs)();
-        this.port = Number(args.prometheus_port);
-        this.app = (0, express_1.default)();
-        this.host = host;
-        this.metricsEndpoint();
-    }
-    listen() {
-        const { logger } = Log_1.Log;
-        this.app.listen(this.port, this.host, () => {
-            logger.info(`Metrics Server started at http://${this.host}:${this.port}/`);
-        });
-    }
-    /**
-     * Mount the metrics endpoint.
-     */
-    metricsEndpoint() {
-        const register = new prom_client_1.default.Registry();
-        register.registerMetric(exports.httpErrorCounter);
-        prom_client_1.default.collectDefaultMetrics({ register, prefix: 'sas_' });
-        // Set up the metrics endpoint
-        this.app.get('/metrics', (_req, res) => {
-            void (async () => {
-                res.set('Content-Type', register.contentType);
-                res.send(await register.metrics());
-            })();
-        });
-    }
-}
-exports.default = Metrics_App;
-//# sourceMappingURL=metrics.js.map

package/build/src/util/metrics.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"metrics.js","sourceRoot":"","sources":["../../../src/util/metrics.ts"],"names":[],"mappings":";;;;;;AAAA,sDAA8B;AAE9B,8DAAiC;AAEjC,wCAAqC;AACrC,4CAAyC;AAE5B,QAAA,gBAAgB,GAAG,IAAI,qBAAM,CAAC,OAAO,CAAC;IAClD,IAAI,EAAE,iBAAiB;IACvB,IAAI,EAAE,uBAAuB;CAC7B,CAAC,CAAC;AAOH,MAAqB,WAAW;IAK/B;;OAEG;IACH,YAAY,EAAE,IAAI,EAAqB;QACtC,MAAM,IAAI,GAAG,IAAA,qBAAS,GAAE,CAAC;QAEzB,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QACzC,IAAI,CAAC,GAAG,GAAG,IAAA,iBAAO,GAAE,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QAEjB,IAAI,CAAC,eAAe,EAAE,CAAC;IACxB,CAAC;IAED,MAAM;QACL,MAAM,EAAE,MAAM,EAAE,GAAG,SAAG,CAAC;QACvB,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,GAAG,EAAE;YAC1C,MAAM,CAAC,IAAI,CAAC,oCAAoC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC;QAC5E,CAAC,CAAC,CAAC;IACJ,CAAC;IAED;;OAEG;IACK,eAAe;QACtB,MAAM,QAAQ,GAAG,IAAI,qBAAM,CAAC,QAAQ,EAAE,CAAC;QACvC,QAAQ,CAAC,cAAc,CAAC,wBAAgB,CAAC,CAAC;QAC1C,qBAAM,CAAC,qBAAqB,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;QAC3D,8BAA8B;QAC9B,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,UAAU,EAAE,CAAC,IAAa,EAAE,GAAa,EAAE,EAAE;YACzD,KAAK,CAAC,KAAK,IAAI,EAAE;gBAChB,GAAG,CAAC,GAAG,CAAC,cAAc,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC;gBAC9C,GAAG,CAAC,IAAI,CAAC,MAAM,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC;YACpC,CAAC,CAAC,EAAE,CAAC;QACN,CAAC,CAAC,CAAC;IACJ,CAAC;CACD;AAxCD,8BAwCC"}