Skip to content

Commit 052297b

Browse files
committed
Lay out structure for Omni Core documentation
These files are mostly placeholders.
1 parent c628147 commit 052297b

File tree

9 files changed

+185
-3
lines changed

9 files changed

+185
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -138,11 +138,11 @@ Related projects:
138138

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

141-
* https://github.com/mastercoin-MSC/omniwallet
141+
* https://github.com/OmniLayer/omniwallet
142142

143-
* https://github.com/mastercoin-MSC/spec
143+
* https://github.com/OmniLayer/spec
144144

145145
Support:
146146
--------
147147

148-
* Open a [GitHub issue] (https://github.com/OmniLayer/omnicore/issues) to file a bug submission.
148+
* Please open a [GitHub issue] (https://github.com/OmniLayer/omnicore/issues) to file a bug submission.

doc/omnicore.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Omni Core related documentation is available in: [src/omnicore/doc](../src/omnicore/doc)

src/omnicore/COPYING

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
Copyright (c) 2013-2015 Omni Core Developers
2+
Copyright (c) 2009-2015 Bitcoin Core Developers
3+
4+
Permission is hereby granted, free of charge, to any person obtaining a copy
5+
of this software and associated documentation files (the "Software"), to deal
6+
in the Software without restriction, including without limitation the rights
7+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8+
copies of the Software, and to permit persons to whom the Software is
9+
furnished to do so, subject to the following conditions:
10+
11+
The above copyright notice and this permission notice shall be included in
12+
all copies or substantial portions of the Software.
13+
14+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
20+
THE SOFTWARE.

src/omnicore/README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
Omni Core (beta) integration/staging tree
2+
=========================================
3+
4+
[![Build Status](https://travis-ci.org/OmniLayer/omnicore.svg?branch=omnicore-0.0.10)](https://travis-ci.org/OmniLayer/omnicore)
5+
6+
What is the Omni Layer
7+
----------------------
8+
The Omni Layer is a communications protocol that uses the Bitcoin block chain to enable features such as smart contracts, user currencies and decentralized peer-to-peer exchanges. A common analogy that is used to describe the relation of the Omni Layer to Bitcoin is that of HTTP to TCP/IP: HTTP, like the Omni Layer, is the application layer to the more fundamental transport and internet layer of TCP/IP, like Bitcoin.
9+
10+
http://www.omnilayer.org
11+
12+
What is Omni Core
13+
-----------------
14+
15+
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.
16+
17+
Disclaimer, warning
18+
-------------------
19+
This software is EXPERIMENTAL software. USE ON MAINNET AT YOUR OWN RISK.
20+
21+
By default this software will use your existing Bitcoin wallet, including spending bitcoins contained therein (for example for transaction fees or trading).
22+
The protocol and transaction processing rules for the Omni Layer are still under active development and are subject to change in future.
23+
Omni Core should be considered an alpha-level product, and you use it at your own risk. Neither the Omni Foundation nor the Omni Core developers assumes any responsibility for funds misplaced, mishandled, lost, or misallocated.
24+
25+
Further, please note that this installation of Omni Core should be viewed as EXPERIMENTAL. Your wallet data, bitcoins and Omni Layer tokens may be lost, deleted, or corrupted, with or without warning due to bugs or glitches. Please take caution.
26+
27+
This software is provided open-source at no cost. You are responsible for knowing the law in your country and determining if your use of this software contravenes any local laws.
28+
29+
PLEASE DO NOT use wallet(s) with significant amounts of bitcoins or Omni Layer tokens while testing!
30+
31+
Related projects
32+
----------------
33+
34+
* https://github.com/OmniLayer/OmniJ
35+
36+
* https://github.com/OmniLayer/omniwallet
37+
38+
* https://github.com/OmniLayer/spec
39+
40+
Support
41+
-------
42+
43+
* Please open a [GitHub issue](https://github.com/OmniLayer/omnicore/issues) to file a bug submission.

src/omnicore/doc/configuration.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
Omni Core configuration
2+
=======================
3+
4+
Omni Core can be configured via command-line options, or by editing `bitcoin.conf`.
5+
6+
##### General
7+
8+
- `-startclean` (boolean, clear persistence files, disabled by default)
9+
10+
##### Logging
11+
12+
- `-omnilogfile=file` (string, log file, `omnicore.log` by default)
13+
- `-omnidebug=category` (multi string, enable log categories, can be `all`, `none`)
14+
15+
##### Transactions
16+
17+
- `-autocommit` (boolean, create or broadcast transactions, enabled by default)
18+
- `-omnitxcache=n` (number, max. size of input transaction cache, `500000` transactions by default)
19+
- `-datacarrier` and `-datacarriersize` determine whether to use class B (multisig) or class C encoding
20+
21+
##### Notifications
22+
23+
- `-omnialertallowsender=source` (multi string, authorize alert senders, can be `any`)
24+
- `-omnialertignoresender=source` (multi string, ignore alert senders)
25+
- `-overrideforcedshutdown` (boolean, overwrite shutdown, triggered by an alert, disabled by default)
26+
27+
##### UI
28+
29+
- `-disclaimer` (boolean, explicitly show QT disclaimer on startup, disabled by default)
30+
- `-omniuiwalletscope=n` (number, max. transactions to show in history, `500` by default)

src/omnicore/doc/release-notes.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Note: this is a temporary file, and shall be updated before a release.
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
Master Core version 0.0.9-rel is available from:
2+
3+
- https://github.com/mastercoin-MSC/mastercore/releases/tag/v0.0.9
4+
5+
General
6+
=======
7+
8+
- This release is consensus critical. You MUST update before block 342650. After block 342650 prior versions WILL provide incorrect data
9+
- This release modifies the schema. You MUST reparse when upgrading (run once with the --startclean option)
10+
- Integrators should regularly poll getinfo_MP for any alerts to ensure they are kept aprised of any urgent issues
11+
12+
Changelog
13+
=========
14+
15+
- Mainnet Send To Owners transaction processing is live from block 342650
16+
- STO support added to listtransactions_MP
17+
- STO RPC calls getsto_MP and sendtoowners_MP added
18+
- Added --startclean option to automate reparsing (removal of MP_ state folders etc)
19+
- Alerting system added including evaluation and shutdown in event of new protocol messages being made live that are unsupported by client
20+
- getinfo_MP RPC call added
21+
- Numerous bugfixes
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
Omni Core version 0.0.9.1-rel is available from:
2+
3+
https://github.com/mastercoin-MSC/mastercore/releases/tag/v0.0.9.1
4+
5+
0.0.9.1 is a minor release and not consensus critical. An upgrade is only mandatory if you are using a version prior 0.0.9.
6+
7+
Please report bugs using the issue tracker at GitHub:
8+
9+
https://github.com/mastercoin-MSC/mastercore/issues
10+
11+
IMPORTANT
12+
=========
13+
14+
- This is the first experimental release of Omni Layer support in the QT UI, please be vigilant with testing and do not risk large amounts of Bitcoin and Omni Layer tokens.
15+
- The transaction index is no longer defaulted to enabled. You will need to ensure you have "txindex=1" (without the quotes) in your configuration file.
16+
- If you are upgrading from a version earlier than 0.0.9-rel you must start with the --startclean parameter at least once to refresh your persistence files.
17+
- The first time Omni Core is run the startup process may take an hour or more as existing Omni Layer transactions are parsed. This is normal and should only be required the first time Omni Core is run.
18+
19+
Upgrading and downgrading
20+
==========================
21+
22+
How to Upgrade
23+
--------------
24+
25+
If you are running an older version, shut it down. Wait until it has completely shut down (which might take a few minutes for older versions), then copy the new version of mastercored/mastercore-qt.
26+
27+
If you are upgrading from any version earlier than 0.0.9, the first time you run you must start with the --startclean parameter at least once to refresh your persistence files.
28+
29+
Downgrading
30+
-----------
31+
32+
Downgrading is not currently supported as older versions will not provide accurate information.
33+
34+
Changelog
35+
=========
36+
37+
General
38+
-------
39+
40+
- Extra console debugging removed
41+
- Bitcoin 0.10 blockchain detection (will refuse to start if out of order block storage is detected)
42+
- txindex default value now matches Bitcoin Core (false)
43+
- Update authorized alert senders
44+
- Added support for TX70 to RPC output
45+
- Fix missing LOCK of cs_main in selectCoins()
46+
- Versioning code updated
47+
48+
49+
UI
50+
--
51+
52+
- New signal added for changes to Omni state (emitted from block handler for blocks containing Omni transactions)
53+
- Fix double clicking a transaction in overview does not activate the Bitcoin history tab
54+
- Splash screen updated to reflect new branding
55+
- Fix frame alignment in overview page
56+
- Update send page behaviour and layout per feedback
57+
- Fix column resizing on balances tab
58+
- Right align amounts in balances tab
59+
- Various rebranding to Omni Core
60+
- Rewritten Omni transaction history tab
61+
- Add protection against long labels growing the UI size to ridiculous proportions
62+
- Update signalling to all Omni pages to ensure up to date info
63+
- Override display of Mastercoin metadata for rebrand (RPC unchanged)
64+
- Acknowledgement of disclaimer will now be remembered
65+
- Ecosystem display fixed in property lookup
66+
- Fix intermittent startup freezes due to locks
File renamed without changes.

0 commit comments

Comments
 (0)