duniterpy package

Subpackages

• duniterpy.api package
  • Subpackages
    • duniterpy.api.bma package
      • Submodules
      • duniterpy.api.bma.blockchain module
      • duniterpy.api.bma.network module
      • duniterpy.api.bma.node module
      • duniterpy.api.bma.tx module
      • duniterpy.api.bma.ud module
      • duniterpy.api.bma.wot module
      • duniterpy.api.bma.ws module
      • Module contents
    • duniterpy.api.ws2p package
      • Submodules
      • duniterpy.api.ws2p.network module
      • duniterpy.api.ws2p.requests module
      • Module contents
  • Submodules
  • duniterpy.api.client module
    • API
      • API.connect_ws()
      • API.request_url()
      • API.reverse_url()
    • Client
      • Client.connect_ws()
      • Client.get()
      • Client.post()
      • Client.query()
    • WSConnection
      • WSConnection.close()
      • WSConnection.receive_json()
      • WSConnection.receive_str()
      • WSConnection.send_str()
    • WSConnectionException
    • parse_error()
    • parse_response()
    • parse_text()
  • duniterpy.api.endpoint module
    • BMAEndpoint
      • BMAEndpoint.API
      • BMAEndpoint.conn_handler()
      • BMAEndpoint.from_inline()
      • BMAEndpoint.inline()
      • BMAEndpoint.re_inline
    • ConnectionHandler
    • ESCoreEndpoint
      • ESCoreEndpoint.API
      • ESCoreEndpoint.conn_handler()
      • ESCoreEndpoint.from_inline()
      • ESCoreEndpoint.inline()
      • ESCoreEndpoint.re_inline
    • ESSubscribtionEndpoint
      • ESSubscribtionEndpoint.API
      • ESSubscribtionEndpoint.conn_handler()
      • ESSubscribtionEndpoint.from_inline()
      • ESSubscribtionEndpoint.inline()
      • ESSubscribtionEndpoint.re_inline
    • ESUserEndpoint
      • ESUserEndpoint.API
      • ESUserEndpoint.conn_handler()
      • ESUserEndpoint.from_inline()
      • ESUserEndpoint.inline()
      • ESUserEndpoint.re_inline
    • Endpoint
      • Endpoint.conn_handler()
      • Endpoint.from_inline()
      • Endpoint.inline()
    • GVAEndpoint
      • GVAEndpoint.API
      • GVAEndpoint.conn_handler()
      • GVAEndpoint.endpoint_format
      • GVAEndpoint.from_inline()
      • GVAEndpoint.inline()
      • GVAEndpoint.re_inline
    • SecuredBMAEndpoint
      • SecuredBMAEndpoint.API
      • SecuredBMAEndpoint.conn_handler()
      • SecuredBMAEndpoint.from_inline()
      • SecuredBMAEndpoint.inline()
      • SecuredBMAEndpoint.re_inline
    • UnknownEndpoint
      • UnknownEndpoint.API
      • UnknownEndpoint.conn_handler()
      • UnknownEndpoint.from_inline()
      • UnknownEndpoint.inline()
    • WS2PEndpoint
      • WS2PEndpoint.API
      • WS2PEndpoint.conn_handler()
      • WS2PEndpoint.from_inline()
      • WS2PEndpoint.inline()
      • WS2PEndpoint.re_inline
    • endpoint()
    • fix_host_ipv4_mix_up()
  • duniterpy.api.errors module
    • DuniterError
  • Module contents
• duniterpy.documents package
  • Subpackages
    • duniterpy.documents.ws2p package
      • Submodules
      • duniterpy.documents.ws2p.heads module
      • duniterpy.documents.ws2p.messages module
      • Module contents
  • Submodules
  • duniterpy.documents.block module
    • Block
      • Block.block_id
      • Block.check_signature()
      • Block.computed_inner_hash()
      • Block.fields_parsers
      • Block.from_parsed_json()
      • Block.from_signed_raw()
      • Block.proof_of_work()
      • Block.raw()
      • Block.re_actives
      • Block.re_certifications
      • Block.re_different_issuers_count
      • Block.re_excluded
      • Block.re_exclusion
      • Block.re_hash
      • Block.re_identities
      • Block.re_issuer
      • Block.re_issuers_frame
      • Block.re_issuers_frame_var
      • Block.re_joiners
      • Block.re_leavers
      • Block.re_mediantime
      • Block.re_memberscount
      • Block.re_nonce
      • Block.re_number
      • Block.re_parameters
      • Block.re_powmin
      • Block.re_previoushash
      • Block.re_previousissuer
      • Block.re_revoked
      • Block.re_time
      • Block.re_transactions
      • Block.re_type
      • Block.re_unitbase
      • Block.re_universaldividend
      • Block.sign()
    • SignatureException
  • duniterpy.documents.block_id module
    • BlockID
      • BlockID.empty()
      • BlockID.from_str()
      • BlockID.re_block_id
      • BlockID.re_hash
    • get_block_id()
  • duniterpy.documents.certification module
    • Certification
      • Certification.fields_parsers
      • Certification.from_inline()
      • Certification.from_signed_raw()
      • Certification.inline()
      • Certification.raw()
      • Certification.re_cert_block_id
      • Certification.re_inline
      • Certification.re_issuer
      • Certification.re_type
      • Certification.sign()
      • Certification.signed_raw()
  • duniterpy.documents.document module
    • Document
      • Document.check_signature()
      • Document.fields_parsers
      • Document.parse_field()
      • Document.raw()
      • Document.re_currency
      • Document.re_signature
      • Document.re_version
      • Document.sha_hash
      • Document.sign()
      • Document.signed_raw()
    • MalformedDocumentError
    • SignatureException
  • duniterpy.documents.identity module
    • Identity
      • Identity.fields_parsers
      • Identity.from_bma_lookup_response()
      • Identity.from_certification_raw()
      • Identity.from_inline()
      • Identity.from_revocation_raw()
      • Identity.from_signed_raw()
      • Identity.inline()
      • Identity.raw()
      • Identity.re_block_id
      • Identity.re_idty_block_id
      • Identity.re_idty_issuer
      • Identity.re_idty_signature
      • Identity.re_idty_unique_id
      • Identity.re_inline
      • Identity.re_issuer
      • Identity.re_meta_ts
      • Identity.re_type
      • Identity.re_uid
      • Identity.re_unique_id
    • IdentityException
  • duniterpy.documents.membership module
    • Membership
      • Membership.fields_parsers
      • Membership.from_inline()
      • Membership.from_signed_raw()
      • Membership.inline()
      • Membership.raw()
      • Membership.re_block
      • Membership.re_certts
      • Membership.re_inline
      • Membership.re_issuer
      • Membership.re_membership_type
      • Membership.re_type
      • Membership.re_userid
  • duniterpy.documents.peer module
    • Peer
      • Peer.fields_parsers
      • Peer.from_bma()
      • Peer.from_signed_raw()
      • Peer.raw()
      • Peer.re_block
      • Peer.re_endpoints
      • Peer.re_pubkey
      • Peer.re_type
  • duniterpy.documents.revocation module
    • Revocation
      • Revocation.extract_self_cert()
      • Revocation.fields_parsers
      • Revocation.from_inline()
      • Revocation.from_signed_raw()
      • Revocation.inline()
      • Revocation.raw()
      • Revocation.re_block_id
      • Revocation.re_idtysignature
      • Revocation.re_inline
      • Revocation.re_issuer
      • Revocation.re_type
      • Revocation.re_uniqueid
      • Revocation.sign()
      • Revocation.signed_raw()
  • duniterpy.documents.transaction module
    • InputSource
      • InputSource.from_inline()
      • InputSource.inline()
      • InputSource.re_inline
    • OutputSource
      • OutputSource.condition_from_text()
      • OutputSource.from_inline()
      • OutputSource.inline()
      • OutputSource.inline_condition()
      • OutputSource.re_inline
    • SIGParameter
      • SIGParameter.from_parameter()
      • SIGParameter.re_sig
    • SignatureException
    • SimpleTransaction
      • SimpleTransaction.is_simple()
    • Transaction
      • Transaction.check_signature()
      • Transaction.check_signatures()
      • Transaction.compact()
      • Transaction.fields_parsers
      • Transaction.from_bma_history()
      • Transaction.from_compact()
      • Transaction.from_signed_raw()
      • Transaction.multi_sign()
      • Transaction.raw()
      • Transaction.re_block_id
      • Transaction.re_comment
      • Transaction.re_compact_block_id
      • Transaction.re_compact_comment
      • Transaction.re_header
      • Transaction.re_inputs
      • Transaction.re_issuers
      • Transaction.re_locktime
      • Transaction.re_outputs
      • Transaction.re_pubkey
      • Transaction.re_type
      • Transaction.re_unlocks
      • Transaction.sign()
      • Transaction.signed_raw()
    • Unlock
      • Unlock.from_inline()
      • Unlock.inline()
      • Unlock.re_inline
    • UnlockParameter
      • UnlockParameter.compute()
      • UnlockParameter.from_parameter()
    • XHXParameter
      • XHXParameter.compute()
      • XHXParameter.from_parameter()
      • XHXParameter.re_xhx
    • reduce_base()
  • Module contents
• duniterpy.grammars package
  • Submodules
  • duniterpy.grammars.output module
    • CLTV
      • CLTV.compose()
      • CLTV.grammar
      • CLTV.token()
    • CSV
      • CSV.compose()
      • CSV.grammar
      • CSV.token()
    • Condition
      • Condition.compose()
      • Condition.grammar
      • Condition.token()
    • Hash
      • Hash.regex
    • Int
      • Int.regex
    • Operator
      • Operator.compose()
      • Operator.grammar
      • Operator.regex
      • Operator.token()
    • Pubkey
      • Pubkey.regex
    • SIG
      • SIG.compose()
      • SIG.grammar
      • SIG.token()
    • XHX
      • XHX.compose()
      • XHX.grammar
      • XHX.token()
  • Module contents
• duniterpy.helpers package
  • Submodules
  • duniterpy.helpers.blockchain module
    • Blockchain()
    • JsonBlockchain
      • JsonBlockchain.current_block()
      • JsonBlockchain.get_block_number()
      • JsonBlockchain.parsechunk()
    • load()
    • load_json()
  • duniterpy.helpers.money module
    • output_available()
  • duniterpy.helpers.network module
    • get_available_nodes()
  • duniterpy.helpers.ws2p module
    • generate_ws2p_endpoint()
    • handshake()
  • Module contents
• duniterpy.key package
  • Submodules
  • duniterpy.key.ascii_armor module
    • AsciiArmor
      • AsciiArmor.create()
      • AsciiArmor.parse()
    • MissingPublickeyAndSigningKeyException
    • ParserMissingPublicKeysException
    • ParserMissingSigningKeyException
  • duniterpy.key.base58 module
    • Base58Encoder
      • Base58Encoder.decode()
      • Base58Encoder.encode()
  • duniterpy.key.constants module
  • duniterpy.key.crc_pubkey module
    • CRCPubkey
      • CRCPubkey.from_pubkey()
      • CRCPubkey.from_str()
      • CRCPubkey.is_valid()
      • CRCPubkey.re_crc_pubkey
    • CRCPubkeyException
  • duniterpy.key.encryption_key module
    • PublicKey
      • PublicKey.base58()
      • PublicKey.encrypt_seal()
    • SecretKey
      • SecretKey.decrypt()
      • SecretKey.encrypt()
  • duniterpy.key.scrypt_params module
    • ScryptParams
  • duniterpy.key.signing_key module
    • SigningKey
      • SigningKey.decrypt_seal()
      • SigningKey.from_credentials()
      • SigningKey.from_credentials_file()
      • SigningKey.from_dubp_mnemonic()
      • SigningKey.from_ewif_file()
      • SigningKey.from_ewif_hex()
      • SigningKey.from_private_key()
      • SigningKey.from_pubsec_file()
      • SigningKey.from_seedhex()
      • SigningKey.from_seedhex_file()
      • SigningKey.from_ssb_file()
      • SigningKey.from_wif_file()
      • SigningKey.from_wif_hex()
      • SigningKey.from_wif_or_ewif_file()
      • SigningKey.from_wif_or_ewif_hex()
      • SigningKey.save_ewif_file()
      • SigningKey.save_private_key()
      • SigningKey.save_pubsec_file()
      • SigningKey.save_seedhex_file()
      • SigningKey.save_wif_file()
    • SigningKeyException
    • opener_user_rw()
  • duniterpy.key.verifying_key module
    • VerifyingKey
      • VerifyingKey.check_signature()
      • VerifyingKey.get_verified_data()
  • Module contents

Submodules

duniterpy.constants module

duniterpy.tools module

duniterpy.tools.convert_seed_to_seedhex(seed: bytes) → str

Convert seed to seedhex

Parameters:

seed – seed

Rtype str:

duniterpy.tools.convert_seedhex_to_seed(seedhex: str) → bytes

Convert seedhex to seed

Parameters:

seedhex – seed coded in hexadecimal base

Rtype bytes:

duniterpy.tools.ensure_bytes(data: str | bytes) → bytes

Convert data in bytes if data is a string

Parameters:

data – Data

Rtype bytes:

duniterpy.tools.ensure_str(data: str | bytes) → str

Convert data in str if data are bytes

Parameters:

data – Data

Rtype str:

duniterpy.tools.get_ws2p_challenge() → str

Return two uuid v4 concatened as ws2p challenge

Rtype str:

duniterpy.tools.xor_bytes(b1: bytes, b2: bytes) → bytearray

Apply XOR operation on two bytes arguments

Parameters:

• b1 – First bytes argument

• b2 – Second bytes argument

Rtype bytearray:

Module contents