pysui.sui_move.model package

Submodules

pysui.sui_move.model.bytecode_tables module

Move byte code table contents.

class pysui.sui_move.model.bytecode_tables.Signature(sig_tokens: list)

Bases: object

.

sig_tokens: list

__init__(sig_tokens: list) → None

class pysui.sui_move.model.bytecode_tables.Identifier(identifier: str)

Bases: object

.

identifier: str

__init__(identifier: str) → None

class pysui.sui_move.model.bytecode_tables.Address(address: str)

Bases: object

.

address: str

__init__(address: str) → None

class pysui.sui_move.model.bytecode_tables.Constant(constant_type: SignatureType, constant_length: int, serialized_value: bytes)

Bases: object

.

constant_type: SignatureType

constant_length: int

serialized_value: bytes

__init__(constant_type: SignatureType, constant_length: int, serialized_value: bytes) → None

class pysui.sui_move.model.bytecode_tables.ModuleHandle(address_index: int, identifier_index: int)

Bases: object

ModuleHandle represents a Module in the ModuleHanles byte code table.

Variables:

address (type) – Index of address entry in Address table
address – int
identifer (type) – Index of ascii name in Identifier table
identifer – int

address_index: int

identifier_index: int

__init__(address_index: int, identifier_index: int) → None

class pysui.sui_move.model.bytecode_tables.StructTypeParameter(constraints: AbilitySet, is_phantom: bool)

Bases: object

StructTypeParameter is a type parameter used in the StructureHandle.

Variables:

abilities – The type parameter constraints
abliities (type) – AbilitySet
is_phantom (type) – Whether the parameter is declared as phantom.
is_phantom – bool

constraints: AbilitySet

is_phantom: bool

__init__(constraints: AbilitySet, is_phantom: bool) → None

class pysui.sui_move.model.bytecode_tables.StructHandle(module_handle_index: int, identifier_index: int, abilities: AbilitySet, type_parameters: list[StructTypeParameter])

Bases: object

StuctHandle represents a Structure in the StructureHanles byte code table.

Variables:

module (type) – Index of Module entry in ModuleHandles table
module – int
identifer (type) – Index of ascii name in Identifier table
identifer – str
abilities – abilities enum for this Structure
abliities (type) – Ability
type_parameters –

module_handle_index: int

identifier_index: int

abilities: AbilitySet

type_parameters: list[StructTypeParameter]

__init__(module_handle_index: int, identifier_index: int, abilities: AbilitySet, type_parameters: list[StructTypeParameter]) → None

class pysui.sui_move.model.bytecode_tables.StructField(identifier_index: int, field_type: list = <factory>)

Bases: object

.

identifier_index: int

field_type: list

__init__(identifier_index: int, field_type: list = <factory>) → None

class pysui.sui_move.model.bytecode_tables.StructDefinition(struct_handle_index: int, tag: ~pysui.sui_move.model.common_types.StructTag, field_count: int = 0, fields: list[~pysui.sui_move.model.bytecode_tables.StructField] = <factory>)

Bases: object

.

struct_handle_index: int

tag: StructTag

field_count: int = 0

fields: list[StructField]

__init__(struct_handle_index: int, tag: ~pysui.sui_move.model.common_types.StructTag, field_count: int = 0, fields: list[~pysui.sui_move.model.bytecode_tables.StructField] = <factory>) → None

class pysui.sui_move.model.bytecode_tables.StructInstantiation(struct_handle_index: int, signature_index: int)

Bases: object

.

struct_handle_index: int

signature_index: int

__init__(struct_handle_index: int, signature_index: int) → None

class pysui.sui_move.model.bytecode_tables.FieldHandle(structure_definition_index: int, field_index: int)

Bases: object

.

structure_definition_index: int

field_index: int

__init__(structure_definition_index: int, field_index: int) → None

class pysui.sui_move.model.bytecode_tables.FieldInstantiation(field_handle_index: int, signature_index: list[int])

Bases: object

.

field_handle_index: int

signature_index: list[int]

__init__(field_handle_index: int, signature_index: list[int]) → None

class pysui.sui_move.model.bytecode_tables.FunctionHandle(module_handle_index: int, identifier_index: int, parameters_signature_index: int, returns_signature_index: int, type_params: list = <factory>)

Bases: object

.

module_handle_index: int

identifier_index: int

parameters_signature_index: int

returns_signature_index: int

type_params: list

__init__(module_handle_index: int, identifier_index: int, parameters_signature_index: int, returns_signature_index: int, type_params: list = <factory>) → None

class pysui.sui_move.model.bytecode_tables.FunctionDefinition(function_handle_index: int, visibility: ~pysui.sui_move.model.common_types.Visibility, flag: ~pysui.sui_move.model.common_types.Flags, aquires_global_resources: list[~typing.Any], locals_cnt: int = 0, code_units: tuple[int, list[tuple[~pysui.sui_move.model.common_types.OpCode, ~typing.Any]]] = <factory>)

Bases: object

.

function_handle_index: int

visibility: Visibility

flag: Flags

aquires_global_resources: list[Any]

locals_cnt: int = 0

code_units: tuple[int, list[tuple[OpCode, Any]]]

__init__(function_handle_index: int, visibility: ~pysui.sui_move.model.common_types.Visibility, flag: ~pysui.sui_move.model.common_types.Flags, aquires_global_resources: list[~typing.Any], locals_cnt: int = 0, code_units: tuple[int, list[tuple[~pysui.sui_move.model.common_types.OpCode, ~typing.Any]]] = <factory>) → None

class pysui.sui_move.model.bytecode_tables.FunctionInstantiation(function_handle_index: int, signature_index: int)

Bases: object

.

function_handle_index: int

signature_index: int

__init__(function_handle_index: int, signature_index: int) → None

class pysui.sui_move.model.bytecode_tables.Friend(address_index: int, identifier_index: int)

Bases: object

.

address_index: int

identifier_index: int

__init__(address_index: int, identifier_index: int) → None

pysui.sui_move.model.common_types module

Move byte code common enums and types.

class pysui.sui_move.model.common_types.OpCode(value)

Bases: IntEnum

Move byte code instructions.

Pop = 1

Ret = 2

BrTrue = 3

BrFalse = 4

Branch = 5

LdU64 = 6

LdConst = 7

LdTrue = 8

LdFalse = 9

CopyLoc = 10

MoveLoc = 11

StLoc = 12

MutBorrowLoc = 13

ImmBorrowLoc = 14

MutBorrowField = 15

ImmBorrowField = 16

Call = 17

Pack = 18

Unpack = 19

ReadRef = 20

WriteRef = 21

Add = 22

Sub = 23

Mul = 24

Mod = 25

Div = 26

BitOr = 27

BitAnd = 28

Xor = 29

Or = 30

And = 31

Not = 32

Eq = 33

Neq = 34

Lt = 35

Gt = 36

Le = 37

Ge = 38

Abort = 39

Nop = 40

Exists = 41

MutBorrowGlobal = 42

ImmBorrowGlobal = 43

MoveFrom = 44

MoveTo = 45

FreezeRef = 46

Shl = 47

Shr = 48

LdU8 = 49

LdU128 = 50

CastU8 = 51

CastU64 = 52

CastU128 = 53

MutBorrowFieldGeneric = 54

ImmBorrowFieldGeneric = 55

CallGeneric = 56

PackGeneric = 57

UnpackGeneric = 58

ExistsGeneric = 59

MutBorrowGlobalGeneric = 60

ImmBorrowGlobalGeneric = 61

MoveFromGeneric = 62

MoveToGeneric = 63

VecPack = 64

VecLen = 65

VecImmBorrow = 66

VecMutBorrow = 67

VecPushBack = 68

VecPopBack = 69

VecUnpack = 70

VecSwap = 71

LdU16 = 72

LdU32 = 73

LdU256 = 74

CastU16 = 75

CastU32 = 76

CastU256 = 77

class pysui.sui_move.model.common_types.TableType(value)

Bases: IntEnum

Move byte code file tables.

ModuleHandles = 1

StructHandles = 2

FunctionHandles = 3

FunctionInstance = 4

Signatures = 5

ConstantPool = 6

Identifiers = 7

AddressIdentifiers = 8

StructDefinitions = 10

StructDefInstances = 11

FunctionDefinitions = 12

FieldHandles = 13

FieldInstances = 14

FriendDeclarations = 15

MetaData = 16

class pysui.sui_move.model.common_types.Ability(value)

Bases: IntFlag

Move structure abilities.

Copy = 1

Drop = 2

Store = 4

Key = 8

class pysui.sui_move.model.common_types.SignatureType(value)

Bases: IntEnum

Move function parameter types.

boolean = 1

u8 = 2

u64 = 3

u128 = 4

Address = 5

Reference = 6

MutableReference = 7

Struct = 8

TypeParameter = 9

Vector = 10

StructInstantiation = 11

Signer = 12

u16 = 13

u32 = 14

u256 = 15

class pysui.sui_move.model.common_types.Visibility(value)

Bases: IntEnum

.

Private = 0

Public = 1

Script = 2

FriendPrivate = 3

class pysui.sui_move.model.common_types.StructTag(value)

Bases: IntEnum

.

Native = 1

HasFields = 2

class pysui.sui_move.model.common_types.TableHeader(kind: TableType, offset: int, length: int, pos: int = 0)

Bases: object

.

kind: TableType

offset: int

length: int

pos: int = 0

__init__(kind: TableType, offset: int, length: int, pos: int = 0) → None

class pysui.sui_move.model.common_types.Flags

Bases: int

.

Native = 2

Entry = 4

is_native() → bool: .

is_entry() → bool: .

class pysui.sui_move.model.common_types.AbilitySet(ability_set: int)

Bases: object

.

__init__(ability_set: int): .

property as_list: list[Ability]: .

property as_bitset: int: .

Module contents

Move module structures and enums.