Skip to content

Commit

Permalink
Merge pull request #72
Browse files Browse the repository at this point in the history 
55fd30f Fix bad link in README.md, reflect current project status (dexX7)
  • Loading branch information
@dexX7
dexX7 committed Jun 2, 2015
2 parents 4eabf88 + 55fd30f commit 34247f0
Showing 1 changed file with 41 additions and 29 deletions.
70 changes: 41 additions & 29 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Omni Core (Beta) integration/staging tree
=================================================
Omni Core (beta) integration/staging tree
=========================================

[![Build Status](https://travis-ci.org/OmniLayer/omnicore.svg?branch=omnicore-0.0.10)](https://travis-ci.org/OmniLayer/omnicore)

Expand All @@ -12,7 +12,7 @@ http://www.omnilayer.org
What is Omni Core
-----------------

Omni Core is a fast, portable Omni Layer implementation that is based off the Bitcoin Core codebase (currently 0.10). This implementation requires no external dependencies extraneous to Bitcoin Core, and is native to the Bitcoin network just like other Bitcoin nodes. It currently supports a wallet mode and it will be seamlessly available on 3 platforms: Windows, Linux and Mac OS. Omni Layer extensions are exposed via the UI and the JSON-RPC interface. Development has been consolidated on the Omni Core product, and once officially released it will become the reference client for the Omni Layer.
Omni Core is a fast, portable Omni Layer implementation that is based off the Bitcoin Core codebase (currently 0.10.2). This implementation requires no external dependencies extraneous to Bitcoin Core, and is native to the Bitcoin network just like other Bitcoin nodes. It currently supports a wallet mode and is seamlessly available on three platforms: Windows, Linux and Mac OS. Omni Layer extensions are exposed via the UI and the JSON-RPC interface. Development has been consolidated on the Omni Core product, and it is the reference client for the Omni Layer.

Disclaimer, warning
-------------------
Expand All @@ -29,12 +29,13 @@ This software is provided open-source at no cost. You are responsible for knowin
PLEASE DO NOT use wallet(s) with significant amounts of bitcoins or Omni Layer tokens while testing!

Testnet
-------------------
-------

Testnet mode allows Omni Core to be run on the Bitcoin testnet blockchain for safe testing.

Testnet mode allows Omni Core to be run on the Bitcoin Testnet blockchain for safe testing.
1. To run Omni Core in testnet mode, run Omni Core with the following option in place: ``` -testnet ```.
2. To receive MSC (and TMSC) on testnet please send TBTC to moneyqMan7uh8FqdCA2BV5yZ8qVrc9ikLP. For each 1 TBTC you will receive 100 MSC and 100 TMSC.
1. To run Omni Core in testnet mode, run Omni Core with the following option in place: `-testnet`.

2. To receive MSC (and TMSC) on testnet please send TBTC to `moneyqMan7uh8FqdCA2BV5yZ8qVrc9ikLP`. For each 1 TBTC you will receive 100 MSC and 100 TMSC.

Dependencies
------------
Expand All @@ -43,8 +44,6 @@ Boost >= 1.53
Installation
------------

*NOTE: This will only build on Ubuntu Linux for now.*

You will need appropriate libraries to run Omni Core on Unix,
please see [doc/build-unix.md](doc/build-unix.md) for the full listing.

Expand All @@ -58,8 +57,8 @@ sudo apt-get install pkg-config
Clone the Omni Core repository:

```
git clone https://github.com/OmniLayer/omnicore.git.git
cd omnicore/
git clone https://github.com/OmniLayer/omnicore.git
cd omnicore/
```

Then, run:
Expand All @@ -74,63 +73,76 @@ Once complete:
```
cd src/
```
and start Omni Core using ```./mastercored``` (or ```./qt/mastercore-qt``` if built with UI). The inital parse step for a first time run
And start Omni Core using `./omnicored` (or `./qt/omnicore-qt` if built with UI). The inital parse step for a first time run
will take up to 60 minutes or more, during this time your client will scan the blockchain for Omni Layer transactions. You can view the
output of the parsing at any time by viewing the log located in your datadir, by default: ```~/.bitcoin/mastercore.log```.
output of the parsing at any time by viewing the log located in your datadir, by default: `~/.bitcoin/omnicore.log`.

Omni Core requires the transaction index to be enabled. Add an entry to your bitcoin.conf file for ```txindex=1``` to enable it or Omni Core will refuse to start.
Omni Core requires the transaction index to be enabled. Add an entry to your bitcoin.conf file for `txindex=1` to enable it or Omni Core will refuse to start.

If a message is returned asking you to reindex, pass the ```-reindex``` flag to mastercored. The reindexing process can take serveral hours.
If a message is returned asking you to reindex, pass the `-reindex` flag as startup option. The reindexing process can take serveral hours.

To issue RPC commands to Master Core you may add the '-server=1' CLI flag or add an entry to the bitcoin.conf file (located in '~/.bitcoin/' by default).
To issue RPC commands to Omni Core you may add the `-server=1` CLI flag or add an entry to the bitcoin.conf file (located in `~/.bitcoin/` by default).

In bitcoin.conf:
```
server=1
```

After this step completes, check that the installation went smoothly by issuing the following command ```./mastercore-cli getinfo_MP``` which should return the 'mastercoreversion' as well as some
After this step completes, check that the installation went smoothly by issuing the following command `./omnicore-cli getinfo_MP` which should return the `mastercoreversion` as well as some
additional information related to the client.

The documentation for the RPC interface and command-line is located in [doc/apidocumentation.md] (doc/apidocumentation.md).

Current feature set:
--------------------

* Broadcasting of simple send (tx0), and send to owners (tx3) [doc] (doc/apidocumentation.md#broadcasting-a-simple-send-transaction)
* Broadcasting of simple send (tx 0), and send to owners (tx 3) [doc] (doc/apidocumentation.md#broadcasting-a-simple-send-transaction)

* Obtaining a Master Protocol balance [doc] (doc/apidocumentation.md#obtaining-a-master-protocol-balance)
* Obtaining a Omni Layer balance [doc] (doc/apidocumentation.md#obtaining-a-master-protocol-balance)

* Obtaining all balances (including smart property) for an address [doc] (doc/apidocumentation.md#obtaining-all-master-protocol-balances-for-an-address)

* Obtaining all balances associated with a specific smart property [doc] (doc/apidocumentation.md#obtaining-all-master-protocol-balances-for-a-property-id)

* Retrieving information about any Master Protocol transaction [doc] (doc/apidocumentation.md#retrieving-a-master-protocol-transaction)
* Retrieving information about any Omni Layer transaction [doc] (doc/apidocumentation.md#retrieving-a-master-protocol-transaction)

* Listing historical transactions of addresses in the wallet [doc] (doc/apidocumentation.md#listing-historical-transactions)

* Retreiving detailed information about a smart property [doc] (doc/apidocumentation.md#retrieving-information-about-a-master-protocol-property)

* Retreiving active and expired crowdsale information [doc] (doc/apidocumentation.md#retrieving-information-for-a-master-protocol-crowdsale)

* Sending a specific BTC amount to a receiver with referenceamount in send_MP
* Sending a specific BTC amount to a receiver with referenceamount in `send_OMNI`

* Creating and broadcasting transactions based on raw Master Protocol data with sendrawtx_MP
* Creating and broadcasting transactions based on raw Omni Layer transactions with `sendrawtx_OMNI`

* Functional UI for balances, sending and historical transactions

* Creating any supported transaction type via RPC interface

* Meta-DEx integration

* Support for class B (multisig) and class C (op-return) encoded transactions

Pending additions:
-------------------
------------------

* Full support of unconfirmed transactions

* Creation of raw transactions with non-wallet inputs

* Meta-DEx support
* Bitcoin based crowdsales

* DEx support (making offer, making accept, making payment)
Related projects:
-----------------

* https://github.com/OmniLayer/OmniJ

* Crowdsales (issuing smart properties, fundraisers, changing currency, closing fundraisers)
* https://github.com/mastercoin-MSC/omniwallet

* gettransaction_MP output should include matched sell offer transaction reference
* https://github.com/mastercoin-MSC/spec

Support:
------------------
--------

* Open a [GitHub issue] (https://github.com/mastercoin-MSC/mastercore/issues) to file a bug submission.
* Open a [GitHub issue] (https://github.com/OmniLayer/omnicore/issues) to file a bug submission.

0 comments on commit 34247f0

Please sign in to comment.