In the future, this demo could have a UI to demonstrate how easy it is to deploy a mCCF network and highlight mCCF’s governance capabilities. However this demo will be via the command-line.
We will be demonstrating a reference data set where lei as a unique identifier and nace codes as the attributes. You can explore the data set here.
This demo can work against the Sandbox or CCF running in a docker image with very little ceremony. As long as you have a terminal in the data-reconciliation-app path, you can run make demo to run in the Sandbox, or make demo-docker to run in a virtual enclave inside docker.
If you wish to run this in Managed CCF, please see the Managed CCF Demo Guidance.
Start the demo by running make demo or make demo-docker in the data-reconciliation-app path.
This part of the demo has started the network and deployed the app. The network is running with 3 members and 1 user, and the app is deployed with the constitution defined here, which means that all members have equal votes on decisions, and a majority of approval votes is required to advance proposals. All members have been activated.
▶️ Starting sandbox...
💤 Waiting for sandbox . . . (23318)
📂 Working directory (for certificates): ./workspace/sandbox_common
💤 Waiting for the app frontend...After you press any key, we will start the ingestion service. This service is a simple REST API that accepts JSON/CSV data. You can ingest data for a particular member, and the data will be stored in the network. There are a few negative test cases demonstrated as well as ingesting different file formats. At this point of the demo you will be asked to press any key to continue.
===============================================
🏁 Starting e2e Tests on server <server ip address>
===============================================
===============================================
🔬 [TEST]: Data Ingestion Service
===============================================
📝 Ingestion Service Validations...
✅ [PASS] Member 0 - CSV data ingest failed (wrong schema)
✅ [PASS] Member 0 - CSV data ingest failed (wrong file)
✅ [PASS] Member 0 - JSON data ingest failed (data length is zero)
✅ [PASS] Member 0 - JSON data ingest failed (data is null)
---
📝 Members Ingesting Data...
✅ [PASS] [200 : OK] - Member 0 data has ingested successfully
✅ [PASS] [200 : OK] - Member 1 data has ingested successfully
✅ [PASS] [200 : OK] - Member 2 data has ingested successfully
🎬 Ingestion Stage Complete
- Press return key to continue...The next part of the demo will show the reporting service. This service is a simple REST API that returns a report of the data that has been ingested. Here we demonstrate retrieving a full report of all of the ingested data for that member. At this point of the demo you will be asked to press any key to continue.
===============================================
🔬 [TEST]: Data Reporting Service (Full Report)
===============================================
📝 Member 0 Full Report:
✅ [PASS] [200 : OK] - Member 0
┌─────────┬─────────────────────┬───────────────────┬────────────────────────┬──────────────────────┬────────────────────────┬───────────┐
│ (index) │ group_status │ majority_minority │ count_of_unique_values │ members_in_agreement │ lei │ nace │
├─────────┼─────────────────────┼───────────────────┼────────────────────────┼──────────────────────┼────────────────────────┼───────────┤
│ 0 │ 'NOT_ENOUGH_DATA' │ 'Minority' │ 2 │ 1 │ '9845002B6B074505A715' │ 'C.10.12' │
│ 1 │ 'NOT_ENOUGH_DATA' │ 'Majority' │ 1 │ 2 │ '984500BA57A56NBD3A24' │ 'G.46.77' │
│ 2 │ 'LACK_OF_CONSENSUS' │ 'Minority' │ 2 │ 1 │ '984500E1B2CA1D4EKG67' │ 'A.01.1' │
│ 3 │ 'LACK_OF_CONSENSUS' │ 'Minority' │ 2 │ 1 │ '9845001D460PEJE54159' │ 'K.64.12' │
│ 4 │ 'IN_CONSENSUS' │ 'Majority' │ 1 │ 3 │ '254900Z8QM2AR51H5I26' │ 'C.10.1' │
│ 5 │ 'IN_CONSENSUS' │ 'Majority' │ 1 │ 3 │ '984500F5BD5BE5767C51' │ 'C.18.13' │
│ 6 │ 'LACK_OF_CONSENSUS' │ 'Minority' │ 2 │ 1 │ '9845005E5AEEB78CE366' │ 'G.46.20' │
│ 7 │ 'NOT_ENOUGH_DATA' │ 'Majority' │ 1 │ 2 │ '9845009C73F4BD8X7827' │ 'R.90.01' │
│ 8 │ 'IN_CONSENSUS' │ 'Majority' │ 1 │ 3 │ '984500815D6139D53E23' │ 'M.69.1' │
│ 9 │ 'LACK_OF_CONSENSUS' │ 'Majority' │ 2 │ 2 │ '984500UF3DE41EFA7F02' │ 'B.08.9' │
└─────────┴─────────────────────┴───────────────────┴────────────────────────┴──────────────────────┴────────────────────────┴───────────┘
📝 Member 1 Full Report:
✅ [PASS] [200 : OK] - Member 1
┌─────────┬─────────────────────┬───────────────────┬────────────────────────┬──────────────────────┬────────────────────────┬───────────┐
│ (index) │ group_status │ majority_minority │ count_of_unique_values │ members_in_agreement │ lei │ nace │
├─────────┼─────────────────────┼───────────────────┼────────────────────────┼──────────────────────┼────────────────────────┼───────────┤
│ 0 │ 'LACK_OF_CONSENSUS' │ 'Majority' │ 2 │ 2 │ '984500E1B2CA1D4EKG67' │ 'A01.1' │
│ 1 │ 'LACK_OF_CONSENSUS' │ 'Majority' │ 2 │ 2 │ '9845001D460PEJE54159' │ 'K.65.12' │
│ 2 │ 'IN_CONSENSUS' │ 'Majority' │ 1 │ 3 │ '254900Z8QM2AR51H5I26' │ 'C.10.1' │
│ 3 │ 'IN_CONSENSUS' │ 'Majority' │ 1 │ 3 │ '984500F5BD5BE5767C51' │ 'C.18.13' │
│ 4 │ 'LACK_OF_CONSENSUS' │ 'Majority' │ 2 │ 2 │ '9845005E5AEEB78CE366' │ 'G.46.19' │
│ 5 │ 'IN_CONSENSUS' │ 'Majority' │ 1 │ 3 │ '984500815D6139D53E23' │ 'M.69.1' │
│ 6 │ 'LACK_OF_CONSENSUS' │ 'Majority' │ 2 │ 2 │ '984500UF3DE41EFA7F02' │ 'B.08.9' │
└─────────┴─────────────────────┴───────────────────┴────────────────────────┴──────────────────────┴────────────────────────┴───────────┘
📝 Member 2 Full Report:
✅ [PASS] [200 : OK] - Member 2
┌─────────┬─────────────────────┬───────────────────┬────────────────────────┬──────────────────────┬────────────────────────┬───────────┐
│ (index) │ group_status │ majority_minority │ count_of_unique_values │ members_in_agreement │ lei │ nace │
├─────────┼─────────────────────┼───────────────────┼────────────────────────┼──────────────────────┼────────────────────────┼───────────┤
│ 0 │ 'NOT_ENOUGH_DATA' │ 'Minority' │ 2 │ 1 │ '9845002B6B074505A715' │ 'C.10.13' │
│ 1 │ 'NOT_ENOUGH_DATA' │ 'Majority' │ 1 │ 2 │ '984500BA57A56NBD3A24' │ 'G.46.77' │
│ 2 │ 'LACK_OF_CONSENSUS' │ 'Majority' │ 2 │ 2 │ '984500E1B2CA1D4EKG67' │ 'A01.1' │
│ 3 │ 'LACK_OF_CONSENSUS' │ 'Majority' │ 2 │ 2 │ '9845001D460PEJE54159' │ 'K.65.12' │
│ 4 │ 'IN_CONSENSUS' │ 'Majority' │ 1 │ 3 │ '254900Z8QM2AR51H5I26' │ 'C.10.1' │
│ 5 │ 'IN_CONSENSUS' │ 'Majority' │ 1 │ 3 │ '984500F5BD5BE5767C51' │ 'C.18.13' │
│ 6 │ 'LACK_OF_CONSENSUS' │ 'Majority' │ 2 │ 2 │ '9845005E5AEEB78CE366' │ 'G.46.19' │
│ 7 │ 'NOT_ENOUGH_DATA' │ 'Majority' │ 1 │ 2 │ '9845009C73F4BD8X7827' │ 'R.90.01' │
│ 8 │ 'IN_CONSENSUS' │ 'Majority' │ 1 │ 3 │ '984500815D6139D53E23' │ 'M.69.1' │
│ 9 │ 'LACK_OF_CONSENSUS' │ 'Minority' │ 2 │ 1 │ '984500UF3DE41EFA7F02' │ 'B.08.10' │
└─────────┴─────────────────────┴───────────────────┴────────────────────────┴──────────────────────┴────────────────────────┴───────────┘
🎬 Full Reports Complete
- Press return key to continue...This next section of the demo is retrieving reports by a specific id. This is a simple REST API that returns a report of the data that has been ingested. Here we demonstrate retrieving an IN_CONSENSUS record , that all members agree on the value of that particular key. At this point of the demo you will be asked to press any key to continue.
===============================================
🔬 [TEST]:Data Reporting Service (GetById)
===============================================
📝 Reporting Service Validations...
✅ [PASS] Member 0 - Getting report by key_not_exist should fail
---
📝 --- IN CONSENSUS Example ---
📝 Member 2 Reporting Data for id 984500F5BD5BE5767C51...
✅ [PASS] [200 : OK] - Member 2
┌────────────────────────┬────────────────────────┐
│ (index) │ Values │
├────────────────────────┼────────────────────────┤
│ group_status │ 'IN_CONSENSUS' │
│ majority_minority │ 'Majority' │
│ count_of_unique_values │ 1 │
│ members_in_agreement │ 3 │
│ lei │ '984500F5BD5BE5767C51' │
│ nace │ 'C.18.13' │
└────────────────────────┴────────────────────────┘
✅ [PASS] - Assert Member 2::984500F5BD5BE5767C51.group_status == IN_CONSENSUS
🎬 IN_CONSENSUS DATAThis example demonstrates the result if not all members have submitted data for a particular key. At this point of the demo you will be asked to press any key to continue.
📝 --- NOT ENOUGH DATA Example ---
📝 Member 2 Reporting Data for id 984500BA57A56NBD3A24...
✅ [PASS] [200 : OK] - Member 2
┌────────────────────────┬────────────────────────┐
│ (index) │ Values │
├────────────────────────┼────────────────────────┤
│ group_status │ 'NOT_ENOUGH_DATA' │
│ majority_minority │ 'Majority' │
│ count_of_unique_values │ 1 │
│ members_in_agreement │ 2 │
│ lei │ '984500BA57A56NBD3A24' │
│ nace │ 'G.46.77' │
└────────────────────────┴────────────────────────┘
✅ [PASS] - Assert Member 2::984500BA57A56NBD3A24.group_status == NOT_ENOUGH_DATA
🎬 NOT_ENOUGH_DATAAnd this example shows the result when the members do not agree on the value for a particular key.
--- LACK OF CONSENSUS Example ---
📝 Member 2 Reporting Data for id 9845001D460PEJE54159...
✅ [PASS] [200 : OK] - Member 2
┌────────────────────────┬────────────────────────┐
│ (index) │ Values │
├────────────────────────┼────────────────────────┤
│ group_status │ 'LACK_OF_CONSENSUS' │
│ majority_minority │ 'Majority' │
│ count_of_unique_values │ 2 │
│ members_in_agreement │ 2 │
│ lei │ '9845001D460PEJE54159' │
│ nace │ 'K.65.12' │
└────────────────────────┴────────────────────────┘
✅ [PASS] - Assert Member 2::9845001D460PEJE54159.group_status == LACK_OF_CONSENSUS
🎬 LACK_OF_CONSENSUS DATATo show how data ingestion can affect all members' reports, we can ingest more data and then re-run the report. We demonstrate this here with member0 ingesting some new data and member2 asking for a report for the same key as in the previous step. You can see that group_status has changed from LACK_OF_CONSENSUS to IN_CONSENSUS.
===============================================
🔬 [TEST]: Report Changes
===============================================
📝 Member 0 Ingesting new Data...
✅ [PASS] [200 : OK] - Member 0 data has ingested successfully
📝 Member 2 Data Status changes for id: 9845001D460PEJE54159...
📝 Member 2 Reporting Data for id 9845001D460PEJE54159...
✅ [PASS] [200 : OK] - Member 2
┌────────────────────────┬────────────────────────┐
│ (index) │ Values │
├────────────────────────┼────────────────────────┤
│ group_status │ 'IN_CONSENSUS' │
│ majority_minority │ 'Majority' │
│ count_of_unique_values │ 1 │
│ members_in_agreement │ 3 │
│ lei │ '9845001D460PEJE54159' │
│ nace │ 'K.65.12' │
└────────────────────────┴────────────────────────┘
✅ [PASS] - Assert Member 2::9845001D460PEJE54159.group_status == IN_CONSENSUS
🎬 Updated Report after New Data SubmissionThe last part of the demo is running a test suite. This is a simple script that runs a series of tests against the REST API. The tests are designed to show the various states of the data and the reporting service.
The main part of the demo is complete. However, if you would like to see how you could handle a code change with CCF, then you can also follow this optional demo