Quantum Resistant Ledger

This is the documentation of QRL Node.

Note

WORK IN PROGRESS

Note

This is the main page of your project’s Sphinx documentation.

It is also possible to refer to the documentation of other Python packages with the Python domain syntax. By default you can reference the documentation of Sphinx, Python, NumPy, SciPy, matplotlib, Pandas, Scikit-Learn. You can add more by extending the intersphinx_mapping in your Sphinx’s conf.py.

The pretty useful extension autodoc is activated by default and lets you include documentation from docstrings. Docstrings can be written in Google (recommended!), NumPy and classical style.

Contents

License

MIT License

Copyright (c) 2017 The Quantum Resistant Ledger

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Developers

  • qrlcore developers:

#1 cyyber 309 commits 19,410 ++ 16,048 –

#2 jleni 240 commits 72,648 ++ 66,410 –

#3 surg0r 227 commits 10,857 ++ 5,095 –

#4 scottdonaldau 29 commits 241,841 ++ 240,315 –

#5 bidulemachin 13 commits 285 ++ 57 –

#6 randomshinichi 10 commits 632 ++ 481 –

#7 converghub 6 commits 204 ++ 40 –

#8 jplomas 4 commits 33 ++ 3 –

#9 Wyc0 4 commits 166 ++ 11 –

#10 leagueofdelegates 4 commits 0 ++ 0 –

#11 randomusergenerator 3 commits 173 ++ 2 –

#12 nickycakes 3 commits 24 ++ 18 –

#13 jomarip 2 commits 36 ++ 0 –

#14 r41d 2 commits 11 ++ 17 –

#15 timhovius 1 commit 2 ++ 2 –

#16 fullmatches 1 commit 0 ++ 0 –

#17 jackalyst 1 commit 1 ++ 1 –

23/10/2017

Changelog

Version 0.X

  • DESCRIBE IMPORTANT CHANGES

qrl

qrl package

Subpackages

qrl.core package
Subpackages
qrl.core.misc package
Submodules
qrl.core.misc.DependencyChecker module
class qrl.core.misc.DependencyChecker.DependencyChecker[source]

Bases: object

static check()[source]
qrl.core.misc.db module
qrl.core.misc.logger module
qrl.core.misc.logger_twisted module
qrl.core.misc.ntp module
Module contents
qrl.core.notification package
Submodules
qrl.core.notification.Observable module
qrl.core.notification.ObservableEvent module
class qrl.core.notification.ObservableEvent.ObservableEvent(event_id)[source]

Bases: object

func_name()[source]
Module contents
qrl.core.processors package
Submodules
qrl.core.processors.TxnProcessor module
Module contents
Submodules
qrl.core.AddressState module
qrl.core.Block module
qrl.core.BlockHeader module
qrl.core.BlockMetadata module
qrl.core.ChainManager module
qrl.core.DifficultyTracker module
qrl.core.ESyncState module
class qrl.core.ESyncState.ESyncState[source]

Bases: enum.Enum

An enumeration.

forked = 4
synced = 3
syncing = 2
unknown = 0
unsynced = 1
qrl.core.Ephemeral module
class qrl.core.Ephemeral.Ephemeral[source]

Bases: object

Ephemeral Messaging Layer

qrl.core.EphemeralMessage module
qrl.core.EphemeralMetadata module
qrl.core.GenesisBlock module
qrl.core.Message module
class qrl.core.Message.Message(pbdata, msg_type)[source]

Bases: object

add_peer(msg_type)[source]
qrl.core.MessageRequest module
qrl.core.Miner module
qrl.core.OutgoingMessage module
qrl.core.PeerInfo module
qrl.core.Peers module
qrl.core.PoWValidator module
qrl.core.Singleton module
class qrl.core.Singleton.Singleton[source]

Bases: type

instance = None
qrl.core.State module
qrl.core.TokenList module
qrl.core.TokenMetadata module
qrl.core.Transaction module
qrl.core.TransactionPool module
qrl.core.Wallet module
qrl.core.config module
qrl.core.formulas module
qrl.core.messagereceipt module
qrl.core.node module
qrl.core.p2pChainManager module
qrl.core.p2pObservable module
qrl.core.p2pObserver module
qrl.core.p2pPeerManager module
qrl.core.p2pTxManagement module
qrl.core.p2pfactory module
qrl.core.p2pprotocol module
qrl.core.qrlnode module
Module contents
qrl.crypto package
Submodules
qrl.crypto.AESHelper module
qrl.crypto.Qryptonight module
qrl.crypto.doctest_data module
qrl.crypto.misc module
qrl.crypto.xmss module
Module contents
qrl.generated package
Submodules
qrl.generated.qrl_pb2 module
qrl.generated.qrl_pb2_grpc module
qrl.generated.qrlbase_pb2 module
qrl.generated.qrlbase_pb2_grpc module
qrl.generated.qrllegacy_pb2 module
qrl.generated.qrllegacy_pb2_grpc module
qrl.generated.qrlmining_pb2 module
qrl.generated.qrlmining_pb2_grpc module
Module contents
qrl.services package
Submodules
qrl.services.AdminAPIService module
qrl.services.BaseService module
qrl.services.MiningAPIService module
qrl.services.PublicAPIService module
qrl.services.grpcHelper module
qrl.services.services module
Module contents

Submodules

qrl.cli module

qrl.grpcProxy module

qrl.main module

qrl.measure module

Module contents

Indices and tables