evernode-js-client 0.6.28 → 0.6.30

package/index.js

@@ -52510,6 +52510,40 @@ class BaseEvernodeClient {
         return (hosts.nextPageToken ? { ...hosts, data: res } : res);
     }
 
+    /**
+     * Get the hosts registered in Evernode.
+     * @returns The list of hosts. 
+     */
+    async getAllHostsFromLedger() {
+        const states = await this.getHookStates();
+        let hosts = {};
+
+        for (const state of states) {
+            const stateKey = Buffer.from(state.key, 'hex');
+            if (state.data) {
+                const stateData = Buffer.from(state.data, 'hex');
+                const decoded = StateHelpers.decodeStateData(stateKey, stateData);
+                if (decoded.type == StateHelpers.StateTypes.HOST_ADDR || decoded.type == StateHelpers.StateTypes.TOKEN_ID) {
+                    hosts[decoded.address] = { ...(hosts[decoded.address] ?? {}), ...decoded };
+                }
+            }
+        }
+
+        const hostList = Object.values(hosts);
+
+        const curMomentStartIdx = await this.getMomentStartIndex();
+        await Promise.all((hostList).map(async host => {
+            const hostAcc = new XrplAccount(host.address, null, { xrplApi: this.xrplApi });
+            host.domain = await hostAcc.getDomain();
+            host.active = (host.lastHeartbeatIndex > (this.config.hostHeartbeatFreq * this.config.momentSize) ?
+                (host.lastHeartbeatIndex >= (curMomentStartIdx - (this.config.hostHeartbeatFreq * this.config.momentSize))) :
+                (host.lastHeartbeatIndex > 0));
+            return host;
+        }));
+
+        return hostList;
+    }
+
     /**
      * Get the candidates proposed in Evernode. The result's are paginated. Default page size is 20. _Note: Specifying both filter and pagination does not supported._
      * @param {object} filters [Optional] Filter criteria to filter the candidates. The filter key can be a either property of the candidate.
@@ -53251,6 +53285,16 @@ class RegistryClient extends BaseEvernodeClient {
         // Filter only active hosts.
         return fullHostList.filter(h => h.active);
     }
+
+    /**
+     * Gets all the active hosts registered in ledger.
+     * @returns The list of active hosts.
+     */
+    async getActiveHostsFromLedger() {
+        const hosts = await this.getAllHostsFromLedger();
+        // Filter only active hosts.
+        return hosts.filter(h => h.active);
+    }
 }
 
 module.exports = {
@@ -53310,12 +53354,22 @@ const VOTE_VALIDATION_ERR = "VOTE_VALIDATION_ERR";
 
 const IPV6_FAMILY = 6;
 
+const MAX_HOST_LEDGER_OFFSET = 30;
+
 class HostClient extends BaseEvernodeClient {
 
     constructor(xrpAddress, xrpSecret, options = {}) {
         super(xrpAddress, xrpSecret, Object.values(HostEvents), true, options);
     }
 
+    /**
+     * Get max ledger sequence for host client.
+     * @returns Max ledger sequence number.
+     */
+    #getMaxLedgerSequence() {
+        return (this.xrplApi.ledgerIndex + MAX_HOST_LEDGER_OFFSET);
+    }
+
     /**
      * Get registration URI token info.
      * @returns The registration URI token object.
@@ -53377,10 +53431,10 @@ class HostClient extends BaseEvernodeClient {
             { ...accountSetFields, Domain: domain } : accountSetFields;
 
         if (Object.keys(accountSetFields).length !== 0)
-            await this.xrplAcc.setAccountFields(accountSetFields);
+            await this.xrplAcc.setAccountFields(accountSetFields, { maxLedgerIndex: this.#getMaxLedgerSequence() });
 
         if (trustLines.length === 0)
-            await this.xrplAcc.setTrustLine(EvernodeConstants.EVR, this.config.evrIssuerAddress, "99999999999999");
+            await this.xrplAcc.setTrustLine(EvernodeConstants.EVR, this.config.evrIssuerAddress, "99999999999999", null, null, { maxLedgerIndex: this.#getMaxLedgerSequence() });
     }
 
     /**
@@ -53442,15 +53496,15 @@ class HostClient extends BaseEvernodeClient {
         const uri = uriBuf.toString('base64');
 
         try {
-            await this.xrplAcc.mintURIToken(uri, null, { isBurnable: true, isHexUri: false });
+            await this.xrplAcc.mintURIToken(uri, null, { isBurnable: true, isHexUri: false }, { maxLedgerIndex: this.#getMaxLedgerSequence() });
         } catch (e) {
             // Re-minting the URIToken after burning that sold URIToken.
             if (e.code === "tecDUPLICATE") {
                 const uriTokenId = this.xrplAcc.generateIssuedURITokenId(uri);
                 console.log(`Burning URIToken related to a previously sold lease.`);
-                await this.xrplAcc.burnURIToken(uriTokenId);
+                await this.xrplAcc.burnURIToken(uriTokenId, { maxLedgerIndex: this.#getMaxLedgerSequence() });
                 console.log("Re-mint the URIToken for the new lease offer.")
-                await this.xrplAcc.mintURIToken(uri, null, { isBurnable: true, isHexUri: false });
+                await this.xrplAcc.mintURIToken(uri, null, { isBurnable: true, isHexUri: false }, { maxLedgerIndex: this.#getMaxLedgerSequence() });
             }
         }
 
@@ -53461,7 +53515,7 @@ class HostClient extends BaseEvernodeClient {
         await this.xrplAcc.sellURIToken(uriToken.index,
             leaseAmount.toString(),
             EvernodeConstants.EVR,
-            this.config.evrIssuerAddress);
+            this.config.evrIssuerAddress, null, null, { maxLedgerIndex: this.#getMaxLedgerSequence() });
     }
 
     /**
@@ -53469,7 +53523,7 @@ class HostClient extends BaseEvernodeClient {
      * @param {string} uriTokenId Hex URI token id of the lease.
      */
     async expireLease(uriTokenId) {
-        await this.xrplAcc.burnURIToken(uriTokenId);
+        await this.xrplAcc.burnURIToken(uriTokenId, { maxLedgerIndex: this.#getMaxLedgerSequence() });
     }
 
     /**
@@ -53523,7 +53577,7 @@ class HostClient extends BaseEvernodeClient {
         if (existingLeaseURITokens) {
             console.log("Burning unsold URITokens related to the previous leases.");
             for (const uriToken of existingLeaseURITokens) {
-                await this.xrplAcc.burnURIToken(uriToken.index);
+                await this.xrplAcc.burnURIToken(uriToken.index, { maxLedgerIndex: this.#getMaxLedgerSequence() });
             }
         }
 
@@ -53538,7 +53592,7 @@ class HostClient extends BaseEvernodeClient {
                 const sellOffer = (await registryAcc.getURITokens()).find(o => o.index == regInfo.uriTokenId && o.Amount);
                 console.log('sell offer')
                 if (sellOffer) {
-                    await this.xrplAcc.buyURIToken(sellOffer);
+                    await this.xrplAcc.buyURIToken(sellOffer, null, { maxLedgerIndex: this.#getMaxLedgerSequence() });
                     console.log("Registration was successfully completed after acquiring the NFT.");
                     return await this.isRegistered();
                 }
@@ -53588,6 +53642,7 @@ class HostClient extends BaseEvernodeClient {
                     { name: HookParamKeys.PARAM_EVENT_TYPE_KEY, value: EventTypes.HOST_REG },
                     { name: HookParamKeys.PARAM_EVENT_DATA1_KEY, value: paramBuf.toString('hex').toUpperCase() }
                 ],
+                maxLedgerIndex: this.#getMaxLedgerSequence(),
                 ...options.transactionOptions
             });
 
@@ -53626,7 +53681,7 @@ class HostClient extends BaseEvernodeClient {
             resolve();
         });
 
-        await this.xrplAcc.buyURIToken(sellOffer);
+        await this.xrplAcc.buyURIToken(sellOffer, null, { maxLedgerIndex: this.#getMaxLedgerSequence() });
         return await this.isRegistered();
     }
 
@@ -53659,6 +53714,7 @@ class HostClient extends BaseEvernodeClient {
                     { name: HookParamKeys.PARAM_EVENT_TYPE_KEY, value: EventTypes.HOST_DEREG },
                     { name: HookParamKeys.PARAM_EVENT_DATA1_KEY, value: paramBuf.toString('hex').toUpperCase() }
                 ],
+                maxLedgerIndex: this.#getMaxLedgerSequence(),
                 ...options.transactionOptions
             });
 
@@ -53720,6 +53776,7 @@ class HostClient extends BaseEvernodeClient {
                     { name: HookParamKeys.PARAM_EVENT_TYPE_KEY, value: EventTypes.HOST_UPDATE_INFO },
                     { name: HookParamKeys.PARAM_EVENT_DATA1_KEY, value: paramBuf.toString('hex') }
                 ],
+                maxLedgerIndex: this.#getMaxLedgerSequence(),
                 ...options.transactionOptions
             });
     }
@@ -53751,6 +53808,7 @@ class HostClient extends BaseEvernodeClient {
                         { name: HookParamKeys.PARAM_EVENT_TYPE_KEY, value: EventTypes.HEARTBEAT },
                         ...(data ? [{ name: HookParamKeys.PARAM_EVENT_DATA1_KEY, value: data }] : [])
                     ],
+                    maxLedgerIndex: this.#getMaxLedgerSequence(),
                     ...options.transactionOptions
                 });
             return res;
@@ -53817,6 +53875,7 @@ class HostClient extends BaseEvernodeClient {
                     { name: HookParamKeys.PARAM_EVENT_TYPE_KEY, value: EventTypes.ACQUIRE_SUCCESS },
                     { name: HookParamKeys.PARAM_EVENT_DATA1_KEY, value: txHash }
                 ],
+                maxLedgerIndex: this.#getMaxLedgerSequence(),
                 ...options.transactionOptions
             });
     }
@@ -53844,6 +53903,7 @@ class HostClient extends BaseEvernodeClient {
                     { name: HookParamKeys.PARAM_EVENT_TYPE_KEY, value: EventTypes.ACQUIRE_ERROR },
                     { name: HookParamKeys.PARAM_EVENT_DATA1_KEY, value: txHash }
                 ],
+                maxLedgerIndex: this.#getMaxLedgerSequence(),
                 ...options.transactionOptions
             });
     }
@@ -53872,6 +53932,7 @@ class HostClient extends BaseEvernodeClient {
                     { name: HookParamKeys.PARAM_EVENT_TYPE_KEY, value: EventTypes.EXTEND_SUCCESS },
                     { name: HookParamKeys.PARAM_EVENT_DATA1_KEY, value: txHash }
                 ],
+                maxLedgerIndex: this.#getMaxLedgerSequence(),
                 ...options.transactionOptions
             });
     }
@@ -53900,6 +53961,7 @@ class HostClient extends BaseEvernodeClient {
                     { name: HookParamKeys.PARAM_EVENT_TYPE_KEY, value: EventTypes.EXTEND_ERROR },
                     { name: HookParamKeys.PARAM_EVENT_DATA1_KEY, value: txHash }
                 ],
+                maxLedgerIndex: this.#getMaxLedgerSequence(),
                 ...options.transactionOptions
             });
     }
@@ -53925,6 +53987,7 @@ class HostClient extends BaseEvernodeClient {
                     { name: HookParamKeys.PARAM_EVENT_TYPE_KEY, value: EventTypes.REFUND },
                     { name: HookParamKeys.PARAM_EVENT_DATA1_KEY, value: txHash }
                 ],
+                maxLedgerIndex: this.#getMaxLedgerSequence(),
                 ...options.transactionOptions
             });
     }
@@ -53946,6 +54009,7 @@ class HostClient extends BaseEvernodeClient {
                 hookParams: [
                     { name: HookParamKeys.PARAM_EVENT_TYPE_KEY, value: EventTypes.HOST_REBATE }
                 ],
+                maxLedgerIndex: this.#getMaxLedgerSequence(),
                 ...options.transactionOptions
             });
     }
@@ -53983,6 +54047,7 @@ class HostClient extends BaseEvernodeClient {
                     { name: HookParamKeys.PARAM_EVENT_TYPE_KEY, value: EventTypes.HOST_TRANSFER },
                     { name: HookParamKeys.PARAM_EVENT_DATA1_KEY, value: paramData.toString('hex') }
                 ],
+                maxLedgerIndex: this.#getMaxLedgerSequence(),
                 ...options.transactionOptions
             });
 
@@ -54029,6 +54094,7 @@ class HostClient extends BaseEvernodeClient {
         if (!(await this.isRegistered()))
             throw 'Host should be registered to propose candidates.';
 
+        options.transactionOptions = { maxLedgerIndex: this.#getMaxLedgerSequence(), ...(options.transactionOptions || {}) }
         return await super._propose(hashes, shortName, options);
     }
 
@@ -54042,6 +54108,7 @@ class HostClient extends BaseEvernodeClient {
         if (!(await this.isRegistered()))
             throw 'Host should be registered to withdraw candidates.';
 
+        options.transactionOptions = { maxLedgerIndex: this.#getMaxLedgerSequence(), ...(options.transactionOptions || {}) }
         return await super._withdraw(candidateId, options);
     }
 
@@ -54055,6 +54122,7 @@ class HostClient extends BaseEvernodeClient {
         if (!(await this.isRegistered()))
             throw 'Host should be registered to report dud hosts.';
 
+        options.transactionOptions = { maxLedgerIndex: this.#getMaxLedgerSequence(), ...(options.transactionOptions || {}) }
         return await this._reportDudHost(hostAddress, options);
     }
 }
@@ -55663,6 +55731,7 @@ const HOST_LAST_VOTE_TIMESTAMP_OFFSET = 116;
 const HOST_SUPPORT_VOTE_FLAG_OFFSET = 124;
 const HOST_REPUTATION_OFFSET = 125;
 const HOST_FLAGS_OFFSET = 126;
+const HOST_TRANSFER_TIMESTAMP_OFFSET = 127;
 
 const HOST_ADDRESS_OFFSET = 0;
 const HOST_CPU_MODEL_NAME_OFFSET = 20;
@@ -55774,6 +55843,9 @@ class StateHelpers {
             const flags = stateDataBuf.readUInt8(HOST_FLAGS_OFFSET);
             data.reputedOnHeartbeat = !!(flags & HOST_FLAGS.REPUTED_ON_HEARTBEAT);
         }
+        if (stateDataBuf.length > HOST_TRANSFER_TIMESTAMP_OFFSET) {
+            data.transferTimestamp = Number(stateDataBuf.readBigUInt64LE(HOST_TRANSFER_TIMESTAMP_OFFSET));
+        }
         return data;
     }
 
@@ -57473,6 +57545,8 @@ class XrplApi {
         });
 
         client.on('disconnected', async (code) => {
+            this.#events.emit(XrplApiEvents.DISCONNECTED, code);
+
             this.#isPrimaryServerConnected = false;
             this.#isFallbackServerConnected = false;
 
@@ -57895,30 +57969,25 @@ class XrplApi {
      * @returns prepared response of the transaction result.
      */
     async #prepareResponse(tx, submissionResult) {
-        const resultCode = submissionResult?.result?.engine_result;
-        if (resultCode === "tesSUCCESS" || resultCode === "tefPAST_SEQ" || resultCode === "tefALREADY") {
-            const result = await this.#waitForFinalTransactionOutcome(submissionResult.result.tx_json.hash, tx.LastLedgerSequence, submissionResult);
-            const txResult = {
-                id: result?.hash,
-                code: result?.meta?.TransactionResult,
-                details: result
-            };
+        const result = await this.#waitForFinalTransactionOutcome(submissionResult.result.tx_json.hash, tx.LastLedgerSequence, submissionResult);
+        const txResult = {
+            id: result?.hash,
+            code: result?.meta?.TransactionResult,
+            details: result
+        };
 
-            console.log("Transaction result: " + txResult.code);
-            const hookExecRes = txResult.details?.meta?.HookExecutions?.map(o => {
-                return {
-                    result: o.HookExecution?.HookResult,
-                    returnCode: parseInt(o.HookExecution?.HookReturnCode, 16),
-                    message: TransactionHelper.hexToASCII(o.HookExecution?.HookReturnString).replace(/\x00+$/, '')
-                }
-            });
-            if (txResult.code === "tesSUCCESS")
-                return { ...txResult, ...(hookExecRes ? { hookExecutionResult: hookExecRes } : {}) };
-            else
-                throw { ...txResult, ...(hookExecRes ? { hookExecutionResult: hookExecRes } : {}) };
-        }
+        console.log("Transaction result: " + txResult.code);
+        const hookExecRes = txResult.details?.meta?.HookExecutions?.map(o => {
+            return {
+                result: o.HookExecution?.HookResult,
+                returnCode: parseInt(o.HookExecution?.HookReturnCode, 16),
+                message: TransactionHelper.hexToASCII(o.HookExecution?.HookReturnString).replace(/\x00+$/, '')
+            }
+        });
+        if (txResult.code === "tesSUCCESS")
+            return { ...txResult, ...(hookExecRes ? { hookExecutionResult: hookExecRes } : {}) };
         else
-            throw resultCode ? `Transaction failed with error ${resultCode}` : 'Transaction failed';
+            throw { ...txResult, ...(hookExecRes ? { hookExecutionResult: hookExecRes } : {}) };
 
     }
 
@@ -57988,6 +58057,7 @@ module.exports = {
 
 const XrplApiEvents = {
     LEDGER: 'ledger',
+    DISCONNECTED: 'disconnected',
     PAYMENT: 'payment',
     NFT_OFFER_CREATE: 'nftokencreateoffer',
     NFT_OFFER_ACCEPT: 'nftokenacceptoffer',

package/package.json

@@ -6,7 +6,7 @@
     ],
     "homepage": "https://github.com/HotPocketDev/evernode-js-client",
     "license": "SEE LICENSE IN https://raw.githubusercontent.com/EvernodeXRPL/evernode-resources/main/license/evernode-license.pdf",
-    "version": "0.6.28",
+    "version": "0.6.30",
     "dependencies": {
         "elliptic": "6.5.4",
         "libsodium-wrappers": "0.7.10",