@partisiablockchain/blockchain-api-transaction-client 5.59.0 → 5.68.0

package/target/main/transactionclient/TransactionTree.js

@@ -0,0 +1,50 @@
+"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 });
+exports.TransactionTree = void 0;
+/** Status for a transaction and the whole tree of spawned events. */
+class TransactionTree {
+    /**
+     * Create new TransactionTree.
+     * @param transaction the original transaction.
+     * @param events list of spawned events from the transaction.
+     */
+    constructor(transaction, events) {
+        this.transaction = transaction;
+        this.events = events;
+    }
+    /**
+     * Check if the executed transaction tree includes any transactions or events which did not
+     * succeed.
+     * @returns true if the transaction tree includes any failures, false if all succeeded.
+     */
+    hasFailures() {
+        if (!this.transaction.executionStatus.success) {
+            return true;
+        }
+        for (const event of this.events) {
+            if (!event.executionStatus.success) {
+                return true;
+            }
+        }
+        return false;
+    }
+}
+exports.TransactionTree = TransactionTree;
+//# sourceMappingURL=TransactionTree.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"TransactionTree.js","sourceRoot":"","sources":["../../../src/main/transactionclient/TransactionTree.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;GAgBG;;;AAIH,qEAAqE;AACrE,MAAa,eAAe;IAM1B;;;;OAIG;IACH,YAAY,WAAgC,EAAE,MAA6B;QACzE,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACI,WAAW;QAChB,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,eAAgB,CAAC,OAAO,EAAE,CAAC;YAC/C,OAAO,IAAI,CAAC;QACd,CAAC;QACD,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChC,IAAI,CAAC,KAAK,CAAC,eAAgB,CAAC,OAAO,EAAE,CAAC;gBACpC,OAAO,IAAI,CAAC;YACd,CAAC;QACH,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AAhCD,0CAgCC"}

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

@@ -1,5 +1,5 @@
 import { SignedTransaction } from "./SignedTransaction";
-import { ExecutedTransaction, TransactionPointer } from "../generated/openapi";
+import { ExecutedTransaction, SerializedTransaction, TransactionPointer } from "../generated/openapi";
 /** Hash as a 32 byte long hex string. */
 export type Hash = string;
 /** BlockchainAddress as 21 byte long hex string. */
@@ -40,10 +40,39 @@ export interface SentTransaction {
     /** 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[];
+/**
+ * A client for getting the information to create a transaction, and send it after creation and
+ * signing.
+ */
+export interface BlockchainClientForTransaction {
+    /**
+     * Get the chain ID for the running chain.
+     * @returns the chain ID string.
+     */
+    getChainId(): Promise<string>;
+    /**
+     * Get the current nonce to use when signing a transaction for the given account.
+     * @param blockchainAddress the address to get the nonce for.
+     * @returns the current nonce to use for signing.
+     */
+    getNonce(blockchainAddress: BlockchainAddress): Promise<number>;
+    /**
+     * Retrieve an executed transaction from the blockchain.
+     * @param shardId The name of the shard to interact with.
+     * @param transactionId The transaction hash.
+     * @returns The retrieved transaction.
+     */
+    getTransaction(shardId: string, transactionId: Hash): Promise<ExecutedTransaction>;
+    /**
+     * Get the production time from the latest created block of a specific shard.
+     * @param shardId the id of the shard.
+     * @returns the production time of the latest created block.
+     */
+    getLatestProductionTime(shardId: string): Promise<number>;
+    /**
+     * Send a signed transaction to the chain and return a pointer to the transaction.
+     * @param serializedTransaction the transaction to send.
+     * @returns a pointer to the transaction on chain.
+     */
+    putTransaction(serializedTransaction: SerializedTransaction): Promise<TransactionPointer>;
 }