Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TwapTask

Represents a TwapTask.

Hierarchy

  • TwapTask

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • Constructs a new TwapTask.

    Parameters

    Returns TwapTask

Properties

aggregatorPubkey

aggregatorPubkey: string

TwapTask aggregatorPubkey.

endingUnixTimestamp

endingUnixTimestamp: number

TwapTask endingUnixTimestamp.

minSamples

minSamples: number

TwapTask minSamples.

period

period: number

TwapTask period.

weightByPropagationTime

weightByPropagationTime: boolean

TwapTask weightByPropagationTime.

Methods

toJSON

  • toJSON(): {}

  • Converts this TwapTask to JSON.

    Returns {}

    JSON object

    • [k: string]: any

Static create

  • Creates a new TwapTask instance using the specified properties.

    Parameters

    Returns TwapTask

    TwapTask instance

Static decode

  • decode(reader: Uint8Array | Reader, length?: number): TwapTask

  • Decodes a TwapTask message from the specified reader or buffer.

    throws

    {Error} If the payload is not a reader or valid buffer

    throws

    {$protobuf.util.ProtocolError} If required fields are missing

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    • Optional length: number

    Returns TwapTask

    TwapTask

Static decodeDelimited

  • decodeDelimited(reader: Uint8Array | Reader): TwapTask

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

    throws

    {Error} If the payload is not a reader or valid buffer

    throws

    {$protobuf.util.ProtocolError} If required fields are missing

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    Returns TwapTask

    TwapTask

Static encode

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

  • Encodes the specified TwapTask message. Does not implicitly verify messages.

    Parameters

    • message: ITwapTask

      TwapTask message or plain object to encode

    • Optional writer: Writer

    Returns Writer

    Writer

Static encodeDelimited

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

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

    Parameters

    • message: ITwapTask

      TwapTask message or plain object to encode

    • Optional writer: Writer

    Returns Writer

    Writer

Static fromObject

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

    Parameters

    • object: {}

      Plain object

      • [k: string]: any

    Returns TwapTask

    TwapTask

Static toObject

  • toObject(message: TwapTask, options?: IConversionOptions): {}

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

    Parameters

    • message: TwapTask

      TwapTask

    • Optional options: IConversionOptions

    Returns {}

    Plain object

    • [k: string]: any

Static verify

  • verify(message: {}): string

  • Verifies a TwapTask message.

    Parameters

    • message: {}

      Plain object to verify

      • [k: string]: any

    Returns string

    null if valid, otherwise the reason why it is not

Generated using TypeDoc