# Mosaic Contracts Change Log ## Version 0.12.0 ### Notable Changes * Implementation of RedeemPool Contract ([#790](https://github.com/mosaicdao/mosaic-contracts/pull/790), [#791](https://github.com/mosaicdao/mosaic-contracts/pull/791)) * Implementation of Redeemer Proxy Contract ([#790](https://github.com/mosaicdao/mosaic-contracts/pull/790), [#791](https://github.com/mosaicdao/mosaic-contracts/pull/791)) ## Version 0.11.0 ### Notable Changes * Gateways should store roots in ring buffer [#726](https://github.com/OpenST/mosaic-contracts/pull/726) * Autogenerate contract interacts using typechain/ts-generator [#781](https://github.com/OpenST/mosaic-contracts/pull/781) * OSTComposer StakeRequest object storage optimization [#778](https://github.com/OpenST/mosaic-contracts/pull/778) * Destructing staker proxy via ost composer contract [#777](https://github.com/OpenST/mosaic-contracts/pull/777) * Hashing of a stake request now confirms EIP-712 [#776](https://github.com/OpenST/mosaic-contracts/pull/776) * `activeStakeRequestCount` removed from OSTComposer contract [#775](https://github.com/OpenST/mosaic-contracts/pull/775) * Mutex refactoring and nonce removal check from StakerProxy.stake [#774](https://github.com/OpenST/mosaic-contracts/pull/774) * Ost composer contract [#750](https://github.com/OpenST/mosaic-contracts/pull/750) * Staker proxy contract [#745](https://github.com/OpenST/mosaic-contracts/pull/745) * Generate proof data [#743](https://github.com/OpenST/mosaic-contracts/pull/743) * Retains a pattern of generated proof data [#760](https://github.com/OpenST/mosaic-contracts/pull/760) * Parallelize Travis CI [#746](https://github.com/OpenST/mosaic-contracts/pull/746) * Fuzzer that generates the valid Merkel Patricia Proofs. [#729](https://github.com/OpenST/mosaic-contracts/pull/729) * Integration tests for redeem and unstake after revert stake [#753](https://github.com/OpenST/mosaic-contracts/pull/753) * Integration tests for revert redeem [#747](https://github.com/OpenST/mosaic-contracts/pull/747) * Integration tests for progress stake and mint after revert [#752](https://github.com/OpenST/mosaic-contracts/pull/752) * Integration tests for redeem & unstake with proof [#734](https://github.com/OpenST/mosaic-contracts/pull/734) * Integration tests for revert stake [#732](https://github.com/OpenST/mosaic-contracts/pull/732) * Integration tests for stake & Mint with proof [#730](https://github.com/OpenST/mosaic-contracts/pull/730) * Correct setting of auxiliaryAccounts in integration tests [#761](https://github.com/OpenST/mosaic-contracts/pull/761) * Merkle Patricia Proof Generator Tool [#717](https://github.com/OpenST/mosaic-contracts/pull/717) * Code deduplication, `UtilityToken`, `Organization` dependencies are imported using git submodules, `SafeMath` dependency is imported as npm package [#728](https://github.com/OpenST/mosaic-contracts/pull/728) * Change references from (branded) token to value token [#710](https://github.com/OpenST/mosaic-contracts/pull/710) * Gateway nonce now starts at zero [#715](https://github.com/OpenST/mosaic-contracts/pull/715) * Improved variable names in GateawayBase.feeAmount() [#713](https://github.com/OpenST/mosaic-contracts/pull/713/files) * Token type as `address` instead of `EIP20Interface` in `UtilityToken` [#714](https://github.com/OpenST/mosaic-contracts/pull/714/files) * Improved message bus documentation, using explicit `inboxMessageStatus` and `outboxMessageStatus` [#709](https://github.com/OpenST/mosaic-contracts/pull/709/files) * Updated vocabulary, coin and ost instead of base token and token [#686](https://github.com/OpenST/mosaic-contracts/pull/686) ## Version 0.10.0 ⚓️ Anchor A gateway for a given EIP20 token is comprised of a `EIP20Gateway` contract on origin and a corresponding `EIP20CoGateway` contract on auxiliary. On auxiliary there is an EIP20 utility token contract that mints and burns utility tokens. It atomically mirrors tokens staked and unstaked on the origin chain. Atomicity is achieved using a 2-phase message passing architecture between the chains. Messages are declared on the source chain and confirmed on the target chain. In order to confirm a message, a facilitator uses a Merkle Patricia proof once the source chain's state has been transferred to the target. Once messages are confirmed on the target chain, the facilitator can efficiently progress them by providing the hash lock secret. Alternatively, anyone can progress the messages with two more Merkle Patricia proofs. Progressing with proofs does not require knowledge of the hash lock secret. Messages can also be reverted if they are not yet completed on the target chain. The current release uses a "anchors" to provide state roots from remote chains. ### Notable Changes * Penalty is now burned on revert stake and revert redeem instead of returning on progress stake with proof and progree redeem with proof([#668](https://github.com/OpenST/mosaic-contracts/pull/668)). * MerklePatriciaProof library can now verify valid proof with extension nodes ([#651](https://github.com/OpenSTFoundation/mosaic-contracts/pull/651)). * Contracts' ABIs and BINs are provided via npm package [@openstfoundation/mosaic-contracts](https://www.npmjs.com/package/@openstfoundation/mosaic-contracts) ([#619](https://github.com/OpenSTFoundation/mosaic-contracts/pull/619), [#637](https://github.com/OpenSTFoundation/mosaic-contracts/pull/637)). * Contracts are now separated into "Gateway" and "Core" contracts ([#221](https://github.com/OpenSTFoundation/mosaic-contracts/pull/221)). * Core logic is now cleanly split into a "mosaic core" and an "anchor" ([#522](https://github.com/OpenSTFoundation/mosaic-contracts/pull/522), [#549](https://github.com/OpenSTFoundation/mosaic-contracts/pull/549)). * Gateway can now interact with decentralized mosaic core ([#463](https://github.com/OpenSTFoundation/mosaic-contracts/pull/463)). * Introduced a new state-machine based message bus ([#293](https://github.com/OpenSTFoundation/mosaic-contracts/pull/293)). * Gateways are now based on the new message bus ([#293](https://github.com/OpenSTFoundation/mosaic-contracts/pull/293)). * Redeeming no longer requires a facilitator argument ([#517](https://github.com/OpenSTFoundation/mosaic-contracts/pull/517)). * CoGateway can no longer be deactivated ([#518](https://github.com/OpenSTFoundation/mosaic-contracts/pull/518)). * Stake and redeem now support "zero gas price" ([#521](https://github.com/OpenSTFoundation/mosaic-contracts/pull/521)). * CoGateway no more mints zero reward amount for facilitator ([#527](https://github.com/OpenSTFoundation/mosaic-contracts/pull/527)). * Mint and burn now changed to increase and decrease supply ([#529](https://github.com/OpenSTFoundation/mosaic-contracts/pull/529), [#540](https://github.com/OpenSTFoundation/mosaic-contracts/pull/540)). * OST prime supply is now increased as base token ([#559](https://github.com/OpenSTFoundation/mosaic-contracts/pull/559)). * Claim and redeem are now called unwrap and wrap. Claim and redeem events are now called token unwrapped and token wrapped ([#533](https://github.com/OpenSTFoundation/mosaic-contracts/pull/533)). * The gateways now accept a "burner" argument. All burnt value will be sent to the burner instead ([#542](https://github.com/OpenSTFoundation/mosaic-contracts/pull/542)). * Staker can now stake without providing signatures. This also means that there is now only one actor known to the Gateways ([#548](https://github.com/OpenSTFoundation/mosaic-contracts/pull/548)). * Gateway and CoGateway now check that the stake/redeem amount covers at least the potential reward ([#600](https://github.com/OpenSTFoundation/mosaic-contracts/pull/600)). * Penalty is returned to the staker and redeemer on progress stake and progress mint, if revocation of message is declared on source chain and target is already progressed ([#576](https://github.com/OpenSTFoundation/mosaic-contracts/pull/576)). * Anchor now stores only recent state roots ([#546](https://github.com/OpenSTFoundation/mosaic-contracts/pull/546)). * Contracts can now be `Organized` in line with [openst-contracts](https://github.com/OpenSTFoundation/openst-contracts) ([#513](https://github.com/OpenSTFoundation/mosaic-contracts/pull/513)). * Gateways are now `Organized` ([#515](https://github.com/OpenSTFoundation/mosaic-contracts/pull/515)). * Only the organization can anchor state roots ([#560](https://github.com/OpenSTFoundation/mosaic-contracts/pull/560)). * Objects are now hashed according to [EIP 712](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-712.md) ([#399](https://github.com/OpenSTFoundation/mosaic-contracts/pull/399), [#566](https://github.com/OpenSTFoundation/mosaic-contracts/pull/566)). * Added tools to make deployment of mosaic easier ([#458](https://github.com/OpenSTFoundation/mosaic-contracts/pull/458), [#550](https://github.com/OpenSTFoundation/mosaic-contracts/pull/550)). * Naming of RLP encoded parameters and variables is unified ([#528](https://github.com/OpenSTFoundation/mosaic-contracts/pull/528)). * Added getter functions for easier interaction ([#598](https://github.com/OpenSTFoundation/mosaic-contracts/pull/598), [#600](https://github.com/OpenSTFoundation/mosaic-contracts/pull/600), [#601](https://github.com/OpenSTFoundation/mosaic-contracts/pull/601), [#602](https://github.com/OpenSTFoundation/mosaic-contracts/pull/602)). * Significantly improved test coverage (various PRs). * Significantly improved readability and maintainability (various PRs). * Stake and mint integration test ([#634](https://github.com/OpenSTFoundation/mosaic-contracts/pull/634)). * Redeem and unstake integration test ([#638](https://github.com/OpenSTFoundation/mosaic-contracts/pull/638)). * Ported repository to Truffle v5 ([#334](https://github.com/OpenSTFoundation/mosaic-contracts/pull/334)). * Ported repository to solidity 0.5.0 ([#480](https://github.com/OpenSTFoundation/mosaic-contracts/pull/480)). #### Updates to Mosaic Core * Core contracts implement an initial version of the Mosaic protocol (various PRs). * Report block headers of both chains to the respective block stores. * Vote on checkpoints (Casper FFG style). * Propose meta-blocks to origin. * Verify a seal on a proposal on origin. * Transfer the new kernel to auxiliary. #### Known Issues of Mosaic Core * Circular dependencies between mosaic core contracts on auxiliary. * Validators can not yet join an existing set of validators. * Validator rewards are not handled yet. ## OpenST-protocol [v0.9.2](https://github.com/OpenSTFoundation/mosaic-contracts/releases/tag/v.0.9.2) March 27 2018 OpenST v0.9.2 improves usability to facilitate application by the [OpenST-Platform](https://github.com/OpenSTFoundation/openst-platform) and other services. Additionally, this release increases test coverage, with additional unit and integration tests, and adds continuous integration with Travis CI. Detailed changelog: - Introduce `conversionRateDecimals` to `BrandedToken` to treat conversion rate as a fixed point arithmetic number ([openst-protocol #107](https://github.com/OpenSTFoundation/openst-protocol/pull/107)) - Expose list of registered tokens on `OpenSTUtility` ([openst-protocol #89](https://github.com/OpenSTFoundation/openst-protocol/pull/89)) - Make token UUIDs iterable on the value chain ([openst-protocol #103](https://github.com/OpenSTFoundation/openst-protocol/pull/103)) - Make token UUIDs iterable on the utility chain ([openst-protocol #102](https://github.com/OpenSTFoundation/openst-protocol/pull/102)) - Incorporate a `beneficiary` into redeem and unstake ([openst-protocol #101](https://github.com/OpenSTFoundation/openst-protocol/pull/101)) - Expose `mints` and `redemptions` on `OpenSTUtility` ([openst-protocol #100](https://github.com/OpenSTFoundation/openst-protocol/pull/100)) - Expose `stakes` and `unstakes` on `OpenSTValue` ([openst-protocol #99](https://github.com/OpenSTFoundation/openst-protocol/pull/99)) - Revise `UtilityTokenAbstract` to set certain invariants upon construction and to expose them ([openst-protocol #97](https://github.com/OpenSTFoundation/openst-protocol/pull/97)) - Remove unneeded files ([openst-protocol #93](https://github.com/OpenSTFoundation/openst-protocol/pull/93)) - Tests: configure Travis CI to run unit tests on `master` and `develop` branches for every commit, merge and pull request ([openst-protocol #87](https://github.com/OpenSTFoundation/openst-protocol/pull/87), [openst-protocol #105](https://github.com/OpenSTFoundation/openst-protocol/pull/105)) - Tests: denominate tokens consistently ([openst-protocol #82](https://github.com/OpenSTFoundation/openst-protocol/pull/82)) - Tests: add unit tests for reversion functions ([openst-protocol #74](https://github.com/OpenSTFoundation/openst-protocol/pull/74)) - Tests: migrate unit tests for `Owned`, `OpsManaged`, and `SafeMath` from SimpleTokenSale repo ([openst-protocol #73](https://github.com/OpenSTFoundation/openst-protocol/pull/73)) - Tests: add integration tests for reversion functions ([openst-protocol #65](https://github.com/OpenSTFoundation/openst-protocol/pull/65)) ## OpenST-protocol [v0.9.1](https://github.com/OpenSTFoundation/mosaic-contracts/releases/tag/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))