Skip to content

Commit d44c8cf

Browse files
authored
Update to v0.12.3 (#12)
* update to v0.12.3 * Update README.md * Update README.md
1 parent 0935162 commit d44c8cf

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+1128
-335
lines changed

README.md

Lines changed: 4 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
1-
# cChannel-eth (WIP)
1+
# cChannel-eth
22

33
[![Build Status](https://travis-ci.org/celer-network/cChannel-eth.svg?branch=master)](https://travis-ci.org/celer-network/cChannel-eth)
44

55
* [Overview](https://github.com/celer-network/cChannel-eth#overview)
6-
* [Work In Progress (WIP) Notice](https://github.com/celer-network/cChannel-eth#work-in-progress-wip-notice)
76
* [Core Concepts](https://github.com/celer-network/cChannel-eth#core-concepts)
87
* [Release Features](https://github.com/celer-network/cChannel-eth#release-features)
98
* [Protocol Buffers Usage](https://github.com/celer-network/cChannel-eth#protocol-buffers-usage)
10-
* [Testnet](https://github.com/celer-network/cChannel-eth#testnet)
119
* [Solidity Version](https://github.com/celer-network/cChannel-eth#solidity-version)
1210
* [Code Structure](https://github.com/celer-network/cChannel-eth#code-structure)
1311
* [contracts folder](https://github.com/celer-network/cChannel-eth#contracts-folder)
@@ -20,10 +18,6 @@ cChannel-eth is a collection of smart contracts acting as the binding of cChanne
2018

2119
For more details about cChannel and Celer Network, please refer to [Celer Network's official website](https://www.celer.network/).
2220

23-
## Work In Progress (WIP) Notice
24-
cChannel-eth is currently under active developments in our private repo. This public repo only acts as a showcase of periodically public updates.
25-
**This repo is not intended for production use and please DO NOT use the code in this repo with any real money, funds or assets.**
26-
2721
## Core Concepts
2822
* **Peers**: channel participants (only supports two-peer channel for now).
2923
* **Simplex Channel**: a single-direction payment channel from one peer to the other peer.
@@ -37,7 +31,7 @@ cChannel-eth is currently under active developments in our private repo. This pu
3731
* **Payment Destination**: the address receives a payment, namely the destination of this payment route.
3832
* **Vouched Conditional Payment Result**: the result of a conditional payment agreed by the payment source and payment destination.
3933
* **PayRegistry**: a global registry which updates and records all payment results.
40-
* **PayIdList**: data structure including a list of payment ids and a hash pointer to next PayIdList, which is used in Batch Multi-Payment Liquidation.
34+
* **PayIdList**: data structure including a list of payment ids and a hash pointer to next PayIdList, which is used in Batch Multi-Payment Clearing.
4135
* **EthPool**: A ETH wrapper to provide ERC20-like APIs for ETH.
4236
* **Virtual Address Resolver**: establishes the mapping from off-chain address to on-chain address.
4337

@@ -60,7 +54,7 @@ cChannel-eth is currently under active developments in our private repo. This pu
6054
* **Cooperative Dynamic Withdraw**: skips challenge period and withdraws fund before channel finalized when both peers reach an agreement.
6155
* **Lightweight cooperative on-chain checkpoint**: support snapshotting transfer map of co-signed states on-chain.
6256
* **Batch Multi-Channel Settlements**: intends to settle multiple channels in one batch with a single on-chain transaction.
63-
* **Batch Multi-Payment Liquidation**: liquidates *N* payments in one batch with a single on-chain transaction using PayIdList, which only requires O(1) on-chain storage and O(*n*/*N*) on-chain verifications to liquidate *n* payments.
57+
* **Batch Multi-Payment Clearing**: clears *N* payments in one batch with a single on-chain transaction using PayIdList, which only requires O(1) on-chain storage and O(*n*/*N*) on-chain verifications to clear *n* payments.
6458
* **Cooperative Settle**: skips challenge period and settles a channel when both peers reach an agreement.
6559

6660
## Protocol Buffers Usage
@@ -71,20 +65,8 @@ We have also developed and open sourced a Solidity library generator of proto3 d
7165

7266
Two proto3 files are used in cChannel-eth, `chain.proto` and `entity.proto`, which are stored in `lib/data/proto/`. `chain.proto` defines data structures only used in on-chain contracts, while `entity.proto` defines data structures used both in on-chain contracts and off-chain communication protocols.
7367

74-
## Latest Deployments
75-
### Ropsten
76-
#### Celer Channel
77-
* Contract address: [0x66804e13b02d2d2d4174ae3b538bf968411bb6c1](https://ropsten.etherscan.io/address/0x66804e13b02d2d2d4174ae3b538bf968411bb6c1)
78-
* Deployed code: [CelerChannel.sol](https://github.com/celer-network/cChannel-eth/blob/v0.11.0/contracts/CelerChannel.sol)
79-
80-
### Alpha Mainnet
81-
**ATTENTION**: this deployment is only for Alpha release testing. Please DO NOT deposit any real ETH, valuable tokens or funds into this version. Celer is not responsible for any loss.
82-
#### Celer Channel
83-
* Contract address: [0xa021fc97622f4259745c8604fb7f6e007a78d4f4](https://etherscan.io/address/0xa021fc97622f4259745c8604fb7f6e007a78d4f4)
84-
* Deployed code: [CelerChannel.sol](https://github.com/celer-network/cChannel-eth/blob/v0.11.0/contracts/CelerChannel.sol)
85-
8668
## Solidity Version
87-
Solidity `^0.5.0` or above is required to run cChannel-eth contracts.
69+
Solidity `^0.5.1` or above is required to run cChannel-eth contracts.
8870

8971
## Code Structure
9072
The following is the main code structure of cChannel-eth:

0 commit comments

Comments
 (0)