@substrate/api-sidecar 20.13.2 → 20.14.0

package/build/src/types/requests.d.ts

@@ -10,6 +10,62 @@ export interface ITx {
     xcmVersion?: number;
     at: string;
 }
+/**
+ * Body for the metadata blob request. Contains transaction data for generating
+ * the minimal metadata proof needed by offline signers.
+ */
+export interface IMetadataBlobBody {
+    /**
+     * Full encoded extrinsic as a hex string. Use this OR the individual components below.
+     */
+    tx?: string;
+    /**
+     * Optional additional signed data for the extrinsic.
+     * Used together with `tx`.
+     */
+    txAdditionalSigned?: string;
+    /**
+     * Call data as hex string. Use this alongside includedInExtrinsic and includedInSignedData.
+     */
+    callData?: string;
+    /**
+     * Signed Extension data included in the extrinsic.
+     */
+    includedInExtrinsic?: string;
+    /**
+     * Signed Extension data included in the signature.
+     */
+    includedInSignedData?: string;
+    /**
+     * Block hash or number to query at. Defaults to finalized head.
+     */
+    at?: string;
+}
+/**
+ * Parameters for generating metadata blob proof.
+ */
+export interface MetadataBlobParams {
+    /**
+     * Full encoded extrinsic. Use this OR the individual parts.
+     */
+    tx?: string;
+    /**
+     * Optional tx additional signed data.
+     */
+    txAdditionalSigned?: string;
+    /**
+     * Call data. Use with includedInExtrinsic and includedInSignedData.
+     */
+    callData?: string;
+    /**
+     * Signed Extension data included in the extrinsic.
+     */
+    includedInExtrinsic?: string;
+    /**
+     * Signed Extension data included in the signature.
+     */
+    includedInSignedData?: string;
+}
 /**
  * Body for the RequestHandlerContract. In other words, the body of the POST route that a message to a contract.
  */
@@ -85,6 +141,7 @@ export interface IBlockQueryParams extends Query {
     decodedXcmMsgs?: string;
     paraId?: string;
     useRcBlock?: string;
+    useRcBlockFormat?: string;
 }
 export interface IRequestHandlerWithMetrics<T = unknown, P = unknown> extends RequestHandler<T, unknown, unknown, P, IMetrics> {
 }

package/build/src/types/requests.js

@@ -1,5 +1,5 @@
 "use strict";
-// Copyright 2017-2025 Parity Technologies (UK) Ltd.
+// Copyright 2017-2026 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

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

@@ -0,0 +1,24 @@
+/**
+ * Minimal relay chain block header information.
+ * Used when `useRcBlockFormat=object` to provide RC block context.
+ */
+export interface IRcBlockInfo {
+    /** The relay chain block hash */
+    hash: string;
+    /** The parent block hash */
+    parentHash: string;
+    /** The relay chain block number */
+    number: string;
+}
+/**
+ * Object format response wrapper for `useRcBlockFormat=object`.
+ * Provides relay chain block info alongside parachain data.
+ *
+ * @typeParam T - The type of data in the parachainDataPerBlock array
+ */
+export interface IRcBlockObjectResponse<T> {
+    /** Minimal relay chain block header info */
+    rcBlock: IRcBlockInfo;
+    /** Array of parachain block data (empty if no AH blocks for this RC block) */
+    parachainDataPerBlock: T[];
+}

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

@@ -0,0 +1,18 @@
+"use strict";
+// Copyright 2017-2025 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
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=RcBlockFormat.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"RcBlockFormat.js","sourceRoot":"","sources":["../../../../src/types/responses/RcBlockFormat.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"}

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

@@ -0,0 +1,11 @@
+import { IAt } from '.';
+export interface ITransactionMetadataBlob {
+    at: IAt;
+    metadataHash: string;
+    metadataBlob: string;
+    specVersion: number;
+    specName: string;
+    base58Prefix: number;
+    decimals: number;
+    tokenSymbol: string;
+}

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

@@ -0,0 +1,18 @@
+"use strict";
+// Copyright 2017-2026 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
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=TransactionMetadataBlob.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"TransactionMetadataBlob.js","sourceRoot":"","sources":["../../../../src/types/responses/TransactionMetadataBlob.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"}

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

@@ -41,6 +41,7 @@ export * from './ParachainInclusion';
 export * from './Paras';
 export * from './Payout';
 export * from './PoolAssets';
+export * from './RcBlockFormat';
 export * from './RuntimeSpec';
 export * from './SanitizedArgs';
 export * from './SanitizedCall';
@@ -50,4 +51,5 @@ export * from './SanitizedEventItemMetadata';
 export * from './SanitizedStorageItemMetadata';
 export * from './TransactionDryRun';
 export * from './TransactionMaterial';
+export * from './TransactionMetadataBlob';
 export * from './ValidateAddress';

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

@@ -1,5 +1,5 @@
 "use strict";
-// Copyright 2017-2025 Parity Technologies (UK) Ltd.
+// Copyright 2017-2026 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
@@ -72,6 +72,7 @@ __exportStar(require("./ParachainInclusion"), exports);
 __exportStar(require("./Paras"), exports);
 __exportStar(require("./Payout"), exports);
 __exportStar(require("./PoolAssets"), exports);
+__exportStar(require("./RcBlockFormat"), exports);
 __exportStar(require("./RuntimeSpec"), exports);
 __exportStar(require("./SanitizedArgs"), exports);
 __exportStar(require("./SanitizedCall"), exports);
@@ -81,5 +82,6 @@ __exportStar(require("./SanitizedEventItemMetadata"), exports);
 __exportStar(require("./SanitizedStorageItemMetadata"), exports);
 __exportStar(require("./TransactionDryRun"), exports);
 __exportStar(require("./TransactionMaterial"), exports);
+__exportStar(require("./TransactionMetadataBlob"), exports);
 __exportStar(require("./ValidateAddress"), exports);
 //# sourceMappingURL=index.js.map

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,wDAAsC;AACtC,6CAA2B;AAC3B,qDAAmC;AACnC,6CAA2B;AAC3B,+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,uDAAqC;AACrC,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,wDAAsC;AACtC,6CAA2B;AAC3B,qDAAmC;AACnC,6CAA2B;AAC3B,+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,uDAAqC;AACrC,0CAAwB;AACxB,2CAAyB;AACzB,+CAA6B;AAC7B,kDAAgC;AAChC,gDAA8B;AAC9B,kDAAgC;AAChC,kDAAgC;AAChC,+DAA6C;AAC7C,mDAAiC;AACjC,+DAA6C;AAC7C,iEAA+C;AAC/C,sDAAoC;AACpC,wDAAsC;AACtC,4DAA0C;AAC1C,oDAAkC"}

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "20.13.2",
+  "version": "20.14.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",
@@ -51,6 +51,7 @@
     "test:test-release": "yarn build:scripts && node scripts/build/runYarnPack.js"
   },
   "dependencies": {
+    "@polkadot-api/merkleize-metadata": "^1.1.29",
     "@polkadot/api": "16.5.2",
     "@polkadot/api-augment": "16.5.2",
     "@polkadot/api-contract": "16.5.2",
@@ -64,7 +65,7 @@
     "express": "^5.2.0",
     "express-winston": "^4.2.0",
     "http-errors": "^2.0.1",
-    "lru-cache": "^11.2.4",
+    "lru-cache": "^11.2.5",
     "prom-client": "^15.1.3",
     "rxjs": "^7.8.2",
     "winston": "^3.19.0",