MoveCoder

Class in @typemove/aptos

Defined in @typemove/aptos

Extends

Constructors

Constructor

new MoveCoder(client: Aptos, ignoreObjectInnerField?: boolean): MoveCoder;

Parameters

ParameterTypeDefault value
clientAptosundefined
ignoreObjectInnerFieldbooleanfalse

Returns

MoveCoder

Overrides

AbstractMoveCoder<MoveModuleBytecode, Event | MoveResource>.constructor

Properties

PropertyModifierTypeDefault valueInherited from
adapterpublicChainAdapter<MoveModuleBytecode, Event | MoveResource>undefinedAbstractMoveCoder.adapter
ignoreObjectInnerFieldreadonlybooleanfalse-

Methods

contains()

contains(account: string, name: string): boolean;

Parameters

ParameterType
accountstring
namestring

Returns

boolean

Inherited from

AbstractMoveCoder.contains


decodeArray()

decodeArray(
   entries: any[], 
   types: TypeDescriptor<any>[], 
   strict?: boolean
): Promise<any[]>;

Parameters

ParameterTypeDefault value
entriesany[]undefined
typesTypeDescriptor<any>[]undefined
strictbooleantrue

Returns

Promise<any[]>

Inherited from

AbstractMoveCoder.decodeArray


decodeCallResult()

decodeCallResult(res: any[], func: string): Promise<any[]>;

Parameters

ParameterType
resany[]
funcstring

Returns

Promise<any[]>

Inherited from

AbstractMoveCoder.decodeCallResult


decodeEvent()

decodeEvent<T>(event: Event): Promise<
  | TypedEventInstance<T>
| undefined>;

Type Parameters

Type Parameter
T

Parameters

ParameterType
eventEvent

Returns

Promise< | TypedEventInstance<T> | undefined>


decodeFunctionPayload()

decodeFunctionPayload<T extends any[]>(payload: EntryFunctionPayloadResponse): Promise<TypedFunctionPayload<T>>;

Type Parameters

Type Parameter
T extends any[]

Parameters

ParameterType
payloadEntryFunctionPayloadResponse

Returns

Promise<TypedFunctionPayload<T>>


decodeResource()

decodeResource<T>(res: MoveResource): Promise<
  | TypedMoveResource<T>
| undefined>;

Type Parameters

Type Parameter
T

Parameters

ParameterType
resMoveResource

Returns

Promise< | TypedMoveResource<T> | undefined>


decodeType()

decodeType<T, ST>(typeStruct: ST, type: TypeDescriptor<T>): Promise<T | undefined>;

Type Parameters

Type Parameter
T
ST

Parameters

ParameterType
typeStructST
typeTypeDescriptor<T>

Returns

Promise<T | undefined>

Inherited from

AbstractMoveCoder.decodeType


encode()

encode(data: any): any;

Parameters

ParameterType
dataany

Returns

any

Inherited from

AbstractMoveCoder.encode


encodeArray()

encodeArray(entriesDecoded: any[]): any[];

Parameters

ParameterType
entriesDecodedany[]

Returns

any[]

Inherited from

AbstractMoveCoder.encodeArray


filterAndDecodeEvents()

filterAndDecodeEvents<T>(type: 
  | string
| TypeDescriptor<T>, resources: Event[]): Promise<TypedEventInstance<T>[]>;

Type Parameters

Type Parameter
T

Parameters

ParameterType
type| string | TypeDescriptor<T>
resourcesEvent[]

Returns

Promise<TypedEventInstance<T>[]>


filterAndDecodeResources()

filterAndDecodeResources<T>(type: 
  | string
| TypeDescriptor<T>, resources: MoveResource[]): Promise<TypedMoveResource<T>[]>;

Type Parameters

Type Parameter
T

Parameters

ParameterType
type| string | TypeDescriptor<T>
resourcesMoveResource[]

Returns

Promise<TypedMoveResource<T>[]>


filterAndDecodeStruct()

filterAndDecodeStruct<T, ST extends Event | MoveResource>(typeMatcher: TypeDescriptor<T>, structsWithTags: ST[]): Promise<DecodedStruct<ST, T>[]>;

Type Parameters

Type Parameter
T
ST extends Event | MoveResource

Parameters

ParameterType
typeMatcherTypeDescriptor<T>
structsWithTagsST[]

Returns

Promise<DecodedStruct<ST, T>[]>

Inherited from

AbstractMoveCoder.filterAndDecodeStruct


getMoveFunction()

getMoveFunction(type: string): Promise<InternalMoveFunction>;

Parameters

ParameterType
typestring

Returns

Promise<InternalMoveFunction>

Inherited from

AbstractMoveCoder.getMoveFunction


getMoveStruct()

getMoveStruct(type: string): Promise<InternalMoveStruct>;

Parameters

ParameterType
typestring

Returns

Promise<InternalMoveStruct>

Inherited from

AbstractMoveCoder.getMoveStruct


load()

load(module: MoveModuleBytecode, address: string): InternalMoveModule;

Parameters

ParameterType
moduleMoveModuleBytecode
addressstring

Returns

InternalMoveModule

Overrides

AbstractMoveCoder.load


maybeGetMoveEnum()

maybeGetMoveEnum(type: string): Promise<InternalMoveEnum | undefined>;

Parameters

ParameterType
typestring

Returns

Promise<InternalMoveEnum | undefined>

Inherited from

AbstractMoveCoder.maybeGetMoveEnum


toMoveValue()

toMoveValue(value: any): MoveValue;

Parameters

ParameterType
valueany

Returns

MoveValue

On this page