hardhatjs 2.22.15

package/internal/core/tasks/task-definitions.d.ts

@@ -0,0 +1,266 @@
+import { ActionType, ArgumentType, ParamDefinition, ParamDefinitionsMap, ScopeDefinition, TaskArguments, TaskDefinition, TaskIdentifier, TasksMap } from "../../../types";
+/**
+ * This class creates a task definition, which consists of:
+ * * a name, that should be unique and will be used to call the task.
+ * * a description. This is optional.
+ * * the action that the task will execute.
+ * * a set of parameters that can be used by the action.
+ *
+ */
+export declare class SimpleTaskDefinition implements TaskDefinition {
+    readonly isSubtask: boolean;
+    get name(): string;
+    get scope(): string | undefined;
+    get description(): string | undefined;
+    readonly paramDefinitions: ParamDefinitionsMap;
+    readonly positionalParamDefinitions: Array<ParamDefinition<any>>;
+    action: ActionType<TaskArguments>;
+    private _positionalParamNames;
+    private _hasVariadicParam;
+    private _hasOptionalPositionalParam;
+    private _scope?;
+    private _task;
+    private _description?;
+    /**
+     * Creates an empty task definition.
+     *
+     * This definition will have no params, and will throw a HH205 if executed.
+     *
+     * @param taskIdentifier The task's identifier.
+     * @param isSubtask `true` if the task is a subtask, `false` otherwise.
+     */
+    constructor(taskIdentifier: TaskIdentifier, isSubtask?: boolean);
+    /**
+     * Sets the task's description.
+     * @param description The description.
+     */
+    setDescription(description: string): this;
+    /**
+     * Sets the task's action.
+     * @param action The action.
+     */
+    setAction<TaskArgumentsT extends TaskArguments>(action: ActionType<TaskArgumentsT>): this;
+    /**
+     * Adds a parameter to the task's definition.
+     *
+     * @remarks This will throw if the `name` is already used by this task or
+     * by Hardhat's global parameters.
+     *
+     * @param name The parameter's name.
+     * @param description The parameter's description.
+     * @param defaultValue A default value. This must be `undefined` if `isOptional` is `true`.
+     * @param type The param's `ArgumentType`. It will parse and validate the user's input.
+     * @param isOptional `true` if the parameter is optional. It's default value is `true` if `defaultValue` is not `undefined`.
+     */
+    addParam<T>(name: string, description?: string, defaultValue?: T, type?: ArgumentType<T>, isOptional?: boolean): this;
+    /**
+     * Adds an optional parameter to the task's definition.
+     *
+     * @see addParam.
+     *
+     * @param name the parameter's name.
+     * @param description the parameter's description.
+     * @param defaultValue a default value.
+     * @param type param's type.
+     */
+    addOptionalParam<T>(name: string, description?: string, defaultValue?: T, type?: ArgumentType<T>): this;
+    /**
+     * Adds a boolean parameter or flag to the task's definition.
+     *
+     * Flags are params with default value set to `false`, and that don't expect
+     * values to be set in the CLI. A normal boolean param must be called with
+     * `--param true`, while a flag is called with `--flag`.
+     *
+     * @param name the parameter's name.
+     * @param description the parameter's description.
+     */
+    addFlag(name: string, description?: string): this;
+    /**
+     * Adds a positional parameter to the task's definition.
+     *
+     * @remarks This will throw if the `name` is already used by this task or
+     * by Hardhat's global parameters.
+     * @remarks This will throw if `isOptional` is `false` and an optional positional
+     * param was already set.
+     * @remarks This will throw if a variadic positional param is already set.
+     *
+     * @param name The parameter's name.
+     * @param description The parameter's description.
+     * @param defaultValue A default value. This must be `undefined` if `isOptional` is `true`.
+     * @param type The param's `ArgumentType`. It will parse and validate the user's input.
+     * @param isOptional `true` if the parameter is optional. It's default value is `true` if `defaultValue` is not `undefined`.
+     */
+    addPositionalParam<T>(name: string, description?: string, defaultValue?: T, type?: ArgumentType<T>, isOptional?: boolean): this;
+    /**
+     * Adds an optional positional parameter to the task's definition.
+     *
+     * @see addPositionalParam.
+     *
+     * @param name the parameter's name.
+     * @param description the parameter's description.
+     * @param defaultValue a default value.
+     * @param type param's type.
+     */
+    addOptionalPositionalParam<T>(name: string, description?: string, defaultValue?: T, type?: ArgumentType<T>): this;
+    /**
+     * Adds a variadic positional parameter to the task's definition. Variadic
+     * positional params act as `...rest` parameters in JavaScript.
+     *
+     * @param name The parameter's name.
+     * @param description The parameter's description.
+     * @param defaultValue A default value. This must be `undefined` if `isOptional` is `true`.
+     * @param type The param's `ArgumentType`. It will parse and validate the user's input.
+     * @param isOptional `true` if the parameter is optional. It's default value is `true` if `defaultValue` is not `undefined`.
+     */
+    addVariadicPositionalParam<T>(name: string, description?: string, defaultValue?: T[] | T, type?: ArgumentType<T>, isOptional?: boolean): this;
+    /**
+     * Adds a positional parameter to the task's definition.
+     *
+     * This will check if the `name` is already used and
+     * if the parameter is being added after a varidic argument.
+     *
+     * @param name the parameter's name.
+     * @param description the parameter's description.
+     * @param defaultValue a default value.
+     * @param type param's type.
+     */
+    addOptionalVariadicPositionalParam<T>(name: string, description?: string, defaultValue?: T[] | T, type?: ArgumentType<T>): this;
+    /**
+     * Adds a positional parameter to the task's definition.
+     *
+     * @param definition the param's definition
+     */
+    private _addPositionalParamDefinition;
+    /**
+     * Validates if the given param's name is after a variadic parameter.
+     * @param name the param's name.
+     * @throws HH200
+     */
+    private _validateNotAfterVariadicParam;
+    /**
+     * Validates if the param's name is already used.
+     * @param name the param's name.
+     *
+     * @throws HH201 if `name` is already used as a param.
+     * @throws HH202 if `name` is already used as a param by Hardhat
+     */
+    private _validateNameNotUsed;
+    /**
+     * Checks if the given name is already used.
+     * @param name the param's name.
+     */
+    private _hasParamDefined;
+    /**
+     * Validates if a mandatory param is being added after optional params.
+     *
+     * @param name the param's name to be added.
+     * @param isOptional true if the new param is optional, false otherwise.
+     *
+     * @throws HH203 if validation fail
+     */
+    private _validateNoMandatoryParamAfterOptionalOnes;
+    private _validateParamNameCasing;
+    private _validateNoDefaultValueForMandatoryParam;
+    private _isStringArray;
+    private _validateCLIArgumentTypesForExternalTasks;
+}
+/**
+ * Allows you to override a previously defined task.
+ *
+ * When overriding a task you can:
+ *  * flag it as a subtask
+ *  * set a new description
+ *  * set a new action
+ *
+ */
+export declare class OverriddenTaskDefinition implements TaskDefinition {
+    readonly parentTaskDefinition: TaskDefinition;
+    readonly isSubtask: boolean;
+    private _description?;
+    private _action?;
+    constructor(parentTaskDefinition: TaskDefinition, isSubtask?: boolean);
+    /**
+     * Sets the task's description.
+     * @param description The description.
+     */
+    setDescription(description: string): this;
+    /**
+     * Overrides the parent task's action.
+     * @param action the action.
+     */
+    setAction<TaskArgumentsT extends TaskArguments>(action: ActionType<TaskArgumentsT>): this;
+    /**
+     * Retrieves the parent task's scope.
+     */
+    get scope(): string | undefined;
+    /**
+     * Retrieves the parent task's name.
+     */
+    get name(): string;
+    /**
+     * Retrieves, if defined, the description of the overridden task,
+     * otherwise retrieves the description of the parent task.
+     */
+    get description(): string | undefined;
+    /**
+     * Retrieves, if defined, the action of the overridden task,
+     * otherwise retrieves the action of the parent task.
+     */
+    get action(): ActionType<any>;
+    /**
+     * Retrieves the parent task's param definitions.
+     */
+    get paramDefinitions(): ParamDefinitionsMap;
+    /**
+     * Retrieves the parent task's positional param definitions.
+     */
+    get positionalParamDefinitions(): ParamDefinition<any>[];
+    /**
+     * Overriden tasks can't add new parameters.
+     */
+    addParam<T>(name: string, description?: string, defaultValue?: T, type?: ArgumentType<T>, isOptional?: boolean): this;
+    /**
+     * Overriden tasks can't add new parameters.
+     */
+    addOptionalParam<T>(name: string, description?: string, defaultValue?: T, type?: ArgumentType<T>): this;
+    /**
+     * Overriden tasks can't add new parameters.
+     */
+    addPositionalParam<T>(_name: string, _description?: string, _defaultValue?: T, _type?: ArgumentType<T>, _isOptional?: boolean): this;
+    /**
+     * Overriden tasks can't add new parameters.
+     */
+    addOptionalPositionalParam<T>(_name: string, _description?: string, _defaultValue?: T, _type?: ArgumentType<T>): this;
+    /**
+     * Overriden tasks can't add new parameters.
+     */
+    addVariadicPositionalParam<T>(_name: string, _description?: string, _defaultValue?: T[], _type?: ArgumentType<T>, _isOptional?: boolean): this;
+    /**
+     * Overriden tasks can't add new parameters.
+     */
+    addOptionalVariadicPositionalParam<T>(_name: string, _description?: string, _defaultValue?: T[], _type?: ArgumentType<T>): this;
+    /**
+     * Add a flag param to the overridden task.
+     * @throws HH201 if param name was already defined in any parent task.
+     * @throws HH209 if param name is not in camelCase.
+     */
+    addFlag(name: string, description?: string): this;
+    private _throwNoParamsOverrideError;
+}
+type AddTaskFunction = <TaskArgumentsT extends TaskArguments>(name: string, descriptionOrAction?: string | ActionType<TaskArgumentsT>, action?: ActionType<TaskArgumentsT>) => TaskDefinition;
+export declare class SimpleScopeDefinition implements ScopeDefinition {
+    readonly name: string;
+    private _description;
+    private _addTask;
+    private _addSubtask;
+    tasks: TasksMap;
+    constructor(name: string, _description: string | undefined, _addTask: AddTaskFunction, _addSubtask: AddTaskFunction);
+    get description(): string | undefined;
+    setDescription(description: string): this;
+    task<TaskArgumentsT extends TaskArguments>(name: string, description?: string, action?: ActionType<TaskArgumentsT>): TaskDefinition;
+    task<TaskArgumentsT extends TaskArguments>(name: string, action: ActionType<TaskArgumentsT>): TaskDefinition;
+    subtask<TaskArgumentsT extends TaskArguments>(name: string, description?: string, action?: ActionType<TaskArgumentsT>): TaskDefinition;
+    subtask<TaskArgumentsT extends TaskArguments>(name: string, action: ActionType<TaskArgumentsT>): TaskDefinition;
+}
+export {};
+//# sourceMappingURL=task-definitions.d.ts.map

package/internal/core/tasks/task-definitions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"task-definitions.d.ts","sourceRoot":"","sources":["../../../src/internal/core/tasks/task-definitions.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,YAAY,EAEZ,eAAe,EACf,mBAAmB,EACnB,eAAe,EACf,aAAa,EACb,cAAc,EACd,cAAc,EACd,QAAQ,EACT,MAAM,gBAAgB,CAAC;AAYxB;;;;;;;GAOG;AACH,qBAAa,oBAAqB,YAAW,cAAc;aA+BvC,SAAS,EAAE,OAAO;IA9BpC,IAAW,IAAI,WAEd;IACD,IAAW,KAAK,uBAEf;IACD,IAAW,WAAW,uBAErB;IACD,SAAgB,gBAAgB,EAAE,mBAAmB,CAAM;IAC3D,SAAgB,0BAA0B,EAAE,KAAK,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,CAAM;IACtE,MAAM,EAAE,UAAU,CAAC,aAAa,CAAC,CAAC;IAEzC,OAAO,CAAC,qBAAqB,CAAc;IAC3C,OAAO,CAAC,iBAAiB,CAAU;IACnC,OAAO,CAAC,2BAA2B,CAAU;IAC7C,OAAO,CAAC,MAAM,CAAC,CAAS;IACxB,OAAO,CAAC,KAAK,CAAS;IACtB,OAAO,CAAC,YAAY,CAAC,CAAS;IAE9B;;;;;;;OAOG;gBAED,cAAc,EAAE,cAAc,EACd,SAAS,GAAE,OAAe;IAe5C;;;OAGG;IACI,cAAc,CAAC,WAAW,EAAE,MAAM;IAKzC;;;OAGG;IACI,SAAS,CAAC,cAAc,SAAS,aAAa,EACnD,MAAM,EAAE,UAAU,CAAC,cAAc,CAAC;IAOpC;;;;;;;;;;;OAWG;IACI,QAAQ,CAAC,CAAC,EACf,IAAI,EAAE,MAAM,EACZ,WAAW,CAAC,EAAE,MAAM,EACpB,YAAY,CAAC,EAAE,CAAC,EAChB,IAAI,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,EACtB,UAAU,GAAE,OAAoC,GAC/C,IAAI;IAqDP;;;;;;;;;OASG;IACI,gBAAgB,CAAC,CAAC,EACvB,IAAI,EAAE,MAAM,EACZ,WAAW,CAAC,EAAE,MAAM,EACpB,YAAY,CAAC,EAAE,CAAC,EAChB,IAAI,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,GACrB,IAAI;IAIP;;;;;;;;;OASG;IACI,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM;IAiBjD;;;;;;;;;;;;;;OAcG;IACI,kBAAkB,CAAC,CAAC,EACzB,IAAI,EAAE,MAAM,EACZ,WAAW,CAAC,EAAE,MAAM,EACpB,YAAY,CAAC,EAAE,CAAC,EAChB,IAAI,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,EACtB,UAAU,UAA6B,GACtC,IAAI;IAyDP;;;;;;;;;OASG;IACI,0BAA0B,CAAC,CAAC,EACjC,IAAI,EAAE,MAAM,EACZ,WAAW,CAAC,EAAE,MAAM,EACpB,YAAY,CAAC,EAAE,CAAC,EAChB,IAAI,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,GACrB,IAAI;IAIP;;;;;;;;;OASG;IACI,0BAA0B,CAAC,CAAC,EACjC,IAAI,EAAE,MAAM,EACZ,WAAW,CAAC,EAAE,MAAM,EACpB,YAAY,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,EACtB,IAAI,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,EACtB,UAAU,UAA6B,GACtC,IAAI;IA6DP;;;;;;;;;;OAUG;IACI,kCAAkC,CAAC,CAAC,EACzC,IAAI,EAAE,MAAM,EACZ,WAAW,CAAC,EAAE,MAAM,EACpB,YAAY,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,EACtB,IAAI,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,GACrB,IAAI;IAUP;;;;OAIG;IACH,OAAO,CAAC,6BAA6B;IAarC;;;;OAIG;IACH,OAAO,CAAC,8BAA8B;IAStC;;;;;;OAMG;IACH,OAAO,CAAC,oBAAoB;IAmB5B;;;OAGG;IACH,OAAO,CAAC,gBAAgB;IAOxB;;;;;;;OAOG;IACH,OAAO,CAAC,0CAA0C;IAelD,OAAO,CAAC,wBAAwB;IAchC,OAAO,CAAC,wCAAwC;IAgBhD,OAAO,CAAC,cAAc;IAItB,OAAO,CAAC,yCAAyC;CAelD;AAED;;;;;;;;GAQG;AACH,qBAAa,wBAAyB,YAAW,cAAc;aAK3C,oBAAoB,EAAE,cAAc;aACpC,SAAS,EAAE,OAAO;IALpC,OAAO,CAAC,YAAY,CAAC,CAAS;IAC9B,OAAO,CAAC,OAAO,CAAC,CAA4B;gBAG1B,oBAAoB,EAAE,cAAc,EACpC,SAAS,GAAE,OAAe;IAM5C;;;OAGG;IACI,cAAc,CAAC,WAAW,EAAE,MAAM;IAKzC;;;OAGG;IACI,SAAS,CAAC,cAAc,SAAS,aAAa,EACnD,MAAM,EAAE,UAAU,CAAC,cAAc,CAAC;IAOpC;;OAEG;IACH,IAAW,KAAK,uBAEf;IAED;;OAEG;IACH,IAAW,IAAI,WAEd;IAED;;;OAGG;IACH,IAAW,WAAW,uBAMrB;IAED;;;OAGG;IACH,IAAW,MAAM,oBAMhB;IAED;;OAEG;IACH,IAAW,gBAAgB,wBAE1B;IAED;;OAEG;IACH,IAAW,0BAA0B,2BAEpC;IAED;;OAEG;IACI,QAAQ,CAAC,CAAC,EACf,IAAI,EAAE,MAAM,EACZ,WAAW,CAAC,EAAE,MAAM,EACpB,YAAY,CAAC,EAAE,CAAC,EAChB,IAAI,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,EACtB,UAAU,CAAC,EAAE,OAAO,GACnB,IAAI;IASP;;OAEG;IACI,gBAAgB,CAAC,CAAC,EACvB,IAAI,EAAE,MAAM,EACZ,WAAW,CAAC,EAAE,MAAM,EACpB,YAAY,CAAC,EAAE,CAAC,EAChB,IAAI,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,GACrB,IAAI;IAUP;;OAEG;IACI,kBAAkB,CAAC,CAAC,EACzB,KAAK,EAAE,MAAM,EACb,YAAY,CAAC,EAAE,MAAM,EACrB,aAAa,CAAC,EAAE,CAAC,EACjB,KAAK,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,EACvB,WAAW,CAAC,EAAE,OAAO,GACpB,IAAI;IAMP;;OAEG;IACI,0BAA0B,CAAC,CAAC,EACjC,KAAK,EAAE,MAAM,EACb,YAAY,CAAC,EAAE,MAAM,EACrB,aAAa,CAAC,EAAE,CAAC,EACjB,KAAK,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,GACtB,IAAI;IAMP;;OAEG;IACI,0BAA0B,CAAC,CAAC,EACjC,KAAK,EAAE,MAAM,EACb,YAAY,CAAC,EAAE,MAAM,EACrB,aAAa,CAAC,EAAE,CAAC,EAAE,EACnB,KAAK,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,EACvB,WAAW,CAAC,EAAE,OAAO,GACpB,IAAI;IAMP;;OAEG;IACI,kCAAkC,CAAC,CAAC,EACzC,KAAK,EAAE,MAAM,EACb,YAAY,CAAC,EAAE,MAAM,EACrB,aAAa,CAAC,EAAE,CAAC,EAAE,EACnB,KAAK,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,GACtB,IAAI;IAMP;;;;OAIG;IACI,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI;IAKxD,OAAO,CAAC,2BAA2B;CAKpC;AAED,KAAK,eAAe,GAAG,CAAC,cAAc,SAAS,aAAa,EAC1D,IAAI,EAAE,MAAM,EACZ,mBAAmB,CAAC,EAAE,MAAM,GAAG,UAAU,CAAC,cAAc,CAAC,EACzD,MAAM,CAAC,EAAE,UAAU,CAAC,cAAc,CAAC,KAChC,cAAc,CAAC;AAEpB,qBAAa,qBAAsB,YAAW,eAAe;aAIzC,IAAI,EAAE,MAAM;IAC5B,OAAO,CAAC,YAAY;IACpB,OAAO,CAAC,QAAQ;IAChB,OAAO,CAAC,WAAW;IANd,KAAK,EAAE,QAAQ,CAAM;gBAGV,IAAI,EAAE,MAAM,EACpB,YAAY,EAAE,MAAM,GAAG,SAAS,EAChC,QAAQ,EAAE,eAAe,EACzB,WAAW,EAAE,eAAe;IAGtC,IAAW,WAAW,uBAErB;IAEM,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI;IAKzC,IAAI,CAAC,cAAc,SAAS,aAAa,EAC9C,IAAI,EAAE,MAAM,EACZ,WAAW,CAAC,EAAE,MAAM,EACpB,MAAM,CAAC,EAAE,UAAU,CAAC,cAAc,CAAC,GAClC,cAAc;IACV,IAAI,CAAC,cAAc,SAAS,aAAa,EAC9C,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,UAAU,CAAC,cAAc,CAAC,GACjC,cAAc;IAaV,OAAO,CAAC,cAAc,SAAS,aAAa,EACjD,IAAI,EAAE,MAAM,EACZ,WAAW,CAAC,EAAE,MAAM,EACpB,MAAM,CAAC,EAAE,UAAU,CAAC,cAAc,CAAC,GAClC,cAAc;IACV,OAAO,CAAC,cAAc,SAAS,aAAa,EACjD,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,UAAU,CAAC,cAAc,CAAC,GACjC,cAAc;CAYlB"}