From 18b7acc078a5fa635ac79810dd2b4b105620d4cd Mon Sep 17 00:00:00 2001
From: Dmitry S <11892559+swift1337@users.noreply.github.com>
Date: Thu, 21 Nov 2024 21:57:09 +0100
Subject: [PATCH] Add readme

---
 zetaclient/tss/readme.md | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)
 create mode 100644 zetaclient/tss/readme.md

diff --git a/zetaclient/tss/readme.md b/zetaclient/tss/readme.md
new file mode 100644
index 0000000000..c98b384037
--- /dev/null
+++ b/zetaclient/tss/readme.md
@@ -0,0 +1,35 @@
+# Zetaclient TSS Overview
+
+(Threshold Signature Scheme)
+
+This package wraps the go-tss library, providing a high-level API for signing arbitrary digests using TSS.
+The underlying go-tss library relies on tss-lib.
+
+## What is a Digest?
+
+A digest is simply a byte slice (`[]byte`), typically representing a transaction hash or other cryptographic input.
+The API allows secure signing of these digests in a distributed manner.
+
+## Architecture Overview
+
+This is the approximate structure of the TSS implementation within Zetaclient:
+
+```text
+zetaclientd(
+    tss.Service(
+        gotss.Server(libp2p()) 
+    )
+)
+```
+
+## Package Structure
+
+- `setup.go`: Initializes the go-tss TSS server and the **Service** wrapper of this package.
+- `keygen.go`: Manages the key generation ceremony, creating keys used by TSS.
+- `service.go`: Implements the **Service** struct, offering methods for signing and verifying digests.
+- Other Files: Utilities and supporting tools for TSS operations.
+
+## Links
+
+- `go-tss`: https://github.com/zeta-chain/go-tss
+- `tss-lib`: https://github.com/zeta-chain/tss-lib