Class AddTask

This task will add a numerical input by a scalar value from a job of subtasks, an aggregator, or a big.

Input: The current running numerical result output from a scalar value, an aggregator, a job of subtasks or a big.

Returns: A numerical result.

Example: Returns the numerical result by adding by a job of subtasks.

{"tasks":[{"valueTask":{"value":100}},{"addTask":{"job":{"tasks":[{"valueTask":{"value":10}}]}}}]}

Example: Returns the numerical result by multiplying by an aggregator.

{"tasks":[{"valueTask":{"value":100}},{"addTask":{"aggregatorPubkey":"GvDMxPzN1sCj7L26YDK2HnMRXEQmQ2aemov8YBtPS7vR"}}]}

Example: Returns the numerical result by multiplying by a big.

{"tasks":[{"cacheTask":{"cacheItems":[{"variableName":"TEN","job":{"tasks":[{"valueTask":{"value":10}}]}}]}},{"valueTask":{"value":100}},{"addTask":{"big":"${TEN}"}}]}

Implements

Constructors

constructor

Properties

Addition? aggregatorPubkey? big? job? scalar?

Methods

toJSON create decode decodeDelimited encode encodeDelimited fromObject getTypeUrl toObject verify

Constructors

constructor

  • new AddTask(properties?: IAddTask): AddTask

    Constructs a new AddTask.

    Parameters

    • Optionalproperties: IAddTask

      Properties to set

    Returns AddTask

Properties

OptionalAddition

Addition?: "aggregatorPubkey" | "big" | "scalar" | "job"

AddTask Addition.

OptionalaggregatorPubkey

aggregatorPubkey?: string

Specifies an aggregator to add by.

Optionalbig

big?: string

A stringified big.js. Accepts variable expansion syntax.

Optionaljob

job?: IOracleJob

A job whose result is computed before adding our numerical input by that result.

Optionalscalar

scalar?: number

Specifies a scalar to add by.

Methods

toJSON

  • toJSON(): { [k: string]: any }

    Converts this AddTask to JSON.

    Returns { [k: string]: any }

    JSON object

Staticcreate

  • create(properties?: IAddTask): AddTask

    Creates a new AddTask instance using the specified properties.

    Parameters

    • Optionalproperties: IAddTask

      Properties to set

    Returns AddTask

    AddTask instance

Staticdecode

  • decode(reader: Uint8Array<ArrayBufferLike> | Reader, length?: number): AddTask

    Decodes an AddTask message from the specified reader or buffer.

    Parameters

    • reader: Uint8Array<ArrayBufferLike> | Reader

      Reader or buffer to decode from

    • Optionallength: number

      Message length if known beforehand

    Returns AddTask

    AddTask

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

StaticdecodeDelimited

  • decodeDelimited(reader: Uint8Array<ArrayBufferLike> | Reader): AddTask

    Decodes an AddTask message from the specified reader or buffer, length delimited.

    Parameters

    • reader: Uint8Array<ArrayBufferLike> | Reader

      Reader or buffer to decode from

    Returns AddTask

    AddTask

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

Staticencode

  • encode(message: IAddTask, writer?: Writer): Writer

    Encodes the specified AddTask message. Does not implicitly verify messages.

    Parameters

    • message: IAddTask

      AddTask message or plain object to encode

    • Optionalwriter: Writer

      Writer to encode to

    Returns Writer

    Writer

StaticencodeDelimited

  • encodeDelimited(message: IAddTask, writer?: Writer): Writer

    Encodes the specified AddTask message, length delimited. Does not implicitly verify messages.

    Parameters

    • message: IAddTask

      AddTask message or plain object to encode

    • Optionalwriter: Writer

      Writer to encode to

    Returns Writer

    Writer

StaticfromObject

  • fromObject(object: { [k: string]: any }): AddTask

    Creates an AddTask message from a plain object. Also converts values to their respective internal types.

    Parameters

    • object: { [k: string]: any }

      Plain object

    Returns AddTask

    AddTask

StaticgetTypeUrl

  • getTypeUrl(typeUrlPrefix?: string): string

    Gets the default type url for AddTask

    Parameters

    Returns string

    The default type url

StatictoObject

  • toObject(message: AddTask, options?: IConversionOptions): { [k: string]: any }

    Creates a plain object from an AddTask message. Also converts values to other types if specified.

    Parameters

    • message: AddTask

      AddTask

    • Optionaloptions: IConversionOptions

      Conversion options

    Returns { [k: string]: any }

    Plain object

Staticverify

  • verify(message: { [k: string]: any }): string

    Verifies an AddTask message.

    Parameters

    • message: { [k: string]: any }

      Plain object to verify

    Returns string

    null if valid, otherwise the reason why it is not

Settings

Member Visibility

On This Page

Constructors
Properties
Methods