Update README

ing-bank · Feb 16, 2023 · 0ef4dd0 · 0ef4dd0
1 parent a13cbdc
commit 0ef4dd0
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -13,6 +13,8 @@ For details about the ZKFlow protocol, please read the [ZKFlow white paper](docs
 
 As ZKP toolchain, ZKFlow uses a [fork](https://github.com/mvdbos/zinc) of Zinc by Matter Labs. The proving system is Groth16. 
 
+Note that ZKFlow is not a fork of Corda and that it does not make any changes to Corda classes. It is an alternative consensus mechanism for Corda, delivered as a Gradle plugin for your CorDapps.
+
 > [!] **DISCLAIMER: Please note that ZKFlow should *NOT* be used in production, nor to transfer ownership of real assets.**
 >
 >Even though the protocol has been peer reviewed, the security of the implementation has not yet been reviewed by a third party. Additionally, There are features related to deployment and ZKP artifact distribution that are not present in this repository but that are important to guarantee secure and correct usage.

diff --git a/TODO.md b/TODO.md
@@ -31,6 +31,6 @@
           .writeText(it.type.toStructureTree().toString())
   }
   ```
-- Fix `ZKNotary.isZKValidating()` to correctly determine if a notary is actually zkvalidating.
+- Fix `ZKNotary.isZKValidating()` to correctly determine if a notary is actually zkvalidating. This is currently hard to implement without touching Corda itself.
 - State version negotiation between counterparties.
 - Currently, `generateZincStructure` is not called automatically as part of CorDapp publication logic. So no checking is done on breaking changes to states. Enable this as part of publication, and enable `verifyZincStructure` as part of compilation. This will ensure no breaking changes can compile. Also have to decide on usable way to determine when versions are 'published' (e.g. actually used in deployment?) and can't be changed anymore.