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

package/target/main/transactionclient/BlockchainTransactionClient.js

@@ -0,0 +1,243 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BlockchainTransactionClient = void 0;
+const openapi_1 = require("../generated/openapi");
+const ConditionWaiter_1 = require("./ConditionWaiter");
+const SignedTransaction_1 = require("./SignedTransaction");
+/** A client that supports signing, sending and waiting for transactions on the blockchain. */
+class BlockchainTransactionClient {
+    constructor(chainController, shardController, authentication, transactionValidityDuration, spawnedEventTimeout, currentTime, conditionWaiter) {
+        this.authentication = authentication;
+        this.chainController = chainController;
+        this.shardController = shardController;
+        this.transactionValidityDuration = transactionValidityDuration;
+        this.spawnedEventTimeout = spawnedEventTimeout;
+        this.currentTime = currentTime;
+        this.conditionWaiter = conditionWaiter;
+    }
+    /**
+     * Create a blockchain transaction client.
+     * @param baseUrl the base url of the chain to connect to
+     * @param authentication authentication of the sender that will sign transactions
+     * @param transactionValidityInMillis the number of milliseconds a signed transaction is valid for
+     *     inclusion in a block.
+     * @param spawnedEventTimeoutInMillis the number of milliseconds the client will wait for a
+     *     spawned event to be included in a block before timing out.
+     * @returns A blockchain transaction client
+     */
+    static create(baseUrl, authentication, transactionValidityInMillis, spawnedEventTimeoutInMillis) {
+        const chainControllerApi = new openapi_1.ChainControllerApi(new openapi_1.Configuration({ basePath: baseUrl }));
+        const shardControllerApi = new openapi_1.ShardControllerApi(new openapi_1.Configuration({ basePath: baseUrl }));
+        return new BlockchainTransactionClient(chainControllerApi, shardControllerApi, authentication, transactionValidityInMillis !== null && transactionValidityInMillis !== void 0 ? transactionValidityInMillis : this.DEFAULT_TRANSACTION_VALIDITY_DURATION, spawnedEventTimeoutInMillis !== null && spawnedEventTimeoutInMillis !== void 0 ? spawnedEventTimeoutInMillis : this.DEFAULT_SPAWNED_EVENT_TIMEOUT, this.DEFAULT_CURRENT_TIME, ConditionWaiter_1.ConditionWaiterImpl.create());
+    }
+    /**
+     * Create a blockchain transaction client used for testing.
+     * @param chainController the client used for communicating with the chain api
+     * @param shardController the client used for communicating with the shard api
+     * @param authentication authentication of the sender that will sign transactions
+     * @param transactionValidityDuration the number of milliseconds a signed transaction is valid for
+     *      inclusion in a block.
+     * @param spawnedEventTimeout the number of milliseconds the client will wait for a
+     *     spawned event to be included in a block before timing out. @param currentTime
+     * @param currentTime support for injecting custom time
+     * @param conditionWaiter support for injecting custom condition waiter
+     * @returns A blockchain transaction client
+     */
+    static createForTest(chainController, shardController, authentication, transactionValidityDuration, spawnedEventTimeout, currentTime, conditionWaiter) {
+        return new BlockchainTransactionClient(chainController, shardController, authentication, transactionValidityDuration, spawnedEventTimeout, currentTime, conditionWaiter);
+    }
+    /**
+     * Sign a transaction in preparation for sending it to the blockchain. The signed transaction
+     * expires after {@link #transactionValidityDuration} millis or if the nonce of the signer
+     * changes.
+     * @param transaction the transaction to sign
+     * @param gasCost the amount of gas to allocate for executing the transaction.
+     * @param applicableUntil the latest time this transaction is allowed
+     * @returns a signed transaction corresponding to the passed transaction.
+     */
+    sign(transaction, gasCost, applicableUntil) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const sender = this.authentication.getAddress();
+            const nonce = (yield this.chainController.getAccount({ address: sender })).nonce;
+            const chainId = (yield this.chainController.getChain()).chainId;
+            let validToTime = this.currentTime() + this.transactionValidityDuration;
+            if (applicableUntil !== undefined) {
+                validToTime = Math.min(validToTime, applicableUntil);
+            }
+            return SignedTransaction_1.SignedTransaction.create(this.authentication, nonce, validToTime, gasCost, chainId, transaction);
+        });
+    }
+    /**
+     * Sends a signed transaction to the blockchain for execution and inclusion in a block.
+     * @param signedTransaction the signed transaction to send.
+     * @returns a sent transaction corresponding to the signed transaction.
+     */
+    send(signedTransaction) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const bytes = signedTransaction.serialize();
+            const serializedTransaction = { payload: bytes.toString("base64") };
+            const transactionPointer = yield this.chainController.putTransaction({ serializedTransaction });
+            return { signedTransaction, transactionPointer };
+        });
+    }
+    /**
+     * Sign and send a transaction to the blockchain for execution.
+     * @param transaction the transaction to sign and send
+     * @param gasCost the amount of gas to allocate for executing the transaction.
+     * @returns a sent transaction corresponding to the signed transaction.
+     */
+    signAndSend(transaction, gasCost) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.send(yield this.sign(transaction, gasCost));
+        });
+    }
+    /**
+     * Waits for a sent transaction to be included in a block on the blockchain.
+     * @param sentTransaction a transaction that has been sent to the blockchain.
+     * @returns the executed state of the transaction.
+     */
+    waitForInclusionInBlock(sentTransaction) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const senderShard = sentTransaction.transactionPointer.destinationShardId;
+            const transactionIdentifier = sentTransaction.transactionPointer.identifier;
+            const validToTime = sentTransaction.signedTransaction.getValidToTime();
+            const timeToWait = validToTime - this.currentTime();
+            return this.waitForTransaction(senderShard, transactionIdentifier, timeToWait);
+        });
+    }
+    /**
+     * Recursively wait for the inclusion of all events spawned by the transaction and the
+     * transaction's events.
+     * @param transaction the transaction to wait for
+     * @returns the execution status for all recursive events spawned by the transaction.
+     */
+    waitForSpawnedEvents(transaction) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let executedTransaction = transaction;
+            if ("signedTransaction" in executedTransaction) {
+                executedTransaction = yield this.waitForInclusionInBlock(executedTransaction);
+            }
+            const events = [];
+            const executionStatus = executedTransaction.executionStatus;
+            const pendingEvents = [...executionStatus.events];
+            while (pendingEvents.length !== 0) {
+                const nextEvent = pendingEvents.shift();
+                const identifier = nextEvent.identifier;
+                const shardId = nextEvent.destinationShardId;
+                const executed = yield this.waitForTransaction(shardId, identifier, this.spawnedEventTimeout);
+                events.push(executed);
+                const executedExecutionStatus = executed.executionStatus;
+                pendingEvents.push(...executedExecutionStatus.events);
+            }
+            return { transaction: executedTransaction, events };
+        });
+    }
+    /**
+     * Try to ensure that the given transaction is included in a final block before the specified time
+     * has passed. Will try to resend the transaction until it has been included in a block or the
+     * specified time has passed. If the transaction has not been included, or we are unable to
+     * determine inclusion, due to network issues, an exception is thrown.
+     *
+     * <p>To determine that a tried transaction has not been included in a block, we must wait until
+     * the last valid block that could have included the transaction has been finalized. The caller of
+     * this function can specify the amount of time to wait for the last valid block after validity
+     * time of the tried transaction has expired.
+     * @param transaction The transaction to sign and send
+     * @param transactionGasCost The amount of gas to allocate for executing the transaction
+     * @param includeBefore The UTC timestamp after which the transaction will no longer tried to be
+     *     sent
+     * @param lastValidBlockWaitTime The amount of time to wait for the last valid block that a tried
+     *     transaction can be included in
+     * @returns The executed state of the transaction
+     * @throws ApiException on io error
+     */
+    ensureInclusionInBlock(transaction, transactionGasCost, includeBefore, lastValidBlockWaitTime) {
+        return __awaiter(this, void 0, void 0, function* () {
+            // Default is 30 days
+            const effectiveLastValidBlockWaitTime = lastValidBlockWaitTime !== null && lastValidBlockWaitTime !== void 0 ? lastValidBlockWaitTime : 2592000000;
+            while (includeBefore > this.currentTime()) {
+                const sentTransaction = yield this.send(yield this.sign(transaction, transactionGasCost, includeBefore));
+                const executedTransaction = yield this.waitForExecutedTransaction(sentTransaction, effectiveLastValidBlockWaitTime);
+                if (executedTransaction !== undefined) {
+                    return executedTransaction;
+                }
+            }
+            throw new Error("Transaction was not included in block before " + includeBefore);
+        });
+    }
+    waitForExecutedTransaction(sentTransaction, latestBlockWait) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                return yield this.waitForInclusionInBlock(sentTransaction);
+            }
+            catch (_) {
+                return yield this.waitForLastPossibleBlockToInclude(sentTransaction, latestBlockWait);
+            }
+        });
+    }
+    waitForLastPossibleBlockToInclude(sentTransaction, latestBlockWait) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const shardId = sentTransaction.transactionPointer.destinationShardId;
+            const validToTime = sentTransaction.signedTransaction.getValidToTime();
+            const timeOut = latestBlockWait + validToTime;
+            yield this.conditionWaiter.waitForCondition(() => __awaiter(this, void 0, void 0, function* () { return (yield this.shardController.getLatestBlock({ shardId })).productionTime; }), (productionTime) => productionTime > validToTime, timeOut, () => `Unable to get block with production time greater than ${validToTime} for shard ${shardId}`);
+            const transactionIdentifier = sentTransaction.transactionPointer.identifier;
+            // Stryker disable BlockStatement
+            try {
+                return yield this.shardController.getTransaction({
+                    shardId,
+                    transactionId: transactionIdentifier,
+                });
+            }
+            catch (_) {
+                return undefined;
+            }
+        });
+    }
+    // Stryker restore BlockStatement
+    waitForTransaction(shardId, transactionId, timeout) {
+        return this.conditionWaiter.waitForCondition(() => this.shardController.getTransaction({ shardId, transactionId }), (value) => value.executionStatus !== undefined && value.executionStatus.finalized, timeout, () => `Transaction '${transactionId}' was not included in a block at shard '${shardId}'`);
+    }
+}
+exports.BlockchainTransactionClient = BlockchainTransactionClient;
+/**
+ * Default signed transaction vilidity time in milliseconds. This is three minutes in
+ * milliseconds.
+ */
+BlockchainTransactionClient.DEFAULT_TRANSACTION_VALIDITY_DURATION = 180000;
+/**
+ * Default timeout for spawned event to be inclusion in a block. This is ten minutes in
+ * milliseconds.
+ */
+BlockchainTransactionClient.DEFAULT_SPAWNED_EVENT_TIMEOUT = 600000;
+/**
+ * Default current time is system time.
+ */
+BlockchainTransactionClient.DEFAULT_CURRENT_TIME = () => new Date().getTime();
+//# sourceMappingURL=BlockchainTransactionClient.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"BlockchainTransactionClient.js","sourceRoot":"","sources":["../../../src/main/transactionclient/BlockchainTransactionClient.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;GAgBG;;;;;;;;;;;;AAGH,kDAO8B;AAC9B,uDAAyE;AACzE,2DAAwD;AAExD,8FAA8F;AAC9F,MAAa,2BAA2B;IA4BtC,YACE,eAAmC,EACnC,eAAmC,EACnC,cAAoC,EACpC,2BAAmC,EACnC,mBAA2B,EAC3B,WAAyB,EACzB,eAAgC;QAEhC,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;QACvC,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;QACvC,IAAI,CAAC,2BAA2B,GAAG,2BAA2B,CAAC;QAC/D,IAAI,CAAC,mBAAmB,GAAG,mBAAmB,CAAC;QAC/C,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;IACzC,CAAC;IAED;;;;;;;;;OASG;IACI,MAAM,CAAC,MAAM,CAClB,OAAe,EACf,cAAoC,EACpC,2BAAoC,EACpC,2BAAoC;QAEpC,MAAM,kBAAkB,GAAG,IAAI,4BAAkB,CAAC,IAAI,uBAAa,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;QAC5F,MAAM,kBAAkB,GAAG,IAAI,4BAAkB,CAAC,IAAI,uBAAa,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;QAC5F,OAAO,IAAI,2BAA2B,CACpC,kBAAkB,EAClB,kBAAkB,EAClB,cAAc,EACd,2BAA2B,aAA3B,2BAA2B,cAA3B,2BAA2B,GAAI,IAAI,CAAC,qCAAqC,EACzE,2BAA2B,aAA3B,2BAA2B,cAA3B,2BAA2B,GAAI,IAAI,CAAC,6BAA6B,EACjE,IAAI,CAAC,oBAAoB,EACzB,qCAAmB,CAAC,MAAM,EAAE,CAC7B,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,aAAa,CAClB,eAAmC,EACnC,eAAmC,EACnC,cAAoC,EACpC,2BAAmC,EACnC,mBAA2B,EAC3B,WAAyB,EACzB,eAAgC;QAEhC,OAAO,IAAI,2BAA2B,CACpC,eAAe,EACf,eAAe,EACf,cAAc,EACd,2BAA2B,EAC3B,mBAAmB,EACnB,WAAW,EACX,eAAe,CAChB,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACU,IAAI,CACf,WAAwB,EACxB,OAAe,EACf,eAAwB;;YAExB,MAAM,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC,UAAU,EAAE,CAAC;YAChD,MAAM,KAAK,GAAG,CAAC,MAAM,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;YACjF,MAAM,OAAO,GAAG,CAAC,MAAM,IAAI,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,CAAC,OAAiB,CAAC;YAC1E,IAAI,WAAW,GAAG,IAAI,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,2BAA2B,CAAC;YACxE,IAAI,eAAe,KAAK,SAAS,EAAE,CAAC;gBAClC,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,eAAe,CAAC,CAAC;YACvD,CAAC;YACD,OAAO,qCAAiB,CAAC,MAAM,CAC7B,IAAI,CAAC,cAAc,EACnB,KAAK,EACL,WAAW,EACX,OAAO,EACP,OAAO,EACP,WAAW,CACZ,CAAC;QACJ,CAAC;KAAA;IAED;;;;OAIG;IACU,IAAI,CAAC,iBAAoC;;YACpD,MAAM,KAAK,GAAG,iBAAiB,CAAC,SAAS,EAAE,CAAC;YAE5C,MAAM,qBAAqB,GAA0B,EAAE,OAAO,EAAE,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC3F,MAAM,kBAAkB,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,cAAc,CAAC,EAAE,qBAAqB,EAAE,CAAC,CAAC;YAChG,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,CAAC;QACnD,CAAC;KAAA;IAED;;;;;OAKG;IACU,WAAW,CAAC,WAAwB,EAAE,OAAe;;YAChE,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC,CAAC;QAChE,CAAC;KAAA;IAED;;;;OAIG;IACU,uBAAuB,CAClC,eAAgC;;YAEhC,MAAM,WAAW,GAAG,eAAe,CAAC,kBAAkB,CAAC,kBAAkB,CAAC;YAC1E,MAAM,qBAAqB,GAAS,eAAe,CAAC,kBAAkB,CAAC,UAAU,CAAC;YAClF,MAAM,WAAW,GAAG,eAAe,CAAC,iBAAiB,CAAC,cAAc,EAAE,CAAC;YACvE,MAAM,UAAU,GAAG,WAAW,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;YAEpD,OAAO,IAAI,CAAC,kBAAkB,CAAC,WAAW,EAAE,qBAAqB,EAAE,UAAU,CAAC,CAAC;QACjF,CAAC;KAAA;IAED;;;;;OAKG;IACU,oBAAoB,CAC/B,WAAkD;;YAElD,IAAI,mBAAmB,GAAG,WAAW,CAAC;YACtC,IAAI,mBAAmB,IAAI,mBAAmB,EAAE,CAAC;gBAC/C,mBAAmB,GAAG,MAAM,IAAI,CAAC,uBAAuB,CAAC,mBAAmB,CAAC,CAAC;YAChF,CAAC;YACD,MAAM,MAAM,GAA0B,EAAE,CAAC;YACzC,MAAM,eAAe,GAAG,mBAAmB,CAAC,eAAgB,CAAC;YAC7D,MAAM,aAAa,GAAG,CAAC,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;YAClD,OAAO,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAClC,MAAM,SAAS,GAAG,aAAa,CAAC,KAAK,EAAwB,CAAC;gBAC9D,MAAM,UAAU,GAAS,SAAS,CAAC,UAAU,CAAC;gBAC9C,MAAM,OAAO,GAAG,SAAS,CAAC,kBAAkB,CAAC;gBAC7C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,UAAU,EAAE,IAAI,CAAC,mBAAmB,CAAC,CAAC;gBAC9F,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBACtB,MAAM,uBAAuB,GAAG,QAAQ,CAAC,eAAgB,CAAC;gBAC1D,aAAa,CAAC,IAAI,CAAC,GAAG,uBAAuB,CAAC,MAAM,CAAC,CAAC;YACxD,CAAC;YACD,OAAO,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,EAAE,CAAC;QACtD,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACU,sBAAsB,CACjC,WAAwB,EACxB,kBAA0B,EAC1B,aAAqB,EACrB,sBAA+B;;YAE/B,qBAAqB;YACrB,MAAM,+BAA+B,GAAG,sBAAsB,aAAtB,sBAAsB,cAAtB,sBAAsB,GAAI,UAAa,CAAC;YAChF,OAAO,aAAa,GAAG,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;gBAC1C,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,IAAI,CACrC,MAAM,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,kBAAkB,EAAE,aAAa,CAAC,CAChE,CAAC;gBACF,MAAM,mBAAmB,GAAG,MAAM,IAAI,CAAC,0BAA0B,CAC/D,eAAe,EACf,+BAA+B,CAChC,CAAC;gBACF,IAAI,mBAAmB,KAAK,SAAS,EAAE,CAAC;oBACtC,OAAO,mBAAmB,CAAC;gBAC7B,CAAC;YACH,CAAC;YACD,MAAM,IAAI,KAAK,CAAC,+CAA+C,GAAG,aAAa,CAAC,CAAC;QACnF,CAAC;KAAA;IAEa,0BAA0B,CACtC,eAAgC,EAChC,eAAuB;;YAEvB,IAAI,CAAC;gBACH,OAAO,MAAM,IAAI,CAAC,uBAAuB,CAAC,eAAe,CAAC,CAAC;YAC7D,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,OAAO,MAAM,IAAI,CAAC,iCAAiC,CAAC,eAAe,EAAE,eAAe,CAAC,CAAC;YACxF,CAAC;QACH,CAAC;KAAA;IAEa,iCAAiC,CAC7C,eAAgC,EAChC,eAAuB;;YAEvB,MAAM,OAAO,GAAG,eAAe,CAAC,kBAAkB,CAAC,kBAAkB,CAAC;YACtE,MAAM,WAAW,GAAG,eAAe,CAAC,iBAAiB,CAAC,cAAc,EAAE,CAAC;YACvE,MAAM,OAAO,GAAG,eAAe,GAAG,WAAW,CAAC;YAC9C,MAAM,IAAI,CAAC,eAAe,CAAC,gBAAgB,CACzC,GAAS,EAAE,gDAAC,OAAA,CAAC,MAAM,IAAI,CAAC,eAAe,CAAC,cAAc,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,cAAc,CAAA,GAAA,EACnF,CAAC,cAAc,EAAE,EAAE,CAAC,cAAc,GAAG,WAAW,EAChD,OAAO,EACP,GAAG,EAAE,CACH,yDAAyD,WAAW,cAAc,OAAO,EAAE,CAC9F,CAAC;YACF,MAAM,qBAAqB,GAAG,eAAe,CAAC,kBAAkB,CAAC,UAAU,CAAC;YAE5E,iCAAiC;YACjC,IAAI,CAAC;gBACH,OAAO,MAAM,IAAI,CAAC,eAAe,CAAC,cAAc,CAAC;oBAC/C,OAAO;oBACP,aAAa,EAAE,qBAAqB;iBACrC,CAAC,CAAC;YACL,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,OAAO,SAAS,CAAC;YACnB,CAAC;QACH,CAAC;KAAA;IACD,iCAAiC;IAEzB,kBAAkB,CACxB,OAAe,EACf,aAAmB,EACnB,OAAe;QAEf,OAAO,IAAI,CAAC,eAAe,CAAC,gBAAgB,CAC1C,GAAG,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,cAAc,CAAC,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC,EACrE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,eAAe,KAAK,SAAS,IAAI,KAAK,CAAC,eAAe,CAAC,SAAS,EACjF,OAAO,EACP,GAAG,EAAE,CAAC,gBAAgB,aAAa,2CAA2C,OAAO,GAAG,CACzF,CAAC;IACJ,CAAC;;AA1SH,kEA2SC;AAhSC;;;GAGG;AACoB,iEAAqC,GAAG,MAAM,CAAC;AAEtE;;;GAGG;AACoB,yDAA6B,GAAG,MAAM,CAAC;AAE9D;;GAEG;AACoB,gDAAoB,GAAG,GAAG,EAAE,CAAC,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC"}

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

@@ -0,0 +1,57 @@
+/**
+ * Generic wait interface allowing the creation of asynchronous calls and wait for these. The user
+ * must provide a value getter and a value predicate, the value getter returns the current value,
+ * the value predicate whether the value is "complete" and the wait is over.
+ */
+export interface ConditionWaiter {
+    /**
+     * Waits for the condition dictated by the input predicate until it is met. Times out by if the
+     * condition is not met within a specified time-out. Sleeps in an incrementing fashion between
+     * checks of the condition until a maximum of 30 seconds between iterations to avoid busy-waiting.
+     * @param valueSupplier The supplier of (possibly) updated values for the condition.
+     * @param valuePredicate The condition that the value must meet before waiting is over.
+     * @param timeoutMs The time to wait for in milliseconds.
+     * @param errorMessage The lazy initialized error message to throw in case of timing out.
+     * @returns The final value returned by the supplier, which meets the condition.
+     */
+    waitForCondition<T>(valueSupplier: () => Promise<T>, valuePredicate: (value: T) => boolean, timeoutMs: number, errorMessage: () => string): Promise<T>;
+}
+/**
+ * Can wait for a condition to become fulfilled by repeatedly sleeping the current thread between
+ * checks.
+ */
+export declare class ConditionWaiterImpl implements ConditionWaiter {
+    private readonly timeSupport;
+    private constructor();
+    /**
+     * @inheritdoc
+     */
+    waitForCondition<T>(valueSupplier: () => Promise<T>, valuePredicate: (value: T) => boolean, timeoutMs: number, errorMessage: () => string): Promise<T>;
+    /**
+     * Creates a new condition waiter using the system time and system sleep.
+     * @returns The transaction waiter.
+     */
+    static create(): ConditionWaiterImpl;
+    /**
+     * Creates a new condition waiter.
+     * @param timeSupport Support for time (current time and sleep).
+     * @returns The transaction waiter.
+     */
+    static createForTest(timeSupport: TimeSupport): ConditionWaiterImpl;
+}
+/** Support for getting the current time and sleeping. */
+export interface TimeSupport {
+    /**
+     * Gets the current time in milliseconds.
+     * @returns The current time in milliseconds.
+     */
+    now(): number;
+    /**
+     * Pauses execution of the current program for some measure of time.
+     * @param ms The time to stop execution in milliseconds.
+     * @returns an empty promise that resolves after the duration has passed
+     */
+    sleep(ms: number): Promise<void>;
+}
+/** Time support that uses the underlying operating system. */
+export declare const TimeSupportSystem: TimeSupport;

package/target/main/transactionclient/ConditionWaiter.js

@@ -0,0 +1,94 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TimeSupportSystem = exports.ConditionWaiterImpl = void 0;
+/**
+ * Can wait for a condition to become fulfilled by repeatedly sleeping the current thread between
+ * checks.
+ */
+class ConditionWaiterImpl {
+    constructor(timeSupport) {
+        this.timeSupport = timeSupport;
+    }
+    /**
+     * @inheritdoc
+     */
+    waitForCondition(valueSupplier, valuePredicate, timeoutMs, errorMessage) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const end = this.timeSupport.now() + timeoutMs;
+            let increasingSleep = 0;
+            let remainingTime;
+            do {
+                let value = undefined;
+                try {
+                    value = yield valueSupplier();
+                }
+                catch (error) {
+                    // Empty try again
+                }
+                if (value !== undefined && valuePredicate(value)) {
+                    return value;
+                }
+                increasingSleep++;
+                const sleepDurationMs = Math.min(30000, 100 * increasingSleep);
+                remainingTime = Math.max(0, end - this.timeSupport.now());
+                const effectiveSleepDuration = Math.min(sleepDurationMs, remainingTime);
+                yield this.timeSupport.sleep(effectiveSleepDuration);
+            } while (remainingTime > 0);
+            throw new Error(errorMessage());
+        });
+    }
+    /**
+     * Creates a new condition waiter using the system time and system sleep.
+     * @returns The transaction waiter.
+     */
+    static create() {
+        return new ConditionWaiterImpl(exports.TimeSupportSystem);
+    }
+    /**
+     * Creates a new condition waiter.
+     * @param timeSupport Support for time (current time and sleep).
+     * @returns The transaction waiter.
+     */
+    static createForTest(timeSupport) {
+        return new ConditionWaiterImpl(timeSupport);
+    }
+}
+exports.ConditionWaiterImpl = ConditionWaiterImpl;
+/** Time support that uses the underlying operating system. */
+exports.TimeSupportSystem = {
+    /** @inheritDoc */
+    now() {
+        return new Date().getTime();
+    },
+    /** @inheritDoc */
+    sleep(ms) {
+        return new Promise((resolve) => setTimeout(resolve, ms));
+    },
+};
+//# sourceMappingURL=ConditionWaiter.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ConditionWaiter.js","sourceRoot":"","sources":["../../../src/main/transactionclient/ConditionWaiter.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;GAgBG;;;;;;;;;;;;AA0BH;;;GAGG;AACH,MAAa,mBAAmB;IAG9B,YAAoB,WAAwB;QAC1C,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;IACjC,CAAC;IAED;;OAEG;IACG,gBAAgB,CACpB,aAA+B,EAC/B,cAAqC,EACrC,SAAiB,EACjB,YAA0B;;YAE1B,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC;YAC/C,IAAI,eAAe,GAAG,CAAC,CAAC;YACxB,IAAI,aAAa,CAAC;YAClB,GAAG,CAAC;gBACF,IAAI,KAAK,GAAkB,SAAS,CAAC;gBACrC,IAAI,CAAC;oBACH,KAAK,GAAG,MAAM,aAAa,EAAE,CAAC;gBAChC,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,kBAAkB;gBACpB,CAAC;gBACD,IAAI,KAAK,KAAK,SAAS,IAAI,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC;oBACjD,OAAO,KAAK,CAAC;gBACf,CAAC;gBACD,eAAe,EAAE,CAAC;gBAClB,MAAM,eAAe,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,GAAG,eAAe,CAAC,CAAC;gBAC/D,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,CAAC;gBAC1D,MAAM,sBAAsB,GAAG,IAAI,CAAC,GAAG,CAAC,eAAe,EAAE,aAAa,CAAC,CAAC;gBACxE,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC;YACvD,CAAC,QAAQ,aAAa,GAAG,CAAC,EAAE;YAC5B,MAAM,IAAI,KAAK,CAAC,YAAY,EAAE,CAAC,CAAC;QAClC,CAAC;KAAA;IAED;;;OAGG;IACI,MAAM,CAAC,MAAM;QAClB,OAAO,IAAI,mBAAmB,CAAC,yBAAiB,CAAC,CAAC;IACpD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,aAAa,CAAC,WAAwB;QAClD,OAAO,IAAI,mBAAmB,CAAC,WAAW,CAAC,CAAC;IAC9C,CAAC;CACF;AAtDD,kDAsDC;AAiBD,8DAA8D;AACjD,QAAA,iBAAiB,GAAgB;IAC5C,kBAAkB;IAClB,GAAG;QACD,OAAO,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;IAC9B,CAAC;IACD,kBAAkB;IAClB,KAAK,CAAC,EAAU;QACd,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;IAC3D,CAAC;CACF,CAAC"}

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

@@ -0,0 +1,24 @@
+import { ec as Elliptic } from "elliptic";
+import { BlockchainAddress, SenderAuthentication, Signature } from "./types";
+/**
+ * Sender authentication based on a key-pair, consisting of a public and private key. The sender
+ * address is computed from the public key.
+ */
+export declare class SenderAuthenticationKeyPair implements SenderAuthentication {
+    private readonly keyPair;
+    /**
+     * Creates authentication for a sender.
+     * @param keyPair The public and private key of the sender. Not nullable.
+     */
+    constructor(keyPair: Elliptic.KeyPair);
+    /**
+     * Creates a sender's authentication from a private key.
+     * @param privateKey The private key to create a key pair from, written as a value in hexidecimal.
+     * @returns authentication for a transaction sender.
+     */
+    static fromString(privateKey: string): SenderAuthenticationKeyPair;
+    /** @inheritDoc */
+    getAddress(): BlockchainAddress;
+    /** @inheritDoc */
+    sign(transactionPayload: Buffer, chainId: string): Promise<Signature>;
+}

package/target/main/transactionclient/SenderAuthenticationKeyPair.js

@@ -0,0 +1,68 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SenderAuthenticationKeyPair = void 0;
+const CryptoUtils_1 = require("../CryptoUtils");
+const bitmanipulation_ts_1 = require("@secata-public/bitmanipulation-ts");
+/**
+ * Sender authentication based on a key-pair, consisting of a public and private key. The sender
+ * address is computed from the public key.
+ */
+class SenderAuthenticationKeyPair {
+    /**
+     * Creates authentication for a sender.
+     * @param keyPair The public and private key of the sender. Not nullable.
+     */
+    constructor(keyPair) {
+        this.keyPair = keyPair;
+    }
+    /**
+     * Creates a sender's authentication from a private key.
+     * @param privateKey The private key to create a key pair from, written as a value in hexidecimal.
+     * @returns authentication for a transaction sender.
+     */
+    static fromString(privateKey) {
+        return new SenderAuthenticationKeyPair(CryptoUtils_1.CryptoUtils.privateKeyToKeypair(privateKey));
+    }
+    /** @inheritDoc */
+    getAddress() {
+        return CryptoUtils_1.CryptoUtils.keyPairToAccountAddress(this.keyPair);
+    }
+    /** @inheritDoc */
+    sign(transactionPayload, chainId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const hash = CryptoUtils_1.CryptoUtils.hashBuffers([
+                transactionPayload,
+                bitmanipulation_ts_1.BigEndianByteOutput.serialize((out) => out.writeString(chainId)),
+            ]).toString("hex");
+            return CryptoUtils_1.CryptoUtils.signatureToBuffer(this.keyPair.sign(hash)).toString("hex");
+        });
+    }
+}
+exports.SenderAuthenticationKeyPair = SenderAuthenticationKeyPair;
+//# sourceMappingURL=SenderAuthenticationKeyPair.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SenderAuthenticationKeyPair.js","sourceRoot":"","sources":["../../../src/main/transactionclient/SenderAuthenticationKeyPair.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;GAgBG;;;;;;;;;;;;AAIH,gDAA6C;AAC7C,0EAAwE;AAExE;;;GAGG;AACH,MAAa,2BAA2B;IAGtC;;;OAGG;IACH,YAAmB,OAAyB;QAC1C,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,UAAkB;QACzC,OAAO,IAAI,2BAA2B,CAAC,yBAAW,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC,CAAC;IACtF,CAAC;IAED,kBAAkB;IACX,UAAU;QACf,OAAO,yBAAW,CAAC,uBAAuB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC3D,CAAC;IAED,kBAAkB;IACL,IAAI,CAAC,kBAA0B,EAAE,OAAe;;YAC3D,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,OAAO,yBAAW,CAAC,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAChF,CAAC;KAAA;CACF;AAjCD,kEAiCC"}

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

@@ -0,0 +1,54 @@
+import { Hash, SenderAuthentication, Transaction } from "./types";
+/**
+ * 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.
+ */
+export declare class SignedTransaction {
+    private readonly inner;
+    private readonly signature;
+    private readonly hash;
+    private constructor();
+    /**
+     * 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: SenderAuthentication, nonce: number, validToTime: number, gasCost: number, chainId: string, transaction: Transaction): Promise<SignedTransaction>;
+    /**
+     * Serialize the signed transaction into bytes.
+     * @returns the serialized bytes.
+     */
+    serialize(): Buffer;
+    /**
+     * Get the identifier of this transaction.
+     * @returns the identify hash
+     */
+    identifier(): Hash;
+    /**
+     * Get the nonce of this transaction.
+     * @returns the nonce
+     */
+    getNonce(): number;
+    /**
+     * 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(): number;
+    /**
+     * Get the gas cost of this transaction.
+     * @returns the gas cost
+     */
+    getGasCost(): number;
+    /**
+     * Get the inner transaction of this transaction.
+     * @returns the inner
+     */
+    getInner(): Transaction;
+}