From b4d72d4f5b3d6edcd299995827d7b57e7ae1e52c Mon Sep 17 00:00:00 2001
From: Mingggggg <80378612+m1n999999@users.noreply.github.com>
Date: Thu, 28 Nov 2024 16:52:18 +0700
Subject: [PATCH] Write doc more detailed (#48)
* explain what is LBEV2Worker
* explain lbev2 class
---
docs/lbe-v2/lbe-v2.md | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/docs/lbe-v2/lbe-v2.md b/docs/lbe-v2/lbe-v2.md
index 3f59cdf..17055fc 100644
--- a/docs/lbe-v2/lbe-v2.md
+++ b/docs/lbe-v2/lbe-v2.md
@@ -10,9 +10,9 @@ This documentation provides guidelines for communicating with and interacting wi
### Transaction Builder Function
-- **LBEV2 Class**: Located in `src/lbe-v2/lbe-v2.ts`.
+- **LBEV2 Class**: class that creates transactions to interact with the LBE V2 protocol. It is located in src/lbe-v2/lbe-v2.ts.
- **User and project owner action Example**: Located in `example/example.ts`.
-- **LBEV2Worker Class**: is a class that executes off-chain actions when an event ends. Located in `src/lbe-v2-worker/worker.ts`.
+- **LBEV2Worker Class**: A class that executes off-chain actions when an event ends. It handles collecting funds to create a liquidity pool and distributing LP Assets to participants in the LBE. This class is located in `src/lbe-v2-worker/worker.ts`.
- **LBEV2Worker Example**: Located in `examples/lbe-v2-worker-example.ts`.
## Example Usage
@@ -259,7 +259,7 @@ const txId = await signedTx.submit();
console.info(`Transaction submitted successfully: ${txId}`);
```
-### Run Worker
+### Run LBE V2 Worker
```ts
const network: Network = "Preprod";