Class MoveCoder

Hierarchy (View Summary)

AbstractMoveCoder<SuiMoveNormalizedModule, SuiEvent | SuiMoveObject>
- MoveCoder

Constructors

constructor

new MoveCoder(client: SuiClient): MoveCoder
Parameters
- client: SuiClient
Returns MoveCoder
Overrides AbstractMoveCoder.constructor
- Defined in node_modules/.pnpm/@typemove+sui@1.8.2_typescript@5.5.2/node_modules/@typemove/sui/dist/esm/move-coder.d.ts:8

Properties

adapter

adapter: ChainAdapter<
    SuiMoveNormalizedModule,
    | SuiEvent
    | {
        dataType: "moveObject";
        fields: MoveStruct;
        hasPublicTransfer: boolean;
        type: string;
    },
>

`Protected`moduleMapping

moduleMapping: Map<string, InternalMoveModule>

Methods

contains

contains(account: string, name: string): boolean
Parameters
- account: string
- name: string
Returns boolean
Inherited from AbstractMoveCoder.contains
- Defined in node_modules/.pnpm/@typemove+move@1.8.2/node_modules/@typemove/move/dist/esm/abstract-move-coder.d.ts:10

`Protected`decode

decode(data: any, type: TypeDescriptor<any>): Promise<any>
Parameters
- data: any
- type: TypeDescriptor<any>
Returns Promise<any>
Overrides AbstractMoveCoder.decode
- Defined in node_modules/.pnpm/@typemove+sui@1.8.2_typescript@5.5.2/node_modules/@typemove/sui/dist/esm/move-coder.d.ts:10

decodeArray

decodeArray(
    entries: any[],
    types: TypeDescriptor<any>[],
    strict?: boolean,
): Promise<any[]>
Parameters
- entries: any[]
- types: TypeDescriptor<any>[]
- Optionalstrict: boolean
Returns Promise<any[]>
Inherited from AbstractMoveCoder.decodeArray
- Defined in node_modules/.pnpm/@typemove+move@1.8.2/node_modules/@typemove/move/dist/esm/abstract-move-coder.d.ts:19

decodeBCS

decodeBCS(
    type: TypeDescriptor<any>,
    data: string | Uint8Array,
    encoding?: Encoding,
): Promise<any>
Parameters
- type: TypeDescriptor<any>
- data: string | Uint8Array
- Optionalencoding: Encoding
Returns Promise<any>
- Defined in node_modules/.pnpm/@typemove+sui@1.8.2_typescript@5.5.2/node_modules/@typemove/sui/dist/esm/move-coder.d.ts:21

`Protected`decodeBigInt

decodeBigInt(data: any): bigint
Parameters
- data: any
Returns bigint
Inherited from AbstractMoveCoder.decodeBigInt
- Defined in node_modules/.pnpm/@typemove+move@1.8.2/node_modules/@typemove/move/dist/esm/abstract-move-coder.d.ts:14

decodeCallResult

decodeCallResult(res: any[], func: string): Promise<any[]>
Parameters
- res: any[]
- func: string
Returns Promise<any[]>
Inherited from AbstractMoveCoder.decodeCallResult
- Defined in node_modules/.pnpm/@typemove+move@1.8.2/node_modules/@typemove/move/dist/esm/abstract-move-coder.d.ts:22

decodeDevInspectResult

decodeDevInspectResult<T extends any[]>(
inspectRes: DevInspectResults,
): Promise<TypedDevInspectResults<T>>
Type Parameters
- T extends any[]
Parameters
- inspectRes: DevInspectResults
Returns Promise<TypedDevInspectResults<T>>
- Defined in node_modules/.pnpm/@typemove+sui@1.8.2_typescript@5.5.2/node_modules/@typemove/sui/dist/esm/move-coder.d.ts:22

`Protected`decodedStruct

decodedStruct<
    T,
    ST extends

            | SuiEvent
            | {
                dataType: "moveObject";
                fields: MoveStruct;
                hasPublicTransfer: boolean;
                type: string;
            },
>(
    typeStruct: ST,
): Promise<undefined | DecodedStruct<ST, T>>
Type Parameters
- T
- ST extends
      | SuiEvent
      | {
          dataType: "moveObject";
          fields: MoveStruct;
          hasPublicTransfer: boolean;
          type: string;
      }
Parameters
- typeStruct: ST
Returns Promise<undefined | DecodedStruct<ST, T>>
Inherited from AbstractMoveCoder.decodedStruct
- Defined in node_modules/.pnpm/@typemove+move@1.8.2/node_modules/@typemove/move/dist/esm/abstract-move-coder.d.ts:24

decodeEvent

decodeEvent<T>(event: SuiEvent): Promise<undefined | TypedEventInstance<T>>
Type Parameters
- T
Parameters
- event: SuiEvent
Returns Promise<undefined | TypedEventInstance<T>>
- Defined in node_modules/.pnpm/@typemove+sui@1.8.2_typescript@5.5.2/node_modules/@typemove/sui/dist/esm/move-coder.d.ts:11

decodeFunctionPayload

decodeFunctionPayload(
payload: MoveCallSuiTransaction,
inputs: SuiCallArg[],
): Promise<MoveCallSuiTransaction>
Parameters
- payload: MoveCallSuiTransaction
- inputs: SuiCallArg[]
Returns Promise<MoveCallSuiTransaction>
- Defined in node_modules/.pnpm/@typemove+sui@1.8.2_typescript@5.5.2/node_modules/@typemove/sui/dist/esm/move-coder.d.ts:15

decodeType

decodeType<T, ST>(
typeStruct: ST,
type: TypeDescriptor<T>,
): Promise<undefined | T>
Type Parameters
- T
- ST
Parameters
- typeStruct: ST
- type: TypeDescriptor<T>
Returns Promise<undefined | T>
Inherited from AbstractMoveCoder.decodeType
- Defined in node_modules/.pnpm/@typemove+move@1.8.2/node_modules/@typemove/move/dist/esm/abstract-move-coder.d.ts:25

encode

encode(data: any): any
Parameters
- data: any
Returns any
Inherited from AbstractMoveCoder.encode
- Defined in node_modules/.pnpm/@typemove+move@1.8.2/node_modules/@typemove/move/dist/esm/abstract-move-coder.d.ts:20

encodeArray

encodeArray(entriesDecoded: any[]): any[]
Parameters
- entriesDecoded: any[]
Returns any[]
Inherited from AbstractMoveCoder.encodeArray
- Defined in node_modules/.pnpm/@typemove+move@1.8.2/node_modules/@typemove/move/dist/esm/abstract-move-coder.d.ts:21

filterAndDecodeEvents

filterAndDecodeEvents<T>(
type: string | TypeDescriptor<T>,
resources: SuiEvent[],
): Promise<TypedEventInstance<T>[]>
Type Parameters
- T
Parameters
- type: string | TypeDescriptor<T>
- resources: SuiEvent[]
Returns Promise<TypedEventInstance<T>[]>
- Defined in node_modules/.pnpm/@typemove+sui@1.8.2_typescript@5.5.2/node_modules/@typemove/sui/dist/esm/move-coder.d.ts:12

filterAndDecodeObjects

filterAndDecodeObjects<T>(
    type: TypeDescriptor<T>,
    objects: {
        dataType: "moveObject";
        fields: MoveStruct;
        hasPublicTransfer: boolean;
        type: string;
    }[],
): Promise<
    DecodedStruct<
        {
            dataType: "moveObject";
            fields: MoveStruct;
            hasPublicTransfer: boolean;
            type: string;
        },
        T,
    >[],
>
Type Parameters
- T
Parameters
- type: TypeDescriptor<T>
- objects: {
      dataType: "moveObject";
      fields: MoveStruct;
      hasPublicTransfer: boolean;
      type: string;
  }[]
Returns Promise<
    DecodedStruct<
        {
            dataType: "moveObject";
            fields: MoveStruct;
            hasPublicTransfer: boolean;
            type: string;
        },
        T,
    >[],
>
- Defined in node_modules/.pnpm/@typemove+sui@1.8.2_typescript@5.5.2/node_modules/@typemove/sui/dist/esm/move-coder.d.ts:14

filterAndDecodeStruct

filterAndDecodeStruct<
    T,
    ST extends

            | SuiEvent
            | {
                dataType: "moveObject";
                fields: MoveStruct;
                hasPublicTransfer: boolean;
                type: string;
            },
>(
    typeMatcher: TypeDescriptor<T>,
    structsWithTags: ST[],
): Promise<DecodedStruct<ST, T>[]>
Type Parameters
- T
- ST extends
      | SuiEvent
      | {
          dataType: "moveObject";
          fields: MoveStruct;
          hasPublicTransfer: boolean;
          type: string;
      }
Parameters
- typeMatcher: TypeDescriptor<T>
- structsWithTags: ST[]
Returns Promise<DecodedStruct<ST, T>[]>
Inherited from AbstractMoveCoder.filterAndDecodeStruct
- Defined in node_modules/.pnpm/@typemove+move@1.8.2/node_modules/@typemove/move/dist/esm/abstract-move-coder.d.ts:23

getBCSType

getBCSType(type: TypeDescriptor<any>): Promise<BcsType<any, any>>
Parameters
- type: TypeDescriptor<any>
Returns Promise<BcsType<any, any>>
- Defined in node_modules/.pnpm/@typemove+sui@1.8.2_typescript@5.5.2/node_modules/@typemove/sui/dist/esm/move-coder.d.ts:19

getDynamicFields

getDynamicFields<T1, T2>(
    objects: {
        dataType: "moveObject";
        fields: MoveStruct;
        hasPublicTransfer: boolean;
        type: string;
    }[],
    keyType?: TypeDescriptor<T1>,
    valueType?: TypeDescriptor<T2>,
): Promise<Field<T1, T2>[]>
Type Parameters
- T1
- T2
Parameters
- objects: {
      dataType: "moveObject";
      fields: MoveStruct;
      hasPublicTransfer: boolean;
      type: string;
  }[]
- OptionalkeyType: TypeDescriptor<T1>
- OptionalvalueType: TypeDescriptor<T2>
Returns Promise<Field<T1, T2>[]>
- Defined in node_modules/.pnpm/@typemove+sui@1.8.2_typescript@5.5.2/node_modules/@typemove/sui/dist/esm/move-coder.d.ts:13

getMoveFunction

getMoveFunction(type: string): Promise<InternalMoveFunction>
Parameters
- type: string
Returns Promise<InternalMoveFunction>
Inherited from AbstractMoveCoder.getMoveFunction
- Defined in node_modules/.pnpm/@typemove+move@1.8.2/node_modules/@typemove/move/dist/esm/abstract-move-coder.d.ts:17

getMoveStruct

getMoveStruct(type: string): Promise<InternalMoveStruct>
Parameters
- type: string
Returns Promise<InternalMoveStruct>
Inherited from AbstractMoveCoder.getMoveStruct
- Defined in node_modules/.pnpm/@typemove+move@1.8.2/node_modules/@typemove/move/dist/esm/abstract-move-coder.d.ts:16

load

load(module: SuiMoveNormalizedModule, address: string): InternalMoveModule
Parameters
- module: SuiMoveNormalizedModule
- address: string
Returns InternalMoveModule
Overrides AbstractMoveCoder.load
- Defined in node_modules/.pnpm/@typemove+sui@1.8.2_typescript@5.5.2/node_modules/@typemove/sui/dist/esm/move-coder.d.ts:9

`Protected`loadInternal

loadInternal(module: InternalMoveModule, address: string): void
Parameters
- module: InternalMoveModule
- address: string
Returns void
Inherited from AbstractMoveCoder.loadInternal
- Defined in node_modules/.pnpm/@typemove+move@1.8.2/node_modules/@typemove/move/dist/esm/abstract-move-coder.d.ts:12

registerBCSTypes

registerBCSTypes(type: TypeDescriptor<any>): Promise<void>
Parameters
- type: TypeDescriptor<any>
Returns Promise<void>
- Defined in node_modules/.pnpm/@typemove+sui@1.8.2_typescript@5.5.2/node_modules/@typemove/sui/dist/esm/move-coder.d.ts:20

Class MoveCoder

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns MoveCoder

Properties

adapter

ProtectedmoduleMapping

Methods

contains

Parameters

Returns boolean

Protecteddecode

Parameters

Returns Promise<any>

decodeArray

Parameters

Returns Promise<any[]>

decodeBCS

Parameters

Returns Promise<any>

ProtecteddecodeBigInt

Parameters

Returns bigint

decodeCallResult

Parameters

Returns Promise<any[]>

decodeDevInspectResult

Type Parameters

Parameters

Returns Promise<TypedDevInspectResults<T>>

ProtecteddecodedStruct

Type Parameters

Parameters

Returns Promise<undefined | DecodedStruct<ST, T>>

decodeEvent

Type Parameters

Parameters

Returns Promise<undefined | TypedEventInstance<T>>

decodeFunctionPayload

Parameters

Returns Promise<MoveCallSuiTransaction>

decodeType

Type Parameters

Parameters

Returns Promise<undefined | T>

encode

Parameters

Returns any

encodeArray

Parameters

Returns any[]

filterAndDecodeEvents

Type Parameters

Parameters

Returns Promise<TypedEventInstance<T>[]>

filterAndDecodeObjects

Type Parameters

Parameters

Returns Promise< DecodedStruct< { dataType: "moveObject"; fields: MoveStruct; hasPublicTransfer: boolean; type: string; }, T, >[],>

filterAndDecodeStruct

Type Parameters

Parameters

Returns Promise<DecodedStruct<ST, T>[]>

getBCSType

Parameters

Returns Promise<BcsType<any, any>>

getDynamicFields

Type Parameters

Parameters

Returns Promise<Field<T1, T2>[]>

getMoveFunction

Parameters

Returns Promise<InternalMoveFunction>

getMoveStruct

`Protected`moduleMapping

`Protected`decode

`Protected`decodeBigInt

`Protected`decodedStruct

Returns Promise<
DecodedStruct<
{
dataType: "moveObject";
fields: MoveStruct;
hasPublicTransfer: boolean;
type: string;
},
T,
>[],
>

`Protected`loadInternal