pysui.sui package
Subpackages
- pysui.sui.sui_builders package
- Submodules
- pysui.sui.sui_builders.base_builder module
- pysui.sui.sui_builders.exec_builders module
- pysui.sui.sui_builders.get_builders module
GetCoinMetaData
GetAllCoinBalances
GetAllCoins
GetCoinTypeBalance
GetCoins
GetLatestSuiSystemState
GetTotalSupply
GetDynamicFieldObject
GetDynamicFields
GetObject
GetMultipleObjects
GetObjectsOwnedByAddress
GetPastObject
GetMultiplePastObjects
GetPackage
GetModule
GetFunction
GetFunctionArgs
GetStructure
GetRpcAPI
GetCommittee
QueryEvents
QueryTransactions
GetEvents
GetTotalTxCount
GetTx
GetMultipleTx
GetDelegatedStakes
GetStakesById
GetLatestCheckpointSequence
GetCheckpointByDigest
GetCheckpointBySequence
GetCheckpoints
GetReferenceGasPrice
NameServiceAddress
NameServiceNames
GetLoadedChildObjects
GetValidatorsApy
GetProtocolConfig
GetChainID
- pysui.sui.sui_builders.subscription_builders module
- Module contents
- pysui.sui.sui_clients package
- Submodules
- pysui.sui.sui_clients.async_client module
SuiClient
SuiClient.__init__()
SuiClient.is_synchronous
SuiClient.execute()
SuiClient.execute_no_sign()
SuiClient.execute_with_multisig()
SuiClient.sign_and_submit()
SuiClient.dry_run()
SuiClient.close()
SuiClient.get_gas()
SuiClient.get_coin()
SuiClient.get_gas_from_faucet()
SuiClient.get_objects()
SuiClient.get_object()
SuiClient.get_objects_for()
SuiClient.get_package()
SuiClient.get_events()
- pysui.sui.sui_clients.common module
SuiRpcResult
PreExecutionResult
pysui_default_handler()
handle_result()
ClientMixin
ClientMixin.__init__()
ClientMixin.transport_open
ClientMixin.is_synchronous
ClientMixin.current_gas_price
ClientMixin.rpc_version
ClientMixin.request_type
ClientMixin.set_request_type
ClientMixin.rpc_api
ClientMixin.rpc_api_names
ClientMixin.api_exists()
ClientMixin.close()
ClientMixin.rpc_version_support()
ClientMixin.version_at_least()
ClientMixin.sign_for_execution()
ClientMixin.protocol
ClientMixin.max_gets
- pysui.sui.sui_clients.subscribe module
- pysui.sui.sui_clients.sync_client module
SuiClient
SuiClient.__init__()
SuiClient.is_synchronous
SuiClient.execute()
SuiClient.execute_no_sign()
SuiClient.execute_with_multisig()
SuiClient.sign_and_submit()
SuiClient.dry_run()
SuiClient.close()
SuiClient.get_gas()
SuiClient.get_coin()
SuiClient.get_gas_from_faucet()
SuiClient.get_object()
SuiClient.get_objects()
SuiClient.get_objects_for()
SuiClient.get_package()
SuiClient.get_events()
- Module contents
- pysui.sui.sui_pgql package
- Submodules
- pysui.sui.sui_pgql.pgql_clients module
PGQL_QueryNode
PGQL_NoOp
PGQL_Fragment
BaseSuiGQLClient
BaseSuiGQLClient.__init__()
BaseSuiGQLClient.config
BaseSuiGQLClient.current_gas_price
BaseSuiGQLClient.rpc_config
BaseSuiGQLClient.protocol
BaseSuiGQLClient.url
BaseSuiGQLClient.client
BaseSuiGQLClient.chain_id
BaseSuiGQLClient.chain_environment
BaseSuiGQLClient.schema_version
BaseSuiGQLClient.base_schema_version
BaseSuiGQLClient.schema
SuiGQLClient
AsyncSuiGQLClient
- pysui.sui.sui_pgql.pgql_configs module
ServiceConfigGQL
ServiceConfigGQL.enabledFeatures
ServiceConfigGQL.maxQueryDepth
ServiceConfigGQL.maxQueryNodes
ServiceConfigGQL.maxOutputNodes
ServiceConfigGQL.defaultPageSize
ServiceConfigGQL.maxDbQueryCost
ServiceConfigGQL.maxPageSize
ServiceConfigGQL.requestTimeoutMs
ServiceConfigGQL.maxQueryPayloadSize
ServiceConfigGQL.__init__()
ServiceConfigGQL.dataclass_json_config
ServiceConfigGQL.from_dict()
ServiceConfigGQL.from_json()
ServiceConfigGQL.schema()
ServiceConfigGQL.to_dict()
ServiceConfigGQL.to_json()
CheckpointNodeGQL
CheckpointNodeGQL.sequenceNumber
CheckpointNodeGQL.timestamp
CheckpointNodeGQL.epoch
CheckpointNodeGQL.reference_gas_price
CheckpointNodeGQL.__init__()
CheckpointNodeGQL.dataclass_json_config
CheckpointNodeGQL.from_dict()
CheckpointNodeGQL.from_json()
CheckpointNodeGQL.schema()
CheckpointNodeGQL.to_dict()
CheckpointNodeGQL.to_json()
CheckpointConnectionGQL
SuiConfigGQL
SuiConfigGQL.chainIdentifier
SuiConfigGQL.serviceConfig
SuiConfigGQL.protocolConfig
SuiConfigGQL.checkpoints
SuiConfigGQL.gqlEnvironment
SuiConfigGQL.from_query()
SuiConfigGQL.__init__()
SuiConfigGQL.dataclass_json_config
SuiConfigGQL.from_dict()
SuiConfigGQL.from_json()
SuiConfigGQL.schema()
SuiConfigGQL.to_dict()
SuiConfigGQL.to_json()
pgql_config()
- pysui.sui.sui_pgql.pgql_fragments module
- pysui.sui.sui_pgql.pgql_query module
GetCoinMetaData
GetAllCoinBalances
GetCoins
GetLatestSuiSystemState
GetObject
GetObjectsOwnedByAddress
GetMultipleGasObjects
GetMultipleObjects
GetPastObject
GetMultiplePastObjects
GetDynamicFields
GetEvents
GetTx
GetMultipleTx
GetDelegatedStakes
GetLatestCheckpointSequence
GetCheckpointByDigest
GetCheckpointBySequence
GetCheckpoints
GetProtocolConfig
GetReferenceGasPrice
GetNameServiceAddress
GetNameServiceNames
GetValidatorsApy
GetCurrentValidators
GetStructure
GetStructures
GetFunction
GetFunctions
GetModule
GetPackage
DryRunTransactionKind
DryRunTransaction
ExecuteTransaction
GetAllCoins
GetCoinTypeBalance
GetTotalSupply
GetFunctionArgs
GetTotalTxCount
QueryEvents
QueryTransactions
GetChainID
GetStakesByIds
GetRpcAPI
GetLoadedChildObjects
GetCommittee
- pysui.sui.sui_pgql.pgql_sync_txn module
SuiTransaction
SuiTransaction.__init__()
SuiTransaction.transaction_data()
SuiTransaction.build()
SuiTransaction.build_and_sign()
SuiTransaction.split_coin()
SuiTransaction.merge_coins()
SuiTransaction.split_coin_equal()
SuiTransaction.split_coin_and_return()
SuiTransaction.transfer_objects()
SuiTransaction.transfer_sui()
SuiTransaction.public_transfer_object()
SuiTransaction.make_move_vector()
SuiTransaction.move_call()
SuiTransaction.stake_coin()
SuiTransaction.unstake_coin()
SuiTransaction.publish()
SuiTransaction.publish_upgrade()
SuiTransaction.custom_upgrade()
- pysui.sui.sui_pgql.pgql_txb_gas module
- pysui.sui.sui_pgql.pgql_txb_signing module
- pysui.sui.sui_pgql.pgql_txn_argb module
- pysui.sui.sui_pgql.pgql_types module
PGQL_Type
PagingCursor
NoopGQL
ErrorGQL
ObjectReadDeletedGQL
ObjectReadDeletedGQL.version
ObjectReadDeletedGQL.object_id
ObjectReadDeletedGQL.object_kind
ObjectReadDeletedGQL.__init__()
ObjectReadDeletedGQL.dataclass_json_config
ObjectReadDeletedGQL.from_dict()
ObjectReadDeletedGQL.from_json()
ObjectReadDeletedGQL.schema()
ObjectReadDeletedGQL.to_dict()
ObjectReadDeletedGQL.to_json()
SuiObjectOwnedShared
SuiObjectOwnedShared.obj_owner_kind
SuiObjectOwnedShared.initial_version
SuiObjectOwnedShared.__init__()
SuiObjectOwnedShared.dataclass_json_config
SuiObjectOwnedShared.from_dict()
SuiObjectOwnedShared.from_json()
SuiObjectOwnedShared.schema()
SuiObjectOwnedShared.to_dict()
SuiObjectOwnedShared.to_json()
SuiObjectOwnedAddress
SuiObjectOwnedAddress.obj_owner_kind
SuiObjectOwnedAddress.address_id
SuiObjectOwnedAddress.__init__()
SuiObjectOwnedAddress.dataclass_json_config
SuiObjectOwnedAddress.from_dict()
SuiObjectOwnedAddress.from_json()
SuiObjectOwnedAddress.schema()
SuiObjectOwnedAddress.to_dict()
SuiObjectOwnedAddress.to_json()
SuiObjectOwnedParent
SuiObjectOwnedImmutable
SuiCoinObjectGQL
SuiCoinObjectGQL.coin_type
SuiCoinObjectGQL.version
SuiCoinObjectGQL.object_digest
SuiCoinObjectGQL.balance
SuiCoinObjectGQL.previous_transaction
SuiCoinObjectGQL.has_public_transfer
SuiCoinObjectGQL.coin_object_id
SuiCoinObjectGQL.object_owner
SuiCoinObjectGQL.object_id
SuiCoinObjectGQL.from_query()
SuiCoinObjectGQL.__init__()
SuiCoinObjectGQL.dataclass_json_config
SuiCoinObjectGQL.from_dict()
SuiCoinObjectGQL.from_json()
SuiCoinObjectGQL.schema()
SuiCoinObjectGQL.to_dict()
SuiCoinObjectGQL.to_json()
SuiCoinFromObjectsGQL
SuiCoinFromObjectsGQL.data
SuiCoinFromObjectsGQL.from_query()
SuiCoinFromObjectsGQL.__init__()
SuiCoinFromObjectsGQL.dataclass_json_config
SuiCoinFromObjectsGQL.from_dict()
SuiCoinFromObjectsGQL.from_json()
SuiCoinFromObjectsGQL.schema()
SuiCoinFromObjectsGQL.to_dict()
SuiCoinFromObjectsGQL.to_json()
SuiCoinObjectsGQL
SuiStakedCoinGQL
SuiStakedCoinGQL.poolId
SuiStakedCoinGQL.version
SuiStakedCoinGQL.has_public_transfer
SuiStakedCoinGQL.principal
SuiStakedCoinGQL.estimated_reward
SuiStakedCoinGQL.activated
SuiStakedCoinGQL.requested
SuiStakedCoinGQL.status
SuiStakedCoinGQL.object_id
SuiStakedCoinGQL.object_digest
SuiStakedCoinGQL.object_owner
SuiStakedCoinGQL.from_query()
SuiStakedCoinGQL.__init__()
SuiStakedCoinGQL.dataclass_json_config
SuiStakedCoinGQL.from_dict()
SuiStakedCoinGQL.from_json()
SuiStakedCoinGQL.schema()
SuiStakedCoinGQL.to_dict()
SuiStakedCoinGQL.to_json()
SuiStakedCoinsGQL
SuiStakedCoinsGQL.owner
SuiStakedCoinsGQL.staked_coins
SuiStakedCoinsGQL.next_cursor
SuiStakedCoinsGQL.from_query()
SuiStakedCoinsGQL.__init__()
SuiStakedCoinsGQL.dataclass_json_config
SuiStakedCoinsGQL.from_dict()
SuiStakedCoinsGQL.from_json()
SuiStakedCoinsGQL.schema()
SuiStakedCoinsGQL.to_dict()
SuiStakedCoinsGQL.to_json()
ObjectReadGQL
ObjectReadGQL.version
ObjectReadGQL.object_id
ObjectReadGQL.object_digest
ObjectReadGQL.previous_transaction_digest
ObjectReadGQL.object_kind
ObjectReadGQL.storage_rebate
ObjectReadGQL.bcs
ObjectReadGQL.object_owner
ObjectReadGQL.has_public_transfer
ObjectReadGQL.object_type
ObjectReadGQL.content
ObjectReadGQL.owner_id
ObjectReadGQL.from_query()
ObjectReadGQL.__init__()
ObjectReadGQL.dataclass_json_config
ObjectReadGQL.from_dict()
ObjectReadGQL.from_json()
ObjectReadGQL.schema()
ObjectReadGQL.to_dict()
ObjectReadGQL.to_json()
ObjectReadsGQL
EventGQL
EventsGQL
TxBlockListGQL
CheckpointGQL
CheckpointGQL.digest
CheckpointGQL.sequence_number
CheckpointGQL.timestamp
CheckpointGQL.networkTotalTransactions
CheckpointGQL.transaction_blocks
CheckpointGQL.previous_checkpoint_digest
CheckpointGQL.from_query()
CheckpointGQL.from_last_checkpoint()
CheckpointGQL.__init__()
CheckpointGQL.dataclass_json_config
CheckpointGQL.from_dict()
CheckpointGQL.from_json()
CheckpointGQL.schema()
CheckpointGQL.to_dict()
CheckpointGQL.to_json()
CheckpointsGQL
BalanceGQL
BalancesGQL
SuiCoinMetadataGQL
SuiCoinMetadataGQL.decimals
SuiCoinMetadataGQL.name
SuiCoinMetadataGQL.symbol
SuiCoinMetadataGQL.description
SuiCoinMetadataGQL.supply
SuiCoinMetadataGQL.address
SuiCoinMetadataGQL.icon_url
SuiCoinMetadataGQL.from_query()
SuiCoinMetadataGQL.__init__()
SuiCoinMetadataGQL.dataclass_json_config
SuiCoinMetadataGQL.from_dict()
SuiCoinMetadataGQL.from_json()
SuiCoinMetadataGQL.schema()
SuiCoinMetadataGQL.to_dict()
SuiCoinMetadataGQL.to_json()
TransactionResultGQL
TransactionResultGQL.expiration
TransactionResultGQL.gas_input
TransactionResultGQL.effects
TransactionResultGQL.digest
TransactionResultGQL.sender
TransactionResultGQL.from_query()
TransactionResultGQL.__init__()
TransactionResultGQL.dataclass_json_config
TransactionResultGQL.from_dict()
TransactionResultGQL.from_json()
TransactionResultGQL.schema()
TransactionResultGQL.to_dict()
TransactionResultGQL.to_json()
DryRunResultGQL
DryRunResultGQL.transaction_block
DryRunResultGQL.results
DryRunResultGQL.error
DryRunResultGQL.from_query()
DryRunResultGQL.__init__()
DryRunResultGQL.dataclass_json_config
DryRunResultGQL.from_dict()
DryRunResultGQL.from_json()
DryRunResultGQL.schema()
DryRunResultGQL.to_dict()
DryRunResultGQL.to_json()
ExecutionResultGQL
ExecutionResultGQL.status
ExecutionResultGQL.lamport_version
ExecutionResultGQL.digest
ExecutionResultGQL.errors
ExecutionResultGQL.from_query()
ExecutionResultGQL.__init__()
ExecutionResultGQL.dataclass_json_config
ExecutionResultGQL.from_dict()
ExecutionResultGQL.from_json()
ExecutionResultGQL.schema()
ExecutionResultGQL.to_dict()
ExecutionResultGQL.to_json()
TransactionSummaryGQL
TransactionSummaryGQL.digest
TransactionSummaryGQL.status
TransactionSummaryGQL.timestamp
TransactionSummaryGQL.errors
TransactionSummaryGQL.from_query()
TransactionSummaryGQL.__init__()
TransactionSummaryGQL.dataclass_json_config
TransactionSummaryGQL.from_dict()
TransactionSummaryGQL.from_json()
TransactionSummaryGQL.schema()
TransactionSummaryGQL.to_dict()
TransactionSummaryGQL.to_json()
TransactionSummariesGQL
TransactionSummariesGQL.data
TransactionSummariesGQL.next_cursor
TransactionSummariesGQL.from_query()
TransactionSummariesGQL.__init__()
TransactionSummariesGQL.dataclass_json_config
TransactionSummariesGQL.from_dict()
TransactionSummariesGQL.from_json()
TransactionSummariesGQL.schema()
TransactionSummariesGQL.to_dict()
TransactionSummariesGQL.to_json()
ValidatorGQL
ValidatorGQL.validator_name
ValidatorGQL.validator_address
ValidatorGQL.description
ValidatorGQL.project_url
ValidatorGQL.staking_pool_sui_balance
ValidatorGQL.pending_stake
ValidatorGQL.pending_pool_token_withdraw
ValidatorGQL.pending_total_sui_withdraw
ValidatorGQL.voting_power
ValidatorGQL.next_epoch_stake
ValidatorGQL.gas_price
ValidatorGQL.next_epoch_gas_price
ValidatorGQL.commission_rate
ValidatorGQL.next_epoch_commission_rate
ValidatorGQL.at_risk
ValidatorGQL.from_query()
ValidatorGQL.__init__()
ValidatorGQL.dataclass_json_config
ValidatorGQL.from_dict()
ValidatorGQL.from_json()
ValidatorGQL.schema()
ValidatorGQL.to_dict()
ValidatorGQL.to_json()
ValidatorSetGQL
ValidatorSetGQL.total_stake
ValidatorSetGQL.validators
ValidatorSetGQL.pending_removals
ValidatorSetGQL.pending_active_validators_size
ValidatorSetGQL.inactive_pools_size
ValidatorSetGQL.validator_candidates_size
ValidatorSetGQL.from_query()
ValidatorSetGQL.__init__()
ValidatorSetGQL.dataclass_json_config
ValidatorSetGQL.from_dict()
ValidatorSetGQL.from_json()
ValidatorSetGQL.schema()
ValidatorSetGQL.to_dict()
ValidatorSetGQL.to_json()
ReferenceGasPriceGQL
ReferenceGasPriceGQL.reference_gas_price
ReferenceGasPriceGQL.from_query()
ReferenceGasPriceGQL.__init__()
ReferenceGasPriceGQL.dataclass_json_config
ReferenceGasPriceGQL.from_dict()
ReferenceGasPriceGQL.from_json()
ReferenceGasPriceGQL.schema()
ReferenceGasPriceGQL.to_dict()
ReferenceGasPriceGQL.to_json()
SystemStateSummaryGQL
SystemStateSummaryGQL.system_state_version
SystemStateSummaryGQL.total_transactions
SystemStateSummaryGQL.reference_gas_price
SystemStateSummaryGQL.system_parameters
SystemStateSummaryGQL.validator_set
SystemStateSummaryGQL.storage_fund
SystemStateSummaryGQL.safe_mode
SystemStateSummaryGQL.from_query()
SystemStateSummaryGQL.__init__()
SystemStateSummaryGQL.dataclass_json_config
SystemStateSummaryGQL.from_dict()
SystemStateSummaryGQL.from_json()
SystemStateSummaryGQL.schema()
SystemStateSummaryGQL.to_dict()
SystemStateSummaryGQL.to_json()
TransactionConstraints
TransactionConstraints.protocol_version
TransactionConstraints.max_arguments
TransactionConstraints.max_input_objects
TransactionConstraints.max_num_transferred_move_object_ids
TransactionConstraints.max_programmable_tx_commands
TransactionConstraints.max_pure_argument_size
TransactionConstraints.max_tx_size_bytes
TransactionConstraints.max_type_argument_depth
TransactionConstraints.max_type_arguments
TransactionConstraints.max_tx_gas
TransactionConstraints.receive_objects
TransactionConstraints.__init__()
TransactionConstraints.from_dict()
TransactionConstraints.from_json()
TransactionConstraints.schema()
TransactionConstraints.to_dict()
TransactionConstraints.to_json()
KeyValue
ProtocolConfigGQL
ProtocolConfigGQL.protocolVersion
ProtocolConfigGQL.configs
ProtocolConfigGQL.featureFlags
ProtocolConfigGQL.transaction_constraints
ProtocolConfigGQL.from_query()
ProtocolConfigGQL.__init__()
ProtocolConfigGQL.dataclass_json_config
ProtocolConfigGQL.from_dict()
ProtocolConfigGQL.from_json()
ProtocolConfigGQL.schema()
ProtocolConfigGQL.to_dict()
ProtocolConfigGQL.to_json()
MoveStructureGQL
MoveStructureGQL.struct_name
MoveStructureGQL.abilities
MoveStructureGQL.fields
MoveStructureGQL.from_query()
MoveStructureGQL.__init__()
MoveStructureGQL.dataclass_json_config
MoveStructureGQL.from_dict()
MoveStructureGQL.from_json()
MoveStructureGQL.schema()
MoveStructureGQL.to_dict()
MoveStructureGQL.to_json()
MoveStructuresGQL
RefType
MoveTypeArg
MoveScalarArg
MoveObjectRefArg
MoveObjectRefArg.ref_type
MoveObjectRefArg.type_package
MoveObjectRefArg.type_module
MoveObjectRefArg.type_struct
MoveObjectRefArg.type_params
MoveObjectRefArg.is_optional
MoveObjectRefArg.is_receiving
MoveObjectRefArg.has_type
MoveObjectRefArg.from_body()
MoveObjectRefArg.__init__()
MoveObjectRefArg.dataclass_json_config
MoveObjectRefArg.from_dict()
MoveObjectRefArg.from_json()
MoveObjectRefArg.schema()
MoveObjectRefArg.to_dict()
MoveObjectRefArg.to_json()
MoveVectorArg
MoveListArg
MoveWitnessArg
MoveArgSummary
MoveFunctionGQL
MoveFunctionGQL.function_name
MoveFunctionGQL.is_entry
MoveFunctionGQL.visibility
MoveFunctionGQL.type_parameters
MoveFunctionGQL.parameters
MoveFunctionGQL.returns
MoveFunctionGQL.from_query()
MoveFunctionGQL.arg_summary()
MoveFunctionGQL.__init__()
MoveFunctionGQL.dataclass_json_config
MoveFunctionGQL.from_dict()
MoveFunctionGQL.from_json()
MoveFunctionGQL.schema()
MoveFunctionGQL.to_dict()
MoveFunctionGQL.to_json()
MoveFunctionsGQL
MoveModuleGQL
MovePackageGQL
ValidatorFullGQL
ValidatorFullGQL.validator_name
ValidatorFullGQL.validator_address
ValidatorFullGQL.description
ValidatorFullGQL.imageUrl
ValidatorFullGQL.projectUrl
ValidatorFullGQL.stakingPoolSuiBalance
ValidatorFullGQL.stakingPoolActivationEpoch
ValidatorFullGQL.exchangeRatesSize
ValidatorFullGQL.rewardsPool
ValidatorFullGQL.poolTokenBalance
ValidatorFullGQL.pendingStake
ValidatorFullGQL.pendingTotalSuiWithdraw
ValidatorFullGQL.pendingPoolTokenWithdraw
ValidatorFullGQL.votingPower
ValidatorFullGQL.gasPrice
ValidatorFullGQL.commissionRate
ValidatorFullGQL.nextEpochStake
ValidatorFullGQL.nextEpochGasPrice
ValidatorFullGQL.nextEpochCommissionRate
ValidatorFullGQL.apy
ValidatorFullGQL.atRisk
ValidatorFullGQL.operating_cap_address
ValidatorFullGQL.exchange_rates_address
ValidatorFullGQL.staking_pool_address
ValidatorFullGQL.from_query()
ValidatorFullGQL.__init__()
ValidatorFullGQL.dataclass_json_config
ValidatorFullGQL.from_dict()
ValidatorFullGQL.from_json()
ValidatorFullGQL.schema()
ValidatorFullGQL.to_dict()
ValidatorFullGQL.to_json()
ValidatorSetsGQL
ValidatorSetsGQL.totalStake
ValidatorSetsGQL.pendingRemovals
ValidatorSetsGQL.pendingActiveValidatorsId
ValidatorSetsGQL.pendingActiveValidatorsSize
ValidatorSetsGQL.stakingPoolMappingsId
ValidatorSetsGQL.inactivePoolsId
ValidatorSetsGQL.validatorCandidatesId
ValidatorSetsGQL.validatorCandidatesSize
ValidatorSetsGQL.validators
ValidatorSetsGQL.next_cursor
ValidatorSetsGQL.from_query()
ValidatorSetsGQL.__init__()
ValidatorSetsGQL.dataclass_json_config
ValidatorSetsGQL.from_dict()
ValidatorSetsGQL.from_json()
ValidatorSetsGQL.schema()
ValidatorSetsGQL.to_dict()
ValidatorSetsGQL.to_json()
ValidatorApyGQL
ValidatorApysGQL
DynamicFieldGQL
DynamicFieldsGQL
DynamicFieldsGQL.parent_object_id
DynamicFieldsGQL.version
DynamicFieldsGQL.next_cursor
DynamicFieldsGQL.dynamic_fields
DynamicFieldsGQL.__init__()
DynamicFieldsGQL.dataclass_json_config
DynamicFieldsGQL.from_dict()
DynamicFieldsGQL.from_json()
DynamicFieldsGQL.from_query()
DynamicFieldsGQL.schema()
DynamicFieldsGQL.to_dict()
DynamicFieldsGQL.to_json()
- pysui.sui.sui_pgql.pgql_validators module
- Module contents
- pysui.sui.sui_txn package
- Submodules
- pysui.sui.sui_txn.async_transaction module
SuiTransactionAsync
SuiTransactionAsync.__init__()
SuiTransactionAsync.get_transaction_data()
SuiTransactionAsync.execute()
SuiTransactionAsync.deferred_execution()
SuiTransactionAsync.inspect_all()
SuiTransactionAsync.make_move_vector()
SuiTransactionAsync.move_call()
SuiTransactionAsync.publish()
SuiTransactionAsync.publish_upgrade()
SuiTransactionAsync.custom_upgrade()
SuiTransactionAsync.stake_coin()
SuiTransactionAsync.unstake_coin()
SuiTransactionAsync.split_coin()
SuiTransactionAsync.split_coin_equal()
SuiTransactionAsync.split_coin_and_return()
SuiTransactionAsync.merge_coins()
SuiTransactionAsync.public_transfer_object()
SuiTransactionAsync.transfer_objects()
SuiTransactionAsync.transfer_sui()
- pysui.sui.sui_txn.signing_ms module
- pysui.sui.sui_txn.sync_transaction module
SuiTransaction
SuiTransaction.__init__()
SuiTransaction.inspect_all()
SuiTransaction.inspect_for_cost()
SuiTransaction.get_transaction_data()
SuiTransaction.execute()
SuiTransaction.deferred_execution()
SuiTransaction.make_move_vector()
SuiTransaction.move_call()
SuiTransaction.publish()
SuiTransaction.publish_upgrade()
SuiTransaction.custom_upgrade()
SuiTransaction.stake_coin()
SuiTransaction.unstake_coin()
SuiTransaction.split_coin()
SuiTransaction.split_coin_equal()
SuiTransaction.split_coin_and_return()
SuiTransaction.merge_coins()
SuiTransaction.public_transfer_object()
SuiTransaction.transfer_objects()
SuiTransaction.transfer_sui()
- pysui.sui.sui_txn.transaction module
- pysui.sui.sui_txn.transaction_builder module
serialize_uint32_as_uleb128()
PureInput
ProgrammableTransactionBuilder
ProgrammableTransactionBuilder.__init__()
ProgrammableTransactionBuilder.finish_for_inspect()
ProgrammableTransactionBuilder.input_pure()
ProgrammableTransactionBuilder.input_obj()
ProgrammableTransactionBuilder.input_obj_from_objarg()
ProgrammableTransactionBuilder.command()
ProgrammableTransactionBuilder.make_move_vector()
ProgrammableTransactionBuilder.move_call()
ProgrammableTransactionBuilder.split_coin()
ProgrammableTransactionBuilder.merge_coins()
ProgrammableTransactionBuilder.transfer_objects()
ProgrammableTransactionBuilder.transfer_sui()
ProgrammableTransactionBuilder.publish()
ProgrammableTransactionBuilder.authorize_upgrade()
ProgrammableTransactionBuilder.publish_upgrade()
ProgrammableTransactionBuilder.commit_upgrade()
- pysui.sui.sui_txn.txn_deser module
- Module contents
- pysui.sui.sui_txresults package
- Submodules
- pysui.sui.sui_txresults.common module
- pysui.sui.sui_txresults.complex_tx module
TxGasData
ChangeEpoch
Genesis
ConsensusCommitPrologue
ConsensusCommitPrologueV2
ProgrammableTransaction
AuthenticatorStateUpdate
RandomnessStateUpdate
EndOfEpochTransaction
TransactionData
MultiSigPublicKey
MultiSig
Transaction
Event
EventBlock
GasCostSummary
Status
Effects
Effects.status
Effects.message_version
Effects.gas_used
Effects.transaction_digest
Effects.gas_object
Effects.modified_at_versions
Effects.dependencies
Effects.mutated
Effects.created
Effects.deleted
Effects.wrapped
Effects.unwrapped
Effects.unwrapped_then_deleted
Effects.shared_objects
Effects.executed_epoch
Effects.events_digest
Effects.__init__()
TxResponse
TxResponse.digest
TxResponse.raw_transaction
TxResponse.balance_changes
TxResponse.object_changes
TxResponse.transaction
TxResponse.errors
TxResponse.effects
TxResponse.events
TxResponse.checkpoint
TxResponse.confirmed_local_execution
TxResponse.timestamp_ms
TxResponse.raw_effects
TxResponse.succeeded
TxResponse.status
TxResponse.__init__()
TxResponseArray
DryRunTxResult
TxInspectionResult
TransactionBytes
ECMHLiveObjectSetDigest
EndOfEpoch
Checkpoint
Checkpoint.checkpoint_commitments
Checkpoint.digest
Checkpoint.epoch
Checkpoint.epoch_rolling_gas_cost_summary
Checkpoint.validator_signature
Checkpoint.network_total_transactions
Checkpoint.sequence_number
Checkpoint.timestamp_ms
Checkpoint.previous_digest
Checkpoint.end_of_epoch_data
Checkpoint.transactions
Checkpoint.__init__()
Checkpoints
NameServices
SubscribedEventParms
SubscribedEvent
SubscribedTransactionParms
SubscribedTransaction
TransactionQueryEnvelope
EventQueryEnvelope
AuxInputs
PublicInputs
ZKLoginProof
ZkLoginAuthenticator
- pysui.sui.sui_txresults.package_meta module
- pysui.sui.sui_txresults.single_tx module
FaucetGas
FaucetGasRequest
ObjectReadData
ObjectPackageReadData
ObjectNotExist
ObjectVersionNotFound
ObjectVersionTooHigh
ObjectDeleted
AddressOwner
ObjectOwner
SharedOwner
ImmutableOwner
NotRequestedOwner
ObjectRawData
DisplayFields
ObjectRead
ObjectRead.version
ObjectRead.object_id
ObjectRead.previous_transaction
ObjectRead.object_type
ObjectRead.storage_rebate
ObjectRead.content
ObjectRead.bcs
ObjectRead.digest
ObjectRead.display
ObjectRead.owner
ObjectRead.identifier
ObjectRead.balance
ObjectRead.type_signature
ObjectRead.owner_address
ObjectRead.differentiate()
ObjectRead.factory()
ObjectRead.__init__()
ObjectReadPage
ObjectRawPackage
ObjectRawRead
SuiPackage
SuiData
SuiCoin
SuiGas
Committee
CommitteeInfo
Table
StakingPool
StakingPool.activation_epoch
StakingPool.deactivation_epoch
StakingPool.exchange_rates
StakingPool.stakinig_pool_id
StakingPool.pending_delegation
StakingPool.pending_pool_token_withdraw
StakingPool.pending_total_sui_withdraw
StakingPool.pool_token_balance
StakingPool.rewards_pool
StakingPool.sui_balance
StakingPool.__init__()
ValidatorMetaData
ValidatorMetaData.description
ValidatorMetaData.image_url
ValidatorMetaData.name
ValidatorMetaData.net_address
ValidatorMetaData.network_pubkey_bytes
ValidatorMetaData.next_epoch_net_address
ValidatorMetaData.next_epoch_network_pubkey_bytes
ValidatorMetaData.next_epoch_p2p_address
ValidatorMetaData.next_epoch_primary_address
ValidatorMetaData.next_epoch_proof_of_possession
ValidatorMetaData.next_epoch_protocol_pubkey_bytes
ValidatorMetaData.next_epoch_worker_address
ValidatorMetaData.next_epoch_worker_pubkey_bytes
ValidatorMetaData.p2p_address
ValidatorMetaData.primary_address
ValidatorMetaData.project_url
ValidatorMetaData.proof_of_possession_bytes
ValidatorMetaData.protocol_pubkey_bytes
ValidatorMetaData.sui_address
ValidatorMetaData.worker_address
ValidatorMetaData.worker_pubkey_bytes
ValidatorMetaData.__init__()
ValidatorSummary
ValidatorSummary.commission_rate
ValidatorSummary.description
ValidatorSummary.exchange_rates_id
ValidatorSummary.exchange_rates_size
ValidatorSummary.gas_price
ValidatorSummary.image_url
ValidatorSummary.name
ValidatorSummary.net_address
ValidatorSummary.network_pubkey_bytes
ValidatorSummary.next_epoch_commission_rate
ValidatorSummary.next_epoch_gas_price
ValidatorSummary.next_epoch_net_address
ValidatorSummary.next_epoch_network_pubkey_bytes
ValidatorSummary.next_epoch_p2p_address
ValidatorSummary.next_epoch_primary_address
ValidatorSummary.next_epoch_proof_of_possession
ValidatorSummary.next_epoch_protocol_pubkey_bytes
ValidatorSummary.next_epoch_stake
ValidatorSummary.next_epoch_worker_address
ValidatorSummary.next_epoch_worker_pubkey_bytes
ValidatorSummary.operation_cap_id
ValidatorSummary.p2p_address
ValidatorSummary.pending_stake
ValidatorSummary.pending_pool_token_withdraw
ValidatorSummary.pending_total_sui_withdraw
ValidatorSummary.pool_token_balance
ValidatorSummary.primary_address
ValidatorSummary.project_url
ValidatorSummary.proof_of_possession_bytes
ValidatorSummary.protocol_pubkey_bytes
ValidatorSummary.rewards_pool
ValidatorSummary.staking_pool_activation_epoch
ValidatorSummary.staking_pool_deactivation_epoch
ValidatorSummary.staking_pool_id
ValidatorSummary.staking_pool_sui_balance
ValidatorSummary.sui_address
ValidatorSummary.voting_power
ValidatorSummary.worker_address
ValidatorSummary.worker_pubkey_bytes
ValidatorSummary.__init__()
SuiLatestSystemState
SuiLatestSystemState.active_validators
SuiLatestSystemState.at_risk_validators
SuiLatestSystemState.epoch
SuiLatestSystemState.epoch_duration_ms
SuiLatestSystemState.epoch_start_timestamp_ms
SuiLatestSystemState.inactive_pools_id
SuiLatestSystemState.inactive_pools_size
SuiLatestSystemState.max_validator_count
SuiLatestSystemState.min_validator_joining_stake
SuiLatestSystemState.pending_active_validators_id
SuiLatestSystemState.pending_active_validators_size
SuiLatestSystemState.pending_removals
SuiLatestSystemState.protocol_version
SuiLatestSystemState.reference_gas_price
SuiLatestSystemState.safe_mode
SuiLatestSystemState.safe_mode_computation_rewards
SuiLatestSystemState.safe_mode_non_refundable_storage_fee
SuiLatestSystemState.safe_mode_storage_rebates
SuiLatestSystemState.safe_mode_storage_rewards
SuiLatestSystemState.stake_subsidy_balance
SuiLatestSystemState.stake_subsidy_current_distribution_amount
SuiLatestSystemState.stake_subsidy_decrease_rate
SuiLatestSystemState.stake_subsidy_distribution_counter
SuiLatestSystemState.stake_subsidy_period_length
SuiLatestSystemState.stake_subsidy_start_epoch
SuiLatestSystemState.staking_pool_mappings_id
SuiLatestSystemState.staking_pool_mappings_size
SuiLatestSystemState.storage_fund_non_refundable_balance
SuiLatestSystemState.storage_fund_total_object_storage_rebates
SuiLatestSystemState.system_state_version
SuiLatestSystemState.total_stake
SuiLatestSystemState.validator_candidates_id
SuiLatestSystemState.validator_candidates_size
SuiLatestSystemState.validator_low_stake_threshold
SuiLatestSystemState.validator_report_records
SuiLatestSystemState.validator_very_low_stake_threshold
SuiLatestSystemState.validator_low_stake_grace_period
SuiLatestSystemState.__init__()
StakedSui
DelegatedStake
DelegatedStakes
SuiCoinMetadata
SuiCoinBalance
CoinBalances
SuiCoinObject
SuiCoinObjects
DynamicFieldInfo
DynamicFields
LoadedChildObject
LoadedChildObjectsResponse
ValidatorApy
ValidatorApys
TransactionConstraints
TransactionConstraints.protocol_version
TransactionConstraints.max_arguments
TransactionConstraints.max_input_objects
TransactionConstraints.max_num_transferred_move_object_ids
TransactionConstraints.max_programmable_tx_commands
TransactionConstraints.max_pure_argument_size
TransactionConstraints.max_tx_size_bytes
TransactionConstraints.max_type_argument_depth
TransactionConstraints.max_type_arguments
TransactionConstraints.max_tx_gas
TransactionConstraints.feature_dict
TransactionConstraints.__init__()
ProtocolConfig
- Module contents
- pysui.sui.sui_types package
- Submodules
- pysui.sui.sui_types.address module
- pysui.sui.sui_types.bcs module
Address
Digest
BuilderArg
ObjectReference
SharedObjectReference
Uint256
U256
OptionalU8
OptionalU16
OptionalU32
OptionalU64
OptionalU128
OptionalU256
TypeTag
StructTag
ObjectArg
CallArg
GasData
Argument
OptionalTypeTag
Optional
OptionalTypeFactory
ProgrammableMoveCall
TransferObjects
SplitCoin
MergeCoins
Publish
MakeMoveVec
Upgrade
Command
ProgrammableTransaction
TransactionKind
TransactionExpiration
TransactionDataV1
TransactionData
MsPublicKey
MsEd25519PublicKey
MsSecp256k1PublicKey
MsSecp256r1PublicKey
MsNewPublicKey
MsBitmap
MsCompressedSig
MultiSignature
TxStringInt
TxStringString
TxTransaction
TxSenderMulti
TxSenderSingle
TxSender
SuiTransactionDataV1
SuiTransaction
- pysui.sui.sui_types.collections module
SuiCollection
SuiArray
SuiArray.__init__()
SuiArray.append()
SuiArray.extend()
SuiArray.input_coins
SuiArray.coins
SuiArray.recipients
SuiArray.amounts
SuiArray.amount
SuiArray.split_amounts
SuiArray.type_arguments
SuiArray.arguments
SuiArray.compiled_modules
SuiArray.dependencies
SuiArray.single_transaction_params
SuiArray.digests
SuiArray.signatures
SuiArray.object_ids
SuiArray.staked_sui_ids
SuiMap
BatchParameter
EventID
- pysui.sui.sui_types.event_filter module
SenderEventQuery
TransactionEventQuery
PackageEventQuery
MoveEventModuleQuery
MoveModuleEventQuery
MoveEventTypeQuery
MoveEventFieldQuery
TimeRangeEventQuery
AndFilter
OrFilter
AllFilter
AnyFilter
CheckpointEvent
MoveFunctionEvent
InputObjectEvent
ChangedObjectEvent
FromAddressEvent
ToAddressEvent
FromAndToAddressEvent
TransactionKindEvent
- pysui.sui.sui_types.scalars module
SuiNullType
SuiString
SuiString.__init__()
SuiString.id
SuiString.function
SuiString.name
SuiString.function_name
SuiString.module
SuiString.module_name
SuiString.struct_name
SuiString.arguments
SuiString.type_arguments
SuiString.compiled_modules
SuiString.cursor
SuiString.move_event_struct_name
SuiString.digest
SuiString.query
SuiString.recipient
SuiString.coin_type
SuiString.limit
SuiString.commitment_type
SuiString.tx_bytes
SuiString.amounts
SuiString.transaction_digest
SuiString.gas_budget
SuiString.amount
SuiString.split_count
SuiTxBytes
SuiSignature
SuiTransactionDigest
ObjectID
ObjectID.object_id
ObjectID.object_ids
ObjectID.object
ObjectID.package
ObjectID.package_object_id
ObjectID.parent_object_id
ObjectID.sui_object_id
ObjectID.coin_object_id
ObjectID.staked_sui
ObjectID.staked_sui_ids
ObjectID.gas
ObjectID.input_coins
ObjectID.coins
ObjectID.delegation
ObjectID.primary_coin
ObjectID.coin_to_merge
SuiBoolean
SuiInteger
SuiInteger.__init__()
SuiInteger.gas_budget
SuiInteger.gas_price
SuiInteger.amount
SuiInteger.amounts
SuiInteger.split_amounts
SuiInteger.count
SuiInteger.limit
SuiInteger.start_time
SuiInteger.end_time
SuiInteger.start
SuiInteger.end
SuiInteger.epoch
SuiInteger.sequence_number
SuiInteger.id
SuiInteger.version
SuiInteger.cursor
SuiInteger.arguments
SuiInteger.split_count
SuiIntegerType
SuiU8
SuiU16
SuiU32
SuiU64
SuiU128
SuiU256
- pysui.sui.sui_types.transaction_filter module
- Module contents
Submodules
pysui.sui.sui_apidesc module
Sui RPC API Descriptor.
- class pysui.sui.sui_apidesc.SuiJsonType
Bases:
ABC
Sui Json Type.
- class pysui.sui.sui_apidesc.SuiJsonNull(type: str, type_path: list[str])
Bases:
DataClassJsonMixin
,SuiJsonType
Sui Json Null Value.
- type: str
- type_path: list[str]
- __init__(type: str, type_path: list[str]) None
- class pysui.sui.sui_apidesc.SuiJsonValue(type: str, type_path: list[str])
Bases:
DataClassJsonMixin
,SuiJsonType
Sui Json Value.
- type: str
- type_path: list[str]
- __init__(type: str, type_path: list[str]) None
- class pysui.sui.sui_apidesc.SuiJsonString(type: str, type_path: list[str])
Bases:
DataClassJsonMixin
,SuiJsonType
Sui Json String.
- type: str
- type_path: list[str]
- __init__(type: str, type_path: list[str]) None
- class pysui.sui.sui_apidesc.SuiJsonBoolean(type: bool, type_path: list[str])
Bases:
DataClassJsonMixin
,SuiJsonType
Sui Json Boolean.
- type: bool
- type_path: list[str]
- __init__(type: bool, type_path: list[str]) None
- class pysui.sui.sui_apidesc.SuiJsonInteger(type: str, type_path: list[str], format: str, minimum: float)
Bases:
DataClassJsonMixin
,SuiJsonType
Sui Json Integer.
- type: str
- type_path: list[str]
- format: str
- minimum: float
- __init__(type: str, type_path: list[str], format: str, minimum: float) None
- class pysui.sui.sui_apidesc.SuiJsonArray(type: str, type_path: list[str], items: SuiJsonType)
Bases:
DataClassJsonMixin
,SuiJsonType
Sui Json Array.
- type: str
- type_path: list[str]
- items: SuiJsonType
- __init__(type: str, type_path: list[str], items: SuiJsonType) None
- class pysui.sui.sui_apidesc.SuiJsonTuple(type: str, type_path: list[str], items: SuiJsonType, minItems: int | None = None, maxItems: int | None = None)
Bases:
DataClassJsonMixin
,SuiJsonType
Sui Json Tuple.
- type: str
- type_path: list[str]
- items: SuiJsonType
- minItems: int = None
- maxItems: int = None
- __init__(type: str, type_path: list[str], items: SuiJsonType, minItems: int | None = None, maxItems: int | None = None) None
- class pysui.sui.sui_apidesc.SuiJsonEnum(type: str, type_path: list[str], enum: list[str])
Bases:
DataClassJsonMixin
,SuiJsonType
Sui Json Enum.
- type: str
- type_path: list[str]
- enum: list[str]
- __init__(type: str, type_path: list[str], enum: list[str]) None
- class pysui.sui.sui_apidesc.SuiJsonObject(type: str, type_path: list[str])
Bases:
DataClassJsonMixin
,SuiJsonType
Sui Json Enum.
- type: str
- type_path: list[str]
- __init__(type: str, type_path: list[str]) None
- class pysui.sui.sui_apidesc.SuiApiParam(name: str, schema: dict | SuiJsonType, required: bool = False, description: str = '')
Bases:
object
Sui API Parameter Data Class.
- name: str
- classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) SchemaF[A]
- required: bool = False
- description: str = ''
- __init__(name: str, schema: dict | SuiJsonType, required: bool = False, description: str = '') None
- classmethod from_dict(kvs: dict | list | str | int | float | bool | None, *, infer_missing=False) A
- classmethod from_json(s: str | bytes | bytearray, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) A
- to_dict(encode_json=False) Dict[str, dict | list | str | int | float | bool | None]
- to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: str | int | None = None, separators: Tuple[str, str] | None = None, default: Callable | None = None, sort_keys: bool = False, **kw) str
- class pysui.sui.sui_apidesc.SuiApiResult(name: str, schema: dict | SuiJsonType, required: bool | None = False)
Bases:
object
Sui API Result Data Class.
- name: str
- classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) SchemaF[A]
- required: bool | None = False
- __init__(name: str, schema: dict | SuiJsonType, required: bool | None = False) None
- classmethod from_dict(kvs: dict | list | str | int | float | bool | None, *, infer_missing=False) A
- classmethod from_json(s: str | bytes | bytearray, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) A
- to_dict(encode_json=False) Dict[str, dict | list | str | int | float | bool | None]
- to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: str | int | None = None, separators: Tuple[str, str] | None = None, default: Callable | None = None, sort_keys: bool = False, **kw) str
- class pysui.sui.sui_apidesc.SuiApi(name: str, params: list[SuiApiParam], result: SuiApiResult, description: str = '')
Bases:
DataClassJsonMixin
Sui API Data Class.
- name: str
- params: list[SuiApiParam]
- result: SuiApiResult
- description: str = ''
- __init__(name: str, params: list[SuiApiParam], result: SuiApiResult, description: str = '') None
- pysui.sui.sui_apidesc.build_api_descriptors(indata: dict) tuple[str, dict, dict]
Build the schema dictionary then API call dictionary.
pysui.sui.sui_bcs module
Sui BCS Conversions [EXPERIMENTAL].
- pysui.sui.sui_bcs.get_txkind_from_tx_bytes(tx_bytes: str) bytes
get_txkind_from_tx_bytes extracts the TransactionKind bytes from tx_bytes.
- Parameters:
tx_bytes (str) – base64 transaction bytes string
- Returns:
Transaction Kind as bytes.
- Return type:
bytes
- pysui.sui.sui_bcs.get_txkind_from_result_asb64(indata: SuiRpcResult) str | SuiRpcResult
inspect_ready_txkind_from_result Return a serialized TransactionKind as base64 encoded string.
Can be then used to submit to InspectTransaction
- Parameters:
indata (SuiRpcResult) – The result of calling a complex transaction prior to signing
- Returns:
A base64 encoded serialized TransactionKind
- Return type:
str
- pysui.sui.sui_bcs.get_txkind_from_result(indata: SuiRpcResult) TransactionKind | Exception
transaction_kind_from_rpcresult converts the transaction bytes into BCS TransactionKind struct.
- Parameters:
indata (SuiRpcResult) – The result of calling a complex transaction prior to signing
- Raises:
ValueError – If the SuiRpcResult contains error
- Returns:
A TransactionKind structure represented in the SuiRpcResult base64 transaciton bytes
- Return type:
Union[bcs.TransactionKind, Exception]
pysui.sui.sui_config module
Default Sui Configuration.
- class pysui.sui.sui_config.SuiConfig(config_path: str, keystore_file: str, alias_file: str | None = None)
Bases:
ClientConfiguration
Sui default configuration class.
- rename_alias(*, old_alias: str, new_alias: str) None
rename_alias Renames existing alias.
- Parameters:
old_alias (str) – Existing alias name
new_alias (str) – Replacement name
- Raises:
ValueError – Invalid arguments
- Returns:
None
- Return type:
NoneType
- create_new_keypair_and_address(*, scheme: SignatureScheme, word_counts: int | None = 12, derivation_path: str | None = None, make_active: bool | None = False, alias: str | None = None) tuple[str, SuiAddress]
create_new_keypair_and_address Create a new keypair and address identifier and writes to client.yaml.
- Parameters:
scheme (SignatureScheme) – Identifies whether new key is ed25519, secp256k1 or secp256r1
word_counts (int, optional) – count of words to generate mnemonic phrase, defaults to 12
derivation_path (str, optional) – The derivation path for key, specific to Signature scheme, defaults to root path of scheme
make_active (bool, optional) – Flag to make address from created KeyPair the ‘active_address’, defaults to False
alias (Optional[str], optional) – Associates alias string to newly created kp and address,defaults to None If not provide, alias will be generated
- Raises:
NotImplementedError – When providing unregognized scheme
- Returns:
The input or generated mnemonic string and the new keypair associated SuiAddress
- Return type:
tuple[str, SuiAddress]
Changed in version 0.42.0: Changed to require keyword arguments.
Changed in version 0.41.0: Added make_active flag.
Changed in version 0.41.0: Support aliases.
Changed in version 0.33.0: Return mnemonics to caller.
- recover_keypair_and_address(scheme: SignatureScheme, mnemonics: str | list[str], derivation_path: str, install: bool = False, make_active: bool | None = False, alias: str | None = None) tuple[str, SuiAddress]
recover_keypair_and_address Recover a keypair from mnemonic string.
- Parameters:
scheme (SignatureScheme) – Identifies whether new key is ed25519, secp256k1 or secp256r1
mnemonics (str) – string of phrases separated by spaces
derivation_path (str) – The derivation path for key, specific to Signature scheme
install (bool, optional) – Flag indicating to write back to sui.keystore, defaults to False This flag is ignored if config was initiated through ‘user_config()’
make_active (bool, optional) – Flag to make address from created KeyPair the ‘active_address’, defaults to False
alias (Optional[str], optional) – Associates alias string to newly created kp and address,defaults to None If not provide, alias will be generated
- Raises:
NotImplementedError – When providing unregognized scheme
ValueError – If recovered keypair/address already exists
- Returns:
The input mnemonic string and the new keypair associated SuiAddress
- Return type:
tuple[str, SuiAddress]
Changed in version 0.41.0: Added make_active flag.
Changed in version 0.41.0: Support aliases.
Changed in version 0.33.0: If install is True, checks if not in ‘user_config’ setup before writing
Added in version 0.24.0: Added to recover keypairs
- add_keypair_from_keystring(*, keystring: str | dict, install: bool = False, make_active: bool | None = False, alias: str | None = False) SuiAddress
add_keypair_from_keystring Adds a KeyPair from Sui keystring.
- Parameters:
keystring (Union[str, dict]) –
Either a valid Sui keystring (flag | private 32 byte seed) in base64 form or a dictionary for conversion from wallet:
{ 'wallet_key':'0x.....', # Wallet exported key hex string 'key_scheme': SignatureScheme.ED25519 # Must align with wallet_key type }
install (bool, optional) – Flag indicating to write back to sui.keystore, defaults to False This flag is ignored if config was initiated through ‘user_config()’
make_active (bool, optional) – Flag to make address from created KeyPair the ‘active_address’, defaults to False
alias (Optional[str], optional) – Associates alias string to newly created kp and address,defaults to None If not provide, alias will be generated
- Raises:
ValueError – If the derived address is already registered in SuiConfig
- Returns:
The derived SuiAddress
- Return type:
Changed in version 0.41.0: Support aliases.
Added in version 0.33.0: Allow import from valid Sui keystring or Wallet key export
- classmethod default_config() SuiConfig
default_config Loads the configuration created by use of sui binaries sui client
- Raises:
SuiFileNotFound – If Sui configuration does not exist
- Returns:
Instantiated configuration ready for use
- Return type:
Changed in version 0.41.0: Sui aliases configuration feature added
Added in version 0.16.1: New loading of default configuration.
- classmethod pysui_config(cfg_path: str) SuiConfig
pysui_config Loads an alternate configuration from specified path.
This behaves as a normal configuration where address and alias adds/changes are persisted
- Parameters:
cfg_path (str) – path to folder holding alternate configuration
- Raises:
SuiFileNotFound – If path is invalid
- Returns:
Instantiated configuration ready for use
- Return type:
Added in version 0.51.0: New alternate configuration path loading.
- classmethod sui_base_config() SuiConfig
sui_base_config Loads the active configuration set by suibase
- Returns:
Instantiated configuration ready for use
- Return type:
Added in version 0.16.1: Supporting more flexible non-default configurations
- classmethod user_config(*, rpc_url: str, prv_keys: list[str | dict] | None = None, ws_url: str | None = None, gql_url: str | None = None) SuiConfig
user_config Load a user defined configuraiton.
Note: New address/keypairs added in this session are not persisted. Note: publish is not available in this option.
- Parameters:
rpc_url (str) – he RPC url for RPC API interaction
prv_keys (Optional[list[Union[str, dict]]], optional) –
Optional list containing either valid Sui keystrings (flag | private 32 byte seed) in base64 form and/or valid Sui bech32 encoded keystrings ‘suiprivkey1xyxy’ and/or dictionaries for conversion from Wallet key exports:
{ 'wallet_key':'0x.....', # Wallet exported key hex string 'key_scheme': SignatureScheme.ED25519 # Must align with wallet_key type }
ws_url (Optional[str], optional) – Optional wss url for subscriptions, defaults to None
gql_url (Optional[str], optional) – Optional GraphQL RPC url, defaults to None
- Returns:
An instance of SuiConfig that can be used to initialize a SuiClient
- Return type:
Changed in version 0.57.0: Add gql_url argument to support setting GraphQL RPC host URL
Changed in version 0.34.0: Add support for suibase localnet proxy
Changed in version 0.33.0: Add support for importing Wallet private keys
Changed in version 0.26.0: Relax initialization requirements of prv_keys
Added in version 0.25.0: Removes reliance on client.yaml
- property rpc_url: str
Return the current URL.
- property graphql_url: str
Return the GraphQL RPC URL.
- property local_config: bool
Return the mode we are running in.
- property faucet_url: str
Return faucet url.
- property socket_url: str
Return socket url.
- property active_address: SuiAddress
Return the current address.
- property environment: str
environment Return the current environment of config in use.
- Returns:
The environment name
- Return type:
str
- set_active_address(address: SuiAddress) SuiAddress
Change the active address to address.
pysui.sui.sui_constants module
Sui Constants.
- pysui.sui.sui_constants.PYSUI_EXEC_ENV: str = 'SUI_EXEC'
Holds the fully qualified path to the active sui binary.
- pysui.sui.sui_constants.PYSUI_CLIENT_CONFIG_ENV: str = 'SUI_CLIENT_CONFIG'
Holds the fully qualified path to the active client.yaml.
- pysui.sui.sui_constants.PYSUI_RPC_VERSION: str = 'SUI_RPC_VERSION'
Holds the RPC version detected at runtime.
- pysui.sui.sui_constants.SUI_BASE_ACTIVE: str = '~/suibase/workdirs/active'
sui-base symbolic link to what configuration is active.
- pysui.sui.sui_constants.SUI_BASE_EXEC_PATH: str = 'target/debug/sui'
sui-base binary location relative to the active configuration workdir.
- pysui.sui.sui_constants.DEFAULT_SUI_BINARY_PATH: str = '~/.cargo/bin/sui'
The default fully qualified sui binary path.
- pysui.sui.sui_constants.DEFAULT_ALIAS_PATH_STRING: str = '~/.sui/sui_config/sui.aliases'
Devnet client configuration default.
- pysui.sui.sui_constants.DEVNET_ENVIRONMENT_KEY: str = 'devnet'
Devnet client configuration environment alias.
- pysui.sui.sui_constants.LOCALNET_ENVIRONMENT_KEY: str = 'localnet'
Localnet client configuration environment alias.
- pysui.sui.sui_constants.TESTNET_ENVIRONMENT_KEY: str = 'testnet'
Testnet client configuration environment alias.
- pysui.sui.sui_constants.DEVNET_SUI_URL: str = 'https://fullnode.devnet.sui.io:443'
Devnet Sui client url.
- pysui.sui.sui_constants.DEVNET_FAUCET_STATUS_URLV1: str = 'https://faucet.devnet.sui.io/v1/status/'
Devnet client faucet url V1.
- pysui.sui.sui_constants.DEVNET_SOCKET_URL: str = 'wss://fullnode.devnet.sui.io:443'
Devnet socket url.
- pysui.sui.sui_constants.LOCALNET_SUI_URL: str = 'https://127.0.0.1:9000'
Testnet Sui client url.
- pysui.sui.sui_constants.LOCALNET_PROXY_SUI_URL: str = 'http://0.0.0.0:44340'
Testnet Sui proxy client url.
- pysui.sui.sui_constants.LOCALNET_FAUCET_URL: str = 'http://127.0.0.1:9123/gas'
Localnet client faucet url.
- pysui.sui.sui_constants.LOCALNET_SOCKET_URL: str = 'ws://127.0.0.1:9000'
Localnet socket url.
- pysui.sui.sui_constants.TESTNET_SUI_URL: str = 'https://fullnode.testnet.sui.io:443'
Testnet Sui client url.
- pysui.sui.sui_constants.TESTNET_SOCKET_URL: str = 'wss://fullnode.testnet.sui.io:443'
Testnet socket url.
- pysui.sui.sui_constants.MAINNET_SUI_URL: str = 'https://fullnode.mainnet.sui.io:443'
Testnet Sui client url.
- pysui.sui.sui_constants.MAINNET_FAUCET_URL: str = ''
Mainnet client faucet url.
- pysui.sui.sui_constants.MAINNET_SOCKET_URL: str = 'wss://fullnode.mainnet.sui.io:443'
Testnet socket url.
- pysui.sui.sui_constants.EMPEHMERAL_PATH: str = 'ephemeral'
A user memory only configuration path
- pysui.sui.sui_constants.EMPEHMERAL_USER: str = 'user'
A user memory only configuration
- pysui.sui.sui_constants.SUI_MIN_ALIAS_LEN: int = 3
Minimal length of an alias name string.
- pysui.sui.sui_constants.SUI_MAX_ALIAS_LEN: int = 64
Maximum length of an alias name string.
- pysui.sui.sui_constants.SUI_HEX_ADDRESS_STRING_LEN: int = 66
Length of valid address string with ‘0x’ prefix.
- pysui.sui.sui_constants.SUI_ADDRESS_STRING_LEN: int = 64
Length of valid address string without ‘0x’ prefix.
- pysui.sui.sui_constants.SUI_KEYPAIR_LEN: int = 44
Length of valid key string base64 string.
- pysui.sui.sui_constants.SUI_BECH32_HRP: str = 'suiprivkey'
Private Key bech32 private key encoding human readable portion
- pysui.sui.sui_constants.PRIVATE_KEY_BYTE_LEN: int = 32
Byte length of general private key
- pysui.sui.sui_constants.SCHEME_PRIVATE_KEY_BYTE_LEN: int = 33
Byte length of general signature scheme and private key
- pysui.sui.sui_constants.ED25519_KEYPAIR_BYTES_LEN: int = 32
Length of ED25519 keypair bytes.
- pysui.sui.sui_constants.ED25519_PUBLICKEY_BYTES_LEN: int = 32
Length of ED25519 public key bytes.
- pysui.sui.sui_constants.ED25519_PRIVATEKEY_BYTES_LEN: int = 32
Length of ED25519 private key bytes.
- pysui.sui.sui_constants.SECP256K1_KEYPAIR_BYTES_LEN: int = 32
Length of SECP256K1 keypair bytes.
- pysui.sui.sui_constants.SECP256K1_PUBLICKEY_BYTES_LEN: int = 33
Length of SECP256K1 public key bytes.
- pysui.sui.sui_constants.SECP256K1_PRIVATEKEY_BYTES_LEN: int = 32
Length of SECP256K1 private key bytes.
- pysui.sui.sui_constants.SECP256R1_KEYPAIR_BYTES_LEN: int = 32
Length of SECP256R1 keypair bytes.
- pysui.sui.sui_constants.SECP256R1_PUBLICKEY_BYTES_LEN: int = 33
Length of SECP256R1 public key bytes.
- pysui.sui.sui_constants.SECP256R1_PRIVATEKEY_BYTES_LEN: int = 32
Length of SECP256R1 private key bytes.
pysui.sui.sui_crypto module
Sui Crpto Keys and Keypairs.
- class pysui.sui.sui_crypto.SuiPublicKey(scheme: SignatureScheme, key_bytes: bytes)
Bases:
PublicKey
SuiPublicKey Sui Basic public key.
- property pub_key: str
Return self as base64 encoded string.
- class pysui.sui.sui_crypto.SuiPrivateKey(scheme: SignatureScheme, key_bytes: bytes)
Bases:
PrivateKey
SuiPrivateKey Sui Basic private/signing key.
Changed in version 0.33.0: Converted to use pysui-fastcrypto
- sign_secure(tx_data: str) list
sign_secure Sign transaction intent.
- Parameters:
public_key (SuiPublicKey) – PublicKey from signer/private key
tx_data (str) – Transaction bytes being signed
- Returns:
Singed transaction as list of u8 bytes
- Return type:
list
- class pysui.sui.sui_crypto.SuiKeyPair
Bases:
KeyPair
SuiKeyPair Sui Basic keypair.
Changed in version 0.33.0: Converted to use pysui-fastcrypto
- __init__() None
__init__ Default keypair initializer.
- property private_key: SuiPrivateKey | None
Return the Private Key.
- property public_key: SuiPublicKey | None
Return the Public Key.
- property scheme: SignatureScheme
Get the keys scheme.
- new_sign_secure(tx_data: str) SuiSignature
New secure sign with intent.
Changed in version 0.33.0: Changes to SuiPrivateKey
- sign_message(message: str) str
Sign arbitrary message, returning it’s base64 raw signature.
Changed in version 0.34.0: Added to sign arbirary messages
- verify_signature(message: str, sig: str) bool
Sign arbitrary message, returning it’s base64 raw signature.
Changed in version 0.34.0: Added to verify signature of message
- serialize_to_bytes() bytes
serialize_to_bytes Returns a SUI conforming keystring as bytes.
- Returns:
Bytes of signature scheme + private key
- Return type:
bytes
- serialize() str
serialize Returns a SUI conforming keystring.
- Returns:
a base64 encoded string of schema and private key bytes
- Return type:
str
- to_bytes() bytes
Convert keypair to bytes.
- classmethod from_pfc_bytes(scheme: SignatureScheme, pub_bytes: bytes, prv_bytes: bytes) SuiKeyPair
Convert bytes to keypair.
- classmethod from_b64(indata: str) SuiKeyPair
Generate KeyPair from base64 keystring.
- class pysui.sui.sui_crypto.BaseMultiSig(sui_pub_keys: list[SuiPublicKey], weights: list[int], threshold: int)
Bases:
object
.
- __init__(sui_pub_keys: list[SuiPublicKey], weights: list[int], threshold: int)
Validating initialization of components.
- property scheme: SignatureScheme
Return the MultiSig signature scheme.
- property address: str
Return the address string generated from the initial keys.
Changed in version 0.16.1: Return add as str to align with non MultiSig SuiAddress behavior
- property as_sui_address: SuiAddress
Return the address as SuiAddress.
Added in version 0.16.1: Provide ability to get MultiSig as SuiAddress
- property public_keys: list[SuiPublicKey]
Return a copy of the list of SuiPublicKeys used in this MultiSig.
- property weights: list[int]
Return a copy of the list of weights used in this MultiSig.
- property threshold: int
Return the threshold amount used in this MultiSig.
- validate_signers(pub_keys: list[SuiPublicKey]) list[int] | ValueError
Validate pubkeys part of multisig and have enough weight.
Changed in version 0.21.1: Exposed as public for use by SuiTransaction
- signature_from(pub_keys: list[SuiPublicKey], signatures: list[SuiSignature]) SuiSignature
signature_from Creates a multisig signature from signed bytes.
- Parameters:
pub_keys (list[SuiPublicKey]) – List of public keys associated to keypairs that created signatures
signatures (list[SuiSignature]) – Signatures from signed transaction bytes digest
- Returns:
A multisig signature
- Return type:
- class pysui.sui.sui_crypto.MultiSig(suikeys: list[SuiKeyPair], weights: list[int], threshold: int)
Bases:
BaseMultiSig
Multi signature support.
- __init__(suikeys: list[SuiKeyPair], weights: list[int], threshold: int)
__init__ Initiate a MultiSig object.
Note that Sui multi-sig accepts up to a maximum of ten (10) individual signer keys.
- Parameters:
suikeys (list[SuiKeyPair]) – The list of keys participating in the multi-sig signing operations.
weights (list[int]) – Corresponding weights for each key. Max value of each weight is 255 (8 bit unsigned)
threshold (int) – The threshold criteria for this MultiSig. Max value is 2549 (16 bit unsigned)
- property full_keys: list[SuiKeyPair]
.
- sign(tx_bytes: str | SuiTxBytes, pub_keys: list[SuiPublicKey]) SuiSignature
sign Signs transaction bytes for operation that changes objects owned by MultiSig address.
Changed in version 0.31.0: Roaring bitmap no longer required in Sui 1.4.x and above.
Added in version 0.21.1: Full signature creation without binaries.
- serialize() str
serialize Serializes the MultiSig object to base64 string.
- Returns:
Base64 string of serialized MultiSig
- Return type:
str
- pysui.sui.sui_crypto.gen_mnemonic_phrase(word_counts: int) str
gen_mnemonic_phrase Generates a unique string of words of count word_counts.
- Parameters:
word_counts (int) – Can be one of 12, 15, 18, 21, 24
- Raises:
ValueError – If word count not in set
- Returns:
The string of words with space separators
- Return type:
str
- pysui.sui.sui_crypto.create_new_keypair(scheme: SignatureScheme | None = SignatureScheme.ED25519, word_counts: int | None = 12, derv_path='') tuple[str, KeyPair]
create_new_keypair Generate a new keypair.
- Parameters:
keytype (SignatureScheme, optional) – One of ED25519, SECP256K1 or SECP256R1 key type, defaults to SignatureScheme.ED25519
word_counts (int, optional) – count of words to generate mnemonic phrase, defaults to 12
derv_path (str, optional) – derivation path coinciding with key type, defaults to None
- Raises:
NotImplementedError – If invalid keytype is provided
- Returns:
mnemonic words and new keypair
- Return type:
tuple[str, KeyPair]
Changed in version 0.33.0: Requires word count, no longer allows phrase.
- pysui.sui.sui_crypto.recover_key_and_address(keytype: SignatureScheme, mnemonics: str | list[str], derv_path: str) tuple[str, KeyPair, SuiAddress]
recover_key_and_address Recover a keypair and address.
- Parameters:
keytype (SignatureScheme) – One of ED25519 or SECP256K1 key type for the original key
mnemonics (Union[str, list[str]]) – mnemonic words used when creating original keypair
derv_path (str) – derivation path used when creating original keypair
- Returns:
mnemonic words, recovered keypair and derived sui address
- Return type:
tuple[str, KeyPair, SuiAddress]
Changed in version 0.33.0: Using pysui-fastcrypto.
- pysui.sui.sui_crypto.create_new_address(keytype: SignatureScheme, word_counts: int | None = 12, derv_path=None) tuple[str, KeyPair, SuiAddress]
create_new_address Create a new keypair and address for a key type.
- Parameters:
keytype (SignatureScheme) – One of ED25519, SECP256K1 or SECP256R1 key type
word_counts (int, optional) – count of words to generate mnemonic phrase, defaults to 12
derv_path (str, optional) – derivation path coinciding with key type, defaults to None
- Returns:
mnemonic words, new keypair and derived sui address
- Return type:
tuple[str, KeyPair, SuiAddress]
Changed in version 0.33.0: Requires word count, no longer allows phrase.
- pysui.sui.sui_crypto.keypair_from_keystring(keystring: str) SuiKeyPair
keypair_from_keystring Parse keystring to keypair.
- Parameters:
keystring (str) – base64 or bech32 keystring encoding
- Raises:
SuiInvalidKeystringLength – If base64 invalid keypair string length
NotImplementedError – If invalid keytype signature in string
- Returns:
keypair derived from keystring
- Return type:
Changed in version 0.57.0: Support bech32 keystring encoding
Changed in version 0.33.0: Using pysui-fastcrypto.
- pysui.sui.sui_crypto.load_keys_and_addresses(keystore_file: str) list[list[dict]] | Exception
load_keys_and_addresses Load keys and addresses.
- Parameters:
keystore_file (str) – The current in use keystore file path
- Raises:
SuiNoKeyPairs – If empty
SuiKeystoreFileError – If error reading file
SuiKeystoreAddressError – JSON error loading keyfile
SuiFileNotFound – If the file does not exists
- Returns:
Cross reference matrix [{},{keystring:KeyPair},{publickyestring:keystring},{str:SuiAddress}]
- Return type:
Union[list[list[dict]], Exception]
Changed in version 0.41.0: Replace cross-reference matrix instead of individual dicts on return
- pysui.sui.sui_crypto.as_keystrings(inputs: list[str | dict]) list[str]
as_keystrings Returns a list of just keystrings from heterogenous list of keystrings or dicts.
- Parameters:
inputs (list[Union[str, dict]]) – List of Sui keystrings or Wallet dict for conversion to keystring
- Returns:
List of strings in Sui keystring form
- Return type:
list[str]
Added in version 0.33.0: To support wallet exported keys.
- pysui.sui.sui_crypto.emphemeral_keys_and_addresses(keystrings: list[str | dict]) list[list[dict]]
emphemeral_keys_and_addresses Convert list of keystrings from SuiConfig.user_config().
- Parameters:
keystrings (list[Union[str, dict]]) – List of Sui keystrings or Wallet dict for conversion to keystring
- Returns:
Cross reference matrix [{},{keystring:KeyPair},{publickyestring:keystring},{str:SuiAddress}]
- Return type:
Union[list[list[dict]], Exception]
Changed in version 0.41.0: Replace cross-reference matrix instead of individual dicts on return
Changed in version 0.33.0: To support wallet exported keys and/or Sui valid keystrings.
pysui.sui.sui_excepts module
Sui Exceptions.
- exception pysui.sui.sui_excepts.SuiException
Bases:
Exception
Base Exception.
- exception pysui.sui.sui_excepts.SuiFileNotFound
Bases:
SuiException
Exception for file missing.
- exception pysui.sui.sui_excepts.SuiConfigFileError
Bases:
SuiException
Config file errors.
- exception pysui.sui.sui_excepts.SuiKeystoreFileError
Bases:
SuiException
Keystore file errors.
- exception pysui.sui.sui_excepts.SuiInvalidAddress
Bases:
SuiException
Invalid Sui address.
- exception pysui.sui.sui_excepts.SuiKeystoreAddressError
Bases:
SuiException
Keystore file errors.
- exception pysui.sui.sui_excepts.SuiInvalidKeystringLength(msg: int)
Bases:
SuiException
Invalid Keystring Length Exception.
- __init__(msg: int) None
Initiate keystring length error.
- exception pysui.sui.sui_excepts.SuiNoKeyPairs
Bases:
SuiException
Exception for missing keypairs.
- __init__() None
Initialize no keypair exception.
- exception pysui.sui.sui_excepts.SuiInvalidKeyPair
Bases:
SuiException
Invalid KeyPair Exception.
- exception pysui.sui.sui_excepts.SuiNotComplexTransaction(tx_name)
Bases:
SuiException
Exception for attempting to sign a simple transaction.
- __init__(tx_name) None
Initialize.
- exception pysui.sui.sui_excepts.SuiApiDefinitionInvalid
Bases:
SuiException
Corrupted Schema Exception.
- exception pysui.sui.sui_excepts.SuiParamSchemaInvalid
Bases:
SuiException
Corrupted Schema Exception.
- exception pysui.sui.sui_excepts.SuiRpcApiNotAvailable
Bases:
SuiException
Non active or non-existing RPC API method exception.
- exception pysui.sui.sui_excepts.SuiRpcApiMalformed
Bases:
SuiException
Sui Method malformed.
- exception pysui.sui.sui_excepts.SuiRpcApiInvalidParameter
Bases:
SuiException
Sui Method invalid parameter.
- exception pysui.sui.sui_excepts.SuiRpcApiError
Bases:
SuiException
For RPC error returns.
- exception pysui.sui.sui_excepts.SuiPackageBuildFail
Bases:
SuiException
For publishing.
- exception pysui.sui.sui_excepts.SuiMiisingBuildFolder
Bases:
SuiException
For publishing.
- exception pysui.sui.sui_excepts.SuiMiisingModuleByteCode
Bases:
SuiException
For publishing.
pysui.sui.sui_txn_validator module
Sui Transaction validator.
- pysui.sui.sui_txn_validator.validate_api(api_method: SuiApi, builder: Builder) tuple[str, str] | SuiRpcApiInvalidParameter
Validate the API parameters and arguments.
pysui.sui.sui_utils module
Utility functions.
- class pysui.sui.sui_utils.CompiledPackage(project_name: str, project_id: str, project_source_digest: bytes, dependencies: list[str], compiled_modules: list[SuiString] | None = None, package_digest: bytes | None = None)
Bases:
object
Ease of compilation information dataclass.
Changed in version 0.17.0: Added the package digest that matches chain digest.
- project_name: str
- project_id: str
- project_source_digest: bytes
- dependencies: list[str]
- package_digest: bytes = None
- pysui.sui.sui_utils.publish_build(path_to_package: Path, args_list: list[str]) CompiledPackage | Exception
Build and collect module base64 strings and dependencies ObjectIDs.
Changed in version 0.17.0: Added the package digest that matches chain digest.
- pysui.sui.sui_utils.sui_base_get_config() tuple[Path, Path, Path | None]
sui_base_get_config Load a sui-base configuration.
- Raises:
ValueError – client.yaml not found
ValueError – sui binary not found
- Returns:
Fully qualified paths to client.yaml and sui binary
- Return type:
tuple[Path, Path]
Changed in version 0.41.0: Sui aliases configuration feature added
- pysui.sui.sui_utils.partition(ilist: Iterable, chunk_size: int)
Partition a list with max paritiion size.
Lazy generation of list partitions with size <= chunk_size
- Parameters:
ilist (Iterable) – A flat list to partition
chunk_size (int) – Max elements per partition
- Yield:
a list of size N where N <= chunk_size
- Return type:
list
- pysui.sui.sui_utils.hexstring_to_sui_id(indata: str, default_fill_length: int = 64) str
Convert hexstring to valid full length sui address/object id.
- pysui.sui.sui_utils.hexstring_to_list(indata: str, default_fill_length: int = 64) list[int]
hexstring_to_list convert a hexstr (e.g. 0x…) into a list of ints.
- Parameters:
indata (str) – Data to conver to list of ints
- Returns:
converted indata to int list
- Return type:
list[int]
Changed in version 0.19.0: Account for > 3 and < 66 size hex string
- pysui.sui.sui_utils.b64str_to_list(indata: str) list[int]
b64str_to_list convert a base64 string into a list of ints.
- Parameters:
indata (str) – Base64 encoded string
- Returns:
converted indata to int list
- Return type:
list[int]
- pysui.sui.sui_utils.b58str_to_list(indata: str) list[int]
b58str_to_list convert a base58 string into a list of ints.
- Parameters:
indata (str) – Base58 encoded string
- Returns:
converted indata to int list
- Return type:
list[int]
- pysui.sui.sui_utils.int_to_listu8(byte_count: int, in_el: int) list[int]
int_to_listu8 converts integer to array of u8 bytes.
- Parameters:
byte_count (int) – Expected byte count of integer
in_el (int) – The integer elements
- Raises:
ValueError – If mismatch on expected and actual byte count
- Returns:
the integer value converted to list of int (u8)
- Return type:
list[int]
- pysui.sui.sui_utils.as_sui_address(in_data: Any) SuiAddress | ValueError
as_sui_address coerces in_data to a SuiAddress.
- Parameters:
in_data (Any) – Data to attempt coercion with
- Raises:
ValueError – If the data is not a valid SuiAddress form
ValueError – If in_data type is not handled by this utility.
- Returns:
A SuiAddress
- Return type:
Union[SuiAddress, ValueError]
- pysui.sui.sui_utils.as_object_id(in_data: Any) ObjectID | ValueError
as_object_id coerces in_data to an ObjectID.
- Parameters:
in_data (Any) – Data to attempt coercion with
- Raises:
ValueError – if indata type not a suitable subtype of SuiScalarType
ValueError – If in_data type is not handled by this utility.
- Returns:
An ObjectID
- Return type:
Union[ObjectID, Union[ValueError, AttributeError]]
- pysui.sui.sui_utils.as_sui_string(in_data: Any) SuiString | ValueError
as_sui_string coerces in_data to a SuiString.
- Parameters:
in_data (Any) – Data to attempt coercion with
- Raises:
ValueError – If in_data type is not handled by this utility.
- Returns:
A SuiString
- Return type:
Union[SuiString, ValueError]
- pysui.sui.sui_utils.as_sui_integer(in_data: Any) SuiInteger | ValueError
as_sui_integer coerces in_data to a SuiInteger.
- Parameters:
in_data (Any) – Data to attempt coercion with
- Raises:
ValueError – If in_data type is not handled by this utility.
- Returns:
A SuiInteger
- Return type:
Union[SuiInteger, ValueError]
- pysui.sui.sui_utils.as_sui_array(in_data: Any) SuiArray | ValueError
as_sui_array coerces in_data to a SuiArray.
- Parameters:
in_data (Any) – Data to attempt coercion with
- Raises:
ValueError – If in_data type is not handled by this utility.
- Returns:
A SuiArray
- Return type:
Union[SuiArray, ValueError]
- pysui.sui.sui_utils.as_sui_map(in_data: Any) SuiMap | ValueError
as_sui_map coerces in_data to a SuiMap.
- Parameters:
in_data (Any) – Data to attempt coercion with
- Raises:
ValueError – If in_data type is not handled by this utility.
- Returns:
A SuiMap
- Return type:
Union[SuiMap, ValueError]
- pysui.sui.sui_utils.as_sui_boolean(in_data: Any) SuiBoolean | ValueError
as_sui_boolean coerces in_data to a SuiBoolean.
- Parameters:
in_data (Any) – Data to attempt coercion with
- Raises:
ValueError – If in_data type is not handled by this utility.
- Returns:
A SuiBoolean
- Return type:
Union[SuiBoolean, ValueError]
- pysui.sui.sui_utils.is_base_64(str_or_bytes: str | bytes | bytearray) bool
is_base_64 validate str_or_bytes if valid base64 construct.
- Parameters:
str_or_bytes (Union[str, bytes, bytearray]) – In data
- Raises:
ValueError – Invalid input type
- Returns:
True if is valid base64
- Return type:
bool
- pysui.sui.sui_utils.to_base_64(in_data: Any, clz: Any) Any | ValueError
to_base_64 Coerce str,bytes or bytearray to base64.
- Parameters:
in_data (Any) – Data to coerce
clz (Any) – Result class that can construct with single argument
- Raises:
ValueError – If in_data type not support for coercion
- Returns:
clz object instance
- Return type:
Union[Any, ValueError]
- pysui.sui.sui_utils.as_sui_txbytes(in_data: Any) SuiTxBytes | ValueError
as_sui_txbytes coerces in_data to a SuiTxBytes.
- Parameters:
in_data (Any) – Data to attempt coercion with
- Raises:
ValueError – If in_data type is not handled by this utility.
- Returns:
A SuiTxBytes
- Return type:
Union[SuiTxBytes, ValueError]
- pysui.sui.sui_utils.as_sui_signature(in_data: Any) SuiSignature | ValueError
as_sui_signature coerces in_data to a SuiSignature.
- Parameters:
in_data (Any) – Data to attempt coercion with
- Raises:
ValueError – If in_data type is not handled by this utility.
- Returns:
A SuiSignature
- Return type:
Union[SuiSignature, ValueError]
- pysui.sui.sui_utils.as_sui_txdigest(in_data: Any) SuiTransactionDigest | ValueError
as_sui_txdigest coerces in_data to a SuiTransactionDigest.
- Parameters:
in_data (Any) – Data to attempt coercion with
- Raises:
ValueError – If in_data type is not handled by this utility.
- Returns:
A SuiTransactionDigest
- Return type:
Union[SuiTransactionDigest, ValueError]
- pysui.sui.sui_utils.COERCION_TO_FROM_SETS = {<class 'pysui.sui.sui_types.address.SuiAddress'>: {<class 'pysui.sui.sui_types.scalars.ObjectID'>, <class 'pysui.sui.sui_types.scalars.SuiString'>, <class 'str'>}, <class 'pysui.sui.sui_types.collections.SuiArray'>: {<class 'list'>, <class 'tuple'>}, <class 'pysui.sui.sui_types.collections.SuiMap'>: {<class 'dict'>}, <class 'pysui.sui.sui_types.scalars.ObjectID'>: {<class 'dataclasses_json.api.DataClassJsonMixin'>, <class 'pysui.sui.sui_types.address.SuiAddress'>, <class 'str'>}, <class 'pysui.sui.sui_types.scalars.SuiBoolean'>: {<class 'bool'>, <class 'int'>, <class 'str'>}, <class 'pysui.sui.sui_types.scalars.SuiInteger'>: {<class 'int'>, <class 'str'>}, <class 'pysui.sui.sui_types.scalars.SuiSignature'>: {<class 'bytearray'>, <class 'bytes'>, <class 'str'>}, <class 'pysui.sui.sui_types.scalars.SuiString'>: {<class 'int'>, <class 'pysui.sui.sui_types.address.SuiAddress'>, <class 'pysui.sui.sui_types.scalars.ObjectID'>, <class 'str'>}, <class 'pysui.sui.sui_types.scalars.SuiTransactionDigest'>: {<class 'pysui.sui.sui_types.scalars.SuiString'>, <class 'str'>}, <class 'pysui.sui.sui_types.scalars.SuiTxBytes'>: {<class 'bytearray'>, <class 'bytes'>, <class 'str'>}}
Keys are the end product pysui type and the value (set) are the types it can convert from.
- pysui.sui.sui_utils.COERCION_FROM_TO_SETS = {<class 'NoneType'>: {<class 'pysui.sui.sui_types.scalars.SuiNullType'>}, <class 'bool'>: {<class 'pysui.sui.sui_types.scalars.SuiBoolean'>}, <class 'bytearray'>: {<class 'pysui.sui.sui_types.scalars.SuiSignature'>, <class 'pysui.sui.sui_types.scalars.SuiTxBytes'>}, <class 'bytes'>: {<class 'pysui.sui.sui_types.scalars.SuiSignature'>, <class 'pysui.sui.sui_types.scalars.SuiTxBytes'>}, <class 'dict'>: {<class 'pysui.sui.sui_types.collections.SuiMap'>}, <class 'int'>: {<class 'pysui.sui.sui_types.scalars.SuiBoolean'>, <class 'pysui.sui.sui_types.scalars.SuiInteger'>, <class 'pysui.sui.sui_types.scalars.SuiString'>}, <class 'list'>: {<class 'pysui.sui.sui_types.collections.SuiArray'>, pysui.sui.sui_types.collections.SuiArray[pysui.sui.sui_types.address.SuiAddress], pysui.sui.sui_types.collections.SuiArray[pysui.sui.sui_types.collections.BatchParameter], pysui.sui.sui_types.collections.SuiArray[pysui.sui.sui_types.scalars.ObjectID], pysui.sui.sui_types.collections.SuiArray[pysui.sui.sui_types.scalars.SuiInteger], pysui.sui.sui_types.collections.SuiArray[pysui.sui.sui_types.scalars.SuiString]}, <class 'pysui.sui.sui_types.scalars.SuiString'>: {<class 'pysui.sui.sui_types.address.SuiAddress'>, <class 'pysui.sui.sui_types.scalars.ObjectID'>, <class 'pysui.sui.sui_types.scalars.SuiBoolean'>}, <class 'str'>: {<class 'pysui.sui.sui_types.address.SuiAddress'>, <class 'pysui.sui.sui_types.scalars.ObjectID'>, <class 'pysui.sui.sui_types.scalars.SuiBoolean'>, <class 'pysui.sui.sui_types.scalars.SuiInteger'>, <class 'pysui.sui.sui_types.scalars.SuiSignature'>, <class 'pysui.sui.sui_types.scalars.SuiString'>, <class 'pysui.sui.sui_types.scalars.SuiTransactionDigest'>, <class 'pysui.sui.sui_types.scalars.SuiTxBytes'>}, <class 'tuple'>: {<class 'pysui.sui.sui_types.collections.SuiArray'>}}
Keys are the inbound types that can be represented in SUI types in the value (set).
- pysui.sui.sui_utils.COERCION_FN_MAP = {<class 'NoneType'>: <function <lambda>>, <class 'pysui.sui.sui_types.address.SuiAddress'>: <function as_sui_address>, <class 'pysui.sui.sui_types.collections.SuiArray'>: <function as_sui_array>, <class 'pysui.sui.sui_types.collections.SuiMap'>: <function as_sui_map>, <class 'pysui.sui.sui_types.scalars.ObjectID'>: <function as_object_id>, <class 'pysui.sui.sui_types.scalars.SuiBoolean'>: <function as_sui_boolean>, <class 'pysui.sui.sui_types.scalars.SuiInteger'>: <function as_sui_integer>, <class 'pysui.sui.sui_types.scalars.SuiSignature'>: <function as_sui_signature>, <class 'pysui.sui.sui_types.scalars.SuiString'>: <function as_sui_string>, <class 'pysui.sui.sui_types.scalars.SuiTransactionDigest'>: <function as_sui_txdigest>, <class 'pysui.sui.sui_types.scalars.SuiTxBytes'>: <function as_sui_txbytes>, pysui.sui.sui_types.collections.SuiArray[pysui.sui.sui_types.address.SuiAddress]: <function as_sui_array>, pysui.sui.sui_types.collections.SuiArray[pysui.sui.sui_types.collections.BatchParameter]: <function as_sui_array>, pysui.sui.sui_types.collections.SuiArray[pysui.sui.sui_types.scalars.ObjectID]: <function as_sui_array>, pysui.sui.sui_types.collections.SuiArray[pysui.sui.sui_types.scalars.SuiInteger]: <function as_sui_array>, pysui.sui.sui_types.collections.SuiArray[pysui.sui.sui_types.scalars.SuiString]: <function as_sui_array>, typing.Any: <function <lambda>>}
Keys are the types and value is the converter function.
Module contents
Main pysui package. Contains imports of various module types.