Class MoveVector<T>

This class is the Aptos Typescript SDK representation of a Move vector<T>, where T represents either a primitive type (bool, u8, u64, ...) or a BCS-serializable struct itself.

It is a BCS-serializable, array-like type that contains an array of values of type T, where T is a class that implements Serializable.

The purpose of this class is to facilitate easy construction of BCS-serializable Move vector<T> types.

Example

// in Move: `vector<u8> [1, 2, 3, 4];`
const vecOfU8s = new MoveVector<U8>([new U8(1), new U8(2), new U8(3), new U8(4)]);
// in Move: `std::bcs::to_bytes(vector<u8> [1, 2, 3, 4]);`
const bcsBytes = vecOfU8s.toUint8Array();

// vector<vector<u8>> [ vector<u8> [1], vector<u8> [1, 2, 3, 4], vector<u8> [5, 6, 7, 8] ];
const vecOfVecs = new MoveVector<MoveVector<U8>>([
  new MoveVector<U8>([new U8(1)]),
  MoveVector.U8([1, 2, 3, 4]),
  MoveVector.U8([5, 6, 7, 8]),
]);

// vector<Option<u8>> [ std::option::some<u8>(1), std::option::some<u8>(2) ];
const vecOfOptionU8s = new MoveVector<MoveOption<U8>>([
   MoveOption.U8(1),
   MoveOption.U8(2),
]);

// vector<MoveString> [ std::string::utf8(b"hello"), std::string::utf8(b"world") ];
const vecOfStrings = new MoveVector([new MoveString("hello"), new MoveString("world")]);
const vecOfStrings2 = MoveVector.MoveString(["hello", "world"]);

Params

values: an Array of values where T is a class that implements Serializable

Returns

a MoveVector<T> with the values values

Index

Constructors

constructor

Properties

values

Methods

bcsToBytes bcsToHex serialize serializeForEntryFunction serializeForScriptFunction Bool MoveString U128 U16 U256 U32 U64 U8 deserialize

Constructors

constructor

new MoveVector<T>(values): MoveVector<T>
Type Parameters
- T extends Serializable & EntryFunctionArgument
Parameters
- values: T[]
Returns MoveVector<T>
Overrides Serializable.constructor
- Defined in src/bcs/serializable/moveStructs.ts:55

Properties

values

values: T[]

Methods

bcsToBytes

bcsToBytes(): Uint8Array
Serializes a Serializable value to its BCS representation. This function is the Typescript SDK equivalent of bcs::to_bytes in Move.

Returns Uint8Array
the BCS representation of the Serializable instance as a byte buffer
Implementation of TransactionArgument.bcsToBytes
Inherited from Serializable.bcsToBytes
- Defined in src/bcs/serializer.ts:27

bcsToHex

bcsToHex(): Hex
Helper function to get a value's BCS-serialized bytes as a Hex instance.

Returns Hex
a Hex instance with the BCS-serialized bytes loaded into its underlying Uint8Array
Implementation of TransactionArgument.bcsToHex
Inherited from Serializable.bcsToHex
- Defined in src/bcs/serializer.ts:37

serialize

serialize(serializer): void
Serialize an argument to BCS-serialized bytes.
Parameters
- serializer: Serializer
Returns void
Implementation of TransactionArgument.serialize
Overrides Serializable.serialize
- Defined in src/bcs/serializable/moveStructs.ts:193

serializeForEntryFunction

serializeForEntryFunction(serializer): void
Serialize an argument as a type-agnostic, fixed byte sequence. The byte sequence contains the number of the following bytes followed by the BCS-serialized bytes for a typed argument.
Parameters
- serializer: Serializer
Returns void
Implementation of TransactionArgument.serializeForEntryFunction
- Defined in src/bcs/serializable/moveStructs.ts:60

serializeForScriptFunction

serializeForScriptFunction(serializer): void
NOTE: This function will only work when the inner values in the MoveVector are U8s.
Parameters
- serializer: Serializer
Returns void
Implementation of TransactionArgument.serializeForScriptFunction
- Defined in src/bcs/serializable/moveStructs.ts:69

`Static` Bool

Bool(values): MoveVector<Bool>
Factory method to generate a MoveVector of Bools from an array of booleans.
Parameters
- values: boolean[]
Returns MoveVector<Bool>
a MoveVector<Bool>
Example
```
const v = MoveVector.Bool([true, false, true, false]);
```
Params
values: an array of bools to convert to Bools
- Defined in src/bcs/serializable/moveStructs.ts:177

`Static` MoveString

MoveString(values): MoveVector<MoveString>
Factory method to generate a MoveVector of MoveStrings from an array of strings.
Parameters
- values: string[]
Returns MoveVector<MoveString>
a MoveVector<MoveString>
Example
```
const v = MoveVector.MoveString(["hello", "world"]);
```
Params
values: an array of strings to convert to MoveStrings
- Defined in src/bcs/serializable/moveStructs.ts:189

`Static` U128

U128(values): MoveVector<U128>
Factory method to generate a MoveVector of U128s from an array of numbers or bigints.
Parameters
- values: AnyNumber[]
Returns MoveVector<U128>
a MoveVector<U128>
Example
```
const v = MoveVector.U128([1, 2, 3, 4]);
```
Params
values: an array of numbers of type number | bigint to convert to U128s
- Defined in src/bcs/serializable/moveStructs.ts:153

`Static` U16

U16(values): MoveVector<U16>
Factory method to generate a MoveVector of U16s from an array of numbers.
Parameters
- values: number[]
Returns MoveVector<U16>
a MoveVector<U16>
Example
```
const v = MoveVector.U16([1, 2, 3, 4]);
```
Params
values: an array of numbers to convert to U16s
- Defined in src/bcs/serializable/moveStructs.ts:117

`Static` U256

U256(values): MoveVector<U256>
Factory method to generate a MoveVector of U256s from an array of numbers or bigints.
Parameters
- values: AnyNumber[]
Returns MoveVector<U256>
a MoveVector<U256>
Example
```
const v = MoveVector.U256([1, 2, 3, 4]);
```
Params
values: an array of numbers of type number | bigint to convert to U256s
- Defined in src/bcs/serializable/moveStructs.ts:165

`Static` U32

U32(values): MoveVector<U32>
Factory method to generate a MoveVector of U32s from an array of numbers.
Parameters
- values: number[]
Returns MoveVector<U32>
a MoveVector<U32>
Example
```
const v = MoveVector.U32([1, 2, 3, 4]);
```
Params
values: an array of numbers to convert to U32s
- Defined in src/bcs/serializable/moveStructs.ts:129

`Static` U64

U64(values): MoveVector<U64>
Factory method to generate a MoveVector of U64s from an array of numbers or bigints.
Parameters
- values: AnyNumber[]
Returns MoveVector<U64>
a MoveVector<U64>
Example
```
const v = MoveVector.U64([1, 2, 3, 4]);
```
Params
values: an array of numbers of type number | bigint to convert to U64s
- Defined in src/bcs/serializable/moveStructs.ts:141

`Static` U8

U8(values): MoveVector<U8>
Factory method to generate a MoveVector of U8s from an array of numbers.
Parameters
- values: number[] | HexInput
Returns MoveVector<U8>
a MoveVector<U8>
Example
```
const v = MoveVector.U8([1, 2, 3, 4]);
```
Params
values: an array of numbers to convert to U8s
- Defined in src/bcs/serializable/moveStructs.ts:89

`Static` deserialize

deserialize<T>(deserializer, cls): MoveVector<T>
Deserialize a MoveVector of type T, specifically where T is a Serializable and Deserializable type.

NOTE: This only works with a depth of one. Generics will not work.

NOTE: This will not work with types that aren't of the Serializable class.

If you're looking for a more flexible deserialization function, you can use the deserializeVector function in the Deserializer class.
Type Parameters
- T extends Serializable & EntryFunctionArgument
Parameters
- deserializer: Deserializer
- cls: Deserializable<T>
Returns MoveVector<T>
a MoveVector of the corresponding class T *
Example
```
const vec = MoveVector.deserialize(deserializer, U64);
```
Params
deserializer: the Deserializer instance to use, with bytes loaded into it already. cls: the class to typecast the input values to, must be a Serializable and Deserializable type.
- Defined in src/bcs/serializable/moveStructs.ts:214

Class MoveVector<T>

Example

Params

Returns

Type Parameters

Hierarchy (view full)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns MoveVector<T>

Properties

values

Methods

bcsToBytes

Returns Uint8Array

bcsToHex

Returns Hex

serialize

Parameters

Returns void

serializeForEntryFunction

Parameters

Returns void

serializeForScriptFunction

Parameters

Returns void

Static Bool

Parameters

Returns MoveVector<Bool>

Example

Params

Static MoveString

Parameters

Returns MoveVector<MoveString>

Example

Params

Static U128

Parameters

Returns MoveVector<U128>

Example

Params

Static U16

Parameters

Returns MoveVector<U16>

Example

Params

Static U256

Parameters

Returns MoveVector<U256>

Example

Params

Static U32

Parameters

Returns MoveVector<U32>

Example

Params

Static U64

Parameters

Returns MoveVector<U64>

Example

Params

Static U8

Parameters

Returns MoveVector<U8>

Example

Params

Static deserialize

Type Parameters

Parameters

Returns MoveVector<T>

Example

Params

Settings

Member Visibility

`Static` Bool

`Static` MoveString

`Static` U128

`Static` U16

`Static` U256

`Static` U32

`Static` U64

`Static` U8

`Static` deserialize