symbolchain.sc package
Module contents
- class symbolchain.sc.AccountAddressRestrictionTransactionV1
Bases:
Transaction
- TRANSACTION_TYPE: TransactionType = 16720
- TRANSACTION_VERSION: int = 1
- TYPE_HINTS = {'deadline': 'pod:Timestamp', 'fee': 'pod:Amount', 'network': 'enum:NetworkType', 'restriction_additions': 'array[UnresolvedAddress]', 'restriction_deletions': 'array[UnresolvedAddress]', 'restriction_flags': 'enum:AccountRestrictionFlags', 'signature': 'pod:Signature', 'signer_public_key': 'pod:PublicKey', 'type_': 'enum:TransactionType'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) AccountAddressRestrictionTransactionV1
- property restriction_additions: List[UnresolvedAddress]
- property restriction_deletions: List[UnresolvedAddress]
- property restriction_flags: AccountRestrictionFlags
- serialize() bytes
- property size: int
- sort() None
- to_json()
- class symbolchain.sc.AccountKeyLinkTransactionV1
Bases:
Transaction
- TRANSACTION_TYPE: TransactionType = 16716
- TRANSACTION_VERSION: int = 1
- TYPE_HINTS = {'deadline': 'pod:Timestamp', 'fee': 'pod:Amount', 'link_action': 'enum:LinkAction', 'linked_public_key': 'pod:PublicKey', 'network': 'enum:NetworkType', 'signature': 'pod:Signature', 'signer_public_key': 'pod:PublicKey', 'type_': 'enum:TransactionType'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) AccountKeyLinkTransactionV1
- property link_action: LinkAction
- serialize() bytes
- property size: int
- sort() None
- to_json()
- class symbolchain.sc.AccountMetadataTransactionV1
Bases:
Transaction
- TRANSACTION_TYPE: TransactionType = 16708
- TRANSACTION_VERSION: int = 1
- TYPE_HINTS = {'deadline': 'pod:Timestamp', 'fee': 'pod:Amount', 'network': 'enum:NetworkType', 'signature': 'pod:Signature', 'signer_public_key': 'pod:PublicKey', 'target_address': 'pod:UnresolvedAddress', 'type_': 'enum:TransactionType', 'value': 'bytes_array'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) AccountMetadataTransactionV1
- property scoped_metadata_key: int
- serialize() bytes
- property size: int
- sort() None
- property target_address: UnresolvedAddress
- to_json()
- property value: bytes
- property value_size_delta: int
- class symbolchain.sc.AccountMosaicRestrictionTransactionV1
Bases:
Transaction
- TRANSACTION_TYPE: TransactionType = 16976
- TRANSACTION_VERSION: int = 1
- TYPE_HINTS = {'deadline': 'pod:Timestamp', 'fee': 'pod:Amount', 'network': 'enum:NetworkType', 'restriction_additions': 'array[UnresolvedMosaicId]', 'restriction_deletions': 'array[UnresolvedMosaicId]', 'restriction_flags': 'enum:AccountRestrictionFlags', 'signature': 'pod:Signature', 'signer_public_key': 'pod:PublicKey', 'type_': 'enum:TransactionType'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) AccountMosaicRestrictionTransactionV1
- property restriction_additions: List[UnresolvedMosaicId]
- property restriction_deletions: List[UnresolvedMosaicId]
- property restriction_flags: AccountRestrictionFlags
- serialize() bytes
- property size: int
- sort() None
- to_json()
- class symbolchain.sc.AccountOperationRestrictionTransactionV1
Bases:
Transaction
- TRANSACTION_TYPE: TransactionType = 17232
- TRANSACTION_VERSION: int = 1
- TYPE_HINTS = {'deadline': 'pod:Timestamp', 'fee': 'pod:Amount', 'network': 'enum:NetworkType', 'restriction_additions': 'array[TransactionType]', 'restriction_deletions': 'array[TransactionType]', 'restriction_flags': 'enum:AccountRestrictionFlags', 'signature': 'pod:Signature', 'signer_public_key': 'pod:PublicKey', 'type_': 'enum:TransactionType'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) AccountOperationRestrictionTransactionV1
- property restriction_additions: List[TransactionType]
- property restriction_deletions: List[TransactionType]
- property restriction_flags: AccountRestrictionFlags
- serialize() bytes
- property size: int
- sort() None
- to_json()
- class symbolchain.sc.AccountRestrictionFlags(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Flag
- ADDRESS = 1
- BLOCK = 32768
- MOSAIC_ID = 2
- OUTGOING = 16384
- TRANSACTION_TYPE = 4
- classmethod deserialize(payload: bytes | bytearray | memoryview) AccountRestrictionFlags
- serialize() bytes
- property size: int
- to_json()
- class symbolchain.sc.Address(address: StrBytes = b'\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00')
Bases:
ByteArray
- SIZE = 24
- serialize() bytes
- property size: int
- class symbolchain.sc.AddressAliasTransactionV1
Bases:
Transaction
- TRANSACTION_TYPE: TransactionType = 16974
- TRANSACTION_VERSION: int = 1
- TYPE_HINTS = {'address': 'pod:Address', 'alias_action': 'enum:AliasAction', 'deadline': 'pod:Timestamp', 'fee': 'pod:Amount', 'namespace_id': 'pod:NamespaceId', 'network': 'enum:NetworkType', 'signature': 'pod:Signature', 'signer_public_key': 'pod:PublicKey', 'type_': 'enum:TransactionType'}
- property alias_action: AliasAction
- classmethod deserialize(payload: bytes | bytearray | memoryview) AddressAliasTransactionV1
- property namespace_id: NamespaceId
- serialize() bytes
- property size: int
- sort() None
- to_json()
- class symbolchain.sc.AddressResolutionEntry
Bases:
object
- TYPE_HINTS = {'resolved_value': 'pod:Address', 'source': 'struct:ReceiptSource'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) AddressResolutionEntry
- serialize() bytes
- property size: int
- sort() None
- property source: ReceiptSource
- to_json()
- class symbolchain.sc.AddressResolutionStatement
Bases:
object
- TYPE_HINTS = {'resolution_entries': 'array[AddressResolutionEntry]', 'unresolved': 'pod:UnresolvedAddress'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) AddressResolutionStatement
- property resolution_entries: List[AddressResolutionEntry]
- serialize() bytes
- property size: int
- sort() None
- to_json()
- property unresolved: UnresolvedAddress
- class symbolchain.sc.AggregateBondedTransactionV1
Bases:
Transaction
- TRANSACTION_TYPE: TransactionType = 16961
- TRANSACTION_VERSION: int = 1
- TYPE_HINTS = {'cosignatures': 'array[Cosignature]', 'deadline': 'pod:Timestamp', 'fee': 'pod:Amount', 'network': 'enum:NetworkType', 'signature': 'pod:Signature', 'signer_public_key': 'pod:PublicKey', 'transactions': 'array[EmbeddedTransaction]', 'transactions_hash': 'pod:Hash256', 'type_': 'enum:TransactionType'}
- property cosignatures: List[Cosignature]
- classmethod deserialize(payload: bytes | bytearray | memoryview) AggregateBondedTransactionV1
- serialize() bytes
- property size: int
- sort() None
- to_json()
- property transactions: List[EmbeddedTransaction]
- class symbolchain.sc.AggregateBondedTransactionV2
Bases:
Transaction
- TRANSACTION_TYPE: TransactionType = 16961
- TRANSACTION_VERSION: int = 2
- TYPE_HINTS = {'cosignatures': 'array[Cosignature]', 'deadline': 'pod:Timestamp', 'fee': 'pod:Amount', 'network': 'enum:NetworkType', 'signature': 'pod:Signature', 'signer_public_key': 'pod:PublicKey', 'transactions': 'array[EmbeddedTransaction]', 'transactions_hash': 'pod:Hash256', 'type_': 'enum:TransactionType'}
- property cosignatures: List[Cosignature]
- classmethod deserialize(payload: bytes | bytearray | memoryview) AggregateBondedTransactionV2
- serialize() bytes
- property size: int
- sort() None
- to_json()
- property transactions: List[EmbeddedTransaction]
- class symbolchain.sc.AggregateCompleteTransactionV1
Bases:
Transaction
- TRANSACTION_TYPE: TransactionType = 16705
- TRANSACTION_VERSION: int = 1
- TYPE_HINTS = {'cosignatures': 'array[Cosignature]', 'deadline': 'pod:Timestamp', 'fee': 'pod:Amount', 'network': 'enum:NetworkType', 'signature': 'pod:Signature', 'signer_public_key': 'pod:PublicKey', 'transactions': 'array[EmbeddedTransaction]', 'transactions_hash': 'pod:Hash256', 'type_': 'enum:TransactionType'}
- property cosignatures: List[Cosignature]
- classmethod deserialize(payload: bytes | bytearray | memoryview) AggregateCompleteTransactionV1
- serialize() bytes
- property size: int
- sort() None
- to_json()
- property transactions: List[EmbeddedTransaction]
- class symbolchain.sc.AggregateCompleteTransactionV2
Bases:
Transaction
- TRANSACTION_TYPE: TransactionType = 16705
- TRANSACTION_VERSION: int = 2
- TYPE_HINTS = {'cosignatures': 'array[Cosignature]', 'deadline': 'pod:Timestamp', 'fee': 'pod:Amount', 'network': 'enum:NetworkType', 'signature': 'pod:Signature', 'signer_public_key': 'pod:PublicKey', 'transactions': 'array[EmbeddedTransaction]', 'transactions_hash': 'pod:Hash256', 'type_': 'enum:TransactionType'}
- property cosignatures: List[Cosignature]
- classmethod deserialize(payload: bytes | bytearray | memoryview) AggregateCompleteTransactionV2
- serialize() bytes
- property size: int
- sort() None
- to_json()
- property transactions: List[EmbeddedTransaction]
- class symbolchain.sc.AliasAction(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- LINK = 1
- UNLINK = 0
- classmethod deserialize(payload: bytes | bytearray | memoryview) AliasAction
- serialize() bytes
- property size: int
- to_json()
- class symbolchain.sc.Block
Bases:
object
- TYPE_HINTS = {'beneficiary_address': 'pod:Address', 'difficulty': 'pod:Difficulty', 'fee_multiplier': 'pod:BlockFeeMultiplier', 'generation_hash_proof': 'struct:VrfProof', 'height': 'pod:Height', 'network': 'enum:NetworkType', 'previous_block_hash': 'pod:Hash256', 'receipts_hash': 'pod:Hash256', 'signature': 'pod:Signature', 'signer_public_key': 'pod:PublicKey', 'state_hash': 'pod:Hash256', 'timestamp': 'pod:Timestamp', 'transactions_hash': 'pod:Hash256', 'type_': 'enum:BlockType'}
- property difficulty: Difficulty
- property fee_multiplier: BlockFeeMultiplier
- property network: NetworkType
- serialize() bytes
- property size: int
- sort() None
- to_json()
- property version: int
- class symbolchain.sc.BlockDuration(block_duration: int = 0)
Bases:
BaseValue
- SIZE = 8
- classmethod deserialize(payload: bytes | bytearray | memoryview) BlockDuration
- serialize() bytes
- class symbolchain.sc.BlockFactory
Bases:
object
- class symbolchain.sc.BlockFeeMultiplier(block_fee_multiplier: int = 0)
Bases:
BaseValue
- SIZE = 4
- classmethod deserialize(payload: bytes | bytearray | memoryview) BlockFeeMultiplier
- serialize() bytes
- class symbolchain.sc.BlockStatement
Bases:
object
- TYPE_HINTS = {'address_resolution_statements': 'array[AddressResolutionStatement]', 'mosaic_resolution_statements': 'array[MosaicResolutionStatement]', 'transaction_statements': 'array[TransactionStatement]'}
- property address_resolution_statements: List[AddressResolutionStatement]
- classmethod deserialize(payload: bytes | bytearray | memoryview) BlockStatement
- property mosaic_resolution_statements: List[MosaicResolutionStatement]
- serialize() bytes
- property size: int
- sort() None
- to_json()
- property transaction_statements: List[TransactionStatement]
- class symbolchain.sc.BlockType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- IMPORTANCE = 33347
- NEMESIS = 32835
- NORMAL = 33091
- serialize() bytes
- property size: int
- to_json()
- class symbolchain.sc.Cosignature
Bases:
object
- TYPE_HINTS = {'signature': 'pod:Signature', 'signer_public_key': 'pod:PublicKey'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) Cosignature
- serialize() bytes
- property size: int
- sort() None
- to_json()
- property version: int
- class symbolchain.sc.DetachedCosignature
Bases:
object
- TYPE_HINTS = {'parent_hash': 'pod:Hash256', 'signature': 'pod:Signature', 'signer_public_key': 'pod:PublicKey'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) DetachedCosignature
- serialize() bytes
- property size: int
- sort() None
- to_json()
- property version: int
- class symbolchain.sc.Difficulty(difficulty: int = 0)
Bases:
BaseValue
- SIZE = 8
- classmethod deserialize(payload: bytes | bytearray | memoryview) Difficulty
- serialize() bytes
- class symbolchain.sc.EmbeddedAccountAddressRestrictionTransactionV1
Bases:
EmbeddedTransaction
- TRANSACTION_TYPE: TransactionType = 16720
- TRANSACTION_VERSION: int = 1
- TYPE_HINTS = {'network': 'enum:NetworkType', 'restriction_additions': 'array[UnresolvedAddress]', 'restriction_deletions': 'array[UnresolvedAddress]', 'restriction_flags': 'enum:AccountRestrictionFlags', 'signer_public_key': 'pod:PublicKey', 'type_': 'enum:TransactionType'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) EmbeddedAccountAddressRestrictionTransactionV1
- property restriction_additions: List[UnresolvedAddress]
- property restriction_deletions: List[UnresolvedAddress]
- property restriction_flags: AccountRestrictionFlags
- serialize() bytes
- property size: int
- sort() None
- to_json()
- class symbolchain.sc.EmbeddedAccountKeyLinkTransactionV1
Bases:
EmbeddedTransaction
- TRANSACTION_TYPE: TransactionType = 16716
- TRANSACTION_VERSION: int = 1
- TYPE_HINTS = {'link_action': 'enum:LinkAction', 'linked_public_key': 'pod:PublicKey', 'network': 'enum:NetworkType', 'signer_public_key': 'pod:PublicKey', 'type_': 'enum:TransactionType'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) EmbeddedAccountKeyLinkTransactionV1
- property link_action: LinkAction
- serialize() bytes
- property size: int
- sort() None
- to_json()
- class symbolchain.sc.EmbeddedAccountMetadataTransactionV1
Bases:
EmbeddedTransaction
- TRANSACTION_TYPE: TransactionType = 16708
- TRANSACTION_VERSION: int = 1
- TYPE_HINTS = {'network': 'enum:NetworkType', 'signer_public_key': 'pod:PublicKey', 'target_address': 'pod:UnresolvedAddress', 'type_': 'enum:TransactionType', 'value': 'bytes_array'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) EmbeddedAccountMetadataTransactionV1
- property scoped_metadata_key: int
- serialize() bytes
- property size: int
- sort() None
- property target_address: UnresolvedAddress
- to_json()
- property value: bytes
- property value_size_delta: int
- class symbolchain.sc.EmbeddedAccountMosaicRestrictionTransactionV1
Bases:
EmbeddedTransaction
- TRANSACTION_TYPE: TransactionType = 16976
- TRANSACTION_VERSION: int = 1
- TYPE_HINTS = {'network': 'enum:NetworkType', 'restriction_additions': 'array[UnresolvedMosaicId]', 'restriction_deletions': 'array[UnresolvedMosaicId]', 'restriction_flags': 'enum:AccountRestrictionFlags', 'signer_public_key': 'pod:PublicKey', 'type_': 'enum:TransactionType'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) EmbeddedAccountMosaicRestrictionTransactionV1
- property restriction_additions: List[UnresolvedMosaicId]
- property restriction_deletions: List[UnresolvedMosaicId]
- property restriction_flags: AccountRestrictionFlags
- serialize() bytes
- property size: int
- sort() None
- to_json()
- class symbolchain.sc.EmbeddedAccountOperationRestrictionTransactionV1
Bases:
EmbeddedTransaction
- TRANSACTION_TYPE: TransactionType = 17232
- TRANSACTION_VERSION: int = 1
- TYPE_HINTS = {'network': 'enum:NetworkType', 'restriction_additions': 'array[TransactionType]', 'restriction_deletions': 'array[TransactionType]', 'restriction_flags': 'enum:AccountRestrictionFlags', 'signer_public_key': 'pod:PublicKey', 'type_': 'enum:TransactionType'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) EmbeddedAccountOperationRestrictionTransactionV1
- property restriction_additions: List[TransactionType]
- property restriction_deletions: List[TransactionType]
- property restriction_flags: AccountRestrictionFlags
- serialize() bytes
- property size: int
- sort() None
- to_json()
- class symbolchain.sc.EmbeddedAddressAliasTransactionV1
Bases:
EmbeddedTransaction
- TRANSACTION_TYPE: TransactionType = 16974
- TRANSACTION_VERSION: int = 1
- TYPE_HINTS = {'address': 'pod:Address', 'alias_action': 'enum:AliasAction', 'namespace_id': 'pod:NamespaceId', 'network': 'enum:NetworkType', 'signer_public_key': 'pod:PublicKey', 'type_': 'enum:TransactionType'}
- property alias_action: AliasAction
- classmethod deserialize(payload: bytes | bytearray | memoryview) EmbeddedAddressAliasTransactionV1
- property namespace_id: NamespaceId
- serialize() bytes
- property size: int
- sort() None
- to_json()
- class symbolchain.sc.EmbeddedHashLockTransactionV1
Bases:
EmbeddedTransaction
- TRANSACTION_TYPE: TransactionType = 16712
- TRANSACTION_VERSION: int = 1
- TYPE_HINTS = {'duration': 'pod:BlockDuration', 'hash': 'pod:Hash256', 'mosaic': 'struct:UnresolvedMosaic', 'network': 'enum:NetworkType', 'signer_public_key': 'pod:PublicKey', 'type_': 'enum:TransactionType'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) EmbeddedHashLockTransactionV1
- property duration: BlockDuration
- property mosaic: UnresolvedMosaic
- serialize() bytes
- property size: int
- sort() None
- to_json()
- class symbolchain.sc.EmbeddedMosaicAddressRestrictionTransactionV1
Bases:
EmbeddedTransaction
- TRANSACTION_TYPE: TransactionType = 16977
- TRANSACTION_VERSION: int = 1
- TYPE_HINTS = {'mosaic_id': 'pod:UnresolvedMosaicId', 'network': 'enum:NetworkType', 'signer_public_key': 'pod:PublicKey', 'target_address': 'pod:UnresolvedAddress', 'type_': 'enum:TransactionType'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) EmbeddedMosaicAddressRestrictionTransactionV1
- property mosaic_id: UnresolvedMosaicId
- property new_restriction_value: int
- property previous_restriction_value: int
- property restriction_key: int
- serialize() bytes
- property size: int
- sort() None
- property target_address: UnresolvedAddress
- to_json()
- class symbolchain.sc.EmbeddedMosaicAliasTransactionV1
Bases:
EmbeddedTransaction
- TRANSACTION_TYPE: TransactionType = 17230
- TRANSACTION_VERSION: int = 1
- TYPE_HINTS = {'alias_action': 'enum:AliasAction', 'mosaic_id': 'pod:MosaicId', 'namespace_id': 'pod:NamespaceId', 'network': 'enum:NetworkType', 'signer_public_key': 'pod:PublicKey', 'type_': 'enum:TransactionType'}
- property alias_action: AliasAction
- classmethod deserialize(payload: bytes | bytearray | memoryview) EmbeddedMosaicAliasTransactionV1
- property namespace_id: NamespaceId
- serialize() bytes
- property size: int
- sort() None
- to_json()
- class symbolchain.sc.EmbeddedMosaicDefinitionTransactionV1
Bases:
EmbeddedTransaction
- TRANSACTION_TYPE: TransactionType = 16717
- TRANSACTION_VERSION: int = 1
- TYPE_HINTS = {'duration': 'pod:BlockDuration', 'flags': 'enum:MosaicFlags', 'id': 'pod:MosaicId', 'network': 'enum:NetworkType', 'nonce': 'pod:MosaicNonce', 'signer_public_key': 'pod:PublicKey', 'type_': 'enum:TransactionType'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) EmbeddedMosaicDefinitionTransactionV1
- property divisibility: int
- property duration: BlockDuration
- property flags: MosaicFlags
- property nonce: MosaicNonce
- serialize() bytes
- property size: int
- sort() None
- to_json()
- class symbolchain.sc.EmbeddedMosaicGlobalRestrictionTransactionV1
Bases:
EmbeddedTransaction
- TRANSACTION_TYPE: TransactionType = 16721
- TRANSACTION_VERSION: int = 1
- TYPE_HINTS = {'mosaic_id': 'pod:UnresolvedMosaicId', 'network': 'enum:NetworkType', 'new_restriction_type': 'enum:MosaicRestrictionType', 'previous_restriction_type': 'enum:MosaicRestrictionType', 'reference_mosaic_id': 'pod:UnresolvedMosaicId', 'signer_public_key': 'pod:PublicKey', 'type_': 'enum:TransactionType'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) EmbeddedMosaicGlobalRestrictionTransactionV1
- property mosaic_id: UnresolvedMosaicId
- property new_restriction_type: MosaicRestrictionType
- property new_restriction_value: int
- property previous_restriction_type: MosaicRestrictionType
- property previous_restriction_value: int
- property reference_mosaic_id: UnresolvedMosaicId
- property restriction_key: int
- serialize() bytes
- property size: int
- sort() None
- to_json()
- class symbolchain.sc.EmbeddedMosaicMetadataTransactionV1
Bases:
EmbeddedTransaction
- TRANSACTION_TYPE: TransactionType = 16964
- TRANSACTION_VERSION: int = 1
- TYPE_HINTS = {'network': 'enum:NetworkType', 'signer_public_key': 'pod:PublicKey', 'target_address': 'pod:UnresolvedAddress', 'target_mosaic_id': 'pod:UnresolvedMosaicId', 'type_': 'enum:TransactionType', 'value': 'bytes_array'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) EmbeddedMosaicMetadataTransactionV1
- property scoped_metadata_key: int
- serialize() bytes
- property size: int
- sort() None
- property target_address: UnresolvedAddress
- property target_mosaic_id: UnresolvedMosaicId
- to_json()
- property value: bytes
- property value_size_delta: int
- class symbolchain.sc.EmbeddedMosaicSupplyChangeTransactionV1
Bases:
EmbeddedTransaction
- TRANSACTION_TYPE: TransactionType = 16973
- TRANSACTION_VERSION: int = 1
- TYPE_HINTS = {'action': 'enum:MosaicSupplyChangeAction', 'delta': 'pod:Amount', 'mosaic_id': 'pod:UnresolvedMosaicId', 'network': 'enum:NetworkType', 'signer_public_key': 'pod:PublicKey', 'type_': 'enum:TransactionType'}
- property action: MosaicSupplyChangeAction
- classmethod deserialize(payload: bytes | bytearray | memoryview) EmbeddedMosaicSupplyChangeTransactionV1
- property mosaic_id: UnresolvedMosaicId
- serialize() bytes
- property size: int
- sort() None
- to_json()
- class symbolchain.sc.EmbeddedMosaicSupplyRevocationTransactionV1
Bases:
EmbeddedTransaction
- TRANSACTION_TYPE: TransactionType = 17229
- TRANSACTION_VERSION: int = 1
- TYPE_HINTS = {'mosaic': 'struct:UnresolvedMosaic', 'network': 'enum:NetworkType', 'signer_public_key': 'pod:PublicKey', 'source_address': 'pod:UnresolvedAddress', 'type_': 'enum:TransactionType'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) EmbeddedMosaicSupplyRevocationTransactionV1
- property mosaic: UnresolvedMosaic
- serialize() bytes
- property size: int
- sort() None
- property source_address: UnresolvedAddress
- to_json()
- class symbolchain.sc.EmbeddedMultisigAccountModificationTransactionV1
Bases:
EmbeddedTransaction
- TRANSACTION_TYPE: TransactionType = 16725
- TRANSACTION_VERSION: int = 1
- TYPE_HINTS = {'address_additions': 'array[UnresolvedAddress]', 'address_deletions': 'array[UnresolvedAddress]', 'network': 'enum:NetworkType', 'signer_public_key': 'pod:PublicKey', 'type_': 'enum:TransactionType'}
- property address_additions: List[UnresolvedAddress]
- property address_deletions: List[UnresolvedAddress]
- classmethod deserialize(payload: bytes | bytearray | memoryview) EmbeddedMultisigAccountModificationTransactionV1
- property min_approval_delta: int
- property min_removal_delta: int
- serialize() bytes
- property size: int
- sort() None
- to_json()
- class symbolchain.sc.EmbeddedNamespaceMetadataTransactionV1
Bases:
EmbeddedTransaction
- TRANSACTION_TYPE: TransactionType = 17220
- TRANSACTION_VERSION: int = 1
- TYPE_HINTS = {'network': 'enum:NetworkType', 'signer_public_key': 'pod:PublicKey', 'target_address': 'pod:UnresolvedAddress', 'target_namespace_id': 'pod:NamespaceId', 'type_': 'enum:TransactionType', 'value': 'bytes_array'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) EmbeddedNamespaceMetadataTransactionV1
- property scoped_metadata_key: int
- serialize() bytes
- property size: int
- sort() None
- property target_address: UnresolvedAddress
- property target_namespace_id: NamespaceId
- to_json()
- property value: bytes
- property value_size_delta: int
- class symbolchain.sc.EmbeddedNamespaceRegistrationTransactionV1
Bases:
EmbeddedTransaction
- TRANSACTION_TYPE: TransactionType = 16718
- TRANSACTION_VERSION: int = 1
- TYPE_HINTS = {'duration': 'pod:BlockDuration', 'id': 'pod:NamespaceId', 'name': 'bytes_array', 'network': 'enum:NetworkType', 'parent_id': 'pod:NamespaceId', 'registration_type': 'enum:NamespaceRegistrationType', 'signer_public_key': 'pod:PublicKey', 'type_': 'enum:TransactionType'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) EmbeddedNamespaceRegistrationTransactionV1
- property duration: BlockDuration
- property id: NamespaceId
- property name: bytes
- property parent_id: NamespaceId
- property registration_type: NamespaceRegistrationType
- serialize() bytes
- property size: int
- sort() None
- to_json()
- class symbolchain.sc.EmbeddedNodeKeyLinkTransactionV1
Bases:
EmbeddedTransaction
- TRANSACTION_TYPE: TransactionType = 16972
- TRANSACTION_VERSION: int = 1
- TYPE_HINTS = {'link_action': 'enum:LinkAction', 'linked_public_key': 'pod:PublicKey', 'network': 'enum:NetworkType', 'signer_public_key': 'pod:PublicKey', 'type_': 'enum:TransactionType'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) EmbeddedNodeKeyLinkTransactionV1
- property link_action: LinkAction
- serialize() bytes
- property size: int
- sort() None
- to_json()
- class symbolchain.sc.EmbeddedSecretLockTransactionV1
Bases:
EmbeddedTransaction
- TRANSACTION_TYPE: TransactionType = 16722
- TRANSACTION_VERSION: int = 1
- TYPE_HINTS = {'duration': 'pod:BlockDuration', 'hash_algorithm': 'enum:LockHashAlgorithm', 'mosaic': 'struct:UnresolvedMosaic', 'network': 'enum:NetworkType', 'recipient_address': 'pod:UnresolvedAddress', 'secret': 'pod:Hash256', 'signer_public_key': 'pod:PublicKey', 'type_': 'enum:TransactionType'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) EmbeddedSecretLockTransactionV1
- property duration: BlockDuration
- property hash_algorithm: LockHashAlgorithm
- property mosaic: UnresolvedMosaic
- property recipient_address: UnresolvedAddress
- serialize() bytes
- property size: int
- sort() None
- to_json()
- class symbolchain.sc.EmbeddedSecretProofTransactionV1
Bases:
EmbeddedTransaction
- TRANSACTION_TYPE: TransactionType = 16978
- TRANSACTION_VERSION: int = 1
- TYPE_HINTS = {'hash_algorithm': 'enum:LockHashAlgorithm', 'network': 'enum:NetworkType', 'proof': 'bytes_array', 'recipient_address': 'pod:UnresolvedAddress', 'secret': 'pod:Hash256', 'signer_public_key': 'pod:PublicKey', 'type_': 'enum:TransactionType'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) EmbeddedSecretProofTransactionV1
- property hash_algorithm: LockHashAlgorithm
- property proof: bytes
- property recipient_address: UnresolvedAddress
- serialize() bytes
- property size: int
- sort() None
- to_json()
- class symbolchain.sc.EmbeddedTransaction
Bases:
object
- TYPE_HINTS = {'network': 'enum:NetworkType', 'signer_public_key': 'pod:PublicKey', 'type_': 'enum:TransactionType'}
- property network: NetworkType
- serialize() bytes
- property size: int
- sort() None
- to_json()
- property type_: TransactionType
- property version: int
- class symbolchain.sc.EmbeddedTransactionFactory
Bases:
object
- classmethod create_by_name(entity_name: str) EmbeddedTransaction
- classmethod deserialize(payload: bytes) EmbeddedTransaction
- class symbolchain.sc.EmbeddedTransferTransactionV1
Bases:
EmbeddedTransaction
- TRANSACTION_TYPE: TransactionType = 16724
- TRANSACTION_VERSION: int = 1
- TYPE_HINTS = {'message': 'bytes_array', 'mosaics': 'array[UnresolvedMosaic]', 'network': 'enum:NetworkType', 'recipient_address': 'pod:UnresolvedAddress', 'signer_public_key': 'pod:PublicKey', 'type_': 'enum:TransactionType'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) EmbeddedTransferTransactionV1
- property message: bytes
- property mosaics: List[UnresolvedMosaic]
- property recipient_address: UnresolvedAddress
- serialize() bytes
- property size: int
- sort() None
- to_json()
- class symbolchain.sc.EmbeddedVotingKeyLinkTransactionV1
Bases:
EmbeddedTransaction
- TRANSACTION_TYPE: TransactionType = 16707
- TRANSACTION_VERSION: int = 1
- TYPE_HINTS = {'end_epoch': 'pod:FinalizationEpoch', 'link_action': 'enum:LinkAction', 'linked_public_key': 'pod:VotingPublicKey', 'network': 'enum:NetworkType', 'signer_public_key': 'pod:PublicKey', 'start_epoch': 'pod:FinalizationEpoch', 'type_': 'enum:TransactionType'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) EmbeddedVotingKeyLinkTransactionV1
- property end_epoch: FinalizationEpoch
- property link_action: LinkAction
- property linked_public_key: VotingPublicKey
- serialize() bytes
- property size: int
- sort() None
- property start_epoch: FinalizationEpoch
- to_json()
- class symbolchain.sc.EmbeddedVrfKeyLinkTransactionV1
Bases:
EmbeddedTransaction
- TRANSACTION_TYPE: TransactionType = 16963
- TRANSACTION_VERSION: int = 1
- TYPE_HINTS = {'link_action': 'enum:LinkAction', 'linked_public_key': 'pod:PublicKey', 'network': 'enum:NetworkType', 'signer_public_key': 'pod:PublicKey', 'type_': 'enum:TransactionType'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) EmbeddedVrfKeyLinkTransactionV1
- property link_action: LinkAction
- serialize() bytes
- property size: int
- sort() None
- to_json()
- class symbolchain.sc.FinalizationEpoch(finalization_epoch: int = 0)
Bases:
BaseValue
- SIZE = 4
- classmethod deserialize(payload: bytes | bytearray | memoryview) FinalizationEpoch
- serialize() bytes
- class symbolchain.sc.FinalizationPoint(finalization_point: int = 0)
Bases:
BaseValue
- SIZE = 4
- classmethod deserialize(payload: bytes | bytearray | memoryview) FinalizationPoint
- serialize() bytes
- class symbolchain.sc.FinalizationRound
Bases:
object
- TYPE_HINTS = {'epoch': 'pod:FinalizationEpoch', 'point': 'pod:FinalizationPoint'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) FinalizationRound
- property epoch: FinalizationEpoch
- property point: FinalizationPoint
- serialize() bytes
- property size: int
- sort() None
- to_json()
- class symbolchain.sc.FinalizedBlockHeader
Bases:
object
- TYPE_HINTS = {'hash': 'pod:Hash256', 'height': 'pod:Height', 'round': 'struct:FinalizationRound'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) FinalizedBlockHeader
- property round: FinalizationRound
- serialize() bytes
- property size: int
- sort() None
- to_json()
- class symbolchain.sc.HarvestFeeReceipt
Bases:
Receipt
- RECEIPT_TYPE: ReceiptType = 8515
- TYPE_HINTS = {'mosaic': 'struct:Mosaic', 'target_address': 'pod:Address', 'type_': 'enum:ReceiptType'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) HarvestFeeReceipt
- serialize() bytes
- property size: int
- sort() None
- to_json()
- class symbolchain.sc.Hash256(hash256: StrBytes = b'\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00')
Bases:
ByteArray
- SIZE = 32
- serialize() bytes
- property size: int
- class symbolchain.sc.Hash512(hash512: StrBytes = b'\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00')
Bases:
ByteArray
- SIZE = 64
- serialize() bytes
- property size: int
- class symbolchain.sc.HashLockTransactionV1
Bases:
Transaction
- TRANSACTION_TYPE: TransactionType = 16712
- TRANSACTION_VERSION: int = 1
- TYPE_HINTS = {'deadline': 'pod:Timestamp', 'duration': 'pod:BlockDuration', 'fee': 'pod:Amount', 'hash': 'pod:Hash256', 'mosaic': 'struct:UnresolvedMosaic', 'network': 'enum:NetworkType', 'signature': 'pod:Signature', 'signer_public_key': 'pod:PublicKey', 'type_': 'enum:TransactionType'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) HashLockTransactionV1
- property duration: BlockDuration
- property mosaic: UnresolvedMosaic
- serialize() bytes
- property size: int
- sort() None
- to_json()
- class symbolchain.sc.Importance(importance: int = 0)
Bases:
BaseValue
- SIZE = 8
- classmethod deserialize(payload: bytes | bytearray | memoryview) Importance
- serialize() bytes
- class symbolchain.sc.ImportanceBlockV1
Bases:
Block
- BLOCK_VERSION: int = 1
- TYPE_HINTS = {'beneficiary_address': 'pod:Address', 'difficulty': 'pod:Difficulty', 'fee_multiplier': 'pod:BlockFeeMultiplier', 'generation_hash_proof': 'struct:VrfProof', 'height': 'pod:Height', 'network': 'enum:NetworkType', 'previous_block_hash': 'pod:Hash256', 'previous_importance_block_hash': 'pod:Hash256', 'receipts_hash': 'pod:Hash256', 'signature': 'pod:Signature', 'signer_public_key': 'pod:PublicKey', 'state_hash': 'pod:Hash256', 'timestamp': 'pod:Timestamp', 'total_voting_balance': 'pod:Amount', 'transactions': 'array[Transaction]', 'transactions_hash': 'pod:Hash256', 'type_': 'enum:BlockType'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) ImportanceBlockV1
- property harvesting_eligible_accounts_count: int
- serialize() bytes
- property size: int
- sort() None
- to_json()
- property transactions: List[Transaction]
- property voting_eligible_accounts_count: int
- class symbolchain.sc.ImportanceHeight(importance_height: int = 0)
Bases:
BaseValue
- SIZE = 8
- classmethod deserialize(payload: bytes | bytearray | memoryview) ImportanceHeight
- serialize() bytes
- class symbolchain.sc.InflationReceipt
Bases:
Receipt
- RECEIPT_TYPE: ReceiptType = 20803
- TYPE_HINTS = {'mosaic': 'struct:Mosaic', 'type_': 'enum:ReceiptType'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) InflationReceipt
- serialize() bytes
- property size: int
- sort() None
- to_json()
- class symbolchain.sc.LinkAction(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- LINK = 1
- UNLINK = 0
- classmethod deserialize(payload: bytes | bytearray | memoryview) LinkAction
- serialize() bytes
- property size: int
- to_json()
- class symbolchain.sc.LockHashAlgorithm(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- HASH_160 = 1
- HASH_256 = 2
- SHA3_256 = 0
- classmethod deserialize(payload: bytes | bytearray | memoryview) LockHashAlgorithm
- serialize() bytes
- property size: int
- to_json()
- class symbolchain.sc.LockHashCompletedFeeReceipt
Bases:
Receipt
- RECEIPT_TYPE: ReceiptType = 8776
- TYPE_HINTS = {'mosaic': 'struct:Mosaic', 'target_address': 'pod:Address', 'type_': 'enum:ReceiptType'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) LockHashCompletedFeeReceipt
- serialize() bytes
- property size: int
- sort() None
- to_json()
- class symbolchain.sc.LockHashCreatedFeeReceipt
Bases:
Receipt
- RECEIPT_TYPE: ReceiptType = 12616
- TYPE_HINTS = {'mosaic': 'struct:Mosaic', 'target_address': 'pod:Address', 'type_': 'enum:ReceiptType'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) LockHashCreatedFeeReceipt
- serialize() bytes
- property size: int
- sort() None
- to_json()
- class symbolchain.sc.LockHashExpiredFeeReceipt
Bases:
Receipt
- RECEIPT_TYPE: ReceiptType = 9032
- TYPE_HINTS = {'mosaic': 'struct:Mosaic', 'target_address': 'pod:Address', 'type_': 'enum:ReceiptType'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) LockHashExpiredFeeReceipt
- serialize() bytes
- property size: int
- sort() None
- to_json()
- class symbolchain.sc.LockSecretCompletedFeeReceipt
Bases:
Receipt
- RECEIPT_TYPE: ReceiptType = 8786
- TYPE_HINTS = {'mosaic': 'struct:Mosaic', 'target_address': 'pod:Address', 'type_': 'enum:ReceiptType'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) LockSecretCompletedFeeReceipt
- serialize() bytes
- property size: int
- sort() None
- to_json()
- class symbolchain.sc.LockSecretCreatedFeeReceipt
Bases:
Receipt
- RECEIPT_TYPE: ReceiptType = 12626
- TYPE_HINTS = {'mosaic': 'struct:Mosaic', 'target_address': 'pod:Address', 'type_': 'enum:ReceiptType'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) LockSecretCreatedFeeReceipt
- serialize() bytes
- property size: int
- sort() None
- to_json()
- class symbolchain.sc.LockSecretExpiredFeeReceipt
Bases:
Receipt
- RECEIPT_TYPE: ReceiptType = 9042
- TYPE_HINTS = {'mosaic': 'struct:Mosaic', 'target_address': 'pod:Address', 'type_': 'enum:ReceiptType'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) LockSecretExpiredFeeReceipt
- serialize() bytes
- property size: int
- sort() None
- to_json()
- class symbolchain.sc.Mosaic
Bases:
object
- TYPE_HINTS = {'amount': 'pod:Amount', 'mosaic_id': 'pod:MosaicId'}
- serialize() bytes
- property size: int
- sort() None
- to_json()
- class symbolchain.sc.MosaicAddressRestrictionTransactionV1
Bases:
Transaction
- TRANSACTION_TYPE: TransactionType = 16977
- TRANSACTION_VERSION: int = 1
- TYPE_HINTS = {'deadline': 'pod:Timestamp', 'fee': 'pod:Amount', 'mosaic_id': 'pod:UnresolvedMosaicId', 'network': 'enum:NetworkType', 'signature': 'pod:Signature', 'signer_public_key': 'pod:PublicKey', 'target_address': 'pod:UnresolvedAddress', 'type_': 'enum:TransactionType'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) MosaicAddressRestrictionTransactionV1
- property mosaic_id: UnresolvedMosaicId
- property new_restriction_value: int
- property previous_restriction_value: int
- property restriction_key: int
- serialize() bytes
- property size: int
- sort() None
- property target_address: UnresolvedAddress
- to_json()
- class symbolchain.sc.MosaicAliasTransactionV1
Bases:
Transaction
- TRANSACTION_TYPE: TransactionType = 17230
- TRANSACTION_VERSION: int = 1
- TYPE_HINTS = {'alias_action': 'enum:AliasAction', 'deadline': 'pod:Timestamp', 'fee': 'pod:Amount', 'mosaic_id': 'pod:MosaicId', 'namespace_id': 'pod:NamespaceId', 'network': 'enum:NetworkType', 'signature': 'pod:Signature', 'signer_public_key': 'pod:PublicKey', 'type_': 'enum:TransactionType'}
- property alias_action: AliasAction
- classmethod deserialize(payload: bytes | bytearray | memoryview) MosaicAliasTransactionV1
- property namespace_id: NamespaceId
- serialize() bytes
- property size: int
- sort() None
- to_json()
- class symbolchain.sc.MosaicDefinitionTransactionV1
Bases:
Transaction
- TRANSACTION_TYPE: TransactionType = 16717
- TRANSACTION_VERSION: int = 1
- TYPE_HINTS = {'deadline': 'pod:Timestamp', 'duration': 'pod:BlockDuration', 'fee': 'pod:Amount', 'flags': 'enum:MosaicFlags', 'id': 'pod:MosaicId', 'network': 'enum:NetworkType', 'nonce': 'pod:MosaicNonce', 'signature': 'pod:Signature', 'signer_public_key': 'pod:PublicKey', 'type_': 'enum:TransactionType'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) MosaicDefinitionTransactionV1
- property divisibility: int
- property duration: BlockDuration
- property flags: MosaicFlags
- property nonce: MosaicNonce
- serialize() bytes
- property size: int
- sort() None
- to_json()
- class symbolchain.sc.MosaicExpiredReceipt
Bases:
Receipt
- RECEIPT_TYPE: ReceiptType = 16717
- TYPE_HINTS = {'artifact_id': 'pod:MosaicId', 'type_': 'enum:ReceiptType'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) MosaicExpiredReceipt
- serialize() bytes
- property size: int
- sort() None
- to_json()
- class symbolchain.sc.MosaicFlags(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Flag
- NONE = 0
- RESTRICTABLE = 4
- REVOKABLE = 8
- SUPPLY_MUTABLE = 1
- TRANSFERABLE = 2
- classmethod deserialize(payload: bytes | bytearray | memoryview) MosaicFlags
- serialize() bytes
- property size: int
- to_json()
- class symbolchain.sc.MosaicGlobalRestrictionTransactionV1
Bases:
Transaction
- TRANSACTION_TYPE: TransactionType = 16721
- TRANSACTION_VERSION: int = 1
- TYPE_HINTS = {'deadline': 'pod:Timestamp', 'fee': 'pod:Amount', 'mosaic_id': 'pod:UnresolvedMosaicId', 'network': 'enum:NetworkType', 'new_restriction_type': 'enum:MosaicRestrictionType', 'previous_restriction_type': 'enum:MosaicRestrictionType', 'reference_mosaic_id': 'pod:UnresolvedMosaicId', 'signature': 'pod:Signature', 'signer_public_key': 'pod:PublicKey', 'type_': 'enum:TransactionType'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) MosaicGlobalRestrictionTransactionV1
- property mosaic_id: UnresolvedMosaicId
- property new_restriction_type: MosaicRestrictionType
- property new_restriction_value: int
- property previous_restriction_type: MosaicRestrictionType
- property previous_restriction_value: int
- property reference_mosaic_id: UnresolvedMosaicId
- property restriction_key: int
- serialize() bytes
- property size: int
- sort() None
- to_json()
- class symbolchain.sc.MosaicMetadataTransactionV1
Bases:
Transaction
- TRANSACTION_TYPE: TransactionType = 16964
- TRANSACTION_VERSION: int = 1
- TYPE_HINTS = {'deadline': 'pod:Timestamp', 'fee': 'pod:Amount', 'network': 'enum:NetworkType', 'signature': 'pod:Signature', 'signer_public_key': 'pod:PublicKey', 'target_address': 'pod:UnresolvedAddress', 'target_mosaic_id': 'pod:UnresolvedMosaicId', 'type_': 'enum:TransactionType', 'value': 'bytes_array'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) MosaicMetadataTransactionV1
- property scoped_metadata_key: int
- serialize() bytes
- property size: int
- sort() None
- property target_address: UnresolvedAddress
- property target_mosaic_id: UnresolvedMosaicId
- to_json()
- property value: bytes
- property value_size_delta: int
- class symbolchain.sc.MosaicNonce(mosaic_nonce: int = 0)
Bases:
BaseValue
- SIZE = 4
- classmethod deserialize(payload: bytes | bytearray | memoryview) MosaicNonce
- serialize() bytes
- class symbolchain.sc.MosaicRentalFeeReceipt
Bases:
Receipt
- RECEIPT_TYPE: ReceiptType = 4685
- TYPE_HINTS = {'mosaic': 'struct:Mosaic', 'recipient_address': 'pod:Address', 'sender_address': 'pod:Address', 'type_': 'enum:ReceiptType'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) MosaicRentalFeeReceipt
- serialize() bytes
- property size: int
- sort() None
- to_json()
- class symbolchain.sc.MosaicResolutionEntry
Bases:
object
- TYPE_HINTS = {'resolved_value': 'pod:MosaicId', 'source': 'struct:ReceiptSource'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) MosaicResolutionEntry
- serialize() bytes
- property size: int
- sort() None
- property source: ReceiptSource
- to_json()
- class symbolchain.sc.MosaicResolutionStatement
Bases:
object
- TYPE_HINTS = {'resolution_entries': 'array[MosaicResolutionEntry]', 'unresolved': 'pod:UnresolvedMosaicId'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) MosaicResolutionStatement
- property resolution_entries: List[MosaicResolutionEntry]
- serialize() bytes
- property size: int
- sort() None
- to_json()
- property unresolved: UnresolvedMosaicId
- class symbolchain.sc.MosaicRestrictionKey(mosaic_restriction_key: int = 0)
Bases:
BaseValue
- SIZE = 8
- classmethod deserialize(payload: bytes | bytearray | memoryview) MosaicRestrictionKey
- serialize() bytes
- class symbolchain.sc.MosaicRestrictionType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- EQ = 1
- GE = 6
- GT = 5
- LE = 4
- LT = 3
- NE = 2
- NONE = 0
- classmethod deserialize(payload: bytes | bytearray | memoryview) MosaicRestrictionType
- serialize() bytes
- property size: int
- to_json()
- class symbolchain.sc.MosaicSupplyChangeAction(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- DECREASE = 0
- INCREASE = 1
- classmethod deserialize(payload: bytes | bytearray | memoryview) MosaicSupplyChangeAction
- serialize() bytes
- property size: int
- to_json()
- class symbolchain.sc.MosaicSupplyChangeTransactionV1
Bases:
Transaction
- TRANSACTION_TYPE: TransactionType = 16973
- TRANSACTION_VERSION: int = 1
- TYPE_HINTS = {'action': 'enum:MosaicSupplyChangeAction', 'deadline': 'pod:Timestamp', 'delta': 'pod:Amount', 'fee': 'pod:Amount', 'mosaic_id': 'pod:UnresolvedMosaicId', 'network': 'enum:NetworkType', 'signature': 'pod:Signature', 'signer_public_key': 'pod:PublicKey', 'type_': 'enum:TransactionType'}
- property action: MosaicSupplyChangeAction
- classmethod deserialize(payload: bytes | bytearray | memoryview) MosaicSupplyChangeTransactionV1
- property mosaic_id: UnresolvedMosaicId
- serialize() bytes
- property size: int
- sort() None
- to_json()
- class symbolchain.sc.MosaicSupplyRevocationTransactionV1
Bases:
Transaction
- TRANSACTION_TYPE: TransactionType = 17229
- TRANSACTION_VERSION: int = 1
- TYPE_HINTS = {'deadline': 'pod:Timestamp', 'fee': 'pod:Amount', 'mosaic': 'struct:UnresolvedMosaic', 'network': 'enum:NetworkType', 'signature': 'pod:Signature', 'signer_public_key': 'pod:PublicKey', 'source_address': 'pod:UnresolvedAddress', 'type_': 'enum:TransactionType'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) MosaicSupplyRevocationTransactionV1
- property mosaic: UnresolvedMosaic
- serialize() bytes
- property size: int
- sort() None
- property source_address: UnresolvedAddress
- to_json()
- class symbolchain.sc.MultisigAccountModificationTransactionV1
Bases:
Transaction
- TRANSACTION_TYPE: TransactionType = 16725
- TRANSACTION_VERSION: int = 1
- TYPE_HINTS = {'address_additions': 'array[UnresolvedAddress]', 'address_deletions': 'array[UnresolvedAddress]', 'deadline': 'pod:Timestamp', 'fee': 'pod:Amount', 'network': 'enum:NetworkType', 'signature': 'pod:Signature', 'signer_public_key': 'pod:PublicKey', 'type_': 'enum:TransactionType'}
- property address_additions: List[UnresolvedAddress]
- property address_deletions: List[UnresolvedAddress]
- classmethod deserialize(payload: bytes | bytearray | memoryview) MultisigAccountModificationTransactionV1
- property min_approval_delta: int
- property min_removal_delta: int
- serialize() bytes
- property size: int
- sort() None
- to_json()
- class symbolchain.sc.NamespaceDeletedReceipt
Bases:
Receipt
- RECEIPT_TYPE: ReceiptType = 16974
- TYPE_HINTS = {'artifact_id': 'pod:NamespaceId', 'type_': 'enum:ReceiptType'}
- property artifact_id: NamespaceId
- classmethod deserialize(payload: bytes | bytearray | memoryview) NamespaceDeletedReceipt
- serialize() bytes
- property size: int
- sort() None
- to_json()
- class symbolchain.sc.NamespaceExpiredReceipt
Bases:
Receipt
- RECEIPT_TYPE: ReceiptType = 16718
- TYPE_HINTS = {'artifact_id': 'pod:NamespaceId', 'type_': 'enum:ReceiptType'}
- property artifact_id: NamespaceId
- classmethod deserialize(payload: bytes | bytearray | memoryview) NamespaceExpiredReceipt
- serialize() bytes
- property size: int
- sort() None
- to_json()
- class symbolchain.sc.NamespaceId(namespace_id: int = 0)
Bases:
BaseValue
- SIZE = 8
- classmethod deserialize(payload: bytes | bytearray | memoryview) NamespaceId
- serialize() bytes
- class symbolchain.sc.NamespaceMetadataTransactionV1
Bases:
Transaction
- TRANSACTION_TYPE: TransactionType = 17220
- TRANSACTION_VERSION: int = 1
- TYPE_HINTS = {'deadline': 'pod:Timestamp', 'fee': 'pod:Amount', 'network': 'enum:NetworkType', 'signature': 'pod:Signature', 'signer_public_key': 'pod:PublicKey', 'target_address': 'pod:UnresolvedAddress', 'target_namespace_id': 'pod:NamespaceId', 'type_': 'enum:TransactionType', 'value': 'bytes_array'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) NamespaceMetadataTransactionV1
- property scoped_metadata_key: int
- serialize() bytes
- property size: int
- sort() None
- property target_address: UnresolvedAddress
- property target_namespace_id: NamespaceId
- to_json()
- property value: bytes
- property value_size_delta: int
- class symbolchain.sc.NamespaceRegistrationTransactionV1
Bases:
Transaction
- TRANSACTION_TYPE: TransactionType = 16718
- TRANSACTION_VERSION: int = 1
- TYPE_HINTS = {'deadline': 'pod:Timestamp', 'duration': 'pod:BlockDuration', 'fee': 'pod:Amount', 'id': 'pod:NamespaceId', 'name': 'bytes_array', 'network': 'enum:NetworkType', 'parent_id': 'pod:NamespaceId', 'registration_type': 'enum:NamespaceRegistrationType', 'signature': 'pod:Signature', 'signer_public_key': 'pod:PublicKey', 'type_': 'enum:TransactionType'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) NamespaceRegistrationTransactionV1
- property duration: BlockDuration
- property id: NamespaceId
- property name: bytes
- property parent_id: NamespaceId
- property registration_type: NamespaceRegistrationType
- serialize() bytes
- property size: int
- sort() None
- to_json()
- class symbolchain.sc.NamespaceRegistrationType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- CHILD = 1
- ROOT = 0
- classmethod deserialize(payload: bytes | bytearray | memoryview) NamespaceRegistrationType
- serialize() bytes
- property size: int
- to_json()
- class symbolchain.sc.NamespaceRentalFeeReceipt
Bases:
Receipt
- RECEIPT_TYPE: ReceiptType = 4942
- TYPE_HINTS = {'mosaic': 'struct:Mosaic', 'recipient_address': 'pod:Address', 'sender_address': 'pod:Address', 'type_': 'enum:ReceiptType'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) NamespaceRentalFeeReceipt
- serialize() bytes
- property size: int
- sort() None
- to_json()
- class symbolchain.sc.NemesisBlockV1
Bases:
Block
- BLOCK_VERSION: int = 1
- TYPE_HINTS = {'beneficiary_address': 'pod:Address', 'difficulty': 'pod:Difficulty', 'fee_multiplier': 'pod:BlockFeeMultiplier', 'generation_hash_proof': 'struct:VrfProof', 'height': 'pod:Height', 'network': 'enum:NetworkType', 'previous_block_hash': 'pod:Hash256', 'previous_importance_block_hash': 'pod:Hash256', 'receipts_hash': 'pod:Hash256', 'signature': 'pod:Signature', 'signer_public_key': 'pod:PublicKey', 'state_hash': 'pod:Hash256', 'timestamp': 'pod:Timestamp', 'total_voting_balance': 'pod:Amount', 'transactions': 'array[Transaction]', 'transactions_hash': 'pod:Hash256', 'type_': 'enum:BlockType'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) NemesisBlockV1
- property harvesting_eligible_accounts_count: int
- serialize() bytes
- property size: int
- sort() None
- to_json()
- property transactions: List[Transaction]
- property voting_eligible_accounts_count: int
- class symbolchain.sc.NetworkType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- MAINNET = 104
- TESTNET = 152
- classmethod deserialize(payload: bytes | bytearray | memoryview) NetworkType
- serialize() bytes
- property size: int
- to_json()
- class symbolchain.sc.NodeKeyLinkTransactionV1
Bases:
Transaction
- TRANSACTION_TYPE: TransactionType = 16972
- TRANSACTION_VERSION: int = 1
- TYPE_HINTS = {'deadline': 'pod:Timestamp', 'fee': 'pod:Amount', 'link_action': 'enum:LinkAction', 'linked_public_key': 'pod:PublicKey', 'network': 'enum:NetworkType', 'signature': 'pod:Signature', 'signer_public_key': 'pod:PublicKey', 'type_': 'enum:TransactionType'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) NodeKeyLinkTransactionV1
- property link_action: LinkAction
- serialize() bytes
- property size: int
- sort() None
- to_json()
- class symbolchain.sc.NormalBlockV1
Bases:
Block
- BLOCK_VERSION: int = 1
- TYPE_HINTS = {'beneficiary_address': 'pod:Address', 'difficulty': 'pod:Difficulty', 'fee_multiplier': 'pod:BlockFeeMultiplier', 'generation_hash_proof': 'struct:VrfProof', 'height': 'pod:Height', 'network': 'enum:NetworkType', 'previous_block_hash': 'pod:Hash256', 'receipts_hash': 'pod:Hash256', 'signature': 'pod:Signature', 'signer_public_key': 'pod:PublicKey', 'state_hash': 'pod:Hash256', 'timestamp': 'pod:Timestamp', 'transactions': 'array[Transaction]', 'transactions_hash': 'pod:Hash256', 'type_': 'enum:BlockType'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) NormalBlockV1
- serialize() bytes
- property size: int
- sort() None
- to_json()
- property transactions: List[Transaction]
- class symbolchain.sc.ProofGamma(proof_gamma: StrBytes = b'\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00')
Bases:
ByteArray
- SIZE = 32
- classmethod deserialize(payload: bytes | bytearray | memoryview) ProofGamma
- serialize() bytes
- property size: int
- class symbolchain.sc.ProofScalar(proof_scalar: StrBytes = b'\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00')
Bases:
ByteArray
- SIZE = 32
- classmethod deserialize(payload: bytes | bytearray | memoryview) ProofScalar
- serialize() bytes
- property size: int
- class symbolchain.sc.ProofVerificationHash(proof_verification_hash: StrBytes = b'\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00')
Bases:
ByteArray
- SIZE = 16
- classmethod deserialize(payload: bytes | bytearray | memoryview) ProofVerificationHash
- serialize() bytes
- property size: int
- class symbolchain.sc.PublicKey(public_key: StrBytes = b'\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00')
Bases:
ByteArray
- SIZE = 32
- serialize() bytes
- property size: int
- class symbolchain.sc.Receipt
Bases:
object
- TYPE_HINTS = {'type_': 'enum:ReceiptType'}
- serialize() bytes
- property size: int
- sort() None
- to_json()
- property type_: ReceiptType
- property version: int
- class symbolchain.sc.ReceiptFactory
Bases:
object
- class symbolchain.sc.ReceiptSource
Bases:
object
- TYPE_HINTS = {}
- classmethod deserialize(payload: bytes | bytearray | memoryview) ReceiptSource
- property primary_id: int
- property secondary_id: int
- serialize() bytes
- property size: int
- sort() None
- to_json()
- class symbolchain.sc.ReceiptType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- ADDRESS_ALIAS_RESOLUTION = 61763
- HARVEST_FEE = 8515
- INFLATION = 20803
- LOCK_HASH_COMPLETED = 8776
- LOCK_HASH_CREATED = 12616
- LOCK_HASH_EXPIRED = 9032
- LOCK_SECRET_COMPLETED = 8786
- LOCK_SECRET_CREATED = 12626
- LOCK_SECRET_EXPIRED = 9042
- MOSAIC_ALIAS_RESOLUTION = 62019
- MOSAIC_EXPIRED = 16717
- MOSAIC_RENTAL_FEE = 4685
- NAMESPACE_DELETED = 16974
- NAMESPACE_EXPIRED = 16718
- NAMESPACE_RENTAL_FEE = 4942
- TRANSACTION_GROUP = 57667
- classmethod deserialize(payload: bytes | bytearray | memoryview) ReceiptType
- serialize() bytes
- property size: int
- to_json()
- class symbolchain.sc.SecretLockTransactionV1
Bases:
Transaction
- TRANSACTION_TYPE: TransactionType = 16722
- TRANSACTION_VERSION: int = 1
- TYPE_HINTS = {'deadline': 'pod:Timestamp', 'duration': 'pod:BlockDuration', 'fee': 'pod:Amount', 'hash_algorithm': 'enum:LockHashAlgorithm', 'mosaic': 'struct:UnresolvedMosaic', 'network': 'enum:NetworkType', 'recipient_address': 'pod:UnresolvedAddress', 'secret': 'pod:Hash256', 'signature': 'pod:Signature', 'signer_public_key': 'pod:PublicKey', 'type_': 'enum:TransactionType'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) SecretLockTransactionV1
- property duration: BlockDuration
- property hash_algorithm: LockHashAlgorithm
- property mosaic: UnresolvedMosaic
- property recipient_address: UnresolvedAddress
- serialize() bytes
- property size: int
- sort() None
- to_json()
- class symbolchain.sc.SecretProofTransactionV1
Bases:
Transaction
- TRANSACTION_TYPE: TransactionType = 16978
- TRANSACTION_VERSION: int = 1
- TYPE_HINTS = {'deadline': 'pod:Timestamp', 'fee': 'pod:Amount', 'hash_algorithm': 'enum:LockHashAlgorithm', 'network': 'enum:NetworkType', 'proof': 'bytes_array', 'recipient_address': 'pod:UnresolvedAddress', 'secret': 'pod:Hash256', 'signature': 'pod:Signature', 'signer_public_key': 'pod:PublicKey', 'type_': 'enum:TransactionType'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) SecretProofTransactionV1
- property hash_algorithm: LockHashAlgorithm
- property proof: bytes
- property recipient_address: UnresolvedAddress
- serialize() bytes
- property size: int
- sort() None
- to_json()
- class symbolchain.sc.Signature(signature: StrBytes = b'\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00')
Bases:
ByteArray
- SIZE = 64
- serialize() bytes
- property size: int
- class symbolchain.sc.Transaction
Bases:
object
- TYPE_HINTS = {'deadline': 'pod:Timestamp', 'fee': 'pod:Amount', 'network': 'enum:NetworkType', 'signature': 'pod:Signature', 'signer_public_key': 'pod:PublicKey', 'type_': 'enum:TransactionType'}
- property network: NetworkType
- serialize() bytes
- property size: int
- sort() None
- to_json()
- property type_: TransactionType
- property version: int
- class symbolchain.sc.TransactionFactory
Bases:
object
- classmethod create_by_name(entity_name: str) Transaction
- classmethod deserialize(payload: bytes) Transaction
- class symbolchain.sc.TransactionStatement
Bases:
object
- TYPE_HINTS = {'receipts': 'array[Receipt]'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) TransactionStatement
- property primary_id: int
- property secondary_id: int
- serialize() bytes
- property size: int
- sort() None
- to_json()
- class symbolchain.sc.TransactionType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum
- ACCOUNT_ADDRESS_RESTRICTION = 16720
- ACCOUNT_KEY_LINK = 16716
- ACCOUNT_METADATA = 16708
- ACCOUNT_MOSAIC_RESTRICTION = 16976
- ACCOUNT_OPERATION_RESTRICTION = 17232
- ADDRESS_ALIAS = 16974
- AGGREGATE_BONDED = 16961
- AGGREGATE_COMPLETE = 16705
- HASH_LOCK = 16712
- MOSAIC_ADDRESS_RESTRICTION = 16977
- MOSAIC_ALIAS = 17230
- MOSAIC_DEFINITION = 16717
- MOSAIC_GLOBAL_RESTRICTION = 16721
- MOSAIC_METADATA = 16964
- MOSAIC_SUPPLY_CHANGE = 16973
- MOSAIC_SUPPLY_REVOCATION = 17229
- MULTISIG_ACCOUNT_MODIFICATION = 16725
- NAMESPACE_METADATA = 17220
- NAMESPACE_REGISTRATION = 16718
- NODE_KEY_LINK = 16972
- SECRET_LOCK = 16722
- SECRET_PROOF = 16978
- TRANSFER = 16724
- VOTING_KEY_LINK = 16707
- VRF_KEY_LINK = 16963
- classmethod deserialize(payload: bytes | bytearray | memoryview) TransactionType
- serialize() bytes
- property size: int
- to_json()
- class symbolchain.sc.TransferTransactionV1
Bases:
Transaction
- TRANSACTION_TYPE: TransactionType = 16724
- TRANSACTION_VERSION: int = 1
- TYPE_HINTS = {'deadline': 'pod:Timestamp', 'fee': 'pod:Amount', 'message': 'bytes_array', 'mosaics': 'array[UnresolvedMosaic]', 'network': 'enum:NetworkType', 'recipient_address': 'pod:UnresolvedAddress', 'signature': 'pod:Signature', 'signer_public_key': 'pod:PublicKey', 'type_': 'enum:TransactionType'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) TransferTransactionV1
- property message: bytes
- property mosaics: List[UnresolvedMosaic]
- property recipient_address: UnresolvedAddress
- serialize() bytes
- property size: int
- sort() None
- to_json()
- class symbolchain.sc.UnresolvedAddress(unresolved_address: StrBytes = b'\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00')
Bases:
ByteArray
- SIZE = 24
- classmethod deserialize(payload: bytes | bytearray | memoryview) UnresolvedAddress
- serialize() bytes
- property size: int
- class symbolchain.sc.UnresolvedMosaic
Bases:
object
- TYPE_HINTS = {'amount': 'pod:Amount', 'mosaic_id': 'pod:UnresolvedMosaicId'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) UnresolvedMosaic
- property mosaic_id: UnresolvedMosaicId
- serialize() bytes
- property size: int
- sort() None
- to_json()
- class symbolchain.sc.UnresolvedMosaicId(unresolved_mosaic_id: int = 0)
Bases:
BaseValue
- SIZE = 8
- classmethod deserialize(payload: bytes | bytearray | memoryview) UnresolvedMosaicId
- serialize() bytes
- class symbolchain.sc.VotingKeyLinkTransactionV1
Bases:
Transaction
- TRANSACTION_TYPE: TransactionType = 16707
- TRANSACTION_VERSION: int = 1
- TYPE_HINTS = {'deadline': 'pod:Timestamp', 'end_epoch': 'pod:FinalizationEpoch', 'fee': 'pod:Amount', 'link_action': 'enum:LinkAction', 'linked_public_key': 'pod:VotingPublicKey', 'network': 'enum:NetworkType', 'signature': 'pod:Signature', 'signer_public_key': 'pod:PublicKey', 'start_epoch': 'pod:FinalizationEpoch', 'type_': 'enum:TransactionType'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) VotingKeyLinkTransactionV1
- property end_epoch: FinalizationEpoch
- property link_action: LinkAction
- property linked_public_key: VotingPublicKey
- serialize() bytes
- property size: int
- sort() None
- property start_epoch: FinalizationEpoch
- to_json()
- class symbolchain.sc.VotingPublicKey(voting_public_key: StrBytes = b'\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00')
Bases:
ByteArray
- SIZE = 32
- classmethod deserialize(payload: bytes | bytearray | memoryview) VotingPublicKey
- serialize() bytes
- property size: int
- class symbolchain.sc.VrfKeyLinkTransactionV1
Bases:
Transaction
- TRANSACTION_TYPE: TransactionType = 16963
- TRANSACTION_VERSION: int = 1
- TYPE_HINTS = {'deadline': 'pod:Timestamp', 'fee': 'pod:Amount', 'link_action': 'enum:LinkAction', 'linked_public_key': 'pod:PublicKey', 'network': 'enum:NetworkType', 'signature': 'pod:Signature', 'signer_public_key': 'pod:PublicKey', 'type_': 'enum:TransactionType'}
- classmethod deserialize(payload: bytes | bytearray | memoryview) VrfKeyLinkTransactionV1
- property link_action: LinkAction
- serialize() bytes
- property size: int
- sort() None
- to_json()
- class symbolchain.sc.VrfProof
Bases:
object
- TYPE_HINTS = {'gamma': 'pod:ProofGamma', 'scalar': 'pod:ProofScalar', 'verification_hash': 'pod:ProofVerificationHash'}
- property gamma: ProofGamma
- property scalar: ProofScalar
- serialize() bytes
- property size: int
- sort() None
- to_json()
- property verification_hash: ProofVerificationHash