@cryptorobot.ai/client 0.0.18 → 0.0.25

package/lib/client.d.ts

@@ -1,71 +1,73 @@
-import type { TransportConnection, Application } from '@feathersjs/feathers';
 import type { AuthenticationClientOptions } from '@feathersjs/authentication-client';
+export type { Config, ConfigData, ConfigPatch, ConfigQuery } from './services/config/config.shared';
+export type { Custom, CustomData, CustomPatch, CustomQuery } from './services/custom/custom.shared';
+export type { ExchangesBalance, ExchangesBalanceData, ExchangesBalancePatch, ExchangesBalanceQuery } from './services/exchanges/balance/balance.shared';
+export type { ExchangesDownload, ExchangesDownloadData, ExchangesDownloadPatch, ExchangesDownloadQuery } from './services/exchanges/download/download.shared';
+export type { ExchangesDownloadWebhooks, ExchangesDownloadWebhooksData, ExchangesDownloadWebhooksPatch, ExchangesDownloadWebhooksQuery } from './services/exchanges/download/webhooks/webhooks.shared';
+export type { Exchanges, ExchangesData, ExchangesPatch, ExchangesQuery } from './services/exchanges/exchanges.shared';
+export type { ExchangesTicker, ExchangesTickerData, ExchangesTickerPatch, ExchangesTickerQuery } from './services/exchanges/ticker/ticker.shared';
+export type { HomepageService } from './services/homepage/homepage.class';
+export type { Homepage, HomepageData, HomepagePatch, HomepageQuery } from './services/homepage/homepage.shared';
+export type { Marketplaces, MarketplacesData, MarketplacesPatch, MarketplacesQuery } from './services/marketplaces/marketplaces.shared';
+export type { Markets, MarketsData, MarketsPatch, MarketsQuery } from './services/markets/markets.shared';
+export type { Messages, MessagesData, MessagesPatch, MessagesQuery } from './services/messages/messages.shared';
+export type { StrategiesAi, StrategiesAiData, StrategiesAiPatch, StrategiesAiQuery } from './services/strategies/ai/ai.shared';
+export type { StrategiesAiStream, StrategiesAiStreamData, StrategiesAiStreamPatch, StrategiesAiStreamQuery } from './services/strategies/ai/stream/stream.shared';
+export type { StrategiesBacktest, StrategiesBacktestData, StrategiesBacktestPatch, StrategiesBacktestQuery } from './services/strategies/backtest/backtest.shared';
+export type { StrategiesBlob, StrategiesBlobData, StrategiesBlobPatch, StrategiesBlobQuery } from './services/strategies/blob/blob.shared';
+export type { StrategiesHyperopt, StrategiesHyperoptData, StrategiesHyperoptPatch, StrategiesHyperoptQuery } from './services/strategies/hyperopt/hyperopt.shared';
+export type { StrategiesIndicators, StrategiesIndicatorsData, StrategiesIndicatorsPatch, StrategiesIndicatorsQuery } from './services/strategies/indicators/indicators.shared';
+export type { Strategies, StrategiesData, StrategiesPatch, StrategiesQuery } from './services/strategies/strategies.shared';
+export type { StrategiesTemplates, StrategiesTemplatesData, StrategiesTemplatesPatch, StrategiesTemplatesQuery } from './services/strategies/templates/templates.shared';
+export type { StripeCharges, StripeChargesData, StripeChargesPatch, StripeChargesQuery } from './services/stripe/charges/charges.shared';
+export type { StripeCustomersCards, StripeCustomersCardsData, StripeCustomersCardsPatch, StripeCustomersCardsQuery } from './services/stripe/customers/cards/cards.shared';
+export type { StripeCustomers, StripeCustomersData, StripeCustomersPatch, StripeCustomersQuery } from './services/stripe/customers/customers.shared';
+export type { StripeCustomersPaymentintent, StripeCustomersPaymentintentData, StripeCustomersPaymentintentPatch, StripeCustomersPaymentintentQuery } from './services/stripe/customers/paymentintent/paymentintent.shared';
+export type { StripeCustomersPaymentmethods, StripeCustomersPaymentmethodsData, StripeCustomersPaymentmethodsPatch, StripeCustomersPaymentmethodsQuery } from './services/stripe/customers/paymentmethods/paymentmethods.shared';
+export type { StripeCustomersSubscriptions, StripeCustomersSubscriptionsData, StripeCustomersSubscriptionsPatch, StripeCustomersSubscriptionsQuery } from './services/stripe/customers/subscriptions/subscriptions.shared';
+export type { StripeProducts, StripeProductsData, StripeProductsPatch, StripeProductsQuery } from './services/stripe/products/products.shared';
+export type { TradersPodsApi, TradersPodsApiData, TradersPodsApiPatch, TradersPodsApiQuery } from './services/traders/pods/api/api.shared';
+export type { TradersPodsBlob, TradersPodsBlobData, TradersPodsBlobPatch, TradersPodsBlobQuery } from './services/traders/pods/blob/blob.shared';
+export type { TradersPodsEvents, TradersPodsEventsData, TradersPodsEventsPatch, TradersPodsEventsQuery } from './services/traders/pods/events/events.shared';
+export type { TradersPods, TradersPodsData, TradersPodsPatch, TradersPodsQuery } from './services/traders/pods/pods.shared';
+export type { TradersPodsWebhooks, TradersPodsWebhooksData, TradersPodsWebhooksPatch, TradersPodsWebhooksQuery } from './services/traders/pods/webhooks/webhooks.shared';
+export type { Traders, TradersData, TradersPatch, TradersQuery } from './services/traders/traders.shared';
+export type { User, UserData, UserPatch, UserQuery } from './services/users/users.shared';
+export type { Version, VersionData, VersionPatch, VersionQuery } from './services/version/version.shared';
+import './services/strategies/hyperopt/hyperopt.shared';
+import type { Application, TransportConnection } from '@feathersjs/feathers';
 import './services/version/version.shared';
-export type { Version, VersionData, VersionQuery, VersionPatch } from './services/version/version.shared';
 import './services/stripe/customers/paymentmethods/paymentmethods.shared';
-export type { StripeCustomersPaymentmethods, StripeCustomersPaymentmethodsData, StripeCustomersPaymentmethodsQuery, StripeCustomersPaymentmethodsPatch } from './services/stripe/customers/paymentmethods/paymentmethods.shared';
 import './services/stripe/customers/subscriptions/subscriptions.shared';
-export type { StripeCustomersSubscriptions, StripeCustomersSubscriptionsData, StripeCustomersSubscriptionsQuery, StripeCustomersSubscriptionsPatch } from './services/stripe/customers/subscriptions/subscriptions.shared';
 import './services/stripe/products/products.shared';
-export type { StripeProducts, StripeProductsData, StripeProductsQuery, StripeProductsPatch } from './services/stripe/products/products.shared';
 import './services/stripe/customers/cards/cards.shared';
-export type { StripeCustomersCards, StripeCustomersCardsData, StripeCustomersCardsQuery, StripeCustomersCardsPatch } from './services/stripe/customers/cards/cards.shared';
 import './services/stripe/customers/paymentintent/paymentintent.shared';
-export type { StripeCustomersPaymentintent, StripeCustomersPaymentintentData, StripeCustomersPaymentintentQuery, StripeCustomersPaymentintentPatch } from './services/stripe/customers/paymentintent/paymentintent.shared';
 import './services/stripe/customers/customers.shared';
-export type { StripeCustomers, StripeCustomersData, StripeCustomersQuery, StripeCustomersPatch } from './services/stripe/customers/customers.shared';
 import './services/stripe/charges/charges.shared';
-export type { StripeCharges, StripeChargesData, StripeChargesQuery, StripeChargesPatch } from './services/stripe/charges/charges.shared';
 import './services/strategies/ai/stream/stream.shared';
-export type { StrategiesAiStream, StrategiesAiStreamData, StrategiesAiStreamQuery, StrategiesAiStreamPatch } from './services/strategies/ai/stream/stream.shared';
 import './services/strategies/ai/ai.shared';
-export type { StrategiesAi, StrategiesAiData, StrategiesAiQuery, StrategiesAiPatch } from './services/strategies/ai/ai.shared';
-import './services/strategies/backtest/results/results.shared';
-export type { StrategiesBacktestResults, StrategiesBacktestResultsData, StrategiesBacktestResultsQuery, StrategiesBacktestResultsPatch } from './services/strategies/backtest/results/results.shared';
 import './services/strategies/backtest/backtest.shared';
-export type { StrategiesBacktest, StrategiesBacktestData, StrategiesBacktestQuery, StrategiesBacktestPatch } from './services/strategies/backtest/backtest.shared';
 import './services/traders/pods/events/events.shared';
-export type { TradersPodsEvents, TradersPodsEventsData, TradersPodsEventsQuery, TradersPodsEventsPatch } from './services/traders/pods/events/events.shared';
 import './services/traders/pods/webhooks/webhooks.shared';
-export type { TradersPodsWebhooks, TradersPodsWebhooksData, TradersPodsWebhooksQuery, TradersPodsWebhooksPatch } from './services/traders/pods/webhooks/webhooks.shared';
 import './services/traders/pods/api/api.shared';
-export type { TradersPodsApi, TradersPodsApiData, TradersPodsApiQuery, TradersPodsApiPatch } from './services/traders/pods/api/api.shared';
 import './services/strategies/indicators/indicators.shared';
-export type { StrategiesIndicators, StrategiesIndicatorsData, StrategiesIndicatorsQuery, StrategiesIndicatorsPatch } from './services/strategies/indicators/indicators.shared';
 import './services/strategies/templates/templates.shared';
-export type { StrategiesTemplates, StrategiesTemplatesData, StrategiesTemplatesQuery, StrategiesTemplatesPatch } from './services/strategies/templates/templates.shared';
 import './services/strategies/blob/blob.shared';
-export type { StrategiesBlob, StrategiesBlobData, StrategiesBlobQuery, StrategiesBlobPatch } from './services/strategies/blob/blob.shared';
 import './services/strategies/strategies.shared';
-export type { Strategies, StrategiesData, StrategiesQuery, StrategiesPatch } from './services/strategies/strategies.shared';
 import './services/traders/pods/pods.shared';
-export type { TradersPods, TradersPodsData, TradersPodsQuery, TradersPodsPatch } from './services/traders/pods/pods.shared';
 import './services/traders/traders.shared';
-export type { Traders, TradersData, TradersQuery, TradersPatch } from './services/traders/traders.shared';
 import './services/exchanges/download/webhooks/webhooks.shared';
-export type { ExchangesDownloadWebhooks, ExchangesDownloadWebhooksData, ExchangesDownloadWebhooksQuery, ExchangesDownloadWebhooksPatch } from './services/exchanges/download/webhooks/webhooks.shared';
 import './services/traders/pods/blob/blob.shared';
-export type { TradersPodsBlob, TradersPodsBlobData, TradersPodsBlobQuery, TradersPodsBlobPatch } from './services/traders/pods/blob/blob.shared';
 import './services/exchanges/download/download.shared';
-export type { ExchangesDownload, ExchangesDownloadData, ExchangesDownloadQuery, ExchangesDownloadPatch } from './services/exchanges/download/download.shared';
 import './services/exchanges/balance/balance.shared';
-export type { ExchangesBalance, ExchangesBalanceData, ExchangesBalanceQuery, ExchangesBalancePatch } from './services/exchanges/balance/balance.shared';
 import './services/exchanges/ticker/ticker.shared';
-export type { ExchangesTicker, ExchangesTickerData, ExchangesTickerQuery, ExchangesTickerPatch } from './services/exchanges/ticker/ticker.shared';
 import './services/marketplaces/marketplaces.shared';
-export type { Marketplaces, MarketplacesData, MarketplacesQuery, MarketplacesPatch } from './services/marketplaces/marketplaces.shared';
 import './services/config/config.shared';
-export type { Config, ConfigData, ConfigQuery, ConfigPatch } from './services/config/config.shared';
 import './services/markets/markets.shared';
-export type { Markets, MarketsData, MarketsQuery, MarketsPatch } from './services/markets/markets.shared';
 import './services/exchanges/exchanges.shared';
-export type { Exchanges, ExchangesData, ExchangesQuery, ExchangesPatch } from './services/exchanges/exchanges.shared';
 import './services/custom/custom.shared';
-export type { Custom, CustomData, CustomQuery, CustomPatch } from './services/custom/custom.shared';
 import './services/messages/messages.shared';
-export type { Messages, MessagesData, MessagesQuery, MessagesPatch } from './services/messages/messages.shared';
 import './services/users/users.shared';
-export type { User, UserData, UserQuery, UserPatch } from './services/users/users.shared';
 export interface Configuration {
     connection: TransportConnection<ServiceTypes>;
 }
@@ -77,7 +79,7 @@ export type ClientApplication = Application<ServiceTypes, Configuration>;
  *
  * @param connection The REST or Socket.io Feathers client connection
  * @param authenticationOptions Additional settings for the authentication client
- * @see https://dove.feathersjs.com/api/client.html
  * @returns The Feathers client application
+ * @see https://dove.feathersjs.com/api/client.html
  */
 export declare const createClient: <Configuration_1 = any>(connection: TransportConnection<ServiceTypes>, authenticationOptions?: Partial<AuthenticationClientOptions>) => ClientApplication;

package/lib/client.js

@@ -1,12 +1,13 @@
 "use strict";
+/* istanbul ignore file */
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createClient = void 0;
-// For more information about this file see https://dove.feathersjs.com/guides/cli/client.html
-const feathers_1 = require("@feathersjs/feathers");
+const hyperopt_shared_1 = require("./services/strategies/hyperopt/hyperopt.shared");
 const authentication_client_1 = __importDefault(require("@feathersjs/authentication-client"));
+const feathers_1 = require("@feathersjs/feathers");
 const version_shared_1 = require("./services/version/version.shared");
 const paymentmethods_shared_1 = require("./services/stripe/customers/paymentmethods/paymentmethods.shared");
 const subscriptions_shared_1 = require("./services/stripe/customers/subscriptions/subscriptions.shared");
@@ -17,7 +18,6 @@ const customers_shared_1 = require("./services/stripe/customers/customers.shared
 const charges_shared_1 = require("./services/stripe/charges/charges.shared");
 const stream_shared_1 = require("./services/strategies/ai/stream/stream.shared");
 const ai_shared_1 = require("./services/strategies/ai/ai.shared");
-const results_shared_1 = require("./services/strategies/backtest/results/results.shared");
 const backtest_shared_1 = require("./services/strategies/backtest/backtest.shared");
 const events_shared_1 = require("./services/traders/pods/events/events.shared");
 const webhooks_shared_1 = require("./services/traders/pods/webhooks/webhooks.shared");
@@ -31,13 +31,6 @@ const traders_shared_1 = require("./services/traders/traders.shared");
 const webhooks_shared_2 = require("./services/exchanges/download/webhooks/webhooks.shared");
 const blob_shared_2 = require("./services/traders/pods/blob/blob.shared");
 const download_shared_1 = require("./services/exchanges/download/download.shared");
-// import { exchangesDataClient } from './services/exchanges/data/data.shared'
-// export type {
-//   ExchangesData,
-//   ExchangesDataData,
-//   ExchangesDataQuery,
-//   ExchangesDataPatch
-// } from './services/exchanges/data/data.shared'
 const balance_shared_1 = require("./services/exchanges/balance/balance.shared");
 const ticker_shared_1 = require("./services/exchanges/ticker/ticker.shared");
 const marketplaces_shared_1 = require("./services/marketplaces/marketplaces.shared");
@@ -52,8 +45,8 @@ const users_shared_1 = require("./services/users/users.shared");
  *
  * @param connection The REST or Socket.io Feathers client connection
  * @param authenticationOptions Additional settings for the authentication client
- * @see https://dove.feathersjs.com/api/client.html
  * @returns The Feathers client application
+ * @see https://dove.feathersjs.com/api/client.html
  */
 const createClient = (connection, authenticationOptions = {}) => {
     const client = (0, feathers_1.feathers)();
@@ -84,7 +77,6 @@ const createClient = (connection, authenticationOptions = {}) => {
     client.configure(webhooks_shared_2.exchangesDownloadWebhooksClient);
     client.configure(events_shared_1.tradersPodsEventsClient);
     client.configure(backtest_shared_1.strategiesBacktestClient);
-    client.configure(results_shared_1.strategiesBacktestResultsClient);
     client.configure(ai_shared_1.strategiesAiClient);
     client.configure(stream_shared_1.strategiesAiStreamClient);
     client.configure(charges_shared_1.stripeChargesClient);
@@ -95,6 +87,8 @@ const createClient = (connection, authenticationOptions = {}) => {
     client.configure(subscriptions_shared_1.stripeCustomersSubscriptionsClient);
     client.configure(paymentmethods_shared_1.stripeCustomersPaymentmethodsClient);
     client.configure(version_shared_1.versionClient);
+    client.configure(hyperopt_shared_1.strategiesHyperoptClient);
+    client.configure(hyperopt_shared_1.strategiesHyperoptClient);
     return client;
 };
 exports.createClient = createClient;

package/lib/configuration.d.ts

@@ -146,8 +146,27 @@ export declare const configurationSchema: import("@feathersjs/typebox").TInterse
         apiKey: import("@feathersjs/typebox").TString<string>;
     }>;
     testData: import("@feathersjs/typebox").TOptional<import("@feathersjs/typebox").TAny>;
-    mixpanel: import("@feathersjs/typebox").TOptional<import("@feathersjs/typebox").TAny>;
+    mixpanel: import("@feathersjs/typebox").TOptional<import("@feathersjs/typebox").TObject<{
+        enabled: import("@feathersjs/typebox").TBoolean;
+        debug: import("@feathersjs/typebox").TBoolean;
+        token: import("@feathersjs/typebox").TString<string>;
+    }>>;
+    mautic: import("@feathersjs/typebox").TOptional<import("@feathersjs/typebox").TObject<{
+        enabled: import("@feathersjs/typebox").TBoolean;
+        url: import("@feathersjs/typebox").TString<string>;
+        username: import("@feathersjs/typebox").TString<string>;
+        password: import("@feathersjs/typebox").TString<string>;
+    }>>;
+    mixpanelClient: import("@feathersjs/typebox").TOptional<import("@feathersjs/typebox").TAny>;
+    firebaseClient: import("@feathersjs/typebox").TOptional<import("@feathersjs/typebox").TAny>;
     telegramClient: import("@feathersjs/typebox").TOptional<import("@feathersjs/typebox").TAny>;
+    brevoClient: import("@feathersjs/typebox").TOptional<import("@feathersjs/typebox").TAny>;
+    mauticClient: import("@feathersjs/typebox").TOptional<import("@feathersjs/typebox").TAny>;
+    brevo: import("@feathersjs/typebox").TOptional<import("@feathersjs/typebox").TObject<{
+        enabled: import("@feathersjs/typebox").TBoolean;
+        apiKey: import("@feathersjs/typebox").TString<string>;
+    }>>;
+    fileSystemId: import("@feathersjs/typebox").TString<string>;
     awsClient: import("@feathersjs/typebox").TOptional<import("@feathersjs/typebox").TAny>;
     telegram: import("@feathersjs/typebox").TOptional<import("@feathersjs/typebox").TObject<{
         enabled: import("@feathersjs/typebox").TBoolean;

package/lib/firebase-push-notification.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/helpers/backtest.helper.d.ts

@@ -1,12 +1,61 @@
 import { HookContext } from '@feathersjs/feathers';
+/** The `BacktestHelper` class provides utility methods for generating and managing backtest deployments. */
 export declare class BacktestHelper {
+    context: HookContext;
     client: any;
-    constructor();
+    batch: any;
+    constructor(context: HookContext);
     static getName(createdAt: any): string;
-    static generate(context: HookContext): object;
-    static promisifyStream(stream: any): any;
+    /**
+     * Generates a container spec for backtesting.
+     *
+     * @param context - The HookContext object.
+     * @returns The generated container spec.
+     */
+    static generate(context: HookContext, provider: string): object;
+    /**
+     * Promisifies a stream and resolves or rejects based on the stream events.
+     *
+     * @param stream - The stream object.
+     * @returns A promise that resolves to true when the stream ends successfully, or rejects with an Unprocessable error
+     *   if the stream data includes 'WARNING - No history for'.
+     */
+    static promisifyStream(container: any): Promise<any>;
+    /**
+     * Retrieves the results of a backtest.
+     *
+     * @param context - The HookContext object.
+     * @returns A Promise that resolves to the parsed results of the backtest.
+     * @throws Unprocessable error if no results are found.
+     */
     static getResults(context: HookContext): any;
+    /**
+     * Retrieves the elapsed time from the backtest results.
+     *
+     * @param {HookContext} context - The context object containing the necessary data.
+     * @returns {Promise<any>} - A promise that resolves to the parsed backtest results.
+     * @throws {Error} - If the backtest results path or meta file is not found.
+     */
     static getElapsedTime(context: HookContext): any;
-    static deploy(context: HookContext, deployment: any): Promise<any>;
+    static verifyCapacityAllocationForCPU(context: HookContext): Promise<any>;
+    /**
+     * Deploys a container for backtesting.
+     *
+     * @param context - The HookContext object.
+     * @param deployment - The deployment object.
+     * @returns A Promise that resolves to the result of the backtest.
+     * @throws If there is an error during the backtest.
+     */
+    static deploy(context: HookContext, deployment: any, provider: string): Promise<any>;
+    /**
+     * Retrieves the trader data path based on the provided context.
+     *
+     * @param {HookContext} context - The context object containing the necessary data.
+     * @returns {string} - The path to the trader data.
+     */
     static getTraderData(context: HookContext): string;
+    updateJobStatus(message: any): Promise<void>;
+    submitJob(command?: string[]): Promise<any>;
+    jobDefinitionExists(name: string): Promise<boolean>;
+    registerJobDefinition(definition: any): Promise<any>;
 }

package/lib/helpers/ccxt.helper.d.ts

@@ -1,15 +1,90 @@
 import { HookContext } from '@feathersjs/feathers';
+/**
+ * The CCXT class provides methods for interacting with cryptocurrency exchanges using the CCXT library. It includes
+ * functions for checking if an exchange is supported, handling errors, retrieving required credentials, loading
+ * markets, and more.
+ *
+ * @class
+ */
 export declare class CCXT {
     ccxt: any;
     context: HookContext;
     exchange: any;
     constructor(context: HookContext);
+    /**
+     * Checks if the given exchange is supported.
+     *
+     * @param exchange - The name of the exchange to check.
+     * @throws NotFound - If the exchange is not available.
+     */
     checkIfExchangeIsSupported(exchange: String): any;
+    /**
+     * Handles different types of errors thrown by the CCXT library.
+     *
+     * @param e - The error object.
+     * @returns Void
+     * @throws GeneralError - If the error is a DDoSProtection error or contains 'ECONNRESET' in the message.
+     * @throws Timeout - If the error is a RequestTimeout error.
+     * @throws NotAuthenticated - If the error is an AuthenticationError.
+     * @throws Unavailable - If the error is an ExchangeNotAvailable error.
+     * @throws GeneralError - If the error is an ExchangeError or NetworkError.
+     */
     errorHandler(e: any): any;
+    /**
+     * Retrieves the required credentials for a given exchange.
+     *
+     * @param exchange - The name of the exchange.
+     * @returns A promise that resolves to an array of required credentials.
+     */
     getRequiredCredentials(exchange: any): Promise<any>;
+    /**
+     * Validates the required credentials for an exchange.
+     *
+     * @param exchange - The exchange object containing the required credentials.
+     * @returns A promise that resolves to true if the credentials are valid, or false if they are not.
+     * @throws BadRequest error if the required credentials are not provided.
+     */
     checkCredentials(exchange: any): Promise<any>;
+    /**
+     * Loads the markets for a given exchange.
+     *
+     * This function is needed to store the pairs from each exchange and runs on every patch exchange hook. However, to
+     * avoid overloading the endpoint, the response update to the market table is done using a minimum time difference
+     * required.
+     *
+     * @param context - The context object.
+     * @param exchange - The exchange name.
+     * @param silent - Optional. If true, suppresses debug logs. Default is false.
+     * @returns A promise that resolves to the loaded markets.
+     * @throws {GeneralError} If there is an error loading the markets.
+     */
     loadMarkets(context: any, exchange: any, silent?: Boolean): Promise<any>;
+    /**
+     * Retrieves the bases and quotes from the given markets.
+     *
+     * @param markets - The markets object.
+     * @returns A promise that resolves to an object containing the markets, bases, and quotes.
+     */
     getBasesAndQuotes(markets: any): Promise<any>;
+    /**
+     * Verifies if the interval needed to wait in order to add again to the database is bigger than the value informed in
+     * default.json. If the interval is not bigger, the method skips creating the data into the database.
+     *
+     * @param {HookContext} context - The context object.
+     * @param {any} markets - The markets data.
+     * @param {String} exchange - The exchange name.
+     * @param {Boolean} [force] - Optional. If true, forces the refresh of the market data.
+     * @returns {Promise<any>} - A promise that resolves with the markets data if the refresh is needed, or false if the
+     *   refresh is not needed.
+     */
     verifyIfNeedToRefresh(context: HookContext, markets: any, exchange: String, force?: Boolean): Promise<any>;
+    /**
+     * Finds all pairs/markets of a specific exchange and keeps only the last one to save space in the database.
+     *
+     * @param {HookContext} context - The context object.
+     * @param {String} exchange - The name of the exchange.
+     * @returns {Promise<any>} - A promise that resolves with the markets data.
+     * @throws {GeneralError} - If there is an error finding or removing the markets.
+     */
     keepOnlyLastOnePerExchange(context: HookContext, exchange: String): Promise<any>;
 }

package/lib/helpers/deployments.helper.d.ts

@@ -2,11 +2,83 @@ import { HookContext } from '@feathersjs/feathers';
 export declare class Docker {
     client: any;
     constructor();
+    /**
+     * Validates if the strategy is available.
+     *
+     * @param context - The HookContext object.
+     * @throws {Unprocessable} - If the strategy is not available.
+     */
     static checkIfStrategyIsAvailable(context: HookContext): void;
+    /**
+     * Check if the strategy file exists in disk.
+     *
+     * @param context - The HookContext object.
+     * @returns Promise<void>
+     * @throws {Unprocessable} - If the strategy file is not available in the disk.
+     */
     static checkIfStrategyExistsInDisk(context: HookContext): Promise<void>;
+    /**
+     * Check if the config file exists in disk.
+     *
+     * @param context - The HookContext object.
+     * @returns Promise<void>
+     */
     static checkIfConfigExistsInDisk(context: HookContext): Promise<void>;
+    /**
+     * Requests an available host port.
+     *
+     * @param context - The HookContext object.
+     * @returns A Promise that resolves to a string representing the available port.
+     * @throws Error if unable to find a free port.
+     */
     static requestAvailableHostPort(context: HookContext): Promise<String>;
+    /**
+     * Generates a deployment object for Docker based on the provided context.
+     *
+     * @param {HookContext} context - The context object containing the necessary data for generating the deployment.
+     * @returns {Promise<object>} - A promise that resolves to the generated deployment object.
+     * @throws {GeneralError} - If there is an error during the generation process.
+     */
     static generate(context: HookContext): Promise<object>;
+    /**
+     * Deploys a container using the provided deployment configuration.
+     *
+     * @param context - The HookContext object.
+     * @param deployment - The deployment configuration.
+     * @returns A promise that resolves to the deployed container.
+     * @throws {NotFound} If the image specified in the deployment configuration is not found.
+     * @throws {GeneralError} If there is an error deploying the container.
+     */
     static deploy(context: HookContext, deployment: any): Promise<any>;
+    /**
+     * Returns the path to the trader data directory.
+     *
+     * @param {HookContext} context - The HookContext object.
+     * @returns {string} - The path to the trader data directory.
+     */
     static getTraderData(context: HookContext): string;
+    /**
+     * Checks if an image with the specified name exists in the Docker registry.
+     *
+     * @param {string} imageName - The name of the image to check.
+     * @returns {Promise<boolean>} - A promise that resolves to true if the image exists, false otherwise.
+     * @throws {Error} - If there is an error checking the image existence.
+     */
+    static checkImageExists(imageName: string): Promise<boolean>;
+    /**
+     * Pulls an image from the Docker registry.
+     *
+     * @param {string} imageName - The name of the image to pull.
+     * @returns {Promise<void>} - A promise that resolves when the image is successfully pulled.
+     * @throws {Error} - If there is an error pulling the image.
+     */
+    static pullImage(imageName: string): Promise<void>;
+    /**
+     * Ensures that the specified image exists in the Docker registry.
+     *
+     * @param {string} imageName - The name of the image to ensure.
+     * @returns {Promise<void>} - A promise that resolves when the image is successfully ensured.
+     * @throws {Error} - If there is an error ensuring the image.
+     */
+    static ensureImage(imageName: string): Promise<void>;
 }

package/lib/helpers/funnel.helper.d.ts

@@ -0,0 +1,17 @@
+import { Application, HookContext } from '@feathersjs/feathers';
+import { User } from 'src/services/users/users.schema';
+export declare class FunnellHelper {
+    app: Application;
+    context: HookContext;
+    mixpanel: any;
+    mautic: any;
+    constructor(context: HookContext);
+    trackSignup(type: String, user: User): Promise<void>;
+    incrementCountOf(key: string, user: User, count?: Number): Promise<void>;
+    trackEvent(context: HookContext): Promise<void>;
+    trackLogin(user: User): Promise<void>;
+    setUserToQualifying(user: User, event?: any): Promise<void>;
+    setUserToOnboarded(user: User): Promise<void>;
+    setUserToNurtured(user: User): Promise<void>;
+    setUserToGivingUp(user: User): Promise<void>;
+}

package/lib/helpers/hyperopt.helper.d.ts

@@ -0,0 +1,14 @@
+import { HookContext } from '@feathersjs/feathers';
+export declare class Hyperopt {
+    context: HookContext;
+    client: any;
+    iam: any;
+    cloudformation: any;
+    constructor(context: HookContext);
+    prepareLocalEnvironment(): Promise<void>;
+    jobDefinitionExists(name: string): Promise<boolean>;
+    generate(context: HookContext): Promise<object>;
+    updateJobStatus(message: any): Promise<void>;
+    registerJobDefinition(definition: any): Promise<any>;
+    submitJob(): Promise<void>;
+}

package/lib/helpers/push-notification.helper.d.ts

@@ -0,0 +1,7 @@
+import { HookContext } from '@feathersjs/feathers';
+import { User } from '../../src/services/users/users.schema';
+export declare class PushNotificationHelper {
+    client: any;
+    constructor(context: HookContext);
+    dispatch(user: User, notification: object): Promise<any>;
+}

package/lib/helpers/queue.helper.d.ts

@@ -1,5 +1,13 @@
 import { HookContext } from '@feathersjs/feathers';
 export declare class QueueHelper {
     constructor();
+    /**
+     * Retrieves a queue from the context based on its ID.
+     *
+     * @param {HookContext} context - The context object containing the application and other data.
+     * @param {string} id - The ID of the queue to retrieve.
+     * @returns {Promise<any>} - A promise that resolves to the queue object.
+     * @throws {NotFound} - If the queue with the specified ID is not found.
+     */
     getQueue(context: HookContext, id: string): Promise<any>;
 }

package/lib/helpers/sqlite3.helper.d.ts

@@ -0,0 +1,6 @@
+export declare class Sqlite {
+    db: any;
+    constructor(path: string);
+    get(sql: any, params?: never[]): any;
+    run(sql: any, params?: never[]): any;
+}

package/lib/helpers/sqs.helper.d.ts

@@ -0,0 +1,7 @@
+import { SQSClient } from '@aws-sdk/client-sqs';
+export declare class SQSHelper {
+    client: SQSClient;
+    constructor();
+    consume(QueueUrl: string): Promise<any>;
+    delete(QueueUrl: string, ReceiptHandle: string): Promise<any>;
+}

package/lib/helpers/subscription.helper.d.ts

@@ -0,0 +1,48 @@
+import { HookContext } from '@feathersjs/feathers';
+/** SubscriptionHelper class provides methods for checking user subscriptions and limits. */
+export declare class SubscriptionHelper {
+    private limits;
+    getLimits(context: HookContext): {
+        traders: number;
+        backtest: {
+            threshold: {
+                cpu: number;
+            };
+            simultaneous: number;
+            memory: number;
+            cpu: number;
+        };
+    };
+    /**
+     * Checks if the user has an active subscription.
+     *
+     * @param {HookContext} context - The hook context object.
+     * @returns {boolean} - Returns true if the user has an active subscription, otherwise undefined.
+     */
+    hasActiveSubscription(context: HookContext): true | undefined;
+    /**
+     * Checks if the user has a trial subscription.
+     *
+     * @param {HookContext} context - The hook context object.
+     * @returns {boolean} - Returns true if the user has a trial subscription, otherwise undefined.
+     */
+    hasFreeTrialSubscriptionExpired(context: HookContext): void;
+    /**
+     * Checks if the user can trade with real money.
+     *
+     * @param {HookContext} context - The hook context object.
+     * @returns {Promise<void>} - Returns a promise that resolves if the user can trade with real money.
+     * @throws {Forbidden} - Throws a Forbidden error if the user does not have an active subscription.
+     */
+    verifyIfUserCanTradeWithRealMoney(context: HookContext): Promise<void>;
+    /**
+     * Checks if the user is below the limits of traders.
+     *
+     * @param {HookContext} context - The hook context object.
+     * @returns {Promise<void>} - Returns a promise that resolves if the user is below the limits of traders.
+     * @throws {Forbidden} - Throws a Forbidden error if the user has reached the limit of running traders.
+     * @throws {Unprocessable} - Throws an Unprocessable error if there is an error getting traders.
+     */
+    verifyIfUserIsBelowLimitsOfTraders(context: HookContext): Promise<void>;
+    verifyBacktestSimultaneouslyLimit(context: HookContext): Promise<void>;
+}

package/lib/helpers/telegram.helper.d.ts

@@ -1,7 +1,32 @@
+import { HookContext } from '@feathersjs/feathers';
+/** The TelegramHelper class provides methods for creating, updating, and deleting Telegram groups. */
 export declare class TelegramHelper {
     client: any;
-    constructor();
+    constructor(context: HookContext);
+    /**
+     * Creates a telegram group with the given title.
+     *
+     * @param {string} title - The title of the group.
+     * @returns {Promise<any>} - A promise that resolves to an object containing the chat_id and invite_link of the
+     *   created group.
+     * @throws {GeneralError} - If there is an error during the creation of the group.
+     */
     createGroup(title: string): Promise<any>;
+    /**
+     * Updates the title of a telegram group.
+     *
+     * @param {any} chat_id - The ID of the group chat.
+     * @param {string} title - The new title for the group.
+     * @returns {Promise<any>} - A promise that resolves to the updated group object.
+     * @throws {GeneralError} - If there is an error during the update of the group title.
+     */
     updateGroup(chat_id: any, title: string): Promise<any>;
+    /**
+     * Deletes a telegram group with the given chat ID.
+     *
+     * @param {any} chat_id - The ID of the group chat.
+     * @returns {Promise<any>} - A promise that resolves to the result of deleting the group.
+     * @throws {GeneralError} - If there is an error during the deletion of the group.
+     */
     deleteGroup(chat_id: any): Promise<any>;
 }