Add readme to protocol module (#23)

* Add readme to protocol module * Update packages/protocol-contracts/README.md * Update packages/protocol-contracts/README.md * Update packages/protocol-contracts/README.md * Update packages/protocol-contracts/README.md Co-authored-by: Lucas <[email protected]>
zeta-chain · Jun 28, 2022 · 8822455 · 8822455
1 parent 9e4ae67
commit 8822455
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/packages/protocol-contracts/README.md b/packages/protocol-contracts/README.md
@@ -0,0 +1,10 @@
+# ZetaChain Protocol Contracts
+
+This package includes:
+* Contracts that interact directly with the protocol (Connector, Zeta token).
+* Utilities and interfaces to make it easy to develop multichain dApps on ZetaChain (ZetaInteractor, ZetaInterfaces, ZetaTokenConsumer).
+
+## Addresses
+
+* TSS address: collectively held by Zeta blockchain validators.
+* TSS Updater address: a Gnosis multi-sig that's under an OpenZeppelin TimeLock for security and transparency. Eventually, the ownership of this role will be delegated to the TSS address.