Constructs and prepares an instance of this scheduler.
The type of statistics to be saved to the database.
Should be defaulted to "leaderboard".
The arguments passed to the command. Typically, this holds required parameters of commands.
The internal dApp configuration object. This object is used to configure key functionalities such as the name of a dApp and the enabled scopes of the backend runtime.
Memory store for the last time of execution. This is used in getStateData to update the latest execution state.
The internal dApp network configuration object. This object is used to configure the access to the underlying blockchain network.
The period format i.e. "D", "W" or "M".
This field will be overriden by sub-classes during initialization.
The command scope. This is the scope that must be enabled
through the configuration files for this command to be
available.
This property is required through the extension of
BaseCommand.
Requires state information of the module. This object is typically populated upon first execution and updated any time later.
This method must return a command name. Note that
it should use only characters of: A-Za-z0-9:-_.
e.g. "scope:name"
This property is required through the extension of
StatisticsCommand.
Method to get the score scheduler config values for this leaderboard aggregation's period format.
This method must return a command signature that
contains hints on the command name and its required
and optional arguments.
e.g. "command
This property is required through the extension of
StatisticsCommand.
Getter for the discovery state identifier, e.g.
"discovery.accounts", "discovery.transactions",
"payout.outputs" etc.
This method is an implementation necessary because
of the extensions of StatefulModule.
This method implements the statistics logic for this command
that will aggregate relevant subjects. Subjects in this command
are provided in config as collection and ** fields** that are
included in transfer transactions on dHealth Network.
As of the time of writing, this scheduler currently supports the
following collections:
assets: The asset that an account has received as rewards.
amount: The amount of an asset that an account received as rewards,
Method to create aggregation query to calculate statistics information
based on config's collection and fields values.
An abstract method to determine the range of time to perform aggregation search for relevant statistics. This method has to be overidden by sub-classes.
This method uses the logger to print debug messages.
This method uses the logger to print error messages.
Optionally, a stack can be passed to print a stack trace.
Abstract method to generate period string for a date instance. Sub-classes have to override this method to return the correct period string.
Abstract method to generate the previous period string for a date instance.
Creates a state query for this discovery service. Each discovery service shall set its own stateIdentifier which is considered the identifier of the discovery module's state document.
This method uses the logger to print info messages.
This helper method serves as a parser for the -c
or --collection option of this command.
The statistics collection can contain a mongo collection
name that must exist in the database.
The --collection argument as passed in the terminal.
A validated mongo database collection name.
This method is the entry point of any command line
executed command. nest-commander implements a flow
where this method is called with parameters that are
respectively the raw arguments and the parsed arguments
to this command call.
This method uses the stateService to fetch the
current execution and also uses it to update the state.
Note that the runWithOptions method is called inside
a try-catch block to force the error handling process.
This method is the entry point of this scheduler. Due to
the usage of the Cron decorator, and the implementation
the nest backend runtime is able to discover this when the
statistics scope is enabled.
This method is necessary to make sure this command is run
with the correct --collection option.
This method must be implemented in sub-classes with a proper
cron expression value.
This method is the second entry point of this scheduler. Due to
the usage of the Cron decorator, and the implementation
the nest backend runtime is able to discover this when the
statistics scope is enabled.
This method is necessary to make sure this command is run
with the correct --collection option.
This method implements the execution logic for
statistics commands that extend this class. Child
classes must implement a aggregate method
that is called in here.
Note that this method is called by BaseCommand
under the hood, which permits to execute and track
failures more consistently at a higher level.
The parsed runtime arguments passed to the command.
This method prints usage information to the command line
and is used by nest-commander to print a correctly formatted
help message.
Note that usage methods can be overwritten but must always
print a standard command line signature.
Generated using TypeDoc
The abstract implementation for the score aggregation scheduler. Contains source code for the execution logic of a command with name:
statistics:LeaderboardAggregation/(D|M|W).v0.3.2