Skip to content

Commit ec354ad

Browse files
committed
docs(readme): reference build instructions
Signed-off-by: Rafael Belchior <[email protected]>
1 parent a74a7ed commit ec354ad

File tree

1 file changed

+3
-36
lines changed

1 file changed

+3
-36
lines changed

README.md

+3-36
Original file line numberDiff line numberDiff line change
@@ -12,50 +12,17 @@ Hyperledger Cactus is currently undergoing a major refactoring effort to enable
1212

1313
## Scope of Project
1414

15-
As blockchain technology proliferates, blockchain integration will become an increasingly important topic in the broader blockchain ecosystem. For instance, people might want to trade between multiple different blockchains that are run on different platforms. The blockchain integration framework is a web application system designed to allow users to securely integrate different blockchains. It includes a set of libraries, data models, and SDK to accelerate development of an integrated services application. Our goal is to build a system that allows users of our code to securely conduct transactions between all of the most commonly used blockchains.
15+
As blockchain technology proliferates, blockchain integration will become an increasingly important topic in the broader blockchain ecosystem. For instance, people might want to trade between multiple different blockchains that are run on different platforms. The blockchain integration framework is a web application system designed to allow users to securely integrate different blockchains. It includes a set of libraries, data models, and SDK to accelerate development of an integrated services application. Our goal is to deliver a system that allows users of our code to securely conduct transactions between all of the most commonly used blockchains.
1616

1717
## Documentation
1818

1919
* [Hyperledger Cactus Home](https://wiki.hyperledger.org/display/cactus)
2020
* [Whitepaper](./whitepaper/whitepaper.md)
2121
* [Hyperledger Forum Introduction To Cactus](https://www.youtube.com/watch?v=fgYrUIc_-sU)
2222

23-
## How It Works
23+
## Running Cactus
2424

25-
### Interworking patterns
26-
Hyperledger Cactus is planning to support following interworking patterns.
27-
28-
- Note: In the following description, **Value (V)** means numerical assets (e.g. money). **Data (D)** means non-numerical assets (e.g. ownership proof). Ledger 1 is source ledger, Ledger 2 is destination ledger.
29-
30-
| No. | Name | Pattern | Consistency |
31-
| --- | ------------------- | ------- | ---------------------------------------------------------------------------------------------- |
32-
| 1. | value transfer | V -> V | check if V1 = V2 <br> (as V1 is value on ledger 1, V2 is value on ledger 2) |
33-
| 2. | value-data transfer | V -> D | check if data transfer is successful when value is transferred |
34-
| 3. | data-value transfer | D -> V | check if value transfer is successful when data is transferred |
35-
| 4. | data transfer | D -> D | check if all D1 is copied on ledger 2 <br> (as D1 is data on ledger 1, D2 is data on ledger 2) |
36-
| 5. | data merge | D <-> D | check if D1 = D2 as a result <br> (as D1 is data on ledger 1, D2 is data on ledger 2) |
37-
38-
### Interworking architecture
39-
Hyperledger Cactus will provide integrated service(s) by executing ledger operations across multiple blockchain ledgers. The execution of operations are controlled by the module of Hyperledger Cactus which will be provided by vendors as the single Hyperledger Cactus Business Logic plugin.
40-
The supported blockchain platforms by Hyperledger Cactus can be added by implementing new Hyperledger Cactus Ledger plugin.
41-
Once an API call to Hyperledger Cactus framework is requested by a User, Business Logic plugin determines which ledger operations should be executed, and it ensures reliability on the issued integrated service is completed as expected.
42-
Following diagram shows the architecture of Hyperledger Cactus based on the discussion made at Hyperledger Cactus project calls.
43-
The overall architecture is as the following figure.
44-
45-
<img src="https://github.com/hyperledger/cactus/raw/master/whitepaper/architecture-with-plugin-and-routing.png" width="700">
46-
47-
Each entity is as follows:
48-
- **Business Logic Plugin**: The entity executes business logic and provide integration services that are connected with multiple blockchains. The entity is composed by web application or smart contract on a blockchain. The entity is a single plugin and required for executing Hyperledger Cactus applications.
49-
- **Ledger Plugin**: The entity communicates Business Logic Plugin with each ledger. The entity is composed by a validator and a verifier as follows. The entity(s) is(are) chosen from multiple plugins on configuration.
50-
- **Validator**: The entity verifies transactions on the connected ledger and makes signatures for requesting to the verifier. The entity connects the verifier using a bi-directional channel.
51-
- **Verifier**: The entity verifies the signatures from the validator. The entity connects the validator using a bi-directional channel.
52-
- **Cactus Routing Interface**: The entity is a routing service between Business Logic Plugin and Ledger Plugin(s). The entity is also a routing service between Business Logic Plugin and API calls from application users.
53-
- **Ledger-n**: Ledger (e.g. Ethereum, Quorum, Hyperledger Fabric, ...)
54-
55-
The execution steps are described as follows:
56-
- **Step 1**: Application user(s) makes an API call for operations on a single ledger or between multiple ledgers. The API call is sent to Business Logic Plugin via Hyperledger Cactus Routing Interface.
57-
- **Step 2**: Business Logic Plugin requests ledger operation(s) to Ledger Plugin(s) via Hyperledger Cactus Routing Interface. Ledger plugin requests the operation(s) to its connected ledger. The operation is settled on the ledger.
58-
- **Step 3**: The Ledger Plugin is monitoring transaction data on its connected ledger. If Ledger Plugin receives transaction data related with the operation(s) of Step 2, Ledger Plugin verifies the transaction and send the verified transaction information to Business Logic Plugin via Hyperledger Cactus Routing Interface, then Business Logic Plugin receives this information and records it.
25+
Please review the [build guidelines](/BUILD.md) to build and run the project.
5926

6027
## Contact
6128
* mailing list: [[email protected]](mailto:[email protected])

0 commit comments

Comments
 (0)