43 lines
1.8 KiB
Markdown
43 lines
1.8 KiB
Markdown
<!---
|
|
Copyright © 2020 Interplanetary Database Association e.V.,
|
|
BigchainDB and IPDB software contributors.
|
|
SPDX-License-Identifier: (Apache-2.0 AND CC-BY-4.0)
|
|
Code is Apache-2.0 and docs are CC-BY-4.0
|
|
--->
|
|
|
|
# Overview
|
|
|
|
A high-level description of the files and subdirectories of BigchainDB.
|
|
|
|
## Files
|
|
|
|
### [`lib.py`](lib.py)
|
|
|
|
The `BigchainDB` class is defined here. Most node-level operations and database interactions are found in this file. This is the place to start if you are interested in implementing a server API, since many of these class methods concern BigchainDB interacting with the outside world.
|
|
|
|
### [`models.py`](./models.py)
|
|
|
|
`Block`, `Transaction`, and `Asset` classes are defined here. The classes mirror the block and transaction structure from the [documentation](https://docs.bigchaindb.com/projects/server/en/latest/data-models/index.html), but also include methods for validation and signing.
|
|
|
|
### [`validation.py`](./validation.py)
|
|
|
|
Base class for validation methods (verification of votes, blocks, and transactions). The actual logic is mostly found in `transaction` and `block` models, defined in [`models.py`](./models.py).
|
|
|
|
### [`processes.py`](./processes.py)
|
|
|
|
Entry point for the BigchainDB process, after initialization. All subprocesses are started here: processes to handle new blocks, votes, etc.
|
|
|
|
### [`config_utils.py`](./config_utils.py)
|
|
|
|
Methods for managing the configuration, including loading configuration files, automatically generating the configuration, and keeping the configuration consistent across BigchainDB instances.
|
|
|
|
## Folders
|
|
|
|
### [`commands`](./commands)
|
|
|
|
Contains code for the [CLI](https://docs.bigchaindb.com/projects/server/en/latest/server-reference/bigchaindb-cli.html) for BigchainDB.
|
|
|
|
### [`db`](./db)
|
|
|
|
Code for building the database connection, creating indexes, and other database setup tasks.
|