[#node-DumpMempool]
= xref:node.adoc[node]::DumpMempool
:relfileprefix: ../
:mrdocs:

Dump the mempool to a file.

== Synopsis

Declared in `<node/mempool_persist.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
bool
DumpMempool(
    xref:CTxMemPool.adoc[CTxMemPool] const& pool,
    xref:fs/path.adoc[fs::path] const& dump_path,
    xref:fsbridge/FopenFn.adoc[fsbridge::FopenFn] mockable_fopen_function = fsbridge::fopen,
    bool skip_file_commit = false);
----

== Return Value

True on success, false if the dump could not be written.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *pool*
| The mempool whose contents are written out.
| *dump_path*
| Destination path for the serialized mempool.
| *mockable_fopen_function*
| File‐open function, overridable for testing.
| *skip_file_commit*
| If true, skip the fsync/commit step (used in tests).
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#