bitcoinlib package

Subpackages

• bitcoinlib.config package
  • Submodules
    • bitcoinlib.config.config module
      • initialize_lib()
      • read_config()
    • bitcoinlib.config.opcodes module
      • op()
    • bitcoinlib.config.secp256k1 module
  • Module contents
• bitcoinlib.services package
  • Submodules
    • bitcoinlib.services.authproxy module
      • AuthServiceProxy
      • EncodeDecimal()
      • JSONRPCException
    • bitcoinlib.services.baseclient module
      • BaseClient
      • ClientError
    • bitcoinlib.services.bcoin module
      • BcoinClient
    • bitcoinlib.services.bitaps module
      • BitapsClient
    • bitcoinlib.services.bitcoind module
      • BitcoindClient
      • ConfigError
    • bitcoinlib.services.bitcoinlibtest module
      • BitcoinLibTestClient
    • bitcoinlib.services.bitflyer module
      • BitflyerClient
    • bitcoinlib.services.bitgo module
      • BitGoClient
    • bitcoinlib.services.blockbook module
      • BlockbookClient
    • bitcoinlib.services.blockbook1 module
      • BlockbookClient
    • bitcoinlib.services.blockchaininfo module
      • BlockchainInfoClient
    • bitcoinlib.services.blockchair module
      • BlockChairClient
    • bitcoinlib.services.blockcypher module
      • BlockCypher
    • bitcoinlib.services.blocksmurfer module
      • BlocksmurferClient
    • bitcoinlib.services.blockstream module
      • BlockstreamClient
    • bitcoinlib.services.chainso module
      • ChainSo
    • bitcoinlib.services.cryptoid module
      • CryptoID
    • bitcoinlib.services.dogecoind module
      • ConfigError
      • DogecoindClient
    • bitcoinlib.services.electrumx module
      • ElectrumxClient
    • bitcoinlib.services.litecoinblockexplorer module
      • LitecoinBlockexplorerClient
    • bitcoinlib.services.litecoind module
      • ConfigError
      • LitecoindClient
    • bitcoinlib.services.litecoreio module
      • LitecoreIOClient
    • bitcoinlib.services.mempool module
      • MempoolClient
    • bitcoinlib.services.nownodes module
      • NownodesClient
    • bitcoinlib.services.services module
      • Cache
      • Service
      • ServiceError
  • Module contents
• bitcoinlib.tools package
  • Submodules
    • bitcoinlib.tools.benchmark module
    • bitcoinlib.tools.clw module
      • create_transaction()
      • create_wallet()
      • exception_handler()
      • get_passphrase()
      • main()
      • parse_args()
      • print_transaction()
    • bitcoinlib.tools.import_database module
    • bitcoinlib.tools.mnemonic_key_create module
    • bitcoinlib.tools.sign_raw module
    • bitcoinlib.tools.wallet_multisig_2of3 module
  • Module contents

Submodules

• bitcoinlib.blocks module
  • Block
    • Block.as_dict()
    • Block.check_proof_of_work()
    • Block.difficulty
    • Block.parse()
    • Block.parse_bytes()
    • Block.parse_bytesio()
    • Block.parse_transaction()
    • Block.parse_transaction_dict()
    • Block.parse_transactions()
    • Block.parse_transactions_dict()
    • Block.serialize()
    • Block.target
    • Block.target_hex
    • Block.update_totals()
    • Block.version_bin
    • Block.version_bips()
• bitcoinlib.db module
  • Db
    • Db.drop_db()
  • DbConfig
    • DbConfig.value
    • DbConfig.variable
  • DbKey
    • DbKey.account_id
    • DbKey.address
    • DbKey.address_index
    • DbKey.balance
    • DbKey.change
    • DbKey.compressed
    • DbKey.cosigner_id
    • DbKey.depth
    • DbKey.encoding
    • DbKey.id
    • DbKey.is_private
    • DbKey.key_type
    • DbKey.latest_txid
    • DbKey.multisig_children
    • DbKey.multisig_parents
    • DbKey.name
    • DbKey.network
    • DbKey.network_name
    • DbKey.parent_id
    • DbKey.path
    • DbKey.private
    • DbKey.public
    • DbKey.purpose
    • DbKey.transaction_inputs
    • DbKey.transaction_outputs
    • DbKey.used
    • DbKey.wallet
    • DbKey.wallet_id
    • DbKey.wif
    • DbKey.witness_type
  • DbKeyMultisigChildren
    • DbKeyMultisigChildren.child_id
    • DbKeyMultisigChildren.key_order
    • DbKeyMultisigChildren.parent_id
  • DbNetwork
    • DbNetwork.description
    • DbNetwork.name
  • DbTransaction
    • DbTransaction.account_id
    • DbTransaction.block_height
    • DbTransaction.coinbase
    • DbTransaction.confirmations
    • DbTransaction.date
    • DbTransaction.fee
    • DbTransaction.id
    • DbTransaction.index
    • DbTransaction.input_total
    • DbTransaction.inputs
    • DbTransaction.is_complete
    • DbTransaction.locktime
    • DbTransaction.network
    • DbTransaction.network_name
    • DbTransaction.output_total
    • DbTransaction.outputs
    • DbTransaction.raw
    • DbTransaction.size
    • DbTransaction.status
    • DbTransaction.txid
    • DbTransaction.verified
    • DbTransaction.version
    • DbTransaction.wallet
    • DbTransaction.wallet_id
    • DbTransaction.witness_type
  • DbTransactionInput
    • DbTransactionInput.address
    • DbTransactionInput.double_spend
    • DbTransactionInput.index_n
    • DbTransactionInput.key
    • DbTransactionInput.key_id
    • DbTransactionInput.output_n
    • DbTransactionInput.prev_txid
    • DbTransactionInput.script
    • DbTransactionInput.script_type
    • DbTransactionInput.sequence
    • DbTransactionInput.transaction
    • DbTransactionInput.transaction_id
    • DbTransactionInput.value
    • DbTransactionInput.witness_type
    • DbTransactionInput.witnesses
  • DbTransactionOutput
    • DbTransactionOutput.address
    • DbTransactionOutput.is_change
    • DbTransactionOutput.key
    • DbTransactionOutput.key_id
    • DbTransactionOutput.output_n
    • DbTransactionOutput.script
    • DbTransactionOutput.script_type
    • DbTransactionOutput.spending_index_n
    • DbTransactionOutput.spending_txid
    • DbTransactionOutput.spent
    • DbTransactionOutput.transaction
    • DbTransactionOutput.transaction_id
    • DbTransactionOutput.value
  • DbWallet
    • DbWallet.anti_fee_sniping
    • DbWallet.children
    • DbWallet.cosigner_id
    • DbWallet.default_account_id
    • DbWallet.encoding
    • DbWallet.id
    • DbWallet.ignore_dust
    • DbWallet.key_path
    • DbWallet.keys
    • DbWallet.main_key_id
    • DbWallet.multisig
    • DbWallet.multisig_n_required
    • DbWallet.name
    • DbWallet.network
    • DbWallet.network_name
    • DbWallet.owner
    • DbWallet.parent_id
    • DbWallet.purpose
    • DbWallet.scheme
    • DbWallet.sort_keys
    • DbWallet.strict
    • DbWallet.transactions
    • DbWallet.witness_type
  • EncryptedBinary
    • EncryptedBinary.cache_ok
    • EncryptedBinary.impl
    • EncryptedBinary.key
    • EncryptedBinary.process_bind_param()
    • EncryptedBinary.process_result_value()
  • EncryptedString
    • EncryptedString.cache_ok
    • EncryptedString.impl
    • EncryptedString.key
    • EncryptedString.process_bind_param()
    • EncryptedString.process_result_value()
  • add_column()
  • compile_largebinary_mysql()
  • db_update()
  • db_update_version_id()
• bitcoinlib.db_cache module
  • DbCache
    • DbCache.drop_db()
  • DbCacheAddress
    • DbCacheAddress.address
    • DbCacheAddress.balance
    • DbCacheAddress.last_block
    • DbCacheAddress.last_txid
    • DbCacheAddress.n_txs
    • DbCacheAddress.n_utxos
    • DbCacheAddress.network_name
  • DbCacheBlock
    • DbCacheBlock.bits
    • DbCacheBlock.block_hash
    • DbCacheBlock.height
    • DbCacheBlock.merkle_root
    • DbCacheBlock.network_name
    • DbCacheBlock.nonce
    • DbCacheBlock.prev_block
    • DbCacheBlock.time
    • DbCacheBlock.tx_count
    • DbCacheBlock.version
  • DbCacheTransaction
    • DbCacheTransaction.block_height
    • DbCacheTransaction.confirmations
    • DbCacheTransaction.date
    • DbCacheTransaction.fee
    • DbCacheTransaction.index
    • DbCacheTransaction.locktime
    • DbCacheTransaction.network_name
    • DbCacheTransaction.nodes
    • DbCacheTransaction.txid
    • DbCacheTransaction.version
    • DbCacheTransaction.witness_type
  • DbCacheTransactionNode
    • DbCacheTransactionNode.address
    • DbCacheTransactionNode.index_n
    • DbCacheTransactionNode.is_input
    • DbCacheTransactionNode.output_n()
    • DbCacheTransactionNode.prev_txid()
    • DbCacheTransactionNode.ref_index_n
    • DbCacheTransactionNode.ref_txid
    • DbCacheTransactionNode.script
    • DbCacheTransactionNode.sequence
    • DbCacheTransactionNode.spending_index_n()
    • DbCacheTransactionNode.spending_txid()
    • DbCacheTransactionNode.spent
    • DbCacheTransactionNode.transaction
    • DbCacheTransactionNode.txid
    • DbCacheTransactionNode.value
    • DbCacheTransactionNode.witnesses
  • DbCacheVars
    • DbCacheVars.expires
    • DbCacheVars.network_name
    • DbCacheVars.type
    • DbCacheVars.value
    • DbCacheVars.varname
  • WitnessTypeTransactions
    • WitnessTypeTransactions.legacy
    • WitnessTypeTransactions.segwit
• bitcoinlib.encoding module
  • EncodingError
  • Quantity
  • addr_base58_to_pubkeyhash()
  • addr_bech32_checksum()
  • addr_bech32_to_pubkeyhash()
  • addr_to_pubkeyhash()
  • aes_decrypt()
  • aes_encrypt()
  • base58encode()
  • change_base()
  • convert_der_sig()
  • convertbits()
  • der_encode_sig()
  • double_sha256()
  • hash160()
  • int_to_varbyteint()
  • normalize_string()
  • normalize_var()
  • pubkeyhash_to_addr()
  • pubkeyhash_to_addr_base58()
  • pubkeyhash_to_addr_bech32()
  • read_varbyteint()
  • read_varbyteint_return()
  • ripemd160()
  • scrypt_hash()
  • sha256()
  • signature_der_decode()
  • signature_der_decode_bytes()
  • signature_der_encode()
  • to_bytes()
  • to_hexstring()
  • varbyteint_to_int()
  • varstr()
• bitcoinlib.keys module
  • Address
    • Address.as_dict()
    • Address.as_json()
    • Address.data
    • Address.hashed_data
    • Address.parse()
    • Address.with_prefix()
  • BKeyError
  • HDKey
    • HDKey.address()
    • HDKey.as_dict()
    • HDKey.as_json()
    • HDKey.child_private()
    • HDKey.child_public()
    • HDKey.fingerprint
    • HDKey.from_passphrase()
    • HDKey.from_seed()
    • HDKey.from_wif()
    • HDKey.info()
    • HDKey.inverse()
    • HDKey.key_for_path()
    • HDKey.network_change()
    • HDKey.public()
    • HDKey.public_master()
    • HDKey.public_master_multisig()
    • HDKey.sign_message()
    • HDKey.subkey_for_path()
    • HDKey.wif()
    • HDKey.wif_key()
    • HDKey.wif_private()
    • HDKey.wif_public()
  • Key
    • Key.address()
    • Key.address_obj
    • Key.address_uncompressed()
    • Key.as_bytes()
    • Key.as_dict()
    • Key.as_hex()
    • Key.as_json()
    • Key.encrypt()
    • Key.from_wif()
    • Key.hash160
    • Key.hex()
    • Key.info()
    • Key.inverse()
    • Key.public()
    • Key.public_point()
    • Key.public_uncompressed_byte
    • Key.public_uncompressed_hex
    • Key.sign_message()
    • Key.verify_message()
    • Key.wif()
    • Key.x
    • Key.y
  • Signature
    • Signature.as_base64()
    • Signature.as_bytes()
    • Signature.as_der_encoded()
    • Signature.as_hex()
    • Signature.as_signed_message()
    • Signature.bytes()
    • Signature.create()
    • Signature.hex()
    • Signature.message
    • Signature.parse()
    • Signature.parse_base64()
    • Signature.parse_bytes()
    • Signature.parse_hex()
    • Signature.public_key
    • Signature.verify()
    • Signature.verify_message()
  • addr_convert()
  • bip38_create_new_encrypted_wif()
  • bip38_decrypt()
  • bip38_encrypt()
  • bip38_intermediate_password()
  • check_network_and_key()
  • deserialize_address()
  • ec_point()
  • ec_point_multiplication()
  • get_key_format()
  • message_magic()
  • mod_sqrt()
  • path_expand()
  • sign()
  • signed_message_parse()
  • verify()
  • verify_message()
• bitcoinlib.main module
  • deprecated()
  • get_encoding_from_witness()
  • get_key_structure_data()
  • script_type_default()
• bitcoinlib.mnemonic module
  • Mnemonic
    • Mnemonic.checksum()
    • Mnemonic.detect_language()
    • Mnemonic.generate()
    • Mnemonic.sanitize_mnemonic()
    • Mnemonic.to_entropy()
    • Mnemonic.to_mnemonic()
    • Mnemonic.to_seed()
    • Mnemonic.word()
    • Mnemonic.wordlist()
• bitcoinlib.networks module
  • Network
    • Network.wif_prefix()
  • NetworkError
  • network_by_value()
  • network_defined()
  • network_values_for()
  • wif_prefix_search()
• bitcoinlib.scripts module
  • Script
    • Script.as_bytes()
    • Script.as_hex()
    • Script.blueprint
    • Script.evaluate()
    • Script.parse()
    • Script.parse_bytes()
    • Script.parse_bytesio()
    • Script.parse_hex()
    • Script.parse_str()
    • Script.raw
    • Script.serialize()
    • Script.serialize_list()
    • Script.view()
  • ScriptError
  • Stack
    • Stack.as_ints()
    • Stack.from_ints()
    • Stack.is_arithmetic()
    • Stack.op_0notequal()
    • Stack.op_1add()
    • Stack.op_1sub()
    • Stack.op_2drop()
    • Stack.op_2dup()
    • Stack.op_2over()
    • Stack.op_2rot()
    • Stack.op_2swap()
    • Stack.op_3dup()
    • Stack.op_abs()
    • Stack.op_add()
    • Stack.op_booland()
    • Stack.op_boolor()
    • Stack.op_checklocktimeverify()
    • Stack.op_checkmultisig()
    • Stack.op_checkmultisigverify()
    • Stack.op_checksequenceverify()
    • Stack.op_checksig()
    • Stack.op_checksigverify()
    • Stack.op_depth()
    • Stack.op_drop()
    • Stack.op_dup()
    • Stack.op_equal()
    • Stack.op_equalverify()
    • Stack.op_hash160()
    • Stack.op_hash256()
    • Stack.op_if()
    • Stack.op_ifdup()
    • Stack.op_max()
    • Stack.op_min()
    • Stack.op_negate()
    • Stack.op_nip()
    • Stack.op_nop()
    • Stack.op_nop1()
    • Stack.op_nop10()
    • Stack.op_nop4()
    • Stack.op_nop5()
    • Stack.op_nop6()
    • Stack.op_nop7()
    • Stack.op_nop8()
    • Stack.op_nop9()
    • Stack.op_not()
    • Stack.op_notif()
    • Stack.op_numequal()
    • Stack.op_numequalverify()
    • Stack.op_numgreaterthan()
    • Stack.op_numgreaterthanorequal()
    • Stack.op_numlessthan()
    • Stack.op_numlessthanorequal()
    • Stack.op_numnotequal()
    • Stack.op_over()
    • Stack.op_pick()
    • Stack.op_return()
    • Stack.op_ripemd160()
    • Stack.op_roll()
    • Stack.op_rot()
    • Stack.op_sha1()
    • Stack.op_sha256()
    • Stack.op_size()
    • Stack.op_sub()
    • Stack.op_swap()
    • Stack.op_tuck()
    • Stack.op_verify()
    • Stack.op_within()
    • Stack.pop_as_number()
  • data_pack()
  • decode_num()
  • encode_num()
  • get_data_type()
• bitcoinlib.transactions module
  • Input
    • Input.as_dict()
    • Input.parse()
    • Input.update_scripts()
    • Input.verify()
  • Output
    • Output.address
    • Output.address_obj
    • Output.as_dict()
    • Output.parse()
    • Output.set_locktime_relative()
    • Output.set_locktime_relative_blocks()
    • Output.set_locktime_relative_time()
  • Transaction
    • Transaction.add_input()
    • Transaction.add_output()
    • Transaction.as_bytes()
    • Transaction.as_dict()
    • Transaction.as_hex()
    • Transaction.as_json()
    • Transaction.bumpfee()
    • Transaction.calc_weight_units()
    • Transaction.calculate_fee()
    • Transaction.estimate_size()
    • Transaction.info()
    • Transaction.load()
    • Transaction.merge_transaction()
    • Transaction.parse()
    • Transaction.parse_bytes()
    • Transaction.parse_bytesio()
    • Transaction.parse_hex()
    • Transaction.raw()
    • Transaction.raw_hex()
    • Transaction.save()
    • Transaction.set_locktime_blocks()
    • Transaction.set_locktime_relative_blocks()
    • Transaction.set_locktime_relative_time()
    • Transaction.set_locktime_time()
    • Transaction.shuffle()
    • Transaction.shuffle_inputs()
    • Transaction.shuffle_outputs()
    • Transaction.sign()
    • Transaction.sign_and_update()
    • Transaction.signature()
    • Transaction.signature_hash()
    • Transaction.signature_segwit()
    • Transaction.update_inputs()
    • Transaction.update_totals()
    • Transaction.verify()
    • Transaction.weight_units
    • Transaction.witness_data()
  • TransactionError
  • get_unlocking_script_type()
  • transaction_update_spents()
• bitcoinlib.values module
  • Value
    • Value.from_satoshi()
    • Value.str()
    • Value.str_auto()
    • Value.str_unit()
    • Value.to_bytes()
    • Value.to_hex()
    • Value.value_sat
  • value_to_satoshi()
• bitcoinlib.wallets module
  • Wallet
    • Wallet.account()
    • Wallet.accounts()
    • Wallet.address_index()
    • Wallet.addresslist()
    • Wallet.as_dict()
    • Wallet.as_json()
    • Wallet.balance()
    • Wallet.balance_update_from_serviceprovider()
    • Wallet.create()
    • Wallet.default_account_id
    • Wallet.default_network_set()
    • Wallet.get_key()
    • Wallet.get_key_change()
    • Wallet.get_keys()
    • Wallet.get_keys_change()
    • Wallet.import_key()
    • Wallet.import_master_key()
    • Wallet.info()
    • Wallet.key()
    • Wallet.key_for_path()
    • Wallet.keys()
    • Wallet.keys_accounts()
    • Wallet.keys_address_change()
    • Wallet.keys_address_payment()
    • Wallet.keys_addresses()
    • Wallet.keys_for_path()
    • Wallet.keys_networks()
    • Wallet.last_address_index()
    • Wallet.name
    • Wallet.network_list()
    • Wallet.networks()
    • Wallet.new_account()
    • Wallet.new_key()
    • Wallet.new_key_change()
    • Wallet.new_keys()
    • Wallet.owner
    • Wallet.path_expand()
    • Wallet.public_master()
    • Wallet.scan()
    • Wallet.scan_key()
    • Wallet.select_inputs()
    • Wallet.send()
    • Wallet.send_to()
    • Wallet.session
    • Wallet.sign_message()
    • Wallet.sweep()
    • Wallet.transaction()
    • Wallet.transaction_create()
    • Wallet.transaction_delete()
    • Wallet.transaction_import()
    • Wallet.transaction_import_raw()
    • Wallet.transaction_last()
    • Wallet.transaction_load()
    • Wallet.transaction_spent()
    • Wallet.transactions()
    • Wallet.transactions_export()
    • Wallet.transactions_full()
    • Wallet.transactions_remove_unconfirmed()
    • Wallet.transactions_update()
    • Wallet.transactions_update_by_txids()
    • Wallet.transactions_update_confirmations()
    • Wallet.utxo_add()
    • Wallet.utxo_last()
    • Wallet.utxos()
    • Wallet.utxos_update()
    • Wallet.verify_message()
    • Wallet.wif()
    • Wallet.witness_types()
  • WalletError
  • WalletKey
    • WalletKey.as_dict()
    • WalletKey.balance_str()
    • WalletKey.from_key()
    • WalletKey.key()
    • WalletKey.name
    • WalletKey.public()
    • WalletKey.sign_message()
    • WalletKey.verify_message()
  • WalletTransaction
    • WalletTransaction.add_input_from_wallet()
    • WalletTransaction.bumpfee()
    • WalletTransaction.delete()
    • WalletTransaction.export()
    • WalletTransaction.from_transaction()
    • WalletTransaction.from_txid()
    • WalletTransaction.info()
    • WalletTransaction.save()
    • WalletTransaction.send()
    • WalletTransaction.sign()
    • WalletTransaction.store()
    • WalletTransaction.to_transaction()
  • normalize_path()
  • wallet_create_or_open()
  • wallet_delete()
  • wallet_delete_if_exists()
  • wallet_empty()
  • wallet_exists()
  • wallets_list()

Module contents