elements/README.md

80 lines
3.6 KiB
Markdown
Raw Normal View History

2019-03-21 13:00:41 +00:00
Elements Project blockchain platform
====================================
2019-03-21 13:00:41 +00:00
[![Build Status](https://travis-ci.org/ElementsProject/elements.svg?branch=master)](https://travis-ci.org/ElementsProject/elements)
2019-03-21 13:00:41 +00:00
https://elementsproject.org
2019-03-21 13:00:41 +00:00
This is the integration and staging tree for the Elements blockchain platform,
a collection of feature experiments and extensions to the Bitcoin protocol.
This platform enables anyone to build their own businesses or networks
pegged to Bitcoin as a sidechain or run as a standalone blockchain with arbitrary asset tokens.
Modes
-----
Elements supports a few different pre-set chains for syncing. Note though some are intended for QA and debugging only:
* Liquid mode: `elementsd -chain=liquidv1` (syncs with Liquid network)
* Bitcoin mainnet mode: `elementsd -chain=main` (not intended to be run for commerce)
* Bitcoin testnet mode: `elementsd -chain=testnet3`
* Bitcoin regtest mode: `elementsd -chain=regtest`
* Elements custom chains: Any other `-chain=` argument. It has regtest-like default parameters that can be over-ridden by the user by a rich set of start-up options.
2019-03-21 13:00:41 +00:00
Confidential Assets
----------------
The latest feature in the Elements blockchain platform is Confidential Assets,
the ability to issue multiple assets on a blockchain where asset identifiers
and amounts are blinded yet auditable through the use of applied cryptography.
2019-03-21 13:00:41 +00:00
* [Announcement of Confidential Assets](https://blockstream.com/2017/04/03/blockstream-releases-elements-confidential-assets.html)
* [Confidential Assets Whitepaper](https://blockstream.com/bitcoin17-final41.pdf) to be presented [April 7th at Financial Cryptography 2017](http://fc17.ifca.ai/bitcoin/schedule.html) in Malta
* [Confidential Assets Tutorial](contrib/assets_tutorial/assets_tutorial.py)
2019-03-21 13:00:41 +00:00
* [Confidential Assets Demo](https://github.com/ElementsProject/confidential-assets-demo)
* [Elements Code Tutorial](https://elementsproject.org/elements-code-tutorial/overview) covering blockchain configuration and how to use the main features.
2019-03-21 13:00:41 +00:00
Features of the Elements blockchain platform
----------------
2010-09-23 18:06:50 +00:00
2019-03-21 13:00:41 +00:00
Compared to Bitcoin itself, it adds the following features:
* [Confidential Assets][asset-issuance]
* [Confidential Transactions][confidential-transactions]
* [Federated Two-Way Peg][federated-peg]
* [Signed Blocks][signed-blocks]
* [Additional opcodes][opcodes]
2010-09-23 18:06:50 +00:00
2019-03-21 13:00:41 +00:00
Previous elements that have been integrated into Bitcoin:
* Segregated Witness
* Relative Lock Time
2010-12-19 10:39:36 -05:00
2019-03-21 13:00:41 +00:00
Elements deferred for additional research and standardization:
* [Schnorr Signatures][schnorr-signatures]
2015-09-24 14:28:07 +01:00
2020-02-04 13:12:42 -05:00
Additional RPC commands and parameters:
2020-03-17 14:27:39 -04:00
* [RPC Docs](https://elementsproject.org/en/doc/)
2020-02-04 13:12:42 -05:00
2019-03-21 13:00:41 +00:00
License
-------
2019-03-21 13:00:41 +00:00
Elements is released under the terms of the MIT license. See [COPYING](COPYING) for more
information or see http://opensource.org/licenses/MIT.
2019-03-21 13:00:41 +00:00
[confidential-transactions]: https://elementsproject.org/features/confidential-transactions
[opcodes]: https://elementsproject.org/features/opcodes
[federated-peg]: https://elementsproject.org/features#federatedpeg
[signed-blocks]: https://elementsproject.org/features#signedblocks
[asset-issuance]: https://elementsproject.org/features/issued-assets
[schnorr-signatures]: https://elementsproject.org/features/schnorr-signatures
2011-09-26 22:22:19 -04:00
2019-03-21 13:00:41 +00:00
What is the Elements Project?
-----------------
Elements is an open source, sidechain-capable blockchain platform. It also allows experiments to more rapidly bring technical innovation to the Bitcoin ecosystem.
2019-03-21 13:00:41 +00:00
Learn more on the [Elements Project website](https://elementsproject.org)
2019-03-21 13:00:41 +00:00
https://github.com/ElementsProject/elementsproject.github.io
Secure Reporting
------------------
2019-03-21 13:00:41 +00:00
See [our vulnerability reporting guide](SECURITY.md)