sdk interface

• sdk_interface package
  • Subpackages
    • sdk_interface.utils package
      • Submodules
      • sdk_interface.utils.caching module
      • sdk_interface.utils.ecdsa_helpers module
      • sdk_interface.utils.encrypted_json module
      • sdk_interface.utils.hasher module
      • sdk_interface.utils.ss58 module
      • Module contents
  • Submodules
  • sdk_interface.base module
    • ExtrinsicReceipt
      • ExtrinsicReceipt.create_from_extrinsic_identifier()
      • ExtrinsicReceipt.error_message
      • ExtrinsicReceipt.extrinsic
      • ExtrinsicReceipt.extrinsic_idx
      • ExtrinsicReceipt.get()
      • ExtrinsicReceipt.get_extrinsic_identifier()
      • ExtrinsicReceipt.is_success
      • ExtrinsicReceipt.process_events()
      • ExtrinsicReceipt.retrieve_extrinsic()
      • ExtrinsicReceipt.total_fee_amount
      • ExtrinsicReceipt.triggered_events
      • ExtrinsicReceipt.weight
    • SubstrateInterface
      • SubstrateInterface.apply_type_registry_presets()
      • SubstrateInterface.chain
      • SubstrateInterface.close()
      • SubstrateInterface.compose_call()
      • SubstrateInterface.connect_websocket()
      • SubstrateInterface.convert_storage_parameter()
      • SubstrateInterface.create_multisig_extrinsic()
      • SubstrateInterface.create_scale_object()
      • SubstrateInterface.create_signed_extrinsic()
      • SubstrateInterface.create_storage_key()
      • SubstrateInterface.create_unsigned_extrinsic()
      • SubstrateInterface.debug_message()
      • SubstrateInterface.decode_scale()
      • SubstrateInterface.encode_scale()
      • SubstrateInterface.extension_call()
      • SubstrateInterface.filter_events()
      • SubstrateInterface.filter_extrinsics()
      • SubstrateInterface.generate_multisig_account()
      • SubstrateInterface.generate_signature_payload()
      • SubstrateInterface.generate_storage_hash()
      • SubstrateInterface.get_account_nonce()
      • SubstrateInterface.get_block()
      • SubstrateInterface.get_block_hash()
      • SubstrateInterface.get_block_header()
      • SubstrateInterface.get_block_metadata()
      • SubstrateInterface.get_block_number()
      • SubstrateInterface.get_block_runtime_version()
      • SubstrateInterface.get_block_timestamp()
      • SubstrateInterface.get_chain_finalised_head()
      • SubstrateInterface.get_chain_head()
      • SubstrateInterface.get_constant()
      • SubstrateInterface.get_events()
      • SubstrateInterface.get_extrinsics()
      • SubstrateInterface.get_metadata()
      • SubstrateInterface.get_metadata_call_function()
      • SubstrateInterface.get_metadata_call_functions()
      • SubstrateInterface.get_metadata_constant()
      • SubstrateInterface.get_metadata_constants()
      • SubstrateInterface.get_metadata_error()
      • SubstrateInterface.get_metadata_errors()
      • SubstrateInterface.get_metadata_event()
      • SubstrateInterface.get_metadata_events()
      • SubstrateInterface.get_metadata_module()
      • SubstrateInterface.get_metadata_modules()
      • SubstrateInterface.get_metadata_runtime_call_function()
      • SubstrateInterface.get_metadata_runtime_call_functions()
      • SubstrateInterface.get_metadata_storage_function()
      • SubstrateInterface.get_metadata_storage_functions()
      • SubstrateInterface.get_payment_info()
      • SubstrateInterface.get_runtime_metadata()
      • SubstrateInterface.get_storage_by_key()
      • SubstrateInterface.get_type_definition()
      • SubstrateInterface.get_type_registry()
      • SubstrateInterface.implements_scaleinfo()
      • SubstrateInterface.init_runtime()
      • SubstrateInterface.is_valid_ss58_address()
      • SubstrateInterface.name
      • SubstrateInterface.properties
      • SubstrateInterface.query()
      • SubstrateInterface.query_map()
      • SubstrateInterface.query_multi()
      • SubstrateInterface.register_extension()
      • SubstrateInterface.reload_type_registry()
      • SubstrateInterface.retrieve_extrinsic_by_hash()
      • SubstrateInterface.retrieve_extrinsic_by_identifier()
      • SubstrateInterface.retrieve_pending_extrinsics()
      • SubstrateInterface.rpc_request()
      • SubstrateInterface.runtime_call()
      • SubstrateInterface.search_block_number()
      • SubstrateInterface.serialize_constant()
      • SubstrateInterface.serialize_module_call()
      • SubstrateInterface.serialize_module_error()
      • SubstrateInterface.serialize_module_event()
      • SubstrateInterface.serialize_storage_item()
      • SubstrateInterface.ss58_decode()
      • SubstrateInterface.ss58_encode()
      • SubstrateInterface.ss58_format
      • SubstrateInterface.submit_extrinsic()
      • SubstrateInterface.subscribe_block_headers()
      • SubstrateInterface.subscribe_storage()
      • SubstrateInterface.supports_rpc_method()
      • SubstrateInterface.token_decimals
      • SubstrateInterface.token_symbol
      • SubstrateInterface.update_type_registry_presets()
      • SubstrateInterface.version
  • sdk_interface.constants module
  • sdk_interface.contracts module
    • ContractCode
      • ContractCode.create_from_code_hash()
      • ContractCode.create_from_contract_files()
      • ContractCode.deploy()
      • ContractCode.upload_wasm()
    • ContractEvent
      • ContractEvent.process()
      • ContractEvent.process_encode()
    • ContractExecutionReceipt
      • ContractExecutionReceipt.contract_events
      • ContractExecutionReceipt.create_from_extrinsic_receipt()
      • ContractExecutionReceipt.process_events()
    • ContractInstance
      • ContractInstance.create_from_address()
      • ContractInstance.exec()
      • ContractInstance.init()
      • ContractInstance.read()
    • ContractMetadata
      • ContractMetadata.create_from_file()
      • ContractMetadata.generate_constructor_data()
      • ContractMetadata.generate_message_data()
      • ContractMetadata.get_event_data()
      • ContractMetadata.get_event_id_by_topic()
      • ContractMetadata.get_return_type_string_for_message()
      • ContractMetadata.get_type_string_for_metadata_type()
  • sdk_interface.exceptions module
    • BlockNotFound
    • ConfigurationError
    • ContractExecFailedException
    • ContractMetadataParseException
    • ContractReadFailedException
    • DeployContractFailedException
    • ExtensionCallNotFound
    • ExtrinsicFailedException
    • ExtrinsicNotFound
    • StorageFunctionNotFound
    • SubstrateRequestException
  • sdk_interface.extensions module
    • Extension
      • Extension.close()
      • Extension.debug_message()
      • Extension.init()
    • SearchExtension
      • SearchExtension.filter_events()
      • SearchExtension.filter_extrinsics()
      • SearchExtension.get_block_timestamp()
      • SearchExtension.search_block_number()
    • SubstrateNodeExtension
      • SubstrateNodeExtension.filter_events()
      • SubstrateNodeExtension.filter_extrinsics()
      • SubstrateNodeExtension.get_block_timestamp()
      • SubstrateNodeExtension.search_block_number()
  • sdk_interface.interfaces module
    • ExtensionInterface
      • ExtensionInterface.call()
      • ExtensionInterface.get_extension_callable()
      • ExtensionInterface.register()
      • ExtensionInterface.unregister_all()
  • sdk_interface.key module
    • DeriveJunction
      • DeriveJunction.from_derive_path()
    • extract_derive_path()
  • sdk_interface.keypair module
    • Keypair
      • Keypair.create_from_encrypted_json()
      • Keypair.create_from_mnemonic()
      • Keypair.create_from_private_key()
      • Keypair.create_from_seed()
      • Keypair.create_from_uri()
      • Keypair.decrypt_message()
      • Keypair.encrypt_message()
      • Keypair.export_to_encrypted_json()
      • Keypair.generate_mnemonic()
      • Keypair.sign()
      • Keypair.validate_mnemonic()
      • Keypair.verify()
    • KeypairType
      • KeypairType.ECDSA
      • KeypairType.ED25519
      • KeypairType.SR25519
    • MnemonicLanguageCode
      • MnemonicLanguageCode.CHINESE_SIMPLIFIED
      • MnemonicLanguageCode.CHINESE_TRADITIONAL
      • MnemonicLanguageCode.ENGLISH
      • MnemonicLanguageCode.FRENCH
      • MnemonicLanguageCode.ITALIAN
      • MnemonicLanguageCode.JAPANESE
      • MnemonicLanguageCode.KOREAN
      • MnemonicLanguageCode.SPANISH
  • sdk_interface.storage module
    • StorageKey
      • StorageKey.convert_storage_parameter()
      • StorageKey.create_from_data()
      • StorageKey.create_from_storage_function()
      • StorageKey.decode_scale_value()
      • StorageKey.generate()
      • StorageKey.to_hex()
  • Module contents
    • ContractCode
      • ContractCode.create_from_code_hash()
      • ContractCode.create_from_contract_files()
      • ContractCode.deploy()
      • ContractCode.upload_wasm()
    • ContractEvent
      • ContractEvent.process()
      • ContractEvent.process_encode()
    • ContractExecutionReceipt
      • ContractExecutionReceipt.contract_events
      • ContractExecutionReceipt.create_from_extrinsic_receipt()
      • ContractExecutionReceipt.process_events()
    • ContractInstance
      • ContractInstance.create_from_address()
      • ContractInstance.exec()
      • ContractInstance.init()
      • ContractInstance.read()
    • ContractMetadata
      • ContractMetadata.create_from_file()
      • ContractMetadata.generate_constructor_data()
      • ContractMetadata.generate_message_data()
      • ContractMetadata.get_event_data()
      • ContractMetadata.get_event_id_by_topic()
      • ContractMetadata.get_return_type_string_for_message()
      • ContractMetadata.get_type_string_for_metadata_type()
    • Extension
      • Extension.close()
      • Extension.debug_message()
      • Extension.init()
    • ExtensionInterface
      • ExtensionInterface.call()
      • ExtensionInterface.get_extension_callable()
      • ExtensionInterface.register()
      • ExtensionInterface.unregister_all()
    • ExtrinsicReceipt
      • ExtrinsicReceipt.create_from_extrinsic_identifier()
      • ExtrinsicReceipt.error_message
      • ExtrinsicReceipt.extrinsic
      • ExtrinsicReceipt.extrinsic_idx
      • ExtrinsicReceipt.get()
      • ExtrinsicReceipt.get_extrinsic_identifier()
      • ExtrinsicReceipt.is_success
      • ExtrinsicReceipt.process_events()
      • ExtrinsicReceipt.retrieve_extrinsic()
      • ExtrinsicReceipt.total_fee_amount
      • ExtrinsicReceipt.triggered_events
      • ExtrinsicReceipt.weight
    • Keypair
      • Keypair.create_from_encrypted_json()
      • Keypair.create_from_mnemonic()
      • Keypair.create_from_private_key()
      • Keypair.create_from_seed()
      • Keypair.create_from_uri()
      • Keypair.decrypt_message()
      • Keypair.encrypt_message()
      • Keypair.export_to_encrypted_json()
      • Keypair.generate_mnemonic()
      • Keypair.sign()
      • Keypair.validate_mnemonic()
      • Keypair.verify()
    • KeypairType
      • KeypairType.ECDSA
      • KeypairType.ED25519
      • KeypairType.SR25519
    • MnemonicLanguageCode
      • MnemonicLanguageCode.CHINESE_SIMPLIFIED
      • MnemonicLanguageCode.CHINESE_TRADITIONAL
      • MnemonicLanguageCode.ENGLISH
      • MnemonicLanguageCode.FRENCH
      • MnemonicLanguageCode.ITALIAN
      • MnemonicLanguageCode.JAPANESE
      • MnemonicLanguageCode.KOREAN
      • MnemonicLanguageCode.SPANISH
    • SearchExtension
      • SearchExtension.filter_events()
      • SearchExtension.filter_extrinsics()
      • SearchExtension.get_block_timestamp()
      • SearchExtension.search_block_number()
    • SubstrateInterface
      • SubstrateInterface.apply_type_registry_presets()
      • SubstrateInterface.chain
      • SubstrateInterface.close()
      • SubstrateInterface.compose_call()
      • SubstrateInterface.connect_websocket()
      • SubstrateInterface.convert_storage_parameter()
      • SubstrateInterface.create_multisig_extrinsic()
      • SubstrateInterface.create_scale_object()
      • SubstrateInterface.create_signed_extrinsic()
      • SubstrateInterface.create_storage_key()
      • SubstrateInterface.create_unsigned_extrinsic()
      • SubstrateInterface.debug_message()
      • SubstrateInterface.decode_scale()
      • SubstrateInterface.encode_scale()
      • SubstrateInterface.extension_call()
      • SubstrateInterface.filter_events()
      • SubstrateInterface.filter_extrinsics()
      • SubstrateInterface.generate_multisig_account()
      • SubstrateInterface.generate_signature_payload()
      • SubstrateInterface.generate_storage_hash()
      • SubstrateInterface.get_account_nonce()
      • SubstrateInterface.get_block()
      • SubstrateInterface.get_block_hash()
      • SubstrateInterface.get_block_header()
      • SubstrateInterface.get_block_metadata()
      • SubstrateInterface.get_block_number()
      • SubstrateInterface.get_block_runtime_version()
      • SubstrateInterface.get_block_timestamp()
      • SubstrateInterface.get_chain_finalised_head()
      • SubstrateInterface.get_chain_head()
      • SubstrateInterface.get_constant()
      • SubstrateInterface.get_events()
      • SubstrateInterface.get_extrinsics()
      • SubstrateInterface.get_metadata()
      • SubstrateInterface.get_metadata_call_function()
      • SubstrateInterface.get_metadata_call_functions()
      • SubstrateInterface.get_metadata_constant()
      • SubstrateInterface.get_metadata_constants()
      • SubstrateInterface.get_metadata_error()
      • SubstrateInterface.get_metadata_errors()
      • SubstrateInterface.get_metadata_event()
      • SubstrateInterface.get_metadata_events()
      • SubstrateInterface.get_metadata_module()
      • SubstrateInterface.get_metadata_modules()
      • SubstrateInterface.get_metadata_runtime_call_function()
      • SubstrateInterface.get_metadata_runtime_call_functions()
      • SubstrateInterface.get_metadata_storage_function()
      • SubstrateInterface.get_metadata_storage_functions()
      • SubstrateInterface.get_payment_info()
      • SubstrateInterface.get_runtime_metadata()
      • SubstrateInterface.get_storage_by_key()
      • SubstrateInterface.get_type_definition()
      • SubstrateInterface.get_type_registry()
      • SubstrateInterface.implements_scaleinfo()
      • SubstrateInterface.init_runtime()
      • SubstrateInterface.is_valid_ss58_address()
      • SubstrateInterface.name
      • SubstrateInterface.properties
      • SubstrateInterface.query()
      • SubstrateInterface.query_map()
      • SubstrateInterface.query_multi()
      • SubstrateInterface.register_extension()
      • SubstrateInterface.reload_type_registry()
      • SubstrateInterface.retrieve_extrinsic_by_hash()
      • SubstrateInterface.retrieve_extrinsic_by_identifier()
      • SubstrateInterface.retrieve_pending_extrinsics()
      • SubstrateInterface.rpc_request()
      • SubstrateInterface.runtime_call()
      • SubstrateInterface.search_block_number()
      • SubstrateInterface.serialize_constant()
      • SubstrateInterface.serialize_module_call()
      • SubstrateInterface.serialize_module_error()
      • SubstrateInterface.serialize_module_event()
      • SubstrateInterface.serialize_storage_item()
      • SubstrateInterface.ss58_decode()
      • SubstrateInterface.ss58_encode()
      • SubstrateInterface.ss58_format
      • SubstrateInterface.submit_extrinsic()
      • SubstrateInterface.subscribe_block_headers()
      • SubstrateInterface.subscribe_storage()
      • SubstrateInterface.supports_rpc_method()
      • SubstrateInterface.token_decimals
      • SubstrateInterface.token_symbol
      • SubstrateInterface.update_type_registry_presets()
      • SubstrateInterface.version
    • SubstrateNodeExtension
      • SubstrateNodeExtension.filter_events()
      • SubstrateNodeExtension.filter_extrinsics()
      • SubstrateNodeExtension.get_block_timestamp()
      • SubstrateNodeExtension.search_block_number()