Constructs and prepares an instance of this scheduler abstraction layer.
The arguments passed to the command. Typically, this holds required parameters of commands.
Contains the size of batches. This field is only used given
BroadcastPayouts.enableBatches is true and determines
the size of transaction batches.
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.
Contains a boolean value that determines whether transactions must be batched if possible (aggregate complete).
Contains a boolean value that determines whether the runtime
is currently using a global dry-run mode.
Note that dry-run mode disables payout broadcasts, as such
transactions will not appear on dHealth Network.
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 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.
Contains an array of transaction hashes that are ready to be broadcast to the network.
Memory store for all transactions that must be broadcast during this execution of the command.
This method must return a database collection which
is used to discover subjects for this preparation.
e.g. "activities"
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
BaseCommand but is intentionally forwarded
to further child classes such that each command defines
its own command name.
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
BaseCommand but is intentionally forwarded
to further child classes such that each command defines
its own command signature.
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 must return a total count of subjects.
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.
This method implements the processor logic for this command
that will prepare relevant subjects' payout entities. Subjects
in this command are defined by the BroadcastPayouts.collection
implementation.
This method must return an array of subjects. Note that subjects will be the subject of a payout broadcast.
The count of subjects to retrieve.
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 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 implements the execution logic for
processor commands that extend this class. Child
classes must implement a process 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 implementation for the payout preparation scheduler. Contains source code for the execution logic of a command with name:
processor:BroadcastPayouts.Notably, this command fetches activities that have not been the subject of payouts yet and then creates transactions and signs transactions.
v0.4.0