diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..fcecbcde --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,61 @@ +## OpenST-protocol v0.9.1 December 19 2017 + +OpenST v0.9.1 is the first release deployed on Ethereum mainnet combined with the +activation of Simple Token to power the OpenST platform. The OpenST platform +allows Ethereum smart contracts to runs faster and cheaper while leveraging +the security properties of Ethereum's Proof-of-Work. In this release we implement +the first corner stone of the protocol: the ability to stake value on Ethereum +mainnet and mint a new representation of that value on a utility chain, +effectively increasing the computational throughput of Ethereum smart contracts +by allowing parallel execution across chains. + +OpenST smart contracts have been restructured to store value separately from +the logic that implements the protocol. v0.9.1 is not yet protocol complete +as the validators are whitelisted and not yet open with stake put forward on +Ethereum mainnet. However, by splitting the protocol implementation into +these two logically separate problems, we can already start working with +member companies and developers to fine-tune the APIs and the developer +experience to build mainstream applications on Ethereum. + +``` + Ethereum mainnet (value) | OpenST platform (utility) + --------------------------------------------------------------------- + Core - - - - - - - - - - - (Core) + / | \ + / | \ + Registrar | Registrar + | | | + OpenSTValue | OpenSTUtility + \_ SimpleStake | \_ UtilityTokenAbstract + | \_ SimpleTokenPrime (base token) + | \_ BrandedToken +``` + +Detailed changelog: + +- Generate documentation in /docs ([openst-protocol#78](https://github.com/OpenSTFoundation/openst-protocol/pull/78)) +- Unit tests for Owned, OpsManaged, SafeMath (carry over from SimpleTokenSale) ([openst-protocol#73](https://github.com/OpenSTFoundation/openst-protocol/pull/73)) +- Add mock ERC20 token for dryrun on Ethereum mainnet ([openst-protocol#71](https://github.com/OpenSTFoundation/openst-protocol/pull/71)) +- Unit tests for protocol transfer ([openst-protocol#66](https://github.com/OpenSTFoundation/openst-protocol/pull/66)) +- Integration tests for reverting stake and redemption ([openst-protocol#65](https://github.com/OpenSTFoundation/openst-protocol/pull/65)) +- Bug fix revert unstaking was restricted to registrar only ([openst-protocol#64](https://github.com/OpenSTFoundation/openst-protocol/pull/64)) +- Implement fallback for process staking and process redemption ([openst-protocol#60](https://github.com/OpenSTFoundation/openst-protocol/pull/60)) +- Bug fix on reverted redemption allow re-use of nonce ([openst-protocol#59](https://github.com/OpenSTFoundation/openst-protocol/pull/59)) +- Initiate and revoke protocol transfer ([openst-protocol#55](https://github.com/OpenSTFoundation/openst-protocol/pull/55)) +- Run Truffle tests with optimised compilation to accurately measure gas usage ([openst-protocol#54](https://github.com/OpenSTFoundation/openst-protocol/pull/54)) +- Integration tests improvement on event assertion ([openst-protocol#47](https://github.com/OpenSTFoundation/openst-protocol/pull/47)) +- Allow reverting escrow after unlock height ([openst-protocol#46](https://github.com/OpenSTFoundation/openst-protocol/pull/46)) +- Set minimal redemption accuracy ([openst-protocol#41](https://github.com/OpenSTFoundation/openst-protocol/pull/41)), ([openst-protocol#38](https://github.com/OpenSTFoundation/openst-protocol/pull/38)) +- Integration test framework for staking ([openst-protocol#37](https://github.com/OpenSTFoundation/openst-protocol/pull/37)) +- Increase unit test coverage for Registrar, OpenSTValue, and OpenSTUtility ([openst-protocol#35](https://github.com/OpenSTFoundation/openst-protocol/pull/35)) +- Bug fix in OpenSTUtility.processRedeeming ([openst-protocol#33](https://github.com/OpenSTFoundation/openst-protocol/pull/33)) +- Correct assertion bug on OpenSTValue.processStaking ([openst-protocol#18](https://github.com/OpenSTFoundation/openst-protocol/pull/18)) +- Complete separation of value and logic for redemption process ([openst-protocol#11](https://github.com/OpenSTFoundation/openst-protocol/pull/11)), ([openst-protocol#12](https://github.com/OpenSTFoundation/openst-protocol/pull/12)), ([openst-protocol#13](https://github.com/OpenSTFoundation/openst-protocol/pull/13)) +- Unit tests for ProtocolVersioned, SimpleStake, BrandedToken, EIP20Token, STPrime, and UtilityTokenAbstract ([openst-protocol#9](https://github.com/OpenSTFoundation/openst-protocol/pull/9)) +- SimpleTokenPrime: add payable initialization function ([openst-protocol#7](https://github.com/OpenSTFoundation/openst-protocol/pull/7)) +- SimpleStake: separate value from logic to enable upgrade path ([openst-protocol#5](https://github.com/OpenSTFoundation/openst-protocol/pull/1)) + + +## OpenST-protocol [v0.9.0](https://github.com/OpenSTFoundation/openst-protocol/releases/tag/v0.9.0) November 8 2017 + + - update OpenST-protocol with work done on Ropsten demo ([openst-protocol#1](https://github.com/OpenSTFoundation/openst-protocol/pull/1)) diff --git a/README.md b/README.md index 1b59975a..79760aa2 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,38 @@ While OpenST 0.9 is available as-is for anyone to use, we caution that this is early stage software and under heavy ongoing development and improvement. Please report bugs and suggested improvements. -Watch demo video of milestone 1 (will take you to [https://www.youtube.com/watch?v=-SxJ8c1Xh_A](https://www.youtube.com/watch?v=-SxJ8c1Xh_A)) +OpenST v0.9.1 is the first release deployed on Ethereum mainnet combined with the +activation of Simple Token to power the OpenST platform. The OpenST platform +allows Ethereum smart contracts to runs faster and cheaper while leveraging +the security properties of Ethereum's Proof-of-Work. In this release we implement +the first corner stone of the protocol: the ability to stake value on Ethereum +mainnet and mint a new representation of that value on a utility chain, +effectively increasing the computational throughput of Ethereum smart contracts +by allowing parallel execution across chains. + +OpenST smart contracts have been restructured to store value separately from +the logic that implements the protocol. v0.9.1 is not yet protocol complete +as the validators are whitelisted and not yet open with stake put forward on +Ethereum mainnet. However, by splitting the protocol implementation into +these two logically separate problems, we can already start working with +member companies and developers to fine-tune the APIs and the developer +experience to build mainstream applications on Ethereum. + +``` + Ethereum mainnet (value) | OpenST platform (utility) + --------------------------------------------------------------------- + Core - - - - - - - - - - - (Core) + / | \ + / | \ + Registrar | Registrar + | | | + OpenSTValue | OpenSTUtility + \_ SimpleStake | \_ UtilityTokenAbstract + | \_ SimpleTokenPrime (base token) + | \_ BrandedToken +``` + +Watch demo video of milestone 1 (v0.9.0 - will take you to [https://www.youtube.com/watch?v=-SxJ8c1Xh_A](https://www.youtube.com/watch?v=-SxJ8c1Xh_A)) [![Milestone 1 demo video](https://img.youtube.com/vi/-SxJ8c1Xh_A/0.jpg)](https://www.youtube.com/watch?v=-SxJ8c1Xh_A) diff --git a/VERSION.md b/VERSION.md new file mode 100644 index 00000000..f374f666 --- /dev/null +++ b/VERSION.md @@ -0,0 +1 @@ +0.9.1