pysui.sui.sui_types package

Submodules

pysui.sui.sui_types.address module

Sui Address Type.

pysui.sui.sui_types.address.valid_sui_address(instr: str) → bool: Verify Sui address string.

Changed in version 0.19.0: Addresses can be between 3 and 66 chars with prefix, 1 and 64 without.

class pysui.sui.sui_types.address.SuiAddress(identifier: SuiString | str)

Bases: SuiBaseType

Sui Address Type.

__init__(identifier: SuiString | str) → None: Initialize address.

property signer: str: Alias for signer in transaction validation.

property owner: str: Alias for signer in transaction validation.

property sender: str: Alias for signer in transaction validation.

property sender_address: str: Alias for sender in transaction validation.

property recipient: str: Alias for recipient in transaction validation.

property validator: str: Alias for recipient in transaction validation.

property recipients: str: Alias for recipients in transaction validation.

classmethod from_keypair_string(keystring: str) → SuiAddress: Address from base64 encoded keypair string with no validation.

classmethod from_bytes(in_bytes: bytes) → SuiAddress: Create address from bytes.

pysui.sui.sui_types.address.address_from_keystring(indata: str) → SuiAddress: From a 88 byte keypair string create a SuiAddress.

pysui.sui.sui_types.bcs module

Sui BCS Types.

class pysui.sui.sui_types.bcs.Address(*args, **kwargs)

Bases: Struct

Address Represents a Sui Address or ObjectID as list of ints.

to_str() → str: .

to_address_str() → str: .

to_sui_address() → SuiAddress: .

classmethod from_sui_address(indata: SuiAddress) → Address: .

classmethod from_str(indata: str) → Address: .

Address

class pysui.sui.sui_types.bcs.Digest(*args, **kwargs)

Bases: Struct

Digest represents a transaction or object base58 value as list of ints.

classmethod from_str(indata: str) → Digest: Digest from base58 string.

classmethod from_bytes(indata: bytes) → Digest: Digest from bytes.

Added in version 0.17.0: Direct from bytes construction

class pysui.sui.sui_types.bcs.VariableArrayU8(*args, **kwargs)

Bases: Struct

Variable length array

Added in version 0.60.0: Handle Sting, etc.

class pysui.sui.sui_types.bcs.Variable(*args, **kwargs)

Bases: Struct

.

classmethod bcs_var_length_field(base_class: Struct, ready_data: list[int]) → Variable: .

classmethod encode(obj)

classmethod decode(cursor)

class pysui.sui.sui_types.bcs.ArrayVar(*args, **kwargs)

Bases: Struct

.

classmethod bcs_array_for(*, base_class, ready_data: list, depth: int = 0): .

class pysui.sui.sui_types.bcs.BuilderArg(name, value=None)

Bases: RustEnum

BuilderArg objects are generated in the TransactionBuilder.

class pysui.sui.sui_types.bcs.ObjectReference(*args, **kwargs)

Bases: Struct

ObjectReference represents an object by it’s objects reference fields.

classmethod from_generic_ref(indata: GenericRef) → ObjectReference

from_generic_ref init construct with GenericRef from ObjectRead structure.

Parameters:: indata (GenericRef) – The reference information for an Object from ObjectRead
Returns:: The instantiated BCS object
Return type:: SharedObjectReference

Deprecated since version 0.54.0: Transitioning to GraphQL

classmethod from_gql_ref(indata: ObjectReadGQL) → ObjectReference

from_generic_ref init construct with GenericRef from ObjectRead structure.

Parameters:: indata (GenericRef) – The reference information for an Object from ObjectRead
Returns:: The instantiated BCS object
Return type:: SharedObjectReference

Added in version 0.54.0: Support argument inferencing

class pysui.sui.sui_types.bcs.SharedObjectReference(*args, **kwargs)

Bases: Struct

SharedObjectReference represents a shared object by it’s objects reference fields.

classmethod from_object_read(indata: ObjectRead) → SharedObjectReference

from_generic_ref init construct with GenericRef from ObjectRead structure.

Parameters:: indata (GenericRef) – The reference information for an Object from ObjectRead
Returns:: The instantiated BCS object
Return type:: SharedObjectReference

Deprecated since version 0.54.0: Transitioning to GraphQL

classmethod from_gql_ref(indata: ObjectReadGQL, is_mutable: bool = False) → SharedObjectReference

from_gql_ref init construct with ObjectReadGQL.

Parameters:: indata (ObjectReadGQL) – The reference information for an Object from ObjectReadGQL
Returns:: The instantiated BCS object
Return type:: SharedObjectReference

Added in version 0.54.0: Support argument inferencing

class pysui.sui.sui_types.bcs.Uint256

Bases: IntType

Uint256 represents a 256 bit ulong as hack as canoser doesn’t support.

byte_lens = 32

max_value = 115792089237316195423570985008687907853269984665640564039457584007913129639935

min_value = 0

signed = False

classmethod encode(value)

encode Override canoser.int_type.IntType to return value as bytes.

Parameters:: value (int) – The inbound python int to covert
Returns:: Representation as bytes
Return type:: bytes

pysui.sui.sui_types.bcs.U256: alias of Uint256

class pysui.sui.sui_types.bcs.OptionalU8(*args, **kwargs)

Bases: RustOptional

OptionalU8 Optional assignment of unsigned 8 bit int.

Deprecated since version 0.54.0: Transitioning to GraphQL

Added in version 0.19.0: Added

class pysui.sui.sui_types.bcs.OptionalU16(*args, **kwargs)

Bases: RustOptional

OptionalU16 Optional assignment of unsigned 16 bit int.

Deprecated since version 0.54.0: Transitioning to GraphQL

Added in version 0.19.0: Added

class pysui.sui.sui_types.bcs.OptionalU32(*args, **kwargs)

Bases: RustOptional

OptionalU32 Optional assignment of unsigned 32 bit int.

Deprecated since version 0.54.0: Transitioning to GraphQL

Added in version 0.19.0: Added

class pysui.sui.sui_types.bcs.OptionalU64(*args, **kwargs)

Bases: RustOptional

OptionalU64 Optional assignment of unsigned 64 bit int.

Deprecated since version 0.54.0: Transitioning to GraphQL

class pysui.sui.sui_types.bcs.OptionalU128(*args, **kwargs)

Bases: RustOptional

OptionalU128 Optional assignment of unsigned 128 bit int.

Deprecated since version 0.54.0: Transitioning to GraphQL

Added in version 0.19.0: Added

class pysui.sui.sui_types.bcs.OptionalU256(*args, **kwargs)

Bases: RustOptional

OptionalU256 Optional assignment of unsigned 256 bit int.

Deprecated since version 0.54.0: Transitioning to GraphQL

Added in version 0.19.0: Added

class pysui.sui.sui_types.bcs.TypeTag(name, value=None)

Bases: RustEnum

TypeTag enum for move call type_arguments.

classmethod type_tag_from(value: str) → TypeTag: .

classmethod update_value_at(index: int, value: Any)

update_value_at Updates the enum list.

Parameters:

index (int) – Index of enum
value (Any) – The BCS type value to insert at index

class pysui.sui.sui_types.bcs.StructTag(*args, **kwargs)

Bases: Struct

StructTag represents a type value (e.g. 0x2::sui::SUI) in BCS when used in MoveCall.

Changed in version 0.51.3: PR fixed nested types that are arrays of types.

Changed in version 0.17.1: Fixed nested types.

classmethod from_type_str(type_str: str) → StructTag

from_type_str convert a type_arg to StructTag.

Parameters:: type_str (str) – Type string (e.g. 0x2::sui::SUI)
Returns:: Instance of StructTag
Return type:: StructTag

class pysui.sui.sui_types.bcs.ObjectArg(name, value=None)

Bases: RustEnum

ObjectArg enum for type of object and it’s reference data when used in MoveCall.

class pysui.sui.sui_types.bcs.CallArg(name, value=None)

Bases: RustEnum

CallArg represents an argument (parameters) of a MoveCall.

Pure type is for scalares, or native, values.

class pysui.sui.sui_types.bcs.GasData(*args, **kwargs)

Bases: Struct

.

class pysui.sui.sui_types.bcs.Argument(name, value=None)

Bases: RustEnum

.

class pysui.sui.sui_types.bcs.OptionalTypeTag(*args, **kwargs)

Bases: RustOptional

OptionalTypeTag Optional assignment of TypeTag.

Deprecated since version 0.54.0: Transitioning to GraphQL

class pysui.sui.sui_types.bcs.Optional(value=None)

Bases: RustOptional

Use from OptionalTypeFactor.

to_json(indent=4): .

class pysui.sui.sui_types.bcs.OptionalTypeFactory

Bases: object

Optional Optional assignment of any canoser type.

Added in version 0.54.0: Support argument inferencing

classmethod as_optional(in_type: ~typing.Any = <class 'canoser.struct.Struct'>) → RustOptional: .

class pysui.sui.sui_types.bcs.ProgrammableMoveCall(*args, **kwargs)

Bases: Struct

A call to either an entry or a public Move function.

class pysui.sui.sui_types.bcs.TransferObjects(*args, **kwargs)

Bases: Struct

It sends n-objects to the specified address.

class pysui.sui.sui_types.bcs.SplitCoin(*args, **kwargs)

Bases: Struct

It splits off some amount into a new coin.

class pysui.sui.sui_types.bcs.MergeCoins(*args, **kwargs)

Bases: Struct

It merges n-coins into the first coin.

class pysui.sui.sui_types.bcs.Publish(*args, **kwargs)

Bases: Struct

Publish represents a sui_publish structure.

class pysui.sui.sui_types.bcs.MakeMoveVec(*args, **kwargs)

Bases: Struct

Given n-values of the same type, it constructs a vector.

class pysui.sui.sui_types.bcs.Upgrade(*args, **kwargs)

Bases: Struct

Upgrade an existing move package onchain.

class pysui.sui.sui_types.bcs.Command(name, value=None)

Bases: RustEnum

.

class pysui.sui.sui_types.bcs.ProgrammableTransaction(*args, **kwargs)

Bases: Struct

.

class pysui.sui.sui_types.bcs.TransactionKind(name, value=None)

Bases: RustEnum

TransactionKind is enumeration of transaction kind.

Deserialization (from_bytes) should only called if attempting to deserialize from the results of calling a transaction (i.e. unsafe_pay) with the first byte and last bytes have been pruned.

This is a stopgap until programmable txns implemented with TransactionBuilder

classmethod from_bytes(in_data: bytes) → TransactionKind: .

class pysui.sui.sui_types.bcs.TransactionExpiration(name, value=None)

Bases: RustEnum

.

class pysui.sui.sui_types.bcs.TransactionDataV1(*args, **kwargs)

Bases: Struct

.

class pysui.sui.sui_types.bcs.TransactionData(name, value=None)

Bases: RustEnum

TransactionData is enumeration of transaction kind.

Deserialization (from_bytes) should only called if attempting to deserialize from the results of calling a transaction (i.e. unsafe_pay).

classmethod variant_for_index(index: int) → tuple[str, RustEnum] | IndexError

variant_for_index returns the enum name and reference tuple from specific index.

Parameters:: index (int) – The index into list of enum values
Raises:: IndexError – When index provided is not valid
Returns:: The name,value tuple of the enum index
Return type:: Union[tuple[str, canoser.RustEnum], ValueError]

classmethod from_bytes(in_data: bytes) → TransactionData: .

class pysui.sui.sui_types.bcs.MsPublicKey(*args, **kwargs)

Bases: Struct

Represents signing PublicKeys for serialization.

Deprecated since version 0.33.0: Unused, scheduled for removal in 0.35.0

Added in version 0.20.4: Added to support in-code MultiSig signing.

class pysui.sui.sui_types.bcs.MsEd25519PublicKey(*args, **kwargs)

Bases: Struct

.

class pysui.sui.sui_types.bcs.MsSecp256k1PublicKey(*args, **kwargs)

Bases: Struct

.

class pysui.sui.sui_types.bcs.MsSecp256r1PublicKey(*args, **kwargs)

Bases: Struct

.

class pysui.sui.sui_types.bcs.MsNewPublicKey(name, value=None)

Bases: RustEnum

Represents signing PublicKeys for serialization.

classmethod from_pubkey(key: PublicKey, weight: int = 0) → MsNewPublicKey: .

class pysui.sui.sui_types.bcs.MsBitmap(*args, **kwargs)

Bases: Struct

Represents signing PublicKeys indexes for serialization.

Added in version 0.26.0: Added to support new MultiSig bitmap in Sui v1.5.0.

class pysui.sui.sui_types.bcs.MsCompressedSig(*args, **kwargs)

Bases: Struct

Represents compressed individual signed messages for serialization.

Added in version 0.20.4: Added to support in-code MultiSig signing.

class pysui.sui.sui_types.bcs.MultiSignature(*args, **kwargs)

Bases: Struct

BCS representation of a MultiSig signature for executions.

Added in version 0.26.0: Sui converting from roaring bitmap to simple bitmap in 1.5.0

class pysui.sui.sui_types.bcs.TxStringInt(*args, **kwargs)

Bases: Struct

Key Value pair where value is int. Used in TxTransaction use table consstruct.

class pysui.sui.sui_types.bcs.TxStringString(*args, **kwargs)

Bases: Struct

Key Value pair where value is string. Used in TxTransaction use table consstruct.

class pysui.sui.sui_types.bcs.TxTransaction(*args, **kwargs)

Bases: Struct

Table of builder constructs.

Serialized out and use to validate deserialization back in

class pysui.sui.sui_types.bcs.TxSenderMulti(*args, **kwargs)

Bases: Struct

BCS Representation of a multi-sig sender/sponsor.

class pysui.sui.sui_types.bcs.TxSenderSingle(*args, **kwargs)

Bases: Struct

BCS representation of a single sender/sponsor.

class pysui.sui.sui_types.bcs.TxSender(name, value=None)

Bases: RustEnum

BCS representation of transaction sender/sponsor.

class pysui.sui.sui_types.bcs.SuiTransactionDataV1(*args, **kwargs)

Bases: Struct

BCS representation of transaction builder.

class pysui.sui.sui_types.bcs.SuiTransaction(name, value=None)

Bases: RustEnum

BCS representation of serialized pysui SuiTransaction (a.k.a. builder).

pysui.sui.sui_types.collections module

Sui Collection Types.

class pysui.sui.sui_types.collections.SuiCollection(identifier: Any)

Bases: SuiBaseType

Generic Collection Type.

class pysui.sui.sui_types.collections.SuiArray(array: list[AT])

Bases: SuiCollection, Generic[AT]

Array type.

__init__(array: list[AT]) → None: Initialize collection.

append(item: AT) → list[AT]: Append and item to array.

extend(items: list[AT]) → list[AT]: Append and item to array.

property input_coins: list[ObjectID]: Alias for transactions.

property coins: list[ObjectID]: Alias for transactions.

property recipients: list[SuiAddress]: Alias for transactions.

property amounts: list[SuiInteger | SuiString]: Alias for transactions.

property amount: list[SuiInteger]: Alias for transactions.

property split_amounts: list[SuiInteger]: Alias for transactions.

property type_arguments: list[SuiString]: Alias for transactions.

property arguments: list[SuiString]: Alias for transactions.

property compiled_modules: list[SuiString]: Alias for transactions.

property dependencies: list[SuiString]: Alias for transactions.

property single_transaction_params: list[dict]: Alias for transactions.

property digests: list[dict]: Alias for transactions.

property signatures: list[dict]: Alias for transactions.

property object_ids: list[dict]: Alias for transactions.

property staked_sui_ids: list[dict]: Alias for transactions.

class pysui.sui.sui_types.collections.SuiMap(key: str, value: Any)

Bases: SuiCollection

Dictionary Type.

__init__(key: str, value: Any) → None: Initialize collection.

add_kv_pair(key: str, value: Any) → SuiMap: Add key value pair to map.

property cursor: dict: Alias for query.

property recipient: dict[str, Any]: Alias for transactions.

property query: dict[str, Any]: Alias for transactions.

property filter: dict[str, Any]: Alias for transactions.

property name: dict[str, Any]: Alias for transactions.

property options: dict[str, Any]: Alias for transactions.

property additional_args: dict[str, Any]: Alias for transaction inspect.

class pysui.sui.sui_types.collections.BatchParameter(key: str, value: Any)

Bases: SuiMap

BatchParameter is abstraction for TransferObjectParams and MoveCallRequestParams.

abstract realize_parameters() → dict: Satisfied by subclasses.

class pysui.sui.sui_types.collections.EventID(event_seq: str, tx_seq: str)

Bases: SuiMap

Event ID specifier.

Changed in version 0.30.0: event_seq and tx_seq changed from int to string

__init__(event_seq: str, tx_seq: str): Initialize EventID.

pysui.sui.sui_types.event_filter module

Sui query and get event filter types.

class pysui.sui.sui_types.event_filter.SenderEventQuery(sender: SuiAddress)

Bases: _EventFilterType, SuiMap

Query events for Sender address.

__init__(sender: SuiAddress): Initialize query parameter.

class pysui.sui.sui_types.event_filter.TransactionEventQuery(txid: str)

Bases: _EventFilterType, SuiMap

Query events for Transaction.

__init__(txid: str): Initialize query parameter.

class pysui.sui.sui_types.event_filter.PackageEventQuery(package_id: str)

Bases: _EventFilterType, SuiMap

Query events for Transaction.

__init__(package_id: str): Initialize query parameter.

class pysui.sui.sui_types.event_filter.MoveEventModuleQuery(module: str, package_id: str)

Bases: _EventFilterType, SuiMap

Query events with the given move event module name.

__init__(module: str, package_id: str): Initialize query parameter.

class pysui.sui.sui_types.event_filter.MoveModuleEventQuery(module: str, package: str)

Bases: _EventFilterType, SuiMap

Query events emitted in a specified Move module.

__init__(module: str, package: str) → None: Initialize query parameter.

class pysui.sui.sui_types.event_filter.MoveEventTypeQuery(struct: str)

Bases: _EventFilterType, SuiMap

Query events for Move Event on Struct type.

__init__(struct: str): Initialize query parameter.

class pysui.sui.sui_types.event_filter.MoveEventFieldQuery(field_path: dict[str, str])

Bases: _EventFilterType, SuiMap

Query events for Move Event fields.

__init__(field_path: dict[str, str])

Initialize query parameter.

field_path argument is dict with {‘path’:PATH_TO_FILE,’value’:true}

class pysui.sui.sui_types.event_filter.TimeRangeEventQuery(start_time: SuiInteger, end_time: SuiInteger)

Bases: _EventFilterType, SuiMap

Query events for Time Range.

__init__(start_time: SuiInteger, end_time: SuiInteger): Initialize query parameter.

class pysui.sui.sui_types.event_filter.AndFilter(*, lhs_filter: _EventFilterType, rhs_filter: _EventFilterType)

Bases: _EventFilterType, SuiMap

AndFilter joins two _EventFilterTypes.

__init__(*, lhs_filter: _EventFilterType, rhs_filter: _EventFilterType) → None

__init__ Filter initializer.

Where event must be of type lhs_filter AND rhs_filter.

Parameters:

lhs_filter (_EventFilterType) – The primary filter used in conjunction with rhs_filter
rhs_filter (_EventFilterType) – The secondary filter used in conjunction with lhs_filter

Raises:

AttributeError – If either lhs_filter or rhs_filter not of type _EventFilterType

class pysui.sui.sui_types.event_filter.OrFilter(*, lhs_filter: _EventFilterType, rhs_filter: _EventFilterType)

Bases: _EventFilterType, SuiMap

AndFilter joins two _EventFilterTypes.

__init__(*, lhs_filter: _EventFilterType, rhs_filter: _EventFilterType) → None

__init__ Filter initializer.

Where event may be of type lhs_filter OR rhs_filter.

Parameters:

lhs_filter (_EventFilterType) – The primary filter used in conjunction with rhs_filter
rhs_filter (_EventFilterType) – The secondary filter used in conjunction with lhs_filter

Raises:

AttributeError – If either lhs_filter or rhs_filter not of type _EventFilterType

class pysui.sui.sui_types.event_filter.AllFilter(*, filters: list[_EventFilterType] | None = None)

Bases: _EventFilterType, SuiMap

AllFilter will alllow all events in filter(s) criteria to be delivered.

__init__(*, filters: list[_EventFilterType] | None = None) → None

__init__ Filter initializer.

Parameters:: filters (list[_EventFilterType], optional) – A list of _EventFilterType, defaults to None

class pysui.sui.sui_types.event_filter.AnyFilter(*, filters: list[_EventFilterType] | None = None)

Bases: _EventFilterType, SuiMap

AnyFilter will alllow any events in filter(s) criteria to be delivered.

__init__(*, filters: list[_EventFilterType] | None = None) → None

__init__ Filter initializer.

Parameters:: filters (list[_EventFilterType], optional) – A list of _EventFilterType, defaults to None

class pysui.sui.sui_types.event_filter.CheckpointEvent(checkpoint_id: str)

Bases: _TransactionFilterType, SuiMap

Query events for Transaction.

__init__(checkpoint_id: str): Initialize query parameter.

Bases: _TransactionFilterType, SuiMap

Query events for Transaction.

__init__(package_id: str | ObjectID, module_name: str | SuiString | None = None, function_name: str | SuiString | None = None): Initialize query parameter.

class pysui.sui.sui_types.event_filter.InputObjectEvent(object_id: str | ObjectID)

Bases: _TransactionFilterType, SuiMap

Query events for Transaction.

__init__(object_id: str | ObjectID): Initialize query parameter.

class pysui.sui.sui_types.event_filter.ChangedObjectEvent(object_id: str | ObjectID)

Bases: _TransactionFilterType, SuiMap

Query events for Transaction.

__init__(object_id: str | ObjectID): Initialize query parameter.

class pysui.sui.sui_types.event_filter.FromAddressEvent(address_id: str | SuiAddress)

Bases: _TransactionFilterType, SuiMap

Query events for Transaction.

__init__(address_id: str | SuiAddress): Initialize query parameter.

class pysui.sui.sui_types.event_filter.ToAddressEvent(address_id: str | SuiAddress)

Bases: _TransactionFilterType, SuiMap

Query events for Transaction.

__init__(address_id: str | SuiAddress): Initialize query parameter.

class pysui.sui.sui_types.event_filter.FromAndToAddressEvent(from_address_id: str | SuiAddress, to_address_id: str | SuiAddress)

Bases: _TransactionFilterType, SuiMap

Query events for Transaction.

__init__(from_address_id: str | SuiAddress, to_address_id: str | SuiAddress): Initialize query parameter.

class pysui.sui.sui_types.event_filter.TransactionKindEvent(transaction_kind: str | SuiString)

Bases: _TransactionFilterType, SuiMap

Query events for Transaction.

__init__(transaction_kind: str | SuiString): Initialize query parameter.

pysui.sui.sui_types.scalars module

Sui Scalar Types.

class pysui.sui.sui_types.scalars.SuiNullType

Bases: SuiScalarType

SuiNullType A null type.

Parameters:: SuiBaseType (_type_) – Super class
Returns:: _description_
Return type:: SuiNullType

__init__() → None

__init__ Native string initializing SuiString.

Parameters:: identifier (Any) – A native python type

property limit: None: Alias for transactions.

property version: None: Alias for transactions.

property cursor: None: Alias for transactions.

property coin_type: None: Alias for transactions.

property epoch: None: Alias for transactions.

property digest: None: Alias for transactions.

property descending_order: None: Alias for transactions.

property gas_price: None: Alias for transactions.

property gas: None: Alias for transactions.

property at_checkpoint: None: Alias for transactions.

class pysui.sui.sui_types.scalars.SuiString(identifier: str)

Bases: SuiScalarType

Sui String type.

__init__(identifier: str) → None

__init__ Native string initializing SuiString.

Parameters:: identifier (str) – A python str

property id: str: Alias for transactions.

property function: str: Alias for transactions.

property name: str: Alias for transactions.

property function_name: str: Alias for transactions.

property module: str: Alias for transactions.

property module_name: str: Alias for transactions.

property struct_name: str: Alias for transactions.

property arguments: str: Alias for transactions.

property type_arguments: str: Alias for transactions.

property compiled_modules: str: Alias for transactions.

property cursor: str: Alias for transactions.

property move_event_struct_name: str: Alias for transactions.

property digest: str: Alias for transactions.

property query: str: Alias for transactions.

property recipient: str: Alias for transactions.

property coin_type: str: Alias for transactions.

property limit: str: Alias for transactions.

property commitment_type: str: Alias for transactions.

property tx_bytes: str: Alias for transactions.

property amounts: str: Alias for transactions.

property transaction_digest: str: Alias for transactions.

property gas_budget: str: Alias for transactions.

property amount: str: Alias for transactions.

property split_count: str: Alias for transactions.

class pysui.sui.sui_types.scalars.SuiTxBytes(identifier: str)

Bases: SuiString

Sui Base64 tx_bytes string.

property tx_bytes: str: Satisfy transaction verification.

class pysui.sui.sui_types.scalars.SuiSignature(identifier: str)

Bases: SuiString

Sui Base64 signature.

property signature: str: Satisfy transaction verification.

property signatures: str: Satisfy transaction verification.

class pysui.sui.sui_types.scalars.SuiTransactionDigest(identifier: str)

Bases: SuiString

Sui Base58 digest.

property digest: str: Alias for transaction.

class pysui.sui.sui_types.scalars.ObjectID(identifier: str)

Bases: SuiString

Sui Object id type.

property object_id: str: Alias over value.

property object_ids: str: Alias over value.

property object: str: Alias over value.

property package: str: Alias over value.

property package_object_id: str: Alias over value.

property parent_object_id: str: Alias over value.

property sui_object_id: str: Alias over value.

property coin_object_id: str: Alias over value.

property staked_sui: str: Alias over value.

property staked_sui_ids: str: Alias over value.

property gas: str: Alias over value.

property input_coins: str: Alias over value.

property coins: str: Alias over value.

property delegation: str: Alias over value.

property primary_coin: str: Alias over value.

property coin_to_merge: str: Alias over value.

class pysui.sui.sui_types.scalars.SuiBoolean(identifier: Any)

Bases: SuiScalarType

Sui Bool type.

property descending_order: bool: Alias for transactions.

class pysui.sui.sui_types.scalars.SuiInteger(value: int)

Bases: SuiScalarType

Sui Number type.

__init__(value: int) → None: Initialize type.

property gas_budget: int: Alias for transactions.

property gas_price: int: Alias for transactions.

property amount: int: Alias for transactions.

property amounts: int: Alias for transactions.

property split_amounts: int: Alias for transactions.

property count: int: Alias for transactions.

property limit: int: Alias for transactions.

property start_time: int: Alias for transactions.

property end_time: int: Alias for transactions.

property start: int: Alias for transactions.

property end: int: Alias for transactions.

property epoch: int: Alias for transactions.

property sequence_number: int: Alias for transactions.

property id: int: Alias for transactions.

property version: int: Alias for transactions.

property cursor: str: Alias for transactions.

property arguments: str: Alias for transactions.

property split_count: int: Alias for transactions.

class pysui.sui.sui_types.scalars.SuiIntegerType

Bases: object

.

to_bytes() → bytes: .

property type_tag_name: str: .

classmethod to_best_fit_integer_type(value: int) → SuiIntegerType: .

class pysui.sui.sui_types.scalars.SuiU8(val: int | str)

Bases: SuiIntegerType

.

__init__(val: int | str): .

class pysui.sui.sui_types.scalars.SuiU16(val: int | str)

Bases: SuiIntegerType

.

__init__(val: int | str): .

class pysui.sui.sui_types.scalars.SuiU32(val: int | str)

Bases: SuiIntegerType

.

__init__(val: int | str): .

class pysui.sui.sui_types.scalars.SuiU64(val: int | str)

Bases: SuiIntegerType

.

__init__(val: int | str): .

class pysui.sui.sui_types.scalars.SuiU128(val: int | str)

Bases: SuiIntegerType

.

__init__(val: int | str): .

class pysui.sui.sui_types.scalars.SuiU256(val: int | str)

Bases: SuiIntegerType

.

__init__(val: int | str): .

pysui.sui.sui_types.transaction_filter module

Sui transaction filter types.

class pysui.sui.sui_types.transaction_filter.CheckpointQuery(check_point: int, options: dict | None = None)

Bases: _TransactionFilterType, SuiMap

Query by checkpoint.

__init__(check_point: int, options: dict | None = None): Initialize query parameter.

class pysui.sui.sui_types.transaction_filter.MoveFunctionQuery(package: str, module: str | None = None, function: str | None = None, options: dict | None = None)

Bases: _TransactionFilterType, SuiMap

Query by move function.

__init__(package: str, module: str | None = None, function: str | None = None, options: dict | None = None): Initialize query parameter.

class pysui.sui.sui_types.transaction_filter.InputObjectQuery(object_id: str | ObjectID, options: dict | None = None)

Bases: _TransactionFilterType, SuiMap

Query by input object.

__init__(object_id: str | ObjectID, options: dict | None = None): Initialize query parameter.

class pysui.sui.sui_types.transaction_filter.ChangedObjectQuery(object_id: str | ObjectID, options: dict | None = None)

Bases: _TransactionFilterType, SuiMap

Query by changed object, including created, mutated and unwrapped objects.

__init__(object_id: str | ObjectID, options: dict | None = None) → None: Initialize query parameter.

class pysui.sui.sui_types.transaction_filter.FromAddressQuery(address: str | SuiAddress, options: dict | None = None)

Bases: _TransactionFilterType, SuiMap

Query by sender address.

__init__(address: str | SuiAddress, options: dict | None = None): Initialize query parameter.

class pysui.sui.sui_types.transaction_filter.ToAddressQuery(address: str | SuiAddress, options: dict | None = None)

Bases: _TransactionFilterType, SuiMap

Query by recipient address.

__init__(address: str | SuiAddress, options: dict | None = None): Initialize query parameter.

class pysui.sui.sui_types.transaction_filter.FromAndToAddressQuery(from_address: str | SuiAddress, to_address: str | SuiAddress, options: dict | None = None)

Bases: _TransactionFilterType, SuiMap

Query by sender and recipient address.

__init__(from_address: str | SuiAddress, to_address: str | SuiAddress, options: dict | None = None): Initialize query parameter.

class pysui.sui.sui_types.transaction_filter.FromOrToAddressQuery(address: str | SuiAddress, options: dict | None = None)

Bases: _TransactionFilterType, SuiMap

Query by sender or recipient address, requires indexer.

Added in version 0.31.0: New filter supported in Sui RPC API 1.5.0

__init__(address: str | SuiAddress, options: dict | None = None): Initialize query parameter.

class pysui.sui.sui_types.transaction_filter.TransactionKindQuery(tx_kind: str, options: dict | None = None)

Bases: _TransactionFilterType, SuiMap

Query by transaction kind.

__init__(tx_kind: str, options: dict | None = None): Initialize query parameter.

class pysui.sui.sui_types.transaction_filter.TransactionKindInQuery(tx_kinds: list, options: dict | None = None)

Bases: _TransactionFilterType, SuiMap

Query by transactions of any given kind in the input, requires indexer.

Added in version 0.31.0: New filter supported in Sui RPC API 1.6.0

__init__(tx_kinds: list, options: dict | None = None): Initialize query parameter.

Module contents

Sui Types package.