pysui.sui.sui_builders package
Submodules
pysui.sui.sui_builders.base_builder module
Sui Builders: Common types.
- class pysui.sui.sui_builders.base_builder.SuiRequestType(value)
Bases:
IntEnum
SuiRequestType Defines the type of request being made when invoking sui_executeTransaction.
- Parameters:
IntEnum (IntEnum) – Base enumeration type
- Raises:
TypeError – If request type enum not known
- WAITFOREFFECTSCERT = 0
- WAITFORLOCALEXECUTION = 1
- as_str() str
Get scheme as string.
- property request_type: str
Satisfy transaction verification.
- class pysui.sui.sui_builders.base_builder.SuiTransactionBuilderMode(value)
Bases:
IntEnum
SuiTransactionBuilderMode Defines the mode of the transaction.
- Parameters:
IntEnum (IntEnum) – Base enumeration type
- Raises:
TypeError – If request type enum not known
- COMMIT = 0
- DEVINSPECT = 1
- as_str() str
Get scheme as string.
- property transactio_buid_type: str
Satisfy transaction verification.
- property txn_builder_mode: str
Satisfy transaction verification.
- property execution_mode: str
Satisfy transaction verification.
- class pysui.sui.sui_builders.base_builder.SuiBaseBuilder(method: str, txn_required: bool, handler_cls=None, handler_func=None)
Bases:
Builder
Base Sui API Builder Class.
Subclasses must identify public vars that are required by Sui RPC API.
- __init__(method: str, txn_required: bool, handler_cls=None, handler_func=None) None
__init__ Initialize builder.
- Parameters:
method (str) – The SUI RPC API method
txn_required (bool) – Indicate that this is a complex request or simple transaction
handler_cls (Type[SuiBaseType], optional) – Designate factor class for receipt data, defaults to None
handler_func (str, optional) – Name of function (either on class or regular function) to convert receipt data, defaults to None
- property params: dict
Return parameters list.
Changed in version 0.24.0: Moved from list to dict for RPC params
- property header: dict
Return copy of the current header.
- property method: str
Return method.
- property txn_required: bool
Get transaction required flag.
- handle_return(indata: dict) dict | SuiBaseType
Handle the expected return.
- classmethod value_type_validator(base_class_name: str, args: dict, builder_types: dict) dict | TypeError
value_type_validator Aligns and or coerces expected arg type from input arg value.
- Parameters:
base_class_name (str) – Class of type
args (dict) – Arguments passed to constructor
builder_types (dict) – Expected types for builder
- Raises:
TypeError – If missing or unresolvable coercion function
ValueError – If unresolvable type
- Returns:
Dictionary of argname to coerced argvalue
- Return type:
Union[dict, TypeError]
- pysui.sui.sui_builders.base_builder.sui_builder(*includes, **kwargs)
sui_builder Decorator to use in Builders.
pysui.sui.sui_builders.exec_builders module
Sui Builders: Complex transaction.
- class pysui.sui.sui_builders.exec_builders.ExecuteTransaction(*, tx_bytes: SuiTxBytes, signatures: SuiArray, options: SuiMap | None = None, request_type: SuiRequestType)
Bases:
_NativeTransactionBuilder
Submit a signed transaction to Sui.
Changed in version 0.51.0: added ‘showRawEffects’ to options flag
- __init__(*, tx_bytes: SuiTxBytes, signatures: SuiArray, options: SuiMap | None = None, request_type: SuiRequestType) None
__init__ Initialize builder.
- Parameters:
tx_bytes (SuiTxBytes) – BCS serialized transaction data bytes without its type tag, as base-64 encoded string
signatures (SuiArray[SuiSignature]) – Array of flag || signature || pubkey bytes, as base-64 encoded string, signatures are committed to the intent message of the transaction data, as base-64 encoded string wrapped in SuiSignatures.
request_type (SuiRequestType) – The request type
- class pysui.sui.sui_builders.exec_builders.DryRunTransaction(*, tx_bytes: SuiTxBytes)
Bases:
_NativeTransactionBuilder
Dry run a signed transaction to Sui.
- __init__(*, tx_bytes: SuiTxBytes) None
Initialize builder.
- class pysui.sui.sui_builders.exec_builders.InspectTransaction(*, sender_address: SuiAddress, tx_bytes: SuiString, gas_price: SuiString | None = None, epoch: SuiString | None = None, additional_args: SuiMap | None = None)
Bases:
_NativeTransactionBuilder
InspectTransaction when executed, return dev-inpsect results of the transaction.
Includes both the transaction effects and return values of the transaction.
- __init__(*, sender_address: SuiAddress, tx_bytes: SuiString, gas_price: SuiString | None = None, epoch: SuiString | None = None, additional_args: SuiMap | None = None) None
__init__ Initialize builder.
- Parameters:
sender_address – The sender/signer of transaction bytes
tx_bytes (SuiString) – BCS serialize base64 encoded string of TransactionKind
gas_price (Optional[SuiString]) – Gas is not charged, but gas usage is still calculated. Default to use reference gas price
epoch (Optional[SuiString]) – The epoch to perform the call. Will be set from the system state object if not provided
pysui.sui.sui_builders.get_builders module
Sui Builders: Simple sui_getXXX calls.
- class pysui.sui.sui_builders.get_builders.GetCoinMetaData(*args, **kwargs)
Bases:
_NativeTransactionBuilder
GetCoinMetaData returns meta data for a specific coin_type.
Deprecated since version 0.52.0: Use QueryNode equivalent
- class pysui.sui.sui_builders.get_builders.GetAllCoinBalances(*args, **kwargs)
Bases:
_NativeTransactionBuilder
GetAllCoinBalances Returns the total coin balances, for all coin types, owned by the address owner..
Deprecated since version 0.52.0: Use QueryNode equivalent
- __init__(*, owner: SuiAddress)
__init__ Initializes builder with address to fetch coin balances for.
- Parameters:
owner (SuiAddress) – the owner’s Sui address
- class pysui.sui.sui_builders.get_builders.GetAllCoins(*args, **kwargs)
Bases:
_NativeTransactionBuilder
GetAllCoins Returns all Coin objects owned by an address.
Deprecated since version 0.52.0: Use QueryNode equivalent
- __init__(*, owner: SuiAddress, cursor: ObjectID | None = None, limit: SuiInteger | None = None)
__init__ Initialize builder.
- Parameters:
owner (SuiAddress) – the coin owner’s address
cursor (ObjectID, optional) – Optional ObjectID as the starting item in returned page, defaults to None
limit (SuiInteger, optional) – Optional SuiInteger maximum number of items per page, defaults to None
- class pysui.sui.sui_builders.get_builders.GetCoinTypeBalance(*args, **kwargs)
Bases:
_NativeTransactionBuilder
GetCoinTypeBalance Return the total coin balance for a coin type.
Deprecated since version 0.52.0: Use QueryNode equivalent
- __init__(*, owner: SuiAddress, coin_type: SuiString | None = '0x2::sui::SUI')
__init__ Initialize builder.
- Parameters:
owner (SuiAddress) – The owner’s Sui address
coin_type (SuiString, optional) – The specific coin type string, defaults to “0x2::sui::SUI”
- class pysui.sui.sui_builders.get_builders.GetCoins(*args, **kwargs)
Bases:
_NativeTransactionBuilder
Return the list of Coin objects of specific coin_type owned by an address.
Deprecated since version 0.52.0: Use QueryNode equivalent
- __init__(*, owner: SuiAddress, coin_type: SuiString | None = '0x2::sui::SUI', cursor: ObjectID | None = None, limit: SuiInteger | None = None)
__init__ Initialize builder.
- Parameters:
owner (SuiAddress) – the coin owner’s Sui address
coin_type (SuiString, optional) – fully qualified type names for the coin, defaults to “0x2::sui::SUI”
cursor (ObjectID, optional) – Optional ObjectID as the starting item in returned page, defaults to None
limit (SuiInteger, optional) – maximum number of items per page, defaults to None
- class pysui.sui.sui_builders.get_builders.GetLatestSuiSystemState(*args, **kwargs)
Bases:
_NativeTransactionBuilder
GetLatestSuiSystemState return the latest known SUI system state.
Deprecated since version 0.52.0: Use QueryNode equivalent
- __init__() None
__init__ Initializes builder.
- class pysui.sui.sui_builders.get_builders.GetTotalSupply(*args, **kwargs)
Bases:
_NativeTransactionBuilder
Return the total supply for a given coin type (eg. 0x2::sui::SUI).
Deprecated since version 0.52.0: Use QueryNode equivalent
- class pysui.sui.sui_builders.get_builders.GetDynamicFieldObject(*args, **kwargs)
Bases:
_NativeTransactionBuilder
GetDynamicFieldObject when executed, return the dynamic field object information for a specified object.
Deprecated since version 0.52.0: Use QueryNode equivalent
- class pysui.sui.sui_builders.get_builders.GetDynamicFields(*args, **kwargs)
Bases:
_NativeTransactionBuilder
GetDynamicFields when executed, returns the list of dynamic field objects owned by an object.
Deprecated since version 0.52.0: Use QueryNode equivalent
- __init__(parent_object_id: ObjectID, cursor: ObjectID | None = None, limit: SuiInteger | None = None) None
__init__ Builder initializer.
- Parameters:
parent_object_id (ObjectID) – The ID of the queried parent object
cursor (SuiInteger, optional) – Optional paging cursor, defaults to None
limit – Maximum item returned per page, default to [QUERY_MAX_RESULT_LIMIT] if not specified, defaults to None
- class pysui.sui.sui_builders.get_builders.GetObject(*args, **kwargs)
Bases:
_NativeTransactionBuilder
GetObject When executed, returns the object detailed information for a specified object.
Deprecated since version 0.52.0: Use QueryNode equivalent
- __init__(*, object_id: ObjectID, options: SuiMap | None = None) None
__init__ Initializes builder.
- Parameters:
object_id (ObjectID) – Object identifier to fetch from chain
- classmethod object_options() dict
object_options get the default options for sui_getObject.
- Returns:
The default options map
- Return type:
dict
- classmethod package_options() dict
package_options get the options that correctly fetch package objects.
- Returns:
The package options map
- Return type:
dict
- class pysui.sui.sui_builders.get_builders.GetMultipleObjects(*args, **kwargs)
Bases:
_NativeTransactionBuilder
GetMultipleObjects When executed, returns the objects detailed information for a list of object identifiers.
Deprecated since version 0.52.0: Use QueryNode equivalent
- __init__(*, object_ids: SuiArray[ObjectID], options: SuiMap | None = None) None
__init__ Initializes builder.
- Parameters:
object_ids (SuiArray) – SuiArray[ObjectID] of object identifiers to fetch from chain
- classmethod object_options() dict
object_options get the default options for sui_getObject.
- Returns:
The default options map
- Return type:
dict
- classmethod package_options() dict
package_options get the options that correctly fetch package objects.
- Returns:
The package options map
- Return type:
dict
- class pysui.sui.sui_builders.get_builders.GetObjectsOwnedByAddress(*args, **kwargs)
Bases:
_NativeTransactionBuilder
GetObjectsOwnedByAddress When executed, returns the list of objects owned by an address.
Deprecated since version 0.52.0: Use QueryNode equivalent
- __init__(address: SuiAddress, query: SuiMap | None = None, cursor: ObjectID | None = None, limit: SuiInteger | None = None) None
__init__ Initialize builder.
- Parameters:
address (SuiAddress) – The owner address to fetch list of ObjectInfo results
- class pysui.sui.sui_builders.get_builders.GetPastObject(*args, **kwargs)
Bases:
_NativeTransactionBuilder
GetPastObject When executed, return the object information for a specified version.
Note there is no software-level guarantee/SLA that objects with past versions can be retrieved by this API, even if the object and version exists/existed. The result may vary across nodes depending on their pruning policies.
Deprecated since version 0.52.0: Use QueryNode equivalent
- __init__(object_id: ObjectID, version: SuiInteger, options: SuiMap | None = None) None
__init__ Initialize builder.
- Parameters:
sui_object (ObjectID, optional) – Object identifier to fetch from chain, defaults to None
version (SuiInteger, optional) – Specific version sequence number being requested, defaults to None
- class pysui.sui.sui_builders.get_builders.GetMultiplePastObjects(*args, **kwargs)
Bases:
_NativeTransactionBuilder
GetMultiplePastObjects When executed, return the object information for a specified version.
Note there is no software-level guarantee/SLA that objects with past versions can be retrieved by this API, even if the object and version exists/existed. The result may vary across nodes depending on their pruning policies.
Deprecated since version 0.52.0: Use QueryNode equivalent
- __init__(past_objects: SuiArray[SuiMap], options: SuiMap | None = None) None
__init__ Initialize builder.
- Parameters:
sui_object (ObjectID, optional) – Object identifier to fetch from chain, defaults to None
version (SuiInteger, optional) – Specific version sequence number being requested, defaults to None
- class pysui.sui.sui_builders.get_builders.GetPackage(*args, **kwargs)
Bases:
_NativeTransactionBuilder
GetPackage When executed, return structured representations of all modules in the given package.
Deprecated since version 0.52.0: Use QueryNode equivalent
- class pysui.sui.sui_builders.get_builders.GetModule(*args, **kwargs)
Bases:
_NativeTransactionBuilder
GetModule When executed, returns the structural representation of a module.
Includes general Module informationn as well as structure and function definitions.
Deprecated since version 0.52.0: Use QueryNode equivalent
- class pysui.sui.sui_builders.get_builders.GetFunction(*args, **kwargs)
Bases:
_NativeTransactionBuilder
GetFunction When executed, returns the structural representation of a module’s function.
Includes general function arguments and return type definitions.
Deprecated since version 0.52.0: Use QueryNode equivalent
- class pysui.sui.sui_builders.get_builders.GetFunctionArgs(*args, **kwargs)
Bases:
_NativeTransactionBuilder
GetFunction When executed, returns the argument types of a Move function.
Deprecated since version 0.52.0: Use QueryNode equivalent
- class pysui.sui.sui_builders.get_builders.GetStructure(*args, **kwargs)
Bases:
_NativeTransactionBuilder
GetStructure When executed, returns a module’s structure representation.
Deprecated since version 0.52.0: Use QueryNode equivalent
- class pysui.sui.sui_builders.get_builders.GetRpcAPI(*args, **kwargs)
Bases:
_NativeTransactionBuilder
GetRpcAPI When executed, returns full list of SUI node RPC API supported.
Deprecated since version 0.52.0: Use QueryNode equivalent
- __init__() None
Initialize builder.
- class pysui.sui.sui_builders.get_builders.GetCommittee(*args, **kwargs)
Bases:
_NativeTransactionBuilder
GetCommittee When executed, returns information on committee (collection of nodes).
Deprecated since version 0.52.0: Use QueryNode equivalent
- class pysui.sui.sui_builders.get_builders.QueryEvents(*args, **kwargs)
Bases:
_NativeTransactionBuilder
QueryEvents returns a list of events for a specified query criteria.
Deprecated since version 0.52.0: Use QueryNode equivalent
- __init__(*, query: SuiMap, cursor: EventID | None = None, limit: SuiInteger | None = None, descending_order: SuiBoolean | None = None) None
Initialize builder.
- class pysui.sui.sui_builders.get_builders.QueryTransactions(*args, **kwargs)
Bases:
_NativeTransactionBuilder
QueryTransactions returns a list of transactions for a specified query criteria..
Deprecated since version 0.52.0: Use QueryNode equivalent
- __init__(*, query: SuiMap, cursor: SuiString | None = None, limit: SuiInteger | None = None, descending_order: SuiBoolean | None = None) None
.
- class pysui.sui.sui_builders.get_builders.GetEvents(*args, **kwargs)
Bases:
_NativeTransactionBuilder
GetEvents When executed, return list of events for a specified query criteria.
Deprecated since version 0.52.0: Use QueryNode equivalent
- class pysui.sui.sui_builders.get_builders.GetTotalTxCount(*args, **kwargs)
Bases:
_NativeTransactionBuilder
GetTotalTxCount When executed, return the total number of transactions known to the server.
Deprecated since version 0.52.0: Use QueryNode equivalent
- __init__() None
Initialize builder.
- class pysui.sui.sui_builders.get_builders.GetTx(*args, **kwargs)
Bases:
_NativeTransactionBuilder
GetTx When executed, return the transaction response object.
Deprecated since version 0.52.0: Use QueryNode equivalent
- classmethod default_options() dict
default_options get the default options for fetching transactions.
- Returns:
The option flags map for sui_getTransaction
- Return type:
dict
- class pysui.sui.sui_builders.get_builders.GetMultipleTx(*args, **kwargs)
Bases:
_NativeTransactionBuilder
.
Deprecated since version 0.52.0: Use QueryNode equivalent
- classmethod default_options() dict
default_options get the default options for fetching transactions.
- Returns:
The option flags map for sui_multiGetTransactions
- Return type:
dict
- class pysui.sui.sui_builders.get_builders.GetDelegatedStakes(*args, **kwargs)
Bases:
_NativeTransactionBuilder
GetDelegatedStakes return all [DelegatedStake] coins for address owner.
Deprecated since version 0.52.0: Use QueryNode equivalent
- __init__(owner: SuiAddress)
__init__ Builder initializer.
- Parameters:
owner (SuiAddress) – SuiAddress of staked coin owner
- class pysui.sui.sui_builders.get_builders.GetStakesById(*args, **kwargs)
Bases:
_NativeTransactionBuilder
GetStakesById return all [DelegatedStake] coins identified.If a Stake was withdrawn its status will be Unstaked.
Deprecated since version 0.52.0: Use QueryNode equivalent
- class pysui.sui.sui_builders.get_builders.GetLatestCheckpointSequence(*args, **kwargs)
Bases:
_NativeTransactionBuilder
GetLatestCheckpointSequence return the sequence number of the latest checkpoint that has been executed.
Deprecated since version 0.52.0: Use QueryNode equivalent
- __init__()
__init__ Builder initializer.
- class pysui.sui.sui_builders.get_builders.GetCheckpointByDigest(*args, **kwargs)
Bases:
_NativeTransactionBuilder
GetCheckpointByDigest return a checkpoint for cp_id.
Deprecated since version 0.52.0: Use QueryNode equivalent
Changed in version 0.24.0: RPC expacts ‘id’ so correct during param fetch
- __init__(cp_id: SuiString)
__init__ Builder initializer.
- Parameters:
cp_id (SuiString) – Checkpoint digest id
- property params: dict
.
- class pysui.sui.sui_builders.get_builders.GetCheckpointBySequence(*args, **kwargs)
Bases:
_NativeTransactionBuilder
GetCheckpoint return a checkpoint for cp_id.
Deprecated since version 0.52.0: Use QueryNode equivalent
Changed in version 0.24.0: RPC expacts ‘id’ so correct during param fetch
- __init__(cp_seq: SuiString)
__init__ Builder initializer.
- Parameters:
cp_seq (SuiString) – Checkpoint sequence number
- property params: dict
.
- class pysui.sui.sui_builders.get_builders.GetCheckpoints(*args, **kwargs)
Bases:
_NativeTransactionBuilder
GetCheckpoints return paginated list of checkpoints.
Deprecated since version 0.52.0: Use QueryNode equivalent
- __init__(*, cursor: SuiString | None = None, limit: SuiInteger | None = None, descending_order: SuiBoolean | None = False)
Builder initializer.
- class pysui.sui.sui_builders.get_builders.GetReferenceGasPrice(*args, **kwargs)
Bases:
_NativeTransactionBuilder
GetReferenceGasPrice return the reference gas price for the network.
Deprecated since version 0.52.0: Use QueryNode equivalent
- __init__()
Builder initializer.
- class pysui.sui.sui_builders.get_builders.NameServiceAddress(*args, **kwargs)
Bases:
_NativeTransactionBuilder
Return the resolved address given resolver and name.
Deprecated since version 0.52.0: Use QueryNode equivalent
New in version 0.17.0: Support Sui 0.32.0 RPC API
- class pysui.sui.sui_builders.get_builders.NameServiceNames(*args, **kwargs)
Bases:
_NativeTransactionBuilder
Return the resolved names given address, if multiple names are resolved, the first one is the primary name.
Deprecated since version 0.52.0: Use QueryNode equivalent
New in version 0.17.0: Support Sui 0.32.0 RPC API
- __init__(*, address: SuiAddress, cursor: ObjectID | None = None, limit: SuiInteger | None = None)
Builder initializer.
- class pysui.sui.sui_builders.get_builders.GetLoadedChildObjects(*, digest: SuiString)
Bases:
_NativeTransactionBuilder
Returns the child object versions loaded by the object runtime particularly dynamic fields.
New in version 0.18.0: New Sui RPC API method.
- class pysui.sui.sui_builders.get_builders.GetValidatorsApy(*args, **kwargs)
Bases:
_NativeTransactionBuilder
Return the validator APY.
Deprecated since version 0.52.0: Use QueryNode equivalent
New in version 0.20.0: New Sui RPC API method.
- __init__()
Builder initializer.
- class pysui.sui.sui_builders.get_builders.GetProtocolConfig(*args, **kwargs)
Bases:
_NativeTransactionBuilder
Return the protocol config table for the given version number.
If the version number is not specified, the node uses the version of the latest epoch it has processed.
Deprecated since version 0.52.0: Use QueryNode equivalent
Changed in version 0.30.0: Generalizing Transaction constraints.
New in version 0.21.0: New Sui (1.1.0) RPC API method.
pysui.sui.sui_builders.subscription_builders module
Sui Builders: For subscriptions and filters.
- class pysui.sui.sui_builders.subscription_builders.SubscribeEvent(*, event_filter: _EventFilterType | None = None)
Bases:
_NativeTransactionBuilder
Parameter argument for suix_subscribeEvent.
- __init__(*, event_filter: _EventFilterType | None = None) None
__init__ Initializer.
This is the primary filter builder for event subscriptions. If event_filters argument is None it will default to
AllFilter
- Parameters:
event_filter (_EventFilterType, optional) – The filter of type _EventFilterType, defaults to None
- Raises:
AttributeError – If event_filters is not of type _EventFilterType
- set_event_filter(event_filter: SuiMap) SubscribeEvent
Update the event filter.
Module contents
Sui Builders package.