README
¶
politeia
Politeia is a system for storing off-chain data that is both versioned and timestamped, essentially “git, a popular revision control system, plus timestamping”. Instead of attempting to store all the data related to Decred’s governance on-chain, we have opted to create an off-chain store of data that is anchored into Decred’s blockchain, minimizing its on-chain footprint.
The politeia stack is as follows:
~~~~~~~~ Internet ~~~~~~~~~
|
+-------------------------+
| politeiawww |
+-------------------------+
|
+-------------------------+
| politeiad |
+-------------------------+
|
~~~~~~~~ Internet ~~~~~~~~~
|
+-------------------------+
| dcrtimed |
+-------------------------+
Core software:
- politeiad - Reference server daemon. Data layer.
- politeiawww - Web backend server; depends on politeiad. User layer.
The politeiawww APIs and politeiawww client can be treated as stable. All other APIs and libraries should be treated as unstable and subject to breaking changes.
See the politeiad README for instructions on building and running politeiad.
See the politeiawww README for instructions on building and running politeiawww.
Directories
¶
| Path | Synopsis |
|---|---|
|
api/v1/identity
zkidentity package manages public and private identities.
|
zkidentity package manages public and private identities. |
|
cmd/legacypoliteia/gitbe
Package gitbe contains the git backend types and filenames that are required by the legacypoliteia tool.
|
Package gitbe contains the git backend types and filenames that are required by the legacypoliteia tool. |
|
plugins/comments
Package comments provides a plugin for extending a record with comment functionality.
|
Package comments provides a plugin for extending a record with comment functionality. |
|
plugins/dcrdata
Package dcrdata provides a plugin for querying the dcrdata block explorer.
|
Package dcrdata provides a plugin for querying the dcrdata block explorer. |
|
plugins/pi
Package pi provides a plugin that extends records with functionality for decred's proposal system.
|
Package pi provides a plugin that extends records with functionality for decred's proposal system. |
|
plugins/ticketvote
Package ticketvote provides a plugin for running votes that require decred tickets to participate.
|
Package ticketvote provides a plugin for running votes that require decred tickets to participate. |
|
plugins/usermd
Package usermd provides a politeiad plugin that extends records with user metadata and provides an API for retrieving records by user metadata.
|
Package usermd provides a politeiad plugin that extends records with user metadata and provides an API for retrieving records by user metadata. |
|
cmd/politeiavoter/sampleconfig
Package sampleconfig provides a single constant that contains the contents of the sample configuration file for politeiavoter.
|
Package sampleconfig provides a single constant that contains the contents of the sample configuration file for politeiavoter. |
|
sessions
Package sessions implements a custom session store that uses the gorilla/sessions and gorilla/securecookie libraries.
|
Package sessions implements a custom session store that uses the gorilla/sessions and gorilla/securecookie libraries. |
|
wsdcrdata
Package wsdcrdata provides a client for managing dcrdata websocket subscriptions.
|
Package wsdcrdata provides a client for managing dcrdata websocket subscriptions. |
|
version
Package version provides a single location to house the version information for dcrd and other utilities provided in the same repository.
|
Package version provides a single location to house the version information for dcrd and other utilities provided in the same repository. |
Click to show internal directories.
Click to hide internal directories.