The BaseCommand represents Lisk commands by providing a generic interface, from which each command extends from.

Hierarchy

Constructors

Properties

_baseStakeAmount: bigint
_factorSelfStakes: number
_internalMethod: InternalMethod
_maxNumberPendingUnlocks: number
_maxNumberSentStakes: number
_posTokenID: Buffer
_tokenMethod: TokenMethod
events: NamedRegistry
schema: {
    $id: string;
    properties: {
        stakes: {
            fieldNumber: number;
            items: {
                properties: {
                    amount: {
                        dataType: string;
                        fieldNumber: number;
                    };
                    validatorAddress: {
                        dataType: string;
                        fieldNumber: number;
                        format: string;
                    };
                };
                required: string[];
                type: string;
            };
            maxItems: number;
            minItems: number;
            type: string;
        };
    };
    required: string[];
    type: string;
} = stakeCommandParamsSchema

Type declaration

  • $id: string
  • properties: {
        stakes: {
            fieldNumber: number;
            items: {
                properties: {
                    amount: {
                        dataType: string;
                        fieldNumber: number;
                    };
                    validatorAddress: {
                        dataType: string;
                        fieldNumber: number;
                        format: string;
                    };
                };
                required: string[];
                type: string;
            };
            maxItems: number;
            minItems: number;
            type: string;
        };
    }
    • stakes: {
          fieldNumber: number;
          items: {
              properties: {
                  amount: {
                      dataType: string;
                      fieldNumber: number;
                  };
                  validatorAddress: {
                      dataType: string;
                      fieldNumber: number;
                      format: string;
                  };
              };
              required: string[];
              type: string;
          };
          maxItems: number;
          minItems: number;
          type: string;
      }
      • fieldNumber: number
      • items: {
            properties: {
                amount: {
                    dataType: string;
                    fieldNumber: number;
                };
                validatorAddress: {
                    dataType: string;
                    fieldNumber: number;
                    format: string;
                };
            };
            required: string[];
            type: string;
        }
        • properties: {
              amount: {
                  dataType: string;
                  fieldNumber: number;
              };
              validatorAddress: {
                  dataType: string;
                  fieldNumber: number;
                  format: string;
              };
          }
          • amount: {
                dataType: string;
                fieldNumber: number;
            }
            • dataType: string
            • fieldNumber: number
          • validatorAddress: {
                dataType: string;
                fieldNumber: number;
                format: string;
            }
            • dataType: string
            • fieldNumber: number
            • format: string
        • required: string[]
        • type: string
      • maxItems: number
      • minItems: number
      • type: string
  • required: string[]
  • type: string
stores: NamedRegistry

Accessors

Methods

  • Parameters

    • args: {
          internalMethod: InternalMethod;
          tokenMethod: TokenMethod;
      }
      • internalMethod: InternalMethod
      • tokenMethod: TokenMethod

    Returns void

  • Applies the state changes of a command through the state machine. The hook Command.execute() is triggered by a transaction identified by the module name and the command name.

    Additionally, an event will be emitted that provides the information on whether a command is executed successfully or failed.

    In this hook, the state can be mutated and events can be emitted.

    If the command verification succeeded, but the hook execution fails, the transaction that triggered this command is still valid, however the state changes applied in this hook are reverted.

    Parameters

    • context: CommandExecuteContext<StakeTransactionParams>

      The context available in every Command.execute() hook.

    Returns Promise<void>

  • Parameters

    • args: {
          baseStakeAmount: bigint;
          factorSelfStakes: number;
          maxNumberPendingUnlocks: number;
          maxNumberSentStakes: number;
          posTokenID: Buffer;
      }
      • baseStakeAmount: bigint
      • factorSelfStakes: number
      • maxNumberPendingUnlocks: number
      • maxNumberSentStakes: number
      • posTokenID: Buffer

    Returns void

Generated using TypeDoc