@substrate/api-sidecar
Version:
REST service that makes it easy to interact with blockchain nodes built using Substrate's FRAME framework.
66 lines • 2.88 kB
JavaScript
;
// 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/>.
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
const services_1 = require("../../services");
const AbstractController_1 = __importDefault(require("../AbstractController"));
/**
* POST a serialized transaction to submit to the transaction queue.
*
* Post info:
* - `data`: Expects a hex-encoded transaction, e.g. '{"tx": "0x..."}'.
* - `headers`: Expects 'Content-Type: application/json'.
*
* Returns:
* - Success:
* - `hash`: The hash of the encoded transaction.
* - Failure:
* - `error`: 'Failed to parse transaction' or 'Failed to submit transaction'. In the case of the former,
* Sidecar was unable to parse the transaction and never submitted it to the client. In
* the case of the latter, the transaction queue rejected the transaction.
* - `extrinsic`: The hex-encoded extrinsic. Only present if Sidecar fails to parse a transaction.
* - `cause`: The error message from parsing or from the client.
*/
class TransactionSubmitController extends AbstractController_1.default {
constructor(api) {
super(api, '/transaction', new services_1.TransactionSubmitService(api));
/**
* Submit a serialized transaction to the transaction queue.
*
* @param req Sidecar TxRequest
* @param res Express Response
*/
this.txSubmit = async ({ body: { tx } }, res) => {
if (!tx) {
throw {
error: 'Missing field `tx` on request body.',
};
}
res.send(await this.service.submitTransaction(tx));
};
this.initRoutes();
}
initRoutes() {
this.router.post(this.path, TransactionSubmitController.catchWrap(this.txSubmit));
}
}
TransactionSubmitController.controllerName = 'TransactionSubmit';
TransactionSubmitController.requiredPallets = [];
exports.default = TransactionSubmitController;
//# sourceMappingURL=TransactionSubmitController.js.map