mirror of
https://github.com/kaspanet/kaspad.git
synced 2025-07-04 11:52:31 +00:00
d984151549
* [NOD-517] Remove copyright notices from all doc.go. * [NOD-517] Updated the root doc.go. * [NOD-517] Remove all cov_report.sh and test_coverage.txt. * [NOD-517] Make all doc.go use the same style of comment. * [NOD-517] Update dagconfig doc.go. * [NOD-517] Update blockdag doc.go. * [NOD-517] Update doc.go in connmgr. * [NOD-517] Update doc.go in fullblocktests. * [NOD-517] Update doc.go in database. * [NOD-517] Update doc.go in ecc. * [NOD-517] Update doc.go in rpctest. * [NOD-517] Removed superfluous license in logs. * [NOD-517] Update doc.go in mempool. * [NOD-517] Updated doc.go in peer. * [NOD-517] Update doc.go in rpcclient. * [NOD-517] Update doc.go in txscript. * [NOD-517] Update doc.go in util. * [NOD-517] Update doc.go in base58. * [NOD-517] Update doc.go in bech32. * [NOD-517] Update doc.go in txsort. * [NOD-517] Update doc.go in wire. * [NOD-517] Fix indentation. * [NOD-517] Add a copyright notice to the main doc.go. * [NOD-517] Add Conformal to the license notices. * [NOD-517] Remove superfluous language from a doc. * [NOD-517] Fix bad example.
26 lines
763 B
Go
26 lines
763 B
Go
/*
|
|
Package ffldb implements a driver for the database package that uses leveldb
|
|
for the backing metadata and flat files for block storage.
|
|
|
|
This driver is the recommended driver for use with kaspad. It makes use leveldb
|
|
for the metadata, flat files for block storage, and checksums in key areas to
|
|
ensure data integrity.
|
|
|
|
Usage
|
|
|
|
This package is a driver to the database package and provides the database type
|
|
of "ffldb". The parameters the Open and Create functions take are the
|
|
database path as a string and the block network:
|
|
|
|
db, err := database.Open("ffldb", "path/to/database", wire.MainNet)
|
|
if err != nil {
|
|
// Handle error
|
|
}
|
|
|
|
db, err := database.Create("ffldb", "path/to/database", wire.MainNet)
|
|
if err != nil {
|
|
// Handle error
|
|
}
|
|
*/
|
|
package ffldb
|