Class ValueTask

Returns a specified value.

Input: None

Returns: A numerical result.

Example: Returns the value 10

{"valueTask": {"value": 10} }

Example: Returns the currentRound result of an aggregator

{"valueTask": {"aggregatorPubkey": "GvDMxPzN1sCj7L26YDK2HnMRXEQmQ2aemov8YBtPS7vR"} }

Example: Returns the value stored in a CacheTask variable

{"valueTask": {"big": "${ONE}"} }

Implements

Constructors

constructor

Properties

aggregatorPubkey? big? hex? utf8? value? Value?

Methods

toJSON create decode decodeDelimited encode encodeDelimited fromObject getTypeUrl toObject verify

Constructors

constructor

  • new ValueTask(properties?: IValueTask): ValueTask

    Constructs a new ValueTask.

    Parameters

    Returns ValueTask

Properties

OptionalaggregatorPubkey

aggregatorPubkey?: string

Specifies an aggregatorr to pull the value of.

Optionalbig

big?: string

A stringified big.js. Accepts variable expansion syntax.

Optionalhex

hex?: string

A stringified hex number (0x prefix is optional).

Optionalutf8

utf8?: string

A utf8 string.

Optionalvalue

value?: number

The value that will be returned from this task.

OptionalValue

Value?: "utf8" | "hex" | "value" | "aggregatorPubkey" | "big"

ValueTask Value.

Methods

toJSON

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

    Converts this ValueTask to JSON.

    Returns { [k: string]: any }

    JSON object

Staticcreate

  • create(properties?: IValueTask): ValueTask

    Creates a new ValueTask instance using the specified properties.

    Parameters

    Returns ValueTask

    ValueTask instance

Staticdecode

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

    Decodes a ValueTask 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 ValueTask

    ValueTask

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

StaticdecodeDelimited

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

    Decodes a ValueTask message from the specified reader or buffer, length delimited.

    Parameters

    • reader: Uint8Array<ArrayBufferLike> | Reader

      Reader or buffer to decode from

    Returns ValueTask

    ValueTask

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

Staticencode

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

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

    Parameters

    • message: IValueTask

      ValueTask message or plain object to encode

    • Optionalwriter: Writer

      Writer to encode to

    Returns Writer

    Writer

StaticencodeDelimited

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

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

    Parameters

    • message: IValueTask

      ValueTask message or plain object to encode

    • Optionalwriter: Writer

      Writer to encode to

    Returns Writer

    Writer

StaticfromObject

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

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

    Parameters

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

      Plain object

    Returns ValueTask

    ValueTask

StaticgetTypeUrl

  • getTypeUrl(typeUrlPrefix?: string): string

    Gets the default type url for ValueTask

    Parameters

    Returns string

    The default type url

StatictoObject

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

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

    Parameters

    • message: ValueTask

      ValueTask

    • Optionaloptions: IConversionOptions

      Conversion options

    Returns { [k: string]: any }

    Plain object

Staticverify

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

    Verifies a ValueTask 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