evernode-js-client 0.6.33 → 0.6.35

package/index.js

@@ -51836,7 +51836,6 @@ const { Defaults } = __nccwpck_require__(8262);
 const { EncryptionHelper } = __nccwpck_require__(4832);
 const { EventEmitter } = __nccwpck_require__(6170);
 const { UtilHelpers } = __nccwpck_require__(6687);
-const { FirestoreHandler } = __nccwpck_require__(9718);
 const { StateHelpers } = __nccwpck_require__(3860);
 const { EvernodeHelpers } = __nccwpck_require__(2523);
 const { HookHelpers } = __nccwpck_require__(4675);
@@ -51860,7 +51859,6 @@ class BaseEvernodeClient {
     #watchEvents;
     #autoSubscribe;
     #ownsXrplApi = false;
-    #firestoreHandler;
 
     constructor(xrpAddress, xrpSecret, watchEvents, autoSubscribe = false, options = {}) {
 
@@ -51879,7 +51877,6 @@ class BaseEvernodeClient {
         this.#watchEvents = watchEvents;
         this.#autoSubscribe = autoSubscribe;
         this.events = new EventEmitter();
-        this.#firestoreHandler = new FirestoreHandler()
 
         this.xrplAcc.on(XrplApiEvents.PAYMENT, (tx, error) => this.#handleEvernodeEvent(tx, error));
         this.xrplAcc.on(XrplApiEvents.URI_TOKEN_BUY, (tx, error) => this.#handleEvernodeEvent(tx, error));
@@ -52487,29 +52484,6 @@ class BaseEvernodeClient {
         return null;
     }
 
-    /**
-     * Get the hosts registered 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 hosts. The filter key can be a either property of the host.
-     * @param {number} pageSize [Optional] Page size for the results.
-     * @param {string} nextPageToken [Optional] Next page's token, If received by the previous result set.
-     * @returns The list of active hosts. The response will be in '{data: [], nextPageToken: ''}' only if there are more pages. Otherwise the response will only contain the host list. 
-     */
-    async getHosts(filters = null, pageSize = null, nextPageToken = null) {
-        const hosts = await this.#firestoreHandler.getHosts(filters, pageSize, nextPageToken);
-        const curMomentStartIdx = await this.getMomentStartIndex();
-        const res = await Promise.all((hosts.nextPageToken ? hosts.data : hosts).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 (hosts.nextPageToken ? { ...hosts, data: res } : res);
-    }
-
     /**
      * Get the hosts registered in Evernode.
      * @returns The list of hosts. 
@@ -52545,94 +52519,25 @@ class BaseEvernodeClient {
     }
 
     /**
-     * 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.
-     * @param {number} pageSize [Optional] Page size for the results.
-     * @param {string} nextPageToken [Optional] Next page's token, If received by the previous result set.
-     * @returns The list of candidates. The response will be in '{data: [], nextPageToken: ''}' only if there are more pages. Otherwise the response will only contain the host list. 
-     */
-    async getCandidates(filters = null, pageSize = null, nextPageToken = null) {
-        const candidates = await this.#firestoreHandler.getCandidates(filters, pageSize, nextPageToken);
-        return candidates;
-    }
-
-    /**
-     * Get all Evernode configuration without paginating.
-     * @returns The list of configuration.
-     */
-    async getAllConfigs() {
-        let fullConfigList = [];
-        const configs = await this.#firestoreHandler.getConfigs();
-        if (configs.nextPageToken) {
-            let currentPageToken = configs.nextPageToken;
-            let nextConfigs = null;
-            fullConfigList = fullConfigList.concat(configs.data);
-            while (currentPageToken) {
-                nextConfigs = await this.#firestoreHandler.getConfigs(null, 50, currentPageToken);
-                fullConfigList = fullConfigList.concat(nextConfigs.nextPageToken ? nextConfigs.data : nextConfigs);
-                currentPageToken = nextConfigs.nextPageToken;
-            }
-        } else {
-            fullConfigList = fullConfigList.concat(configs);
-        }
-
-        return fullConfigList;
-    }
-
-    /**
-     * Get all the hosts without paginating.
-     * @returns The list of hosts.
+     * Get the governor in Evernode.
+     * @returns The list of candidates. 
      */
-    async getAllHosts() {
-        let fullHostList = [];
-        const hosts = await this.#firestoreHandler.getHosts();
-        if (hosts.nextPageToken) {
-            let currentPageToken = hosts.nextPageToken;
-            let nextHosts = null;
-            fullHostList = fullHostList.concat(hosts.data);
-            while (currentPageToken) {
-                nextHosts = await this.#firestoreHandler.getHosts(null, 50, currentPageToken);
-                fullHostList = fullHostList.concat(nextHosts.nextPageToken ? nextHosts.data : nextHosts);
-                currentPageToken = nextHosts.nextPageToken;
-            }
-        } else {
-            fullHostList = fullHostList.concat(hosts);
-        }
-
-        const curMomentStartIdx = await this.getMomentStartIndex();
-        await Promise.all((fullHostList).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 fullHostList;
-    }
+    async getAllCandidatesFromLedger() {
+        const states = await this.getHookStates();
+        let candidates = [];
 
-    /**
-     * Get all the candidates without paginating.
-     * @returns The list of candidates.
-     */
-    async getAllCandidates() {
-        let fullCandidateList = [];
-        const candidates = await this.#firestoreHandler.getCandidates();
-        if (candidates.nextPageToken) {
-            let currentPageToken = candidates.nextPageToken;
-            let nextCandidates = null;
-            fullCandidateList = fullCandidateList.concat(candidates.data);
-            while (currentPageToken) {
-                nextCandidates = await this.#firestoreHandler.getCandidates(null, 50, currentPageToken);
-                fullCandidateList = fullCandidateList.concat(nextCandidates.nextPageToken ? nextCandidates.data : nextCandidates);
-                currentPageToken = nextCandidates.nextPageToken;
+        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.CANDIDATE_ID) {
+                    candidates.push(decoded);
+                }
             }
-        } else {
-            fullCandidateList = fullCandidateList.concat(candidates);
         }
 
-        return fullCandidateList;
+        return candidates;
     }
 
     /**
@@ -52717,10 +52622,11 @@ class BaseEvernodeClient {
      */
     async getDudHostCandidatesByOwner(ownerAddress = this.xrplAcc.address) {
         try {
-            let candidates = await this.#firestoreHandler.getCandidates({ ownerAddress: ownerAddress });
-            if (candidates && candidates.length > 0) {
-                candidates = candidates.filter(c => StateHelpers.getCandidateType(c.uniqueId) == EvernodeConstants.CandidateTypes.DudHost);
-                return candidates;
+            const candidates = await this.getAllCandidatesFromLedger();
+            let filteredCandidates = candidates.filter(c => c.ownerAddress === ownerAddress);
+            if (filteredCandidates && filteredCandidates.length > 0) {
+                filteredCandidates = filteredCandidates.filter(c => StateHelpers.getCandidateType(c.uniqueId) == EvernodeConstants.CandidateTypes.DudHost);
+                return filteredCandidates;
             }
         } catch (error) {
             console.log(error)
@@ -53263,29 +53169,6 @@ class RegistryClient extends BaseEvernodeClient {
         super(options.registryAddress, null, Object.values(RegistryEvents), false, options);
     }
 
-    /**
-     * Gets all the active hosts registered in Evernode without paginating.
-     * @returns The list of active hosts.
-     */
-    async getActiveHosts() {
-        let fullHostList = [];
-        const hosts = await this.getHosts();
-        if (hosts.nextPageToken) {
-            let currentPageToken = hosts.nextPageToken;
-            let nextHosts = null;
-            fullHostList = fullHostList.concat(hosts.data);
-            while (currentPageToken) {
-                nextHosts = await this.getHosts(null, null, currentPageToken);
-                fullHostList = fullHostList.concat(nextHosts.nextPageToken ? nextHosts.data : nextHosts);
-                currentPageToken = nextHosts.nextPageToken;
-            }
-        } else {
-            fullHostList = fullHostList.concat(hosts);
-        }
-        // Filter only active hosts.
-        return fullHostList.filter(h => h.active);
-    }
-
     /**
      * Gets all the active hosts registered in ledger.
      * @returns The list of active hosts.
@@ -54666,8 +54549,7 @@ const https = __nccwpck_require__(5687);
 const DefinitionsUrl = 'https://raw.githubusercontent.com/EvernodeXRPL/evernode-resources/main/definitions/definitions.json';
 
 const DefaultValues = {
-    xrplApi: null,
-    useCentralizedRegistry: false,
+    xrplApi: null
 }
 
 const HookTypes = {
@@ -55417,334 +55299,6 @@ module.exports = {
 
 /***/ }),
 
-/***/ 9718:
-/***/ ((module, __unused_webpack_exports, __nccwpck_require__) => {
-
-const https = __nccwpck_require__(5687);
-const { Defaults } = __nccwpck_require__(8262);
-
-const FirestoreOperations = {
-    EQUAL: 'EQUAL',
-    AND: 'AND'
-}
-
-class FirestoreHandler {
-    #projectId = null;
-    #collectionPrefix = null;
-
-    constructor(options = {}) {
-        this.#projectId = options.stateIndexId || Defaults.values.stateIndexId;
-        this.#collectionPrefix = options.collectionPrefix || Defaults.values.governorAddress;
-    }
-
-    /**
-     * Convert given document value object to real format and snake_case key to camelCase.
-     * @param key Name of the property.
-     * @param value Value to be parsed.
-     * @returns Parsed key and value.
-     */
-    #parseValue(key, value) {
-        // Convert snake_case to camelCase.
-        const ccKey = key.replace(/_([a-z])/g, function (g) { return g[1].toUpperCase(); });
-        const type = Object.keys(value)[0];
-        let parsed;
-        switch (type) {
-            case 'integerValue':
-                parsed = parseInt(value[type]);
-                break;
-            case 'floatValue':
-                parsed = parseFloat(value[type]);
-                break;
-            case 'mapValue':
-                parsed = {};
-                for (const [subKey, subValue] of Object.entries(value[type].fields)) {
-                    const field = this.#parseValue(subKey, subValue);
-                    parsed[field.key] = field.value;
-                }
-                break;
-            default:
-                parsed = value[type];
-                break;
-        }
-        return { key: ccKey, value: parsed };
-    }
-
-    /**
-     * Get values filtered according to the given body.
-     * @param body Body to parsed in to the query reqest.
-     * @returns Result set.
-     */
-    async #runQuery(body) {
-        const url = this.buildApiPath(null, null, true);
-        return await this.sendRequest('POST', url, null, body);
-    }
-
-    /**
-     * Get documents from a collection.
-     * @param collectionId Name of the collection.
-     * @param pageSize Optianal page size if result set needed to be paginated
-     * @param nextPageToken Next page token of a paginated result set.
-     * @returns Result set.
-     */
-    async #read(collectionId, pageSize = null, nextPageToken = null) {
-        if (!collectionId)
-            throw { type: 'Validation Error', message: 'collectionId is required' };
-
-        const url = this.buildApiPath(collectionId);
-        let params = (pageSize || nextPageToken) ? {} : null;
-        if (pageSize)
-            params = { pageSize: pageSize };
-        if (nextPageToken)
-            params = { pageToken: nextPageToken, ...params };
-
-        return await this.sendRequest('GET', url, params);
-    }
-
-    /**
-     * Get documents from a collection with filtering support.
-     * @param collectionId Name of the collection.
-     * @param filter Optional filters to filter documents.
-     * @param pageSize Optianal page size if result set needed to be paginated
-     * @param nextPageToken Next page token of a paginated result set.
-     * @returns Parsed readable result set.
-     */
-    async #getDocuments(collectionId, filters = null, pageSize = null, nextPageToken = null) {
-        if (filters && (pageSize || nextPageToken))
-            throw { type: 'Validation Error', message: 'Pagination isn\'t supported with filter.' };
-
-        let data;
-        // If there are filters send requst in query mode.
-        if (filters) {
-            // Prepare the query body from given filters.
-            let where = {
-                compositeFilter: {
-                    filters: Object.entries(filters).map(([key, value]) => {
-                        const field = this.convertValue(key, value);
-                        return {
-                            fieldFilter: {
-                                field: { fieldPath: field.key },
-                                op: FirestoreOperations.EQUAL,
-                                value: field.value
-                            }
-                        }
-                    }),
-                    op: filters.operator ? filters.operator : FirestoreOperations.AND
-                }
-            };
-            for (const [key, value] of Object.entries(filters)) {
-                const field = this.convertValue(key, value);
-                let fieldFilter = {
-                    field: { fieldPath: field.key },
-                    op: FirestoreOperations.EQUAL,
-                    value: field.value
-                }
-                where.compositeFilter.filters.push({ fieldFilter: fieldFilter });
-            }
-
-            let body = {
-                structuredQuery: {
-                    where: where,
-                    from: [{ collectionId: collectionId }]
-                }
-            };
-            data = await this.#runQuery(body);
-            data = data ? JSON.parse(data) : [];
-            if (data && data.length && data[0].document) {
-                return data.map(d => {
-                    return this.parseDocument(d.document);
-                });
-            }
-        }
-        else {
-            data = await this.#read(collectionId, pageSize, nextPageToken);
-            data = data ? JSON.parse(data) : {};
-            if (data.documents && data.documents.length) {
-                const list = data.documents.map(d => {
-                    return this.parseDocument(d);
-                });
-                return data.nextPageToken ? {
-                    data: list,
-                    nextPageToken: data.nextPageToken
-                } : list;
-            }
-        }
-
-        return [];
-    }
-
-    getCollectionId(collection) {
-        // Document if is generated with given prefix.
-        return `${this.#collectionPrefix}_${collection}`;
-    }
-
-    /**
-     * Send http requst.
-     * @param httpMethod GET/POST/PATCH/DELETE
-     * @param url Url for the request.
-     * @param params Optional query params.
-     * @param data Optional request body.
-     * @param options Optional options.
-     * @returns Result set.
-     */
-    async sendRequest(httpMethod, url, params = null, data = null, options = null) {
-        if (!Defaults.values.useCentralizedRegistry) {
-            console.warn("Please change the useCentralizedRegistry flag to true in Defaults if you want to use this function!")
-            throw new Error("Centralized function is in use!!")
-        }
-        
-        const urlObj = new URL(url);
-        // Populate uri params to the URL object.
-        if (params) {
-            for (const [key, value] of Object.entries(params)) {
-                if (value) {
-                    // If value is a array, populate it with same name.
-                    if (typeof value === 'object') {
-                        for (const val of value) {
-                            if (val)
-                                urlObj.searchParams.append(key, val);
-                        }
-                    }
-                    else
-                        urlObj.searchParams.set(key, value);
-                }
-            }
-        }
-
-        let reqOptions = {
-            method: httpMethod,
-            protocol: urlObj.protocol,
-            hostname: urlObj.hostname,
-            port: urlObj.port,
-            path: `${urlObj.pathname}?${urlObj.searchParams.toString()}`,
-            ...(options ? options : {})
-        };
-
-        return new Promise(async (resolve, reject) => {
-            // Send request and collect data chuncks to a buffer. Then return the result set on end event.
-            // Resolve only if the status is 200.
-            const req = https.request(reqOptions, (res) => {
-                let resData = '';
-                res.on('data', (d) => {
-                    resData += d;
-                });
-                res.on('end', async () => {
-                    if (res.statusCode === 200) {
-                        resolve(resData);
-                        return;
-                    }
-                    reject({ status: res.statusCode, data: resData });
-                    return;
-                });
-            }).on('error', async (e) => {
-                reject(e);
-                return;
-            });
-
-            if (data)
-                req.write(typeof data === 'object' ? JSON.stringify(data) : data);
-
-            req.end();
-        });
-    }
-
-    /**
-     * Generate url for firestore.
-     * @param collectionId Optional collection name.
-     * @param documentId Optional document name.
-     * @param isQuery Whether a query request or not.
-     * @returns The generated url.
-     */
-    buildApiPath(collectionId = null, documentId = null, isQuery = false) {
-        let path = `https://firestore.googleapis.com/v1/projects/${this.#projectId}/databases/(default)/documents`;
-        if (collectionId)
-            path += `/${collectionId.toString()}`;
-        if (documentId)
-            path += `/${documentId.toString()}`;
-        if (isQuery)
-            path += ':runQuery';
-        return path;
-    }
-
-    /**
-     * Generate firestore document value object from given key and value, Convert camelCase key to snake_case.
-     * @param key Name of the value.
-     * @param value Value to be parsed.
-     * @returns Generated firestore document object.
-     */
-    convertValue(key, value) {
-        // Convert camelCase to snake_case.
-        const uKey = key.replace(/([A-Z])/g, function (g) { return `_${g[0].toLocaleLowerCase()}`; });
-        let val = {};
-        let type
-        switch (typeof value) {
-            case 'number':
-                type = (value % 1 > 0 ? 'float' : 'integer');
-                val = value;
-                break;
-            case 'object':
-                type = 'map';
-                val = {
-                    fields: {}
-                }
-                // Prepare the firestore write body with the given data object.
-                for (const [subKey, subValue] of Object.entries(value)) {
-                    const field = this.convertValue(subKey, subValue);
-                    val.fields[field.key] = field.value;
-                }
-                break;
-            case 'boolean':
-                type = 'boolean';
-                val = value;
-                break;
-            default:
-                type = 'string';
-                val = value;
-                break;
-        }
-        type = `${type}Value`;
-        let obj = {};
-        obj[type] = val;
-        return { key: uKey, value: obj };
-    }
-
-    /**
-     * Convert the firestore document to human readable simplified json object.
-     * @param document Firestore document.
-     * @returns Simplified json object for the document.
-     */
-    parseDocument(document) {
-        let item = {
-            id: document.name.split('/').pop(),
-            createTime: new Date(document.createTime),
-            updateTime: new Date(document.updateTime)
-        };
-        for (const [key, value] of Object.entries(document.fields)) {
-            const field = this.#parseValue(key, value);
-            item[field.key] = field.value;
-        }
-        return item;
-    }
-
-    async getCandidates(filters = null, pageSize = null, nextPageToken = null) {
-        return await this.#getDocuments(this.getCollectionId('candidates'), filters, pageSize, nextPageToken);
-    }
-
-    async getHosts(filters = null, pageSize = null, nextPageToken = null) {
-        return await this.#getDocuments(this.getCollectionId('hosts'), filters, pageSize, nextPageToken);
-    }
-
-    async getConfigs(filters = null, pageSize = null, nextPageToken = null) {
-        return await this.#getDocuments(this.getCollectionId('configs'), filters, pageSize, nextPageToken);
-    }
-}
-
-module.exports = {
-    FirestoreHandler,
-    FirestoreOperations
-}
-
-/***/ }),
-
 /***/ 4675:
 /***/ ((module, __unused_webpack_exports, __nccwpck_require__) => {
 
@@ -55800,7 +55354,6 @@ const { XrplApiEvents, XrplConstants } = __nccwpck_require__(3307);
 const { XrplAccount } = __nccwpck_require__(9329);
 const { EvernodeConstants, HookStateKeys, HookParamKeys, EventTypes } = __nccwpck_require__(9849);
 const { XflHelpers } = __nccwpck_require__(3243);
-const { FirestoreHandler } = __nccwpck_require__(9718);
 const { StateHelpers } = __nccwpck_require__(3860);
 const { UtilHelpers } = __nccwpck_require__(6687);
 const { TransactionHelper } = __nccwpck_require__(7071);
@@ -55829,7 +55382,6 @@ module.exports = {
     Defaults,
     XflHelpers,
     StateHelpers,
-    FirestoreHandler,
     UtilHelpers,
     TransactionHelper,
     EncryptionHelper,

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.33",
+    "version": "0.6.35",
     "dependencies": {
         "elliptic": "6.5.4",
         "libsodium-wrappers": "0.7.10",