Class Args

Storage and serialization class for remote function call arguments.

Remarks

This class can serialize typescript native types into bytes, in order to make smart-contract function call easier. It also can deserialize bytes.

Constructors

constructor

Properties

argsList getNextData offset serialized

Methods

addArray addBool addF32 addF64 addI128 addI32 addI64 addSerializable addSerializableObjectArray addString addU128 addU256 addU32 addU64 addU8 addUint8Array getArgsList getOffset nextArray nextBool nextF32 nextF64 nextI128 nextI32 nextI64 nextSerializable nextSerializableObjectArray nextString nextU128 nextU256 nextU32 nextU64 nextU8 nextUint8Array serialize concatArrays

Constructors

constructor

  • new Args(serialized?, offset?): Args

  • Constructor to either serialize or deserialize data passed from/to DApps and remote Smart contracts.

    Parameters

    • Optional serialized: number[] | Uint8Array

      The optional serialized arguments to deserialize.

    • Optional offset: number

      The optional offset to start deserializing from.

    Returns Args

Properties

Private argsList

argsList: any

Private getNextData

getNextData: any

Returns the data of requested size for current offset

Param: size

The data size

Returns

the slice of the serialized internal buffer

Private offset

offset: any

Private serialized

serialized: any

Methods

addArray

  • addArray(arg, type): this

  • Adds an array of objects to the serialized arguments.

    Parameters

    Returns this

    the serialized arguments to be able to chain add method calls.

    Remarks

    If the type of the values of the array is not native type, this will serialize the pointers, which is certainly not what you want! You can only serialize properly array of native types or array of Serializable object.

    See

    addSerializableObjectArray

addBool

  • addBool(value): this

  • Adds a boolean to the serialized arguments.

    Parameters

    • value: boolean

      the boolean to add.

    Returns this

    the serialized arguments to be able to chain add method calls.

addF32

  • addF32(value): this

  • Adds a floating number to the serialized arguments.

    Parameters

    • value: number

      the number to add.

    Returns this

    the serialized arguments to be able to chain add method calls.

addF64

  • addF64(value): this

  • Adds a long floating number to the serialized arguments.

    Parameters

    • value: number

      the number to add.

    Returns this

    the serialized arguments to be able to chain add method calls.

addI128

  • addI128(bigInt): this

  • Adds a signed long integer to the serialized arguments.

    Parameters

    • bigInt: bigint

    Returns this

    the serialized arguments to be able to chain add method calls.

addI32

  • addI32(value): this

  • Adds a signed integer to the serialized arguments.

    Parameters

    • value: number

      the number to add.

    Returns this

    the serialized arguments to be able to chain add method calls.

addI64

  • addI64(bigInt): this

  • Adds a signed long integer to the serialized arguments.

    Parameters

    • bigInt: bigint

    Returns this

    the serialized arguments to be able to chain add method calls.

addSerializable

  • addSerializable<T>(value): this

  • Adds a serializable object to the serialized arguments.

    Type Parameters

    • T

    Parameters

    Returns this

    the serialized arguments to be able to chain add method calls.

    Remarks

    The object must implement the ISerializable interface

    See

    ISerializable

addSerializableObjectArray

  • addSerializableObjectArray<T>(arg): this

  • Adds an array of serializable objects to the serialized arguments.

    Type Parameters

    Parameters

    • arg: T[]

      the argument to add

    Returns this

    the serialized arguments to be able to chain add method calls.

    Remarks

    Each object must implement the ISerializable interface. This will perform a deep copy of your objects thanks to the ISerializable.serialize method you define in your class.

    See

    ISerializable

addString

  • addString(value): this

  • Adds a string to the serialized arguments.

    Parameters

    • value: string

      the number to add.

    Returns this

    the serialized arguments to be able to chain add method calls.

    Remarks

    Works only if the argument is an instance of a handled type (String of 4294967295 characters maximum)

addU128

  • addU128(bigInt): this

  • Adds an unsigned long integer to the serialized arguments.

    Parameters

    • bigInt: bigint

    Returns this

    the serialized arguments to be able to chain add method calls.

addU256

  • addU256(bigInt): this

  • Adds an unsigned long integer to the serialized arguments.

    Parameters

    • bigInt: bigint

    Returns this

    the serialized arguments to be able to chain add method calls.

addU32

  • addU32(value): this

  • Adds an unsigned integer to the serialized arguments.

    Parameters

    • value: number

      the number to add.

    Returns this

    the serialized arguments to be able to chain add method calls.

addU64

  • addU64(bigInt): this

  • Adds an unsigned long integer to the serialized arguments.

    Parameters

    • bigInt: bigint

    Returns this

    the serialized arguments to be able to chain add method calls.

addU8

  • addU8(value): this

  • Adds a unsigned byte to the serialized arguments.

    Parameters

    • value: number

      the number to add.

    Returns this

    the serialized arguments to be able to chain add method calls.

addUint8Array

  • addUint8Array(array): this

  • Adds a byte array integer to the serialized arguments.

    Parameters

    • array: Uint8Array

      the array to add.

    Returns this

    the serialized arguments to be able to chain add method calls.

getArgsList

  • getArgsList(): IParam[]

  • Returns IParam[]

getOffset

  • getOffset(): number

  • Returns the current deserialization offset of the serialized byte array.

    Returns number

    the current offset

nextArray

  • nextArray<T>(type): T[]

  • Returns the next array of ArgTypes objects in the serialized byte array

    Type Parameters

    • T

    Parameters

    • type: ArrayTypes

      the type of the elements in the array.

    Returns T[]

    the next array of object that are native type

    Remarks

    Increments to offset to point the data after the one that as been deserialized in the byte array.

nextBool

  • nextBool(): boolean

  • Returns the next boolean in the serialized byte array.

    Returns boolean

    the deserialized boolean.

    Remarks

    Increments to offset to point the data after the one that as been deserialized in the byte array.

nextF32

  • nextF32(): number

  • Returns the next floating number in the serialized byte array.

    Returns number

    the deserialized number.

    Remarks

    Increments to offset to point the data after the one that as been deserialized in the byte array.

nextF64

  • nextF64(): number

  • Returns the next long floating number in the serialized byte array.

    Returns number

    the deserialized number.

    Remarks

    Increments to offset to point the data after the one that as been deserialized in the byte array.

nextI128

  • nextI128(): bigint

  • Returns the next int128 in the serialized byte array.

    Returns bigint

    the deserialized number.

    Remarks

    Increments to offset to point the data after the one that as been deserialized in the byte array.

nextI32

  • nextI32(): number

  • Returns the next signed integer in the serialized byte array.

    Returns number

    the deserialized number.

    Remarks

    Increments to offset to point the data after the one that as been deserialized in the byte array.

nextI64

  • nextI64(): bigint

  • Returns the next signed long integer in the serialized byte array.

    Returns bigint

    the deserialized number.

    Remarks

    Increments to offset to point the data after the one that as been deserialized in the byte array.

nextSerializable

  • nextSerializable<T>(ctor): T

  • Returns the next ISerializable object in the serialized byte array

    Type Parameters

    Parameters

    • ctor: (new () => T)

      the class constructor prototype T.prototype

        • new (): T

        • Returns T

    Returns T

    the deserialized object T

    Remarks

    Increments to offset to point the data after the one that as been deserialized in the byte array.

nextSerializableObjectArray

  • nextSerializableObjectArray<T>(ctor): T[]

  • Returns the next array of ISerializable objects in the serialized byte array

    Type Parameters

    Parameters

    • ctor: (new () => T)

      the class constructor prototype T.prototype

        • new (): T

        • Returns T

    Returns T[]

    the deserialized array of object that implement ISerializable

    Remarks

    Increments to offset to point the data after the one that as been deserialized in the byte array.

nextString

  • nextString(): string

  • Returns the next string in the serialized byte array.

    Returns string

    the deserialized string

    Remarks

    Increments to offset to point the data after the one that as been deserialized in the byte array.

nextU128

  • nextU128(): bigint

  • Returns the next uint128 in the serialized byte array.

    Returns bigint

    the deserialized number.

    Remarks

    Increments to offset to point the data after the one that as been deserialized in the byte array.

nextU256

  • nextU256(): bigint

  • Returns the next uint256 in the serialized byte array.

    Returns bigint

    the deserialized number.

    Remarks

    Increments to offset to point the data after the one that as been deserialized in the byte array.

nextU32

  • nextU32(): number

  • Returns the next unsigned integer in the serialized byte array.

    Returns number

    the deserialized number

    Remarks

    Increments to offset to point the data after the one that as been deserialized in the byte array.

nextU64

  • nextU64(): bigint

  • Returns the next long integer in the serialized byte array.

    Returns bigint

    the deserialized number.

    Remarks

    Increments to offset to point the data after the one that as been deserialized in the byte array.

nextU8

  • nextU8(): bigint

  • Returns the next unsigned byte in the serialized byte array.

    Returns bigint

    the deserialized number.

    Remarks

    Increments to offset to point the data after the one that as been deserialized in the byte array.

nextUint8Array

  • nextUint8Array(): Uint8Array

  • Returns the next sub byte array in the serialized byte array.

    Returns Uint8Array

    the deserialized byte array.

    Remarks

    Increments to offset to point the data after the one that as been deserialized in the byte array.

serialize

  • serialize(): number[]

  • Returns the serialized byte array.

    Returns number[]

    A byte array.

Static concatArrays

  • concatArrays(a, b): Uint8Array

  • Internal function to concat to Uint8Array.

    Parameters

    • a: Uint8Array

      first array to concat

    • b: Uint8Array

      second array to concat

    Returns Uint8Array

    the concatenated array

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc