Inside Bitcoin

751     */
752    std::optional<OutputType> m_default_change_type{};
753    /** Absolute maximum transaction fee (in satoshis) used by default for the wallet */
754    CAmount m_default_max_tx_fee{DEFAULT_TRANSACTION_MAXFEE};
755
756    /** Number of pre-generated keys/scripts by each spkm (part of the look-ahead process, used to detect payments) */
757    int64_t m_keypool_size{DEFAULT_KEYPOOL_SIZE};
758
759    /** Notify external script when a wallet transaction comes in or is updated (handled by -walletnotify) */
760    std::string m_notify_tx_changed_script;
761
762    size_t KeypoolCountExternalKeys() const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
763    bool TopUpKeyPool(unsigned int kpSize = 0);
764
765    // Filter struct for 'ListAddrBookAddresses'
766    struct AddrBookFilter {
767        // Fetch addresses with the provided label
768        std::optional<std::string> m_op_label{std::nullopt};
769        // Don't include change addresses by default
770        bool ignore_change{true};
771    };
772
773    /**
774     * Filter and retrieve destinations stored in the addressbook
775     */
776    std::vector<CTxDestination> ListAddrBookAddresses(const std::optional<AddrBookFilter>& filter) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
777
778    /**
779     * Retrieve all the known labels in the address book
780     */
781    std::set<std::string> ListAddrBookLabels(std::optional<AddressPurpose> purpose) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
782
783    /**
784     * Walk-through the address book entries.
785     * Stops when the provided 'ListAddrBookFunc' returns false.
786     */
787    using ListAddrBookFunc = std::function<void(const CTxDestination& dest, const std::string& label, bool is_change, const std::optional<AddressPurpose> purpose)>;
788    void ForEachAddrBookEntry(const ListAddrBookFunc& func) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
789
790    /**
791     * Marks all outputs in each one of the destinations dirty, so their cache is
792     * reset and does not return outdated information.
793     */
794    void MarkDestinationsDirty(const std::set<CTxDestination>& destinations) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
795
796    util::Result<CTxDestination> GetNewDestination(OutputType type, const std::string& label);
797    util::Result<CTxDestination> GetNewChangeDestination(OutputType type);
798
799    bool IsMine(const CTxDestination& dest) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
800    bool IsMine(const CScript& script) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
801    /** Returns amount of debit, i.e. the amount leaving this wallet due to this input */
802    CAmount GetDebit(const CTxIn& txin) const;
803    bool IsMine(const CTxOut& txout) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
804    bool IsMine(const CTransaction& tx) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
805    bool IsMine(const COutPoint& outpoint) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
806    /** should probably be renamed to IsRelevantToMe */
807    bool IsFromMe(const CTransaction& tx) const;
808    CAmount GetDebit(const CTransaction& tx) const;
809
810    DBErrors PopulateWalletFromDB(bilingual_str& error, std::vector<bilingual_str>& warnings);
811
812    /** Erases the provided transactions from the wallet. */
813    util::Result<void> RemoveTxs(std::vector<Txid>& txs_to_remove) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
814    util::Result<void> RemoveTxs(WalletBatch& batch, std::vector<Txid>& txs_to_remove) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
815
816    bool SetAddressBook(const CTxDestination& address, const std::string& strName, const std::optional<AddressPurpose>& purpose);
817
818    bool DelAddressBook(const CTxDestination& address);
819    bool DelAddressBookWithDB(WalletBatch& batch, const CTxDestination& address);
820
821    bool IsAddressPreviouslySpent(const CTxDestination& dest) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
822    bool SetAddressPreviouslySpent(WalletBatch& batch, const CTxDestination& dest, bool used) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
823
824    std::vector<std::string> GetAddressReceiveRequests() const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
825    bool SetAddressReceiveRequest(WalletBatch& batch, const CTxDestination& dest, const std::string& id, const std::string& value) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
826    bool EraseAddressReceiveRequest(WalletBatch& batch, const CTxDestination& dest, const std::string& id) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
827
828    unsigned int GetKeyPoolSize() const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
829
830    //! Get wallet transactions that conflict with given transaction (spend same outputs)
831    std::set<Txid> GetConflicts(const Txid& txid) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
832
833    //! Check if a given transaction has any of its outputs spent by another transaction in the wallet
834    bool HasWalletSpend(const CTransactionRef& tx) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
835
836    //! Close wallet database
837    void Close();
838
839    /** Wallet is about to be unloaded */
840    btcsignals::signal<void ()> NotifyUnload;
841
842    /**
843     * Address book entry changed.
844     * @note called without lock cs_wallet held.
845     */
846    btcsignals::signal<void(const CTxDestination& address,
847                                 const std::string& label, bool isMine,
848                                 AddressPurpose purpose, ChangeType status)>
849        NotifyAddressBookChanged;
850
851    /**
852     * Wallet transaction added, removed or updated.
853     * @note called with lock cs_wallet held.
854     */
855    btcsignals::signal<void(const Txid& hashTx, ChangeType status)> NotifyTransactionChanged;
856
857    /** Show progress e.g. for rescan */
858    btcsignals::signal<void (const std::string &title, int nProgress)> ShowProgress;
859
860    /** Keypool has new keys */
861    btcsignals::signal<void ()> NotifyCanGetAddressesChanged;
862
863    /**
864     * Wallet status (encrypted, locked) changed.
865     * Note: Called without locks held.
866     */
867    btcsignals::signal<void (CWallet* wallet)> NotifyStatusChanged;
868
869    /** Inquire whether this wallet broadcasts transactions. */
870    bool GetBroadcastTransactions() const { return fBroadcastTransactions; }
871    /** Set whether this wallet broadcasts transactions. */
872    void SetBroadcastTransactions(bool broadcast) { fBroadcastTransactions = broadcast; }
873
874    /** Return whether transaction can be abandoned */
875    bool TransactionCanBeAbandoned(const Txid& hashTx) const;
876
877    /* Mark a transaction (and it in-wallet descendants) as abandoned so its inputs may be respent. */
878    bool AbandonTransaction(const Txid& hashTx);
879    bool AbandonTransaction(CWalletTx& tx) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
880
881    /** Mark a transaction as replaced by another transaction. */
882    bool MarkReplaced(const Txid& originalHash, const Txid& newHash);
883
884    static bool LoadWalletArgs(std::shared_ptr<CWallet> wallet, const WalletContext& context, bilingual_str& error, std::vector<bilingual_str>& warnings);
885
886    /* Initializes, creates and returns a new CWallet; returns a null pointer in case of an error */
887    static std::shared_ptr<CWallet> CreateNew(WalletContext& context, const std::string& name, std::unique_ptr<WalletDatabase> database, uint64_t wallet_creation_flags, bool born_encrypted, bilingual_str& error, std::vector<bilingual_str>& warnings);
888
889    /* Initializes, loads, and returns a CWallet from an existing wallet; returns a null pointer in case of an error */
890    static std::shared_ptr<CWallet> LoadExisting(WalletContext& context, const std::string& name, std::unique_ptr<WalletDatabase> database, bilingual_str& error, std::vector<bilingual_str>& warnings);
891
892    /**
893     * Wallet post-init setup
894     * Gives the wallet a chance to register repetitive tasks and complete post-init tasks
895     */
896    void postInitProcess();
897
898    [[nodiscard]] bool BackupWallet(const std::string& strDest) const;
899
900    /* Returns true if HD is enabled */
901    bool IsHDEnabled() const;
902
903    /* Returns true if the wallet can give out new addresses. This means it has keys in the keypool or can generate new keys */
904    bool CanGetAddresses(bool internal = false) const;
905
906    /* Returns the time of the first created key or, in case of an import, it could be the time of the first received transaction */
907    int64_t GetBirthTime() const { return m_birth_time; }
908
909    /**
910     * Blocks until the wallet state is up-to-date to /at least/ the current
911     * chain at the time this function is entered
912     * Obviously holding cs_main/cs_wallet when going into this call may cause
913     * deadlock
914     */
915    void BlockUntilSyncedToCurrentChain() const LOCKS_EXCLUDED(::cs_main) EXCLUSIVE_LOCKS_REQUIRED(!cs_wallet);
916
917    /** set a single wallet flag */
918    void SetWalletFlag(uint64_t flags);
919
920    /** Unsets a single wallet flag */
921    void UnsetWalletFlag(uint64_t flag);
922
923    /** check if a certain wallet flag is set */
924    bool IsWalletFlagSet(uint64_t flag) const override;
925
926    /** overwrite all flags by the given uint64_t
927       flags must be uninitialised (or 0)
928       only known flags may be present */
929    void InitWalletFlags(uint64_t flags);
930    /** Loads the flags into the wallet. (used by LoadWallet) */
931    bool LoadWalletFlags(uint64_t flags);
932    //! Retrieve all of the wallet's flags
933    uint64_t GetWalletFlags() const;
934
935    /** Return wallet name for use in logs, will return "default wallet" if the wallet has no name. */
936    std::string LogName() const override
937    {
938        std::string name{GetName()};
939        return name.empty() ? "default wallet" : name;
940    };
941
942    /** Return wallet name for display, like LogName() but translates "default wallet" string. */
943    std::string DisplayName() const
944    {
945        std::string name{GetName()};
946        return name.empty() ? _("default wallet") : name;
947    };
948
949    /** Prepends the wallet name in logging output to ease debugging in multi-wallet use cases */
950    template <typename... Params>
951    void WalletLogPrintf(util::ConstevalFormatString<sizeof...(Params)> wallet_fmt, const Params&... params) const
952    {
953        LogInfo("[%s] %s", LogName(), tfm::format(wallet_fmt, params...));
954    };
955
956    void LogStats() const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
957    {
958        AssertLockHeld(cs_wallet);
959        WalletLogPrintf("setKeyPool.size() = %u\n",      GetKeyPoolSize());
960        WalletLogPrintf("mapWallet.size() = %u\n",       mapWallet.size());
961        WalletLogPrintf("m_address_book.size() = %u\n",  m_address_book.size());
962    };
963
964    //! Returns all unique ScriptPubKeyMans in m_internal_spk_managers and m_external_spk_managers
965    std::set<ScriptPubKeyMan*> GetActiveScriptPubKeyMans() const;
966    bool IsActiveScriptPubKeyMan(const ScriptPubKeyMan& spkm) const;
967
968    //! Returns all unique ScriptPubKeyMans
969    std::set<ScriptPubKeyMan*> GetAllScriptPubKeyMans() const;
970
971    //! Get the ScriptPubKeyMan for the given OutputType and internal/external chain.
972    ScriptPubKeyMan* GetScriptPubKeyMan(const OutputType& type, bool internal) const;
973
974    //! Get all the ScriptPubKeyMans for a script
975    std::set<ScriptPubKeyMan*> GetScriptPubKeyMans(const CScript& script) const;
976    //! Get the ScriptPubKeyMan by id
977    ScriptPubKeyMan* GetScriptPubKeyMan(const uint256& id) const;
978
979    //! Get the SigningProvider for a script
980    std::unique_ptr<SigningProvider> GetSolvingProvider(const CScript& script) const;
981    std::unique_ptr<SigningProvider> GetSolvingProvider(const CScript& script, SignatureData& sigdata) const;
982
983    //! Get the wallet descriptors for a script.
984    std::vector<WalletDescriptor> GetWalletDescriptors(const CScript& script) const;
985
986    //! Get the LegacyDataSPKM used for all legacy output types and both internal and external chains.
987    LegacyDataSPKM* GetLegacyDataSPKM() const;
988    LegacyDataSPKM* GetOrCreateLegacyDataSPKM();
989
990    //! Create a LegacyDataSPKM and set it for all legacy output types and both internal and external chains.
991    void SetupLegacyDataSPKM();
992
993    bool WithEncryptionKey(std::function<bool (const CKeyingMaterial&)> cb) const override;
994
995    bool HasEncryptionKeys() const override;
996    bool HaveCryptedKeys() const;
997
998    /** Get last block processed height */
999    int GetLastBlockHeight() const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
1000    {