This repository has been archived by the owner on Apr 13, 2022. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
212 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,121 @@ | ||
Creative Commons Legal Code | ||
|
||
CC0 1.0 Universal | ||
|
||
CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE | ||
LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN | ||
ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS | ||
INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES | ||
REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS | ||
PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM | ||
THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED | ||
HEREUNDER. | ||
|
||
Statement of Purpose | ||
|
||
The laws of most jurisdictions throughout the world automatically confer | ||
exclusive Copyright and Related Rights (defined below) upon the creator | ||
and subsequent owner(s) (each and all, an "owner") of an original work of | ||
authorship and/or a database (each, a "Work"). | ||
|
||
Certain owners wish to permanently relinquish those rights to a Work for | ||
the purpose of contributing to a commons of creative, cultural and | ||
scientific works ("Commons") that the public can reliably and without fear | ||
of later claims of infringement build upon, modify, incorporate in other | ||
works, reuse and redistribute as freely as possible in any form whatsoever | ||
and for any purposes, including without limitation commercial purposes. | ||
These owners may contribute to the Commons to promote the ideal of a free | ||
culture and the further production of creative, cultural and scientific | ||
works, or to gain reputation or greater distribution for their Work in | ||
part through the use and efforts of others. | ||
|
||
For these and/or other purposes and motivations, and without any | ||
expectation of additional consideration or compensation, the person | ||
associating CC0 with a Work (the "Affirmer"), to the extent that he or she | ||
is an owner of Copyright and Related Rights in the Work, voluntarily | ||
elects to apply CC0 to the Work and publicly distribute the Work under its | ||
terms, with knowledge of his or her Copyright and Related Rights in the | ||
Work and the meaning and intended legal effect of CC0 on those rights. | ||
|
||
1. Copyright and Related Rights. A Work made available under CC0 may be | ||
protected by copyright and related or neighboring rights ("Copyright and | ||
Related Rights"). Copyright and Related Rights include, but are not | ||
limited to, the following: | ||
|
||
i. the right to reproduce, adapt, distribute, perform, display, | ||
communicate, and translate a Work; | ||
ii. moral rights retained by the original author(s) and/or performer(s); | ||
iii. publicity and privacy rights pertaining to a person's image or | ||
likeness depicted in a Work; | ||
iv. rights protecting against unfair competition in regards to a Work, | ||
subject to the limitations in paragraph 4(a), below; | ||
v. rights protecting the extraction, dissemination, use and reuse of data | ||
in a Work; | ||
vi. database rights (such as those arising under Directive 96/9/EC of the | ||
European Parliament and of the Council of 11 March 1996 on the legal | ||
protection of databases, and under any national implementation | ||
thereof, including any amended or successor version of such | ||
directive); and | ||
vii. other similar, equivalent or corresponding rights throughout the | ||
world based on applicable law or treaty, and any national | ||
implementations thereof. | ||
|
||
2. Waiver. To the greatest extent permitted by, but not in contravention | ||
of, applicable law, Affirmer hereby overtly, fully, permanently, | ||
irrevocably and unconditionally waives, abandons, and surrenders all of | ||
Affirmer's Copyright and Related Rights and associated claims and causes | ||
of action, whether now known or unknown (including existing as well as | ||
future claims and causes of action), in the Work (i) in all territories | ||
worldwide, (ii) for the maximum duration provided by applicable law or | ||
treaty (including future time extensions), (iii) in any current or future | ||
medium and for any number of copies, and (iv) for any purpose whatsoever, | ||
including without limitation commercial, advertising or promotional | ||
purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each | ||
member of the public at large and to the detriment of Affirmer's heirs and | ||
successors, fully intending that such Waiver shall not be subject to | ||
revocation, rescission, cancellation, termination, or any other legal or | ||
equitable action to disrupt the quiet enjoyment of the Work by the public | ||
as contemplated by Affirmer's express Statement of Purpose. | ||
|
||
3. Public License Fallback. Should any part of the Waiver for any reason | ||
be judged legally invalid or ineffective under applicable law, then the | ||
Waiver shall be preserved to the maximum extent permitted taking into | ||
account Affirmer's express Statement of Purpose. In addition, to the | ||
extent the Waiver is so judged Affirmer hereby grants to each affected | ||
person a royalty-free, non transferable, non sublicensable, non exclusive, | ||
irrevocable and unconditional license to exercise Affirmer's Copyright and | ||
Related Rights in the Work (i) in all territories worldwide, (ii) for the | ||
maximum duration provided by applicable law or treaty (including future | ||
time extensions), (iii) in any current or future medium and for any number | ||
of copies, and (iv) for any purpose whatsoever, including without | ||
limitation commercial, advertising or promotional purposes (the | ||
"License"). The License shall be deemed effective as of the date CC0 was | ||
applied by Affirmer to the Work. Should any part of the License for any | ||
reason be judged legally invalid or ineffective under applicable law, such | ||
partial invalidity or ineffectiveness shall not invalidate the remainder | ||
of the License, and in such case Affirmer hereby affirms that he or she | ||
will not (i) exercise any of his or her remaining Copyright and Related | ||
Rights in the Work or (ii) assert any associated claims and causes of | ||
action with respect to the Work, in either case contrary to Affirmer's | ||
express Statement of Purpose. | ||
|
||
4. Limitations and Disclaimers. | ||
|
||
a. No trademark or patent rights held by Affirmer are waived, abandoned, | ||
surrendered, licensed or otherwise affected by this document. | ||
b. Affirmer offers the Work as-is and makes no representations or | ||
warranties of any kind concerning the Work, express, implied, | ||
statutory or otherwise, including without limitation warranties of | ||
title, merchantability, fitness for a particular purpose, non | ||
infringement, or the absence of latent or other defects, accuracy, or | ||
the present or absence of errors, whether or not discoverable, all to | ||
the greatest extent permissible under applicable law. | ||
c. Affirmer disclaims responsibility for clearing rights of other persons | ||
that may apply to the Work or any use thereof, including without | ||
limitation any person's Copyright and Related Rights in the Work. | ||
Further, Affirmer disclaims responsibility for obtaining any necessary | ||
consents, permissions or other rights required for any use of the | ||
Work. | ||
d. Affirmer understands and acknowledges that Creative Commons is not a | ||
party to this document and has no duty or obligation with respect to | ||
this CC0 or use of the Work. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,19 +1,91 @@ | ||
Scorex-Basics Sub-Module | ||
======================== | ||
|
||
The module contains utility functions & basic common structure to be used by other parts of the project: | ||
|
||
- Block structure and corresponding structures. Please note, there's no need to inherit from the Block trait, all | ||
functions to generate / parse / check a block are already in the trait & Block companion object | ||
- ConsensusModule interface to a consensus module(see "Consensus Module" section below) | ||
- TransactionModule interface to a transaction module(see "Transaction Module" section below) | ||
- Interfaces for state & history. | ||
- Basic transaction interface | ||
- Cryptographic hash functions. The only implementation in use at the moment is SHA-256 | ||
- Signing/verification functions. Curve 25519 is the only current implementation | ||
- RipeMD160 / Base58 | ||
- Accounts. Basically an account is just a wrapper around valid address provided as string, could be | ||
accomplished with public key or public/private keypair. | ||
- NTP client for time synchronization(but please note, there's no global time in a cryptocurrency p2p | ||
network!) | ||
- ScorexLogging trait to be mixed into classes for logging | ||
Scorex - The modular blockchain framework [![Build Status](http://23.94.190.226:8080/buildStatus/icon?job=scorex/master)](http://23.94.190.226:8080/job/scorex/branch/master) | ||
========================= | ||
|
||
Motivation | ||
---------- | ||
|
||
There are two huge problems around cryptocurrencies development project Scorex aims to weaken: | ||
|
||
* Bitcoin Core source code contains more 100K lines of code(80K of C++ only), Nxt is more than 45K | ||
line of Java code. All parts of the design(network/transactional/consensus protocols) are mixed in a hard way. | ||
So researchers and developers are not in good start positions to make experiments. | ||
|
||
In opposite, Scorex is less than 4K lines of Scala code. Transactional layer is as simple as that. Consensus algo | ||
could be switched easily(with two consensus algos out of the box, one could be replaced with an another with | ||
just one line of code edited!) | ||
|
||
* New coins are trying to make money immediately, often having just one or two pretty controversial | ||
feature. Scorex is the free and open tool aiming to make other systems development easier. | ||
|
||
Features | ||
-------- | ||
|
||
* Compact, functional code | ||
* Modular design | ||
* Scala language | ||
* Two 100% Proof-of-Stake consensus algos out of the closedBox, Nxt-like and Qora-like. One algo could be replaced | ||
with an another with just one line of code edited. | ||
* Additional consensus module Proof-of-Work consensus algo is available as [separate module](https://github.com/ScorexProject/Permacoin-consensus) | ||
* Simplest transactional model | ||
* Asynchronous network layer on top of TCP | ||
* JSON API | ||
* Command line client for the JSON API | ||
* Cryptographic primitives externalized into [separate scrypto framework](https://github.com/ScorexProject/scrypto) | ||
|
||
Getting Started | ||
--------------- | ||
|
||
* [Quick start guide](https://github.com/ScorexProject/Scorex/wiki/Getting-started) | ||
* [Documentation](https://github.com/ScorexProject/Scorex/wiki) | ||
* [Example project](https://github.com/ScorexProject/Lagonaki) | ||
* [Additional consensus module](https://github.com/ScorexProject/Permacoin-consensus) | ||
* [CI](http://23.94.190.226:8080/job/scorex/) | ||
* [Releases](https://github.com/ScorexProject/Scorex/releases) | ||
|
||
Command-Line Client | ||
------------------- | ||
|
||
Run ./cli.sh after launching server to issue API requests to it via command-line client. See API section below. | ||
Some examples of CLI commands: | ||
|
||
* GET blocks/first | ||
* POST payment {"amount":400, "fee":1, "sender":"2kx3DyWJpYYfLErWpRMLHwkL1ZGyKHAPNKr","recipient":"Y2BXLjiAhPUMSo8iBbDEhv81VwKnytTXsH"} | ||
|
||
More reading | ||
------------ | ||
|
||
Besides of [documentation](https://github.com/ScorexProject/Scorex/wiki) there are other resources describing Scorex: | ||
|
||
Articles: | ||
|
||
[The Architecture Of A Cryptocurrency](docs/articles/components.md) | ||
|
||
[On the Way to a Modular Cryptocurrency, Part 1: Generic Block Structure](docs/articles/modular1.md) | ||
|
||
[On the Way to a Modular Cryptocurrency, Part 2: Stackable API](docs/articles/modular2.md) | ||
|
||
[On Private Blockchains, Technically](docs/artices/private-chains.md) | ||
|
||
Readmes: | ||
|
||
[Scorex-Basics Sub-Module](scorex-basics/README.md) | ||
|
||
Others: | ||
|
||
[API Description](docs/API.md) | ||
|
||
Please join our mail-list: [https://groups.io/g/scorex-dev](https://groups.io/g/scorex-dev) . | ||
|
||
|
||
Contributions | ||
------------- | ||
|
||
Contributions are welcome! Please take a look into [issues](https://github.com/ConsensusResearch/Scorex-Lagonaki/issues). | ||
Testing codebase is very small at the moment, so writing a test is not just good for start, but useful as well. | ||
|
||
License | ||
------- | ||
|
||
To the extent possible under law, the authors have dedicated all copyright and related and neighboring | ||
rights to this software to the public domain worldwide. This software is distributed without any warranty. | ||
You can find applied CC0 license legalcode in the [COPYING](COPYING) |