evernode-js-client 0.4.53 → 0.5.0

package/.eslintrc.json

@@ -0,0 +1,14 @@
+{
+    "env": {
+        "browser": true,
+        "commonjs": true,
+        "es2021": true
+    },
+    "extends": "eslint:recommended",
+    "parserOptions": {
+        "ecmaVersion": 13
+    },
+    "rules": {
+        "no-async-promise-executor": "off"
+    }
+}

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 HotPocketDev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,26 @@
+# Evernode js client
+Javascript client library for Evernode.
+(Only tested on NodeJS)
+
+## Prerequisites
+```
+npm i -g @vercel/ncc
+```
+
+## Publish to npm
+First, update the version in package.json.
+```
+npm install
+npm login
+npm run publish
+```
+
+## Running tests
+```
+cd test
+npm install
+node test.js
+```
+
+## NPM package
+https://www.npmjs.com/package/evernode-js-client

package/clean-pkg.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+# Create a clean dist/package.json for publishing.
+node -p "const pkg=require('./package.json'); delete pkg.scripts; delete pkg.devDependencies; JSON.stringify(pkg, null, 4)" \
+    > dist/package.json

package/npm-readme.md

@@ -0,0 +1,4 @@
+# Evernode library for nodejs and browser.
+Evernode library contains helper methods to interact with Evernode ecosystem.
+
+- [Source code](https://github.com/HotPocketDev/evernode-js-client)

package/package.json

@@ -1,11 +1,26 @@
 {
     "name": "evernode-js-client",
-    "version": "0.4.53",
+    "description": "Javascript client library for Evernode.",
+    "keywords": [
+        "Evernode"
+    ],
+    "homepage": "https://github.com/HotPocketDev/evernode-js-client",
+    "license": "MIT",
+    "version": "0.5.0",
+    "scripts": {
+        "lint": "./node_modules/.bin/eslint src/**/*.js",
+        "build": "npm run lint && ncc build src/index.js -e elliptic -e xrpl -e ripple-address-codec -e ripple-keypairs -o dist/",
+        "bundle": "npm run build && ./clean-pkg.sh",
+        "publish": "npm run bundle && npm publish ./dist"
+    },
     "dependencies": {
         "elliptic": "6.5.4",
         "ripple-address-codec": "4.2.0",
         "ripple-keypairs": "1.1.0",
         "xrpl": "2.2.1",
         "xrpl-binary-codec": "1.4.2"
+    },
+    "devDependencies": {
+        "eslint": "8.3.0"
     }
 }

package/remove-versions.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+# This script removes previous npm package versions. (need to be logged into npm first)
+
+for i in {0..36}
+do
+    pkg="evernode-js-client@0.4.$i"
+    echo Unpublishing $pkg
+    npm unpublish $pkg
+    sleep 2
+done

package/src/clients/base-evernode-client.js

@@ -0,0 +1,567 @@
+const codec = require('ripple-address-codec');
+const { Buffer } = require('buffer');
+const { XrplApi } = require('../xrpl-api');
+const { XrplAccount } = require('../xrpl-account');
+const { XrplApiEvents, XrplConstants } = require('../xrpl-common');
+const { EvernodeEvents, MemoTypes, MemoFormats, EvernodeConstants, HookStateKeys } = require('../evernode-common');
+const { DefaultValues } = require('../defaults');
+const { EncryptionHelper } = require('../encryption-helper');
+const { EventEmitter } = require('../event-emitter');
+const { UtilHelpers } = require('../util-helpers');
+const { FirestoreHandler } = require('../firestore/firestore-handler');
+const { StateHelpers } = require('../state-helpers');
+
+class BaseEvernodeClient {
+
+    #watchEvents;
+    #autoSubscribe;
+    #ownsXrplApi = false;
+    #firestoreHandler;
+
+    constructor(xrpAddress, xrpSecret, watchEvents, autoSubscribe = false, options = {}) {
+
+        this.connected = false;
+        this.registryAddress = options.registryAddress || DefaultValues.registryAddress;
+
+        this.xrplApi = options.xrplApi || DefaultValues.xrplApi || new XrplApi(options.rippledServer);
+        if (!options.xrplApi && !DefaultValues.xrplApi)
+            this.#ownsXrplApi = true;
+
+        this.xrplAcc = new XrplAccount(xrpAddress, xrpSecret, { xrplApi: this.xrplApi });
+        this.accKeyPair = xrpSecret && this.xrplAcc.deriveKeypair();
+        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.NFT_OFFER_CREATE, (tx, error) => this.#handleEvernodeEvent(tx, error));
+        this.xrplAcc.on(XrplApiEvents.NFT_OFFER_ACCEPT, (tx, error) => this.#handleEvernodeEvent(tx, error));
+
+    }
+
+    /**
+     * Listens to the subscribed events. This will listen for the event without detaching the handler until it's 'off'.
+     * @param {string} event Event name.
+     * @param {function(event)} handler Callback function to handle the event.
+     */
+    on(event, handler) {
+        this.events.on(event, handler);
+    }
+
+    /**
+    * Listens to the subscribed events. This will listen only once and detach the handler.
+    * @param {string} event Event name.
+    * @param {function(event)} handler Callback function to handle the event.
+    */
+    once(event, handler) {
+        this.events.once(event, handler);
+    }
+
+    /**
+     * Detach the listener event.
+     * @param {string} event Event name.
+     * @param {function(event)} handler (optional) Can be sent if a specific handler need to be detached. All the handlers will be detached if not specified.
+     */
+    off(event, handler = null) {
+        this.events.off(event, handler);
+    }
+
+    /**
+     * Connects the client to xrpl server and do the config loading and subscriptions. 'subscribe' is called inside this.
+     * @returns boolean value, 'true' if success.
+     */
+    async connect() {
+        if (this.connected)
+            return true;
+
+        await this.xrplApi.connect();
+
+        // Invoking the info command to check the account existence. This is important to 
+        // identify a network reset from XRPL. 
+        await this.xrplAcc.getInfo();
+
+        this.config = await this.#getEvernodeConfig();
+        this.connected = true;
+
+        if (this.#autoSubscribe)
+            await this.subscribe();
+
+        return true;
+    }
+
+    /**
+     * Disconnects the client to xrpl server and do the un-subscriptions. 'unsubscribe' is called inside this.
+     */
+    async disconnect() {
+        await this.unsubscribe();
+
+        if (this.#ownsXrplApi)
+            await this.xrplApi.disconnect();
+    }
+
+    /**
+     * Subscribes to the registry client events.
+     */
+    async subscribe() {
+        await this.xrplAcc.subscribe();
+    }
+
+    /**
+     * Unsubscribes from the registry client events.
+     */
+    async unsubscribe() {
+        await this.xrplAcc.unsubscribe();
+    }
+
+    /**
+     * Get the EVR balance in the registry account.
+     * @returns The available EVR amount as a 'string'.
+     */
+    async getEVRBalance() {
+        const lines = await this.xrplAcc.getTrustLines(EvernodeConstants.EVR, this.config.evrIssuerAddress);
+        if (lines.length > 0)
+            return lines[0].balance;
+        else
+            return '0';
+    }
+
+    /**
+     * Get all XRPL hook states in the registry account.
+     * @returns The list of hook states including Evernode configuration and hosts.
+     */
+    async getHookStates() {
+        const regAcc = new XrplAccount(this.registryAddress, null, { xrplApi: this.xrplApi });
+        const configs = await regAcc.getNamespaceEntries(EvernodeConstants.HOOK_NAMESPACE);
+
+        if (configs)
+            return configs.filter(c => c.LedgerEntryType === 'HookState').map(c => { return { key: c.HookStateKey, data: c.HookStateData } });
+        return [];
+    }
+
+    /**
+     * Get the moment from the given XRP ledger index. (1 Moment - 1190 XRP ledgers).
+     * @param {number} ledgerIndex [Optional] Ledger index to get the moment value.
+     * @returns The moment of the given XPR ledger index as 'number'. Returns current moment if XRP ledger index is not given.
+     */
+    async getMoment(ledgerIndex = null) {
+        const lv = ledgerIndex || this.xrplApi.ledgerIndex;
+        const m = Math.floor((lv - this.config.momentBaseIdx) / this.config.momentSize);
+
+        await Promise.resolve(); // Awaiter placeholder for future async requirements.
+        return m;
+    }
+
+    /**
+     * Get start XRP ledger index of the moment (of the given XRPL index).
+     * @param {number} ledgerIndex [Optional] Ledger index to get the moment value.
+     * @returns The XRP ledger index of the moment (of the given XRPL index) as a 'number'. Returns the current moment's start XRP ledger index if ledger index parameter is not given.
+     */
+    async getMomentStartIndex(ledgerIndex = null) {
+        const lv = ledgerIndex || this.xrplApi.ledgerIndex;
+        const m = Math.floor((lv - this.config.momentBaseIdx) / this.config.momentSize);
+
+        await Promise.resolve(); // Awaiter placeholder for future async requirements.
+        return this.config.momentBaseIdx + (m * this.config.momentSize);
+    }
+
+    /**
+     * Get Evernode configuration
+     * @returns An object with all the configuration and their values.
+     */
+    async #getEvernodeConfig() {
+        let states = await this.getHookStates();
+        const configStateKeys = {
+            evrIssuerAddress: HookStateKeys.EVR_ISSUER_ADDR,
+            foundationAddress: HookStateKeys.FOUNDATION_ADDR,
+            hostRegFee: HookStateKeys.HOST_REG_FEE,
+            momentSize: HookStateKeys.MOMENT_SIZE,
+            hostHeartbeatFreq: HookStateKeys.HOST_HEARTBEAT_FREQ,
+            momentBaseIdx: HookStateKeys.MOMENT_BASE_IDX,
+            purchaserTargetPrice: HookStateKeys.PURCHASER_TARGET_PRICE,
+            leaseAcquireWindow: HookStateKeys.LEASE_ACQUIRE_WINDOW,
+            rewardInfo: HookStateKeys.REWARD_INFO,
+            rewardConfiguaration: HookStateKeys.REWARD_CONFIGURATION,
+            hostCount: HookStateKeys.HOST_COUNT
+        }
+        let config = {};
+        for (const [key, value] of Object.entries(configStateKeys)) {
+            const stateKey = Buffer.from(value, 'hex');
+            const stateData = Buffer.from(UtilHelpers.getStateData(states, value), 'hex');
+            const decoded = StateHelpers.decodeStateData(stateKey, stateData);
+            config[key] = decoded.value;
+        }
+        return config;
+    }
+
+    /**
+     * Loads the configs from XRPL hook and updates the in-memory config.
+     */
+    async refreshConfig() {
+        this.config = await this.#getEvernodeConfig();
+    }
+
+    /**
+     * Extracts transaction info and emits the Evernode event.
+     * @param {object} tx XRPL transaction to be handled.
+     * @param {any} error Error if there's any.
+     */
+    async #handleEvernodeEvent(tx, error) {
+        if (error)
+            console.error(error);
+        else if (!tx)
+            console.log('handleEvernodeEvent: Invalid transaction.');
+        else {
+            const ev = await this.extractEvernodeEvent(tx);
+            if (ev && this.#watchEvents.find(e => e === ev.name))
+                this.events.emit(ev.name, ev.data);
+        }
+    }
+
+    /**
+     * Extracts the transaction info from a given transaction.
+     * @param {object} tx Transaction to be deserialized and extracted.
+     * @returns The event object in the format {name: '', data: {}}. Returns null if not handled. Note: You need to deserialize memos before passing the transaction to this function.
+     */
+    async extractEvernodeEvent(tx) {
+        if (tx.TransactionType === 'NFTokenAcceptOffer' && tx.NFTokenSellOffer && tx.Memos.length >= 1 &&
+            tx.Memos[0].type === MemoTypes.ACQUIRE_LEASE && tx.Memos[0].format === MemoFormats.BASE64 && tx.Memos[0].data) {
+
+            // If our account is the destination host account, then decrypt the payload.
+            let payload = tx.Memos[0].data;
+            if (tx.Destination === this.xrplAcc.address) {
+                const decrypted = this.accKeyPair && await EncryptionHelper.decrypt(this.accKeyPair.privateKey, payload);
+                if (decrypted)
+                    payload = decrypted;
+                else
+                    console.log('Failed to decrypt acquire data.');
+            }
+
+            return {
+                name: EvernodeEvents.AcquireLease,
+                data: {
+                    transaction: tx,
+                    host: tx.Destination,
+                    nfTokenId: tx.NFTokenSellOffer?.NFTokenID,
+                    leaseAmount: tx.NFTokenSellOffer?.Amount?.value,
+                    acquireRefId: tx.hash,
+                    tenant: tx.Account,
+                    payload: payload
+                }
+            }
+        }
+
+        else if (tx.TransactionType === 'NFTokenAcceptOffer' && tx.NFTokenBuyOffer && tx.Memos.length >= 1 &&
+            tx.Memos[0].type === MemoTypes.HOST_POST_DEREG && tx.Memos[0].format === MemoFormats.HEX && tx.Memos[0].data) {
+            return {
+                name: EvernodeEvents.HostPostDeregistered,
+                data: {
+                    transaction: tx,
+                    nfTokenId: tx.NFTokenBuyOffer.NFTokenID,
+                    flags: tx.Flags,
+                    hash: tx.hash
+                }
+            }
+        }
+
+        else if (tx.Memos.length >= 2 &&
+            tx.Memos[0].type === MemoTypes.ACQUIRE_SUCCESS && tx.Memos[0].data &&
+            tx.Memos[1].type === MemoTypes.ACQUIRE_REF && tx.Memos[1].data) {
+
+            let payload = tx.Memos[0].data;
+            const acquireRefId = tx.Memos[1].data;
+
+            // If our account is the destination user account, then decrypt the payload.
+            if (tx.Memos[0].format === MemoFormats.BASE64 && tx.Destination === this.xrplAcc.address) {
+                const decrypted = this.accKeyPair && await EncryptionHelper.decrypt(this.accKeyPair.privateKey, payload);
+                if (decrypted)
+                    payload = decrypted;
+                else
+                    console.log('Failed to decrypt instance data.');
+            }
+
+            return {
+                name: EvernodeEvents.AcquireSuccess,
+                data: {
+                    transaction: tx,
+                    acquireRefId: acquireRefId,
+                    payload: payload
+                }
+            }
+
+        }
+        else if (tx.Memos.length >= 2 &&
+            tx.Memos[0].type === MemoTypes.ACQUIRE_ERROR && tx.Memos[0].data &&
+            tx.Memos[1].type === MemoTypes.ACQUIRE_REF && tx.Memos[1].data) {
+
+            let error = tx.Memos[0].data;
+            const acquireRefId = tx.Memos[1].data;
+
+            if (tx.Memos[0].format === MemoFormats.JSON)
+                error = JSON.parse(error).reason;
+
+            return {
+                name: EvernodeEvents.AcquireError,
+                data: {
+                    transaction: tx,
+                    acquireRefId: acquireRefId,
+                    reason: error
+                }
+            }
+        }
+        else if (tx.Memos.length >= 1 &&
+            tx.Memos[0].type === MemoTypes.HOST_REG && tx.Memos[0].format === MemoFormats.TEXT && tx.Memos[0].data) {
+
+            const parts = tx.Memos[0].data.split(';');
+            return {
+                name: EvernodeEvents.HostRegistered,
+                data: {
+                    transaction: tx,
+                    host: tx.Account,
+                    token: parts[0],
+                    instanceSize: parts[1],
+                    location: parts[2]
+                }
+            }
+        }
+        else if (tx.Memos.length >= 1 && tx.Memos[0].type === MemoTypes.HOST_DEREG) {
+            return {
+                name: EvernodeEvents.HostDeregistered,
+                data: {
+                    transaction: tx,
+                    host: tx.Account
+                }
+            }
+        }
+        else if (tx.Memos.length >= 1 &&
+            tx.Memos[0].type === MemoTypes.HEARTBEAT) {
+
+            return {
+                name: EvernodeEvents.Heartbeat,
+                data: {
+                    transaction: tx,
+                    host: tx.Account
+                }
+            }
+        }
+        else if (tx.Memos.length >= 1 &&
+            tx.Memos[0].type === MemoTypes.EXTEND_LEASE && tx.Memos[0].format === MemoFormats.HEX && tx.Memos[0].data) {
+
+            let nfTokenId = tx.Memos[0].data;
+
+            return {
+                name: EvernodeEvents.ExtendLease,
+                data: {
+                    transaction: tx,
+                    extendRefId: tx.hash,
+                    tenant: tx.Account,
+                    currency: tx.Amount.currency,
+                    payment: parseFloat(tx.Amount.value),
+                    nfTokenId: nfTokenId
+                }
+            }
+        }
+        else if (tx.Memos.length >= 2 &&
+            tx.Memos[0].type === MemoTypes.EXTEND_SUCCESS && tx.Memos[0].format === MemoFormats.HEX && tx.Memos[0].data &&
+            tx.Memos[1].type === MemoTypes.EXTEND_REF && tx.Memos[1].format === MemoFormats.HEX && tx.Memos[1].data) {
+
+            const extendResBuf = Buffer.from(tx.Memos[0].data, 'hex');
+            const extendRefId = tx.Memos[1].data;
+
+            return {
+                name: EvernodeEvents.ExtendSuccess,
+                data: {
+                    transaction: tx,
+                    extendRefId: extendRefId,
+                    expiryMoment: extendResBuf.readUInt32BE()
+                }
+            }
+
+        }
+        else if (tx.Memos.length >= 2 &&
+            tx.Memos[0].type === MemoTypes.EXTEND_ERROR && tx.Memos[0].data &&
+            tx.Memos[1].type === MemoTypes.EXTEND_REF && tx.Memos[1].data) {
+
+            let error = tx.Memos[0].data;
+            const extendRefId = tx.Memos[1].data;
+
+            if (tx.Memos[0].format === MemoFormats.JSON)
+                error = JSON.parse(error).reason;
+
+            return {
+                name: EvernodeEvents.ExtendError,
+                data: {
+                    transaction: tx,
+                    extendRefId: extendRefId,
+                    reason: error
+                }
+            }
+        }
+        else if (tx.Memos.length >= 1 &&
+            tx.Memos[0].type === MemoTypes.REGISTRY_INIT && tx.Memos[0].format === MemoFormats.HEX && tx.Memos[0].data) {
+
+            return {
+                name: EvernodeEvents.RegistryInitialized,
+                data: {
+                    transaction: tx
+                }
+            }
+        }
+        else if (tx.Memos.length >= 1 &&
+            tx.Memos[0].type === MemoTypes.HOST_UPDATE_INFO && tx.Memos[0].format === MemoFormats.TEXT && tx.Memos[0].data) {
+
+            const specs = tx.Memos[0].data.split(';');
+
+            return {
+                name: EvernodeEvents.HostRegUpdated,
+                data: {
+                    transaction: tx,
+                    host: tx.Account,
+                    version: specs[specs.length - 1],
+                    specs: specs,
+                }
+            }
+        }
+        else if (tx.Memos.length >= 1 &&
+            tx.Memos[0].type === MemoTypes.DEAD_HOST_PRUNE && tx.Memos[0].format === MemoFormats.HEX && tx.Memos[0].data) {
+
+            const addrsBuf = Buffer.from(tx.Memos[0].data, 'hex');
+
+            return {
+                name: EvernodeEvents.DeadHostPrune,
+                data: {
+                    transaction: tx,
+                    host: codec.encodeAccountID(addrsBuf)
+                }
+            }
+        }
+
+        return null;
+    }
+
+    /**
+     * Get the registered host information.
+     * @param {string} hostAddress [Optional] Address of the host.
+     * @returns The registered host information object. Returns null is not registered.
+     */
+    async getHostInfo(hostAddress = this.xrplAcc.address) {
+        try {
+            const addrStateKey = StateHelpers.generateHostAddrStateKey(hostAddress);
+            const addrStateIndex = StateHelpers.getHookStateIndex(this.registryAddress, addrStateKey);
+            const addrLedgerEntry = await this.xrplApi.getLedgerEntry(addrStateIndex);
+            const addrStateData = addrLedgerEntry?.HookStateData;
+            if (addrStateData) {
+                const addrStateDecoded = StateHelpers.decodeHostAddressState(Buffer.from(addrStateKey, 'hex'), Buffer.from(addrStateData, 'hex'));
+                const curMomentStartIdx = await this.getMomentStartIndex();
+                addrStateDecoded.active = (addrStateDecoded.lastHeartbeatLedger > (this.config.hostHeartbeatFreq * this.config.momentSize) ?
+                    (addrStateDecoded.lastHeartbeatLedger >= (curMomentStartIdx - (this.config.hostHeartbeatFreq * this.config.momentSize))) :
+                    (addrStateDecoded.lastHeartbeatLedger > 0))
+
+                const nftIdStatekey = StateHelpers.generateTokenIdStateKey(addrStateDecoded.nfTokenId);
+                const nftIdStateIndex = StateHelpers.getHookStateIndex(this.registryAddress, nftIdStatekey);
+                const nftIdLedgerEntry = await this.xrplApi.getLedgerEntry(nftIdStateIndex);
+
+                const nftIdStateData = nftIdLedgerEntry?.HookStateData;
+                if (nftIdStateData) {
+                    const nftIdStateDecoded = StateHelpers.decodeTokenIdState(Buffer.from(nftIdStateData, 'hex'));
+                    return { ...addrStateDecoded, ...nftIdStateDecoded };
+                }
+            }
+        }
+        catch (e) {
+            // If the exception is entryNotFound from Rippled there's no entry for the host, So return null.
+            if (e?.data?.error !== 'entryNotFound')
+                throw e;
+        }
+
+        return null;
+    }
+
+    /**
+     * Get all 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();
+        // Populate the host active status.
+        (hosts.nextPageToken ? hosts.data : hosts).forEach(h => {
+            h.active = (h.lastHeartbeatLedger > (this.config.hostHeartbeatFreq * this.config.momentSize) ?
+                (h.lastHeartbeatLedger >= (curMomentStartIdx - (this.config.hostHeartbeatFreq * this.config.momentSize))) :
+                (h.lastHeartbeatLedger > 0))
+        });
+        return hosts;
+    }
+
+    /**
+     * 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.
+     */
+    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);
+        }
+
+        return fullHostList;
+    }
+
+    /**
+     * Remove a host which is inactive for a long period. The inactivity is checked by Evernode it self and only pruned if inactive thresholds are met.
+     * @param {string} hostAddress XRPL address of the host to be pruned.
+     */
+    async pruneDeadHost(hostAddress) {
+        if (this.xrplAcc.address === this.registryAddress)
+            throw 'Invalid function call';
+
+        let memoData = Buffer.allocUnsafe(20);
+        codec.decodeAccountID(hostAddress).copy(memoData);
+
+        await this.xrplAcc.makePayment(this.registryAddress,
+            XrplConstants.MIN_XRP_AMOUNT,
+            XrplConstants.XRP,
+            null,
+            [{ type: MemoTypes.DEAD_HOST_PRUNE, format: MemoFormats.HEX, data: memoData.toString('hex') }]);
+
+    }
+}
+
+module.exports = {
+    BaseEvernodeClient
+}