@partisiablockchain/blockchain-api-transaction-client 4.146.0 → 5.1.0

package/target/main/transactionclient/SignedTransaction.js

@@ -0,0 +1,128 @@
+"use strict";
+/*
+ * Copyright (C) 2022 - 2023 Partisia Blockchain Foundation
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero 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 Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SignedTransaction = void 0;
+const bn_js_1 = __importDefault(require("bn.js"));
+const bitmanipulation_ts_1 = require("@secata-public/bitmanipulation-ts");
+const CryptoUtils_1 = require("../CryptoUtils");
+/**
+ * A transaction that has been signed by a private key. A signed transaction is ready to be sent to
+ * the blockchain. A signed transaction has limited durability, since it includes information about
+ * the valid-to-time and the next available nonce of the sending user.
+ */
+class SignedTransaction {
+    constructor(inner, signature, hash) {
+        this.inner = inner;
+        this.signature = signature;
+        this.hash = hash;
+    }
+    /**
+     * Create a signed transaction to send to PBC.
+     * @param senderAuthentication the sender authentication to sign the transaction with.
+     * @param nonce the nonce of the signing account.
+     * @param validToTime the unix time that the transaction is valid to.
+     * @param gasCost the amount of gas allocated to executing the transaction.
+     * @param chainId the id of the chain.
+     * @param transaction the transaction to sign.
+     * @returns the signed transaction.
+     */
+    static create(senderAuthentication, nonce, validToTime, gasCost, chainId, transaction) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const inner = { nonce, validToTime, gasCost, innerTransaction: transaction };
+            const transactionPayload = serializeInnerPart(inner);
+            const hash = CryptoUtils_1.CryptoUtils.hashBuffers([
+                transactionPayload,
+                bitmanipulation_ts_1.BigEndianByteOutput.serialize((out) => out.writeString(chainId)),
+            ]).toString("hex");
+            const signature = yield senderAuthentication.sign(transactionPayload, chainId);
+            return new SignedTransaction(inner, signature, hash);
+        });
+    }
+    /**
+     * Serialize the signed transaction into bytes.
+     * @returns the serialized bytes.
+     */
+    serialize() {
+        return Buffer.concat([Buffer.from(this.signature, "hex"), serializeInnerPart(this.inner)]);
+    }
+    /**
+     * Get the identifier of this transaction.
+     * @returns the identify hash
+     */
+    identifier() {
+        return CryptoUtils_1.CryptoUtils.hashBuffers([
+            Buffer.from(this.hash, "hex"),
+            Buffer.from(this.signature, "hex"),
+        ]).toString("hex");
+    }
+    /**
+     * Get the nonce of this transaction.
+     * @returns the nonce
+     */
+    getNonce() {
+        return this.inner.nonce;
+    }
+    /**
+     * Get the valid-to-time of this transaction. If the transaction is not included in a block before
+     * this time it will fail.
+     * @returns the valid to time as a unix timestamp.
+     */
+    getValidToTime() {
+        return this.inner.validToTime;
+    }
+    /**
+     * Get the gas cost of this transaction.
+     * @returns the gas cost
+     */
+    getGasCost() {
+        return this.inner.gasCost;
+    }
+    /**
+     * Get the inner transaction of this transaction.
+     * @returns the inner
+     */
+    getInner() {
+        return this.inner.innerTransaction;
+    }
+}
+exports.SignedTransaction = SignedTransaction;
+/** Serialize the inner part of a signed transaction to bytes. */
+function serializeInnerPart(innerPart) {
+    return bitmanipulation_ts_1.BigEndianByteOutput.serialize((out) => {
+        out.writeI64(new bn_js_1.default(innerPart.nonce));
+        out.writeI64(new bn_js_1.default(innerPart.validToTime));
+        out.writeI64(new bn_js_1.default(innerPart.gasCost));
+        out.writeBytes(Buffer.from(innerPart.innerTransaction.address, "hex"));
+        out.writeI32(innerPart.innerTransaction.rpc.length);
+        out.writeBytes(innerPart.innerTransaction.rpc);
+    });
+}
+//# sourceMappingURL=SignedTransaction.js.map

package/target/main/transactionclient/SignedTransaction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SignedTransaction.js","sourceRoot":"","sources":["../../../src/main/transactionclient/SignedTransaction.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;GAgBG;;;;;;;;;;;;;;;AAEH,kDAAuB;AACvB,0EAAwE;AACxE,gDAA6C;AAG7C;;;;GAIG;AACH,MAAa,iBAAiB;IAK5B,YAAoB,KAAgB,EAAE,SAAoB,EAAE,IAAU;QACpE,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED;;;;;;;;;OASG;IACI,MAAM,CAAO,MAAM,CACxB,oBAA0C,EAC1C,KAAa,EACb,WAAmB,EACnB,OAAe,EACf,OAAe,EACf,WAAwB;;YAExB,MAAM,KAAK,GAAc,EAAE,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,gBAAgB,EAAE,WAAW,EAAE,CAAC;YACxF,MAAM,kBAAkB,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC;YACrD,MAAM,IAAI,GAAG,yBAAW,CAAC,WAAW,CAAC;gBACnC,kBAAkB;gBAClB,wCAAmB,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;aACjE,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YACnB,MAAM,SAAS,GAAG,MAAM,oBAAoB,CAAC,IAAI,CAAC,kBAAkB,EAAE,OAAO,CAAC,CAAC;YAC/E,OAAO,IAAI,iBAAiB,CAAC,KAAK,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;QACvD,CAAC;KAAA;IAED;;;OAGG;IACI,SAAS;QACd,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,EAAE,kBAAkB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAC7F,CAAC;IAED;;;OAGG;IACI,UAAU;QACf,OAAO,yBAAW,CAAC,WAAW,CAAC;YAC7B,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC;YAC7B,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC;SACnC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACrB,CAAC;IAED;;;OAGG;IACI,QAAQ;QACb,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC;IAC1B,CAAC;IAED;;;;OAIG;IACI,cAAc;QACnB,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC;IAChC,CAAC;IAED;;;OAGG;IACI,UAAU;QACf,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC;IAC5B,CAAC;IAED;;;OAGG;IACI,QAAQ;QACb,OAAO,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC;IACrC,CAAC;CACF;AA1FD,8CA0FC;AAcD,iEAAiE;AACjE,SAAS,kBAAkB,CAAC,SAAoB;IAC9C,OAAO,wCAAmB,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE;QAC3C,GAAG,CAAC,QAAQ,CAAC,IAAI,eAAE,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;QACtC,GAAG,CAAC,QAAQ,CAAC,IAAI,eAAE,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC;QAC5C,GAAG,CAAC,QAAQ,CAAC,IAAI,eAAE,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;QACxC,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;QACvE,GAAG,CAAC,QAAQ,CAAC,SAAS,CAAC,gBAAgB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACpD,GAAG,CAAC,UAAU,CAAC,SAAS,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;AACL,CAAC"}

package/target/main/transactionclient/types.d.ts

@@ -0,0 +1,49 @@
+import { SignedTransaction } from "./SignedTransaction";
+import { ExecutedTransaction, TransactionPointer } from "../generated/openapi";
+/** Hash as a 32 byte long hex string. */
+export type Hash = string;
+/** BlockchainAddress as 21 byte long hex string. */
+export type BlockchainAddress = string;
+/** Signature as 65 byte long hex string. */
+export type Signature = string;
+/**
+ * Authentication for a sender of a transaction. Sending transactions requires a blockchain address
+ * and the ability to sign messages.
+ */
+export interface SenderAuthentication {
+    /**
+     * Get the address of the sender.
+     * @returns The blockchain address of the sender.
+     */
+    getAddress(): BlockchainAddress;
+    /**
+     * Sign a transaction.
+     * @param transactionPayload payload of the transaction
+     * @param chainId the chain id
+     * @returns the signature of the message
+     */
+    sign(transactionPayload: Buffer, chainId: string): Promise<Signature>;
+}
+/** A transaction. */
+export interface Transaction {
+    /** The address of the receiver of the transaction. */
+    address: BlockchainAddress;
+    /** The rpc of the transaction. */
+    rpc: Buffer;
+}
+/**
+ * A transaction that has been sent to the blockchain for execution.
+ */
+export interface SentTransaction {
+    /** The signed transaction that was sent. */
+    signedTransaction: SignedTransaction;
+    /** A pointer to the signed transaction that was sent. */
+    transactionPointer: TransactionPointer;
+}
+/** Status for a transaction and the whole tree of spawned events. */
+export interface TransactionTree {
+    /** The original transaction. */
+    transaction: ExecutedTransaction;
+    /** List of spawned events from the transaction. */
+    events: ExecutedTransaction[];
+}

package/target/main/transactionclient/types.js

@@ -0,0 +1,20 @@
+"use strict";
+/*
+ * Copyright (C) 2022 - 2023 Partisia Blockchain Foundation
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero 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 Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/target/main/transactionclient/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/main/transactionclient/types.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;GAgBG"}