Class MoveOption<T>

Represents an argument for entry functions, providing methods to serialize the argument to BCS-serialized bytes and convert it to different formats.

Type Parameters

Hierarchy (View Summary, Expand)

Implements

Implementation - BCS

bcsToBytes bcsToHex isSome unwrap Bool MoveString U128 U16 U256 U32 U64 U8

Implementation - Transactions

serialize serializeForEntryFunction

Constructors

constructor

Methods

toString toStringWithoutPrefix deserialize

Properties

value?

Implementation - BCS

bcsToBytes

bcsToHex

  • bcsToHex(): Hex

    Converts the BCS-serialized bytes of a value into a Hex instance. This function provides a Hex representation of the BCS-serialized data for easier handling and manipulation.

    Returns Hex

    A Hex instance with the BCS-serialized bytes loaded into its underlying Uint8Array.

isSome

unwrap

  • unwrap(): T

    Retrieves the inner value of the MoveOption.

    This method is inspired by Rust's Option<T>.unwrap(), where attempting to unwrap a None value results in a panic. This method will throw an error if the value is not present.

    Returns T

    The contained value if present.

    Example

    const option = new MoveOption<Bool>(new Bool(true));
    const value = option.unwrap();  // Returns the Bool instance

    Throws

    Throws an error if the MoveOption does not contain a value.

StaticBool

  • Bool(value?: null | boolean): MoveOption<Bool>

    Factory method to generate a MoveOption from a boolean or undefined.

    Parameters

    • Optionalvalue: null | boolean

      the value used to fill the MoveOption. If value is undefined the resulting MoveOption's .isSome() method will return false.

    Returns MoveOption<Bool>

    a MoveOption with an inner value value

    Example

    MoveOption.Bool(true).isSome() === true;
    MoveOption.Bool().isSome() === false;
    MoveOption.Bool(undefined).isSome() === false;

StaticMoveString

  • MoveString(value?: null | string): MoveOption<MoveString>

    Factory method to generate a MoveOption from a string or undefined.

    Parameters

    • Optionalvalue: null | string

      the value used to fill the MoveOption. If value is undefined the resulting MoveOption's .isSome() method will return false.

    Returns MoveOption<MoveString>

    a MoveOption with an inner value value

    Example

    MoveOption.MoveString("hello").isSome() === true;
    MoveOption.MoveString("").isSome() === true;
    MoveOption.MoveString().isSome() === false;
    MoveOption.MoveString(undefined).isSome() === false;

StaticU128

  • U128(value?: null | AnyNumber): MoveOption<U128>

    Factory method to generate a MoveOption from a number or a bigint or undefined.

    Parameters

    • Optionalvalue: null | AnyNumber

      the value used to fill the MoveOption. If value is undefined the resulting MoveOption's .isSome() method will return false.

    Returns MoveOption<U128>

    a MoveOption with an inner value value

    Example

    MoveOption.U128(1).isSome() === true;
    MoveOption.U128().isSome() === false;
    MoveOption.U128(undefined).isSome() === false;

StaticU16

  • U16(value?: null | number): MoveOption<U16>

    Factory method to generate a MoveOption from a number or undefined.

    Parameters

    • Optionalvalue: null | number

      the value used to fill the MoveOption. If value is undefined the resulting MoveOption's .isSome() method will return false.

    Returns MoveOption<U16>

    a MoveOption with an inner value value

    Example

    MoveOption.U16(1).isSome() === true;
    MoveOption.U16().isSome() === false;
    MoveOption.U16(undefined).isSome() === false;

StaticU256

  • U256(value?: null | AnyNumber): MoveOption<U256>

    Factory method to generate a MoveOption from a number or a bigint or undefined.

    Parameters

    • Optionalvalue: null | AnyNumber

      the value used to fill the MoveOption. If value is undefined the resulting MoveOption's .isSome() method will return false.

    Returns MoveOption<U256>

    a MoveOption with an inner value value

    Example

    MoveOption.U256(1).isSome() === true;
    MoveOption.U256().isSome() === false;
    MoveOption.U256(undefined).isSome() === false;

StaticU32

  • U32(value?: null | number): MoveOption<U32>

    Factory method to generate a MoveOption from a number or undefined.

    Parameters

    • Optionalvalue: null | number

      the value used to fill the MoveOption. If value is undefined the resulting MoveOption's .isSome() method will return false.

    Returns MoveOption<U32>

    a MoveOption with an inner value value

    Example

    MoveOption.U32(1).isSome() === true;
    MoveOption.U32().isSome() === false;
    MoveOption.U32(undefined).isSome() === false;

StaticU64

  • U64(value?: null | AnyNumber): MoveOption<U64>

    Factory method to generate a MoveOption from a number or a bigint or undefined.

    Parameters

    • Optionalvalue: null | AnyNumber

      the value used to fill the MoveOption. If value is undefined the resulting MoveOption's .isSome() method will return false.

    Returns MoveOption<U64>

    a MoveOption with an inner value value

    Example

    MoveOption.U64(1).isSome() === true;
    MoveOption.U64().isSome() === false;
    MoveOption.U64(undefined).isSome() === false;

StaticU8

  • U8(value?: null | number): MoveOption<U8>

    Factory method to generate a MoveOption from a number or undefined.

    Parameters

    • Optionalvalue: null | number

      the value used to fill the MoveOption. If value is undefined the resulting MoveOption's .isSome() method will return false.

    Returns MoveOption<U8>

    a MoveOption with an inner value value

    Example

    MoveOption.U8(1).isSome() === true;
    MoveOption.U8().isSome() === false;
    MoveOption.U8(undefined).isSome() === false;

Implementation - Transactions

serialize

serializeForEntryFunction

Constructors

constructor

Methods

toString

  • toString(): string

    Returns the hex string representation of the Serializable value with the 0x prefix.

    Returns string

    the hex formatas a string prefixed by 0x.

toStringWithoutPrefix

Staticdeserialize

Properties

Optional Readonlyvalue

value?: T

Settings

Member Visibility

On This Page

Implementation - BCS
Implementation - Transactions
Constructors
Methods
Properties
MMNEPVFCICPMFPCPTTAAATR