postchain-client 2.0.2 → 2.0.3

package/built/cjs/index.js

@@ -385,7 +385,19 @@ function sortDictPairByKey(dict) {
     return sortedDict;
 }
 
+const MERKLE_HASH_VERSIONS = {
+    ONE: 1,
+    TWO: 2,
+    UNSET: NaN,
+};
+
 const gtvHash2 = (obj, merkleHashVersion) => {
+    if (!Object.values(MERKLE_HASH_VERSIONS).includes(merkleHashVersion)) {
+        throw new Error("Merkle hash version is not valid");
+    }
+    if (isNaN(merkleHashVersion)) {
+        throw new Error("Merkle hash version is not set");
+    }
     return merklehashts.gtvHash(obj, merkleHashVersion);
 };
 const encode$1 = encodeValue;
@@ -610,7 +622,7 @@ function sign(gtx, privOrSigProv, merkleHashVersion, pubKey) {
         else {
             // Removes signatures and extract the rawgtxBody
             const rawGtxBody = gtxToRawGtxBody(gtx);
-            const signature = yield privOrSigProv.sign(rawGtxBody);
+            const signature = yield privOrSigProv.sign(rawGtxBody, merkleHashVersion);
             return addSignature(privOrSigProv.pubKey, signature, gtx);
         }
     });
@@ -680,7 +692,7 @@ function checkExistingGTXSignatures(txHash, gtx) {
     }
     return true;
 }
-function newSignatureProvider(merkleHashVersion, keyPair) {
+function newSignatureProvider(keyPair) {
     let pub, priv;
     if (keyPair) {
         priv = ensureBuffer(keyPair.privKey);
@@ -691,7 +703,7 @@ function newSignatureProvider(merkleHashVersion, keyPair) {
     }
     return {
         pubKey: pub,
-        sign: (gtx) => __awaiter$9(this, void 0, void 0, function* () {
+        sign: (gtx, merkleHashVersion) => __awaiter$9(this, void 0, void 0, function* () {
             const signature = getDigestToSignFromRawGtxBody(gtx, merkleHashVersion);
             return signDigest(signature, priv);
         }),
@@ -988,6 +1000,7 @@ exports.TransactionEvent = void 0;
     TransactionEvent["DappConfirmed"] = "dappConfirmed";
     TransactionEvent["DappReceived"] = "dappReceived";
     TransactionEvent["Signed"] = "signed";
+    TransactionEvent["Rejected"] = "rejected";
 })(exports.TransactionEvent || (exports.TransactionEvent = {}));
 exports.AnchoringStatus = void 0;
 (function (AnchoringStatus) {
@@ -1296,11 +1309,6 @@ function encodeTransaction(gtx) {
     return serialize(gtx);
 }
 
-const MERKLE_HASH_VERSIONS = {
-    ONE: 1,
-    TWO: 2,
-};
-
 const MerkleHashSchema = zod.z.object({
     merkle_hash_version: zod.z.number().int().positive(),
 });
@@ -1583,7 +1591,8 @@ function retryRequest({ method, path, config, postObject, validateStatusCode, })
         let error = null;
         let transactionTimestamp = undefined;
         const { nodeManager } = config;
-        for (const endpoint of nodeManager.getAvailableNodes()) {
+        const availableNodes = nodeManager.getAvailableNodes();
+        for (const endpoint of availableNodes) {
             for (let attempt = 0; attempt < config.attemptsPerEndpoint; attempt++) {
                 const response = yield handleRequest(method, path, endpoint.url, postObject);
                 error = (_a = response === null || response === void 0 ? void 0 : response.error) !== null && _a !== void 0 ? _a : null;
@@ -1594,6 +1603,7 @@ function retryRequest({ method, path, config, postObject, validateStatusCode, })
                 const isServerError = statusCode ? hasServerError(statusCode) : false;
                 if (isStatusCodeValid && !error) {
                     // Find a way to have this handled more elegantly in the node manager.
+                    nodeManager.lastUsedNode = endpoint;
                     if (nodeManager.stickedNode !== endpoint) {
                         nodeManager.setStickyNode(endpoint);
                     }
@@ -1744,7 +1754,7 @@ function getClientConfigFromSettings(settings) {
                     nodeManager,
                     endpointPool,
                     chainId: settings.blockchainIid,
-                    merkleHashVersion: (_k = settings.merkleHashVersion) !== null && _k !== void 0 ? _k : 0,
+                    merkleHashVersion: (_k = settings.merkleHashVersion) !== null && _k !== void 0 ? _k : MERKLE_HASH_VERSIONS.UNSET,
                 });
             }
             throw new MissingBlockchainIdentifierError();
@@ -1759,17 +1769,18 @@ function getClientConfigFromSettings(settings) {
                 nodeManager,
                 endpointPool,
                 chainId: directoryChainIid,
-                merkleHashVersion: (_l = settings.merkleHashVersion) !== null && _l !== void 0 ? _l : 0,
+                merkleHashVersion: (_l = settings.merkleHashVersion) !== null && _l !== void 0 ? _l : MERKLE_HASH_VERSIONS.UNSET,
             });
         }))();
         return {
             endpointPool,
             nodeManager: nodeManager,
             blockchainRid: blockchainRidToUse,
-            merkleHashVersion: (_e = settings.merkleHashVersion) !== null && _e !== void 0 ? _e : 0,
+            merkleHashVersion: (_e = settings.merkleHashVersion) !== null && _e !== void 0 ? _e : MERKLE_HASH_VERSIONS.UNSET,
             dappStatusPolling: setStatusPolling(settings.dappStatusPolling),
             clusterAnchoringStatusPolling: setStatusPolling(settings.clusterAnchoringStatusPolling),
             systemAnchoringStatusPolling: setStatusPolling(settings.systemAnchoringStatusPolling),
+            retryTransactionPolling: setRetryTransactionPolling(settings.retryTransactionPolling),
             failoverStrategy: ((_f = settings.failOverConfig) === null || _f === void 0 ? void 0 : _f.strategy) || defaultFailoverConfig.strategy,
             attemptsPerEndpoint: ((_g = settings.failOverConfig) === null || _g === void 0 ? void 0 : _g.attemptsPerEndpoint) || defaultFailoverConfig.attemptsPerEndpoint,
             attemptInterval: ((_h = settings.failOverConfig) === null || _h === void 0 ? void 0 : _h.attemptInterval) || defaultFailoverConfig.attemptInterval,
@@ -1805,7 +1816,6 @@ function nodeDiscovery({ nodeManager, directoryEndpointPool, failOverConfig, blo
             endpointPool: directoryEndpointPool,
             chainId: directoryIid,
             failOverConfig,
-            merkleHashVersion: 0,
         });
         const blockchainRidToUse = yield (() => __awaiter$5(this, void 0, void 0, function* () {
             if (blockchainRid) {
@@ -1817,7 +1827,6 @@ function nodeDiscovery({ nodeManager, directoryEndpointPool, failOverConfig, blo
                     endpointPool: directoryEndpointPool,
                     chainId: blockchainIid,
                     failOverConfig,
-                    merkleHashVersion: 0,
                 });
             }
             throw new MissingBlockchainIdentifierError();
@@ -1825,7 +1834,6 @@ function nodeDiscovery({ nodeManager, directoryEndpointPool, failOverConfig, blo
         const D1Client = yield createClient({
             nodeUrlPool: getUrlsFromEndpoints(directoryEndpointPool),
             blockchainRid: directoryBRID,
-            merkleHashVersion: 0,
         });
         return yield getBlockchainApiUrls(D1Client, ensureBuffer(blockchainRidToUse));
     });
@@ -1998,7 +2006,6 @@ function getSystemClient(directoryNodeUrlPool, directoryChainRid) {
         return yield createClient({
             directoryNodeUrlPool,
             blockchainRid: directoryChainRid,
-            merkleHashVersion: 0,
         });
     });
 }
@@ -2037,7 +2044,7 @@ const getUrlsFromEndpoints = (endpointPool) => {
 function awaitDappConfirmation(txRID, dappStatusPolling, getTransactionStatus) {
     var _a;
     return __awaiter$5(this, void 0, void 0, function* () {
-        let lastKnownResult;
+        let lastKnownResult = null;
         for (let i = 0; i < dappStatusPolling.count; i++) {
             lastKnownResult = yield getTransactionStatus(txRID);
             if (lastKnownResult.status === exports.ResponseStatus.Confirmed) {
@@ -2048,10 +2055,7 @@ function awaitDappConfirmation(txRID, dappStatusPolling, getTransactionStatus) {
             }
             yield sleep(dappStatusPolling.interval);
         }
-        // TS issue. This could be fixed by implementing new retry strategy
-        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-        //@ts-expect-error
-        return lastKnownResult;
+        throw new Error(`Retry count exceeded. Confirmation not received. Last transaction status: ${lastKnownResult === null || lastKnownResult === void 0 ? void 0 : lastKnownResult.status}`);
     });
 }
 function awaitClusterAnchoringChainConfirmation(txRID, clusterAnchoringStatusPolling, getClusterAnchoringTransactionConfirmation) {
@@ -2165,6 +2169,13 @@ function setStatusPolling(statusPolling) {
         count: (_b = statusPolling === null || statusPolling === void 0 ? void 0 : statusPolling.count) !== null && _b !== void 0 ? _b : 20,
     };
 }
+function setRetryTransactionPolling(statusPolling) {
+    var _a, _b;
+    return {
+        interval: (_a = statusPolling === null || statusPolling === void 0 ? void 0 : statusPolling.interval) !== null && _a !== void 0 ? _a : 500,
+        count: (_b = statusPolling === null || statusPolling === void 0 ? void 0 : statusPolling.count) !== null && _b !== void 0 ? _b : 3,
+    };
+}
 function linkPromiEvents(event1, event2) {
     const transactionEvents = Object.values(exports.TransactionEvent).filter((event) => typeof event === "string");
     /* eslint-disable @typescript-eslint/no-explicit-any */
@@ -2236,11 +2247,12 @@ function getBlockchainRidFromIid({ endpointPool, chainId, failOverConfig = {}, n
             dappStatusPolling: setStatusPolling(),
             clusterAnchoringStatusPolling: setStatusPolling(),
             systemAnchoringStatusPolling: setStatusPolling(),
+            retryTransactionPolling: setRetryTransactionPolling(),
             failoverStrategy: mergedFailOverConfig.strategy,
             attemptsPerEndpoint: mergedFailOverConfig.attemptsPerEndpoint,
             attemptInterval: mergedFailOverConfig.attemptInterval,
             unreachableDuration: mergedFailOverConfig.unreachableDuration,
-            merkleHashVersion: 0,
+            merkleHashVersion: MERKLE_HASH_VERSIONS.UNSET,
         };
         const { error, statusCode, rspBody } = yield requestWithFailoverStrategy(Method.GET, `/brid/iid_${chainId}`, config);
         const blockchainRid = isString(rspBody);
@@ -2548,7 +2560,7 @@ function getAnchoringClient(client, dappBlockchainRid, cluster) {
         if (!sourceClusterInfo || !sourceClusterInfo.anchoring_chain) {
             throw Error("Cluster info could not be found");
         }
-        const networkSettings = Object.assign(Object.assign({}, client.config), { directoryNodeUrlPool: getUrlsFromEndpoints(client.config.endpointPool), blockchainRid: toString(sourceClusterInfo.anchoring_chain), merkleHashVersion: 0 });
+        const networkSettings = Object.assign(Object.assign({}, client.config), { directoryNodeUrlPool: getUrlsFromEndpoints(client.config.endpointPool), blockchainRid: toString(sourceClusterInfo.anchoring_chain) });
         const clientConfiguredToAnchoringchain = yield createClient(networkSettings);
         return clientConfiguredToAnchoringchain;
     });
@@ -2906,6 +2918,48 @@ function createClient(settings) {
                     }
                 });
             },
+            sendTransactionWithRetries(transaction, callback, confirmationLevel = exports.ChainConfirmationLevel.Dapp) {
+                const client = this;
+                function sendOnce() {
+                    return client.sendTransaction(transaction, true, callback, confirmationLevel);
+                }
+                const promiEvent = new Web3PromiEvent((resolve, reject) => __awaiter$1(this, void 0, void 0, function* () {
+                    let error = null;
+                    // await sleep(1000);
+                    for (let i = 0; i < config.retryTransactionPolling.count; i++) {
+                        info(`sendTransactionWithRetries attempt ${i + 1} of ${config.retryTransactionPolling.count}`);
+                        const tmpPromiEvent = sendOnce()
+                            .on(exports.TransactionEvent.ClusterAnchoringConfirmation, receipt => {
+                            promiEvent.emit(exports.TransactionEvent.ClusterAnchoringConfirmation, receipt);
+                        })
+                            .on(exports.TransactionEvent.SystemAnchoringConfirmation, receipt => {
+                            promiEvent.emit(exports.TransactionEvent.SystemAnchoringConfirmation, receipt);
+                        })
+                            .on(exports.TransactionEvent.DappReceived, receipt => {
+                            promiEvent.emit(exports.TransactionEvent.DappReceived, receipt);
+                        })
+                            .on(exports.TransactionEvent.Signed, receipt => {
+                            promiEvent.emit(exports.TransactionEvent.Signed, receipt);
+                        })
+                            .on(exports.TransactionEvent.DappConfirmed, receipt => {
+                            promiEvent.emit(exports.TransactionEvent.DappConfirmed, receipt);
+                        })
+                            .catch(tmpError => {
+                            warning(`sendTransactionWithRetries error on attempt ${i + 1} of ${config.retryTransactionPolling.count}: ${tmpError}`);
+                            promiEvent.emit(exports.TransactionEvent.Rejected, tmpError);
+                            error = tmpError;
+                        });
+                        const tmpReceipt = yield tmpPromiEvent;
+                        if (tmpReceipt) {
+                            resolve(tmpReceipt);
+                            return;
+                        }
+                        yield sleep(config.retryTransactionPolling.interval);
+                    }
+                    reject(error);
+                }));
+                return promiEvent;
+            },
             sendTransaction(transaction, doStatusPolling = true, callback, confirmationLevel = exports.ChainConfirmationLevel.Dapp) {
                 const promiEvent = new Web3PromiEvent((resolve, reject) => __awaiter$1(this, void 0, void 0, function* () {
                     var _a, _b;
@@ -2940,14 +2994,15 @@ function createClient(settings) {
                             clusterAnchoringStatusPolling: client.config.clusterAnchoringStatusPolling,
                             systemAnchoringStatusPolling: client.config.systemAnchoringStatusPolling,
                         };
-                        let transactionReceipt = yield handleDappConfirmations(transactionRid, doStatusPolling, confirmationLevel, promiEvent, statusPollingConfig.dappStatusPolling, () => client.getTransactionStatus(transactionRid, callback), client);
+                        const stickyNodeClient = yield createStickyNodeClient(client); //to avoid false rejections by oblivious nodes
+                        let transactionReceipt = yield handleDappConfirmations(transactionRid, doStatusPolling, confirmationLevel, promiEvent, statusPollingConfig.dappStatusPolling, () => stickyNodeClient.getTransactionStatus(transactionRid, callback), stickyNodeClient);
                         if (confirmationLevel === exports.ChainConfirmationLevel.None ||
                             confirmationLevel === exports.ChainConfirmationLevel.Dapp) {
                             resolve(transactionReceipt);
                             return;
                         }
                         const { anchoringClient, systemAnchoringChainBridString } = yield getAnchoringClientAndSystemChainRid(client);
-                        transactionReceipt = yield handleSystemConfirmations(transactionReceipt, confirmationLevel, promiEvent, statusPollingConfig, anchoringClient, systemAnchoringChainBridString, () => client.getClusterAnchoringTransactionConfirmation(transactionRid, anchoringClient, callback), anchoredTxRid => client.getSystemAnchoringTransactionConfirmation(anchoredTxRid, anchoringClient, systemAnchoringChainBridString, callback));
+                        transactionReceipt = yield handleSystemConfirmations(transactionReceipt, confirmationLevel, promiEvent, statusPollingConfig, anchoringClient, systemAnchoringChainBridString, () => stickyNodeClient.getClusterAnchoringTransactionConfirmation(transactionRid, anchoringClient, callback), anchoredTxRid => stickyNodeClient.getSystemAnchoringTransactionConfirmation(anchoredTxRid, anchoringClient, systemAnchoringChainBridString, callback));
                         resolve(transactionReceipt);
                     }
                     catch (error) {
@@ -3367,6 +3422,21 @@ function createClient(settings) {
                 return merkleHashVersion;
             });
         }
+        function createStickyNodeClient(client) {
+            var _a;
+            return __awaiter$1(this, void 0, void 0, function* () {
+                if (!client.config.nodeManager.lastUsedNode) {
+                    throw new Error("No last used node found; cannot create sticky node client");
+                }
+                const stickyNodeClient = yield createClient({
+                    nodeUrlPool: (_a = client.config.nodeManager.lastUsedNode) === null || _a === void 0 ? void 0 : _a.url,
+                    blockchainRid: client.config.blockchainRid,
+                    merkleHashVersion: client.config.merkleHashVersion,
+                    useStickyNode: true,
+                });
+                return stickyNodeClient;
+            });
+        }
     });
 }
 
@@ -3392,6 +3462,7 @@ function createStubClient() {
                 dappStatusPolling: setStatusPolling({ interval: 5000, count: 5 }),
                 clusterAnchoringStatusPolling: setStatusPolling(),
                 systemAnchoringStatusPolling: setStatusPolling(),
+                retryTransactionPolling: setRetryTransactionPolling(),
                 failoverStrategy: exports.FailoverStrategy.AbortOnError,
                 attemptsPerEndpoint: 3,
                 attemptInterval: 5000,
@@ -3411,6 +3482,9 @@ function createStubClient() {
             sendTransaction() {
                 return new Web3PromiEvent((_resolve, reject) => reject("sendTransaction rejected"));
             },
+            sendTransactionWithRetries() {
+                return new Web3PromiEvent((_resolve, reject) => reject("sendTransactionWithRetries rejected"));
+            },
             signAndSendUniqueTransaction() {
                 return new Web3PromiEvent((_resolve, reject) => reject("signAndSendUniqueTransaction rejected"));
             },