Function formatProtocolCancellation

  • formatProtocolCancellation(cancellation, UntilBlock?): TransmissionCancellation

  • Parameters

    • cancellation: "untilBlock" | "anytime" | "none"

      The cancellation kind (string) : "anytime", "none" or "untilBlock".

    • Optional UntilBlock: number

      The block number before which user cancellation is available. Can only be set for "untilBlock" cancellation.

    Returns TransmissionCancellation

    An object representing the cancellation of the transmission protocol.

    Name

    formatProtocolCancellation

    Summary

    Returns an object according to the cancellation kind required.

Settings

Member Visibility

Theme

Generated using TypeDoc