From 8c1cc9640ebc7c441df48550d3458d957682e2e0 Mon Sep 17 00:00:00 2001 From: Ha Quang Minh Date: Thu, 28 Nov 2024 14:25:21 +0700 Subject: [PATCH 1/2] explain what is LBEV2Worker --- docs/lbe-v2/lbe-v2.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/lbe-v2/lbe-v2.md b/docs/lbe-v2/lbe-v2.md index 3f59cdf..7a651f4 100644 --- a/docs/lbe-v2/lbe-v2.md +++ b/docs/lbe-v2/lbe-v2.md @@ -12,7 +12,7 @@ This documentation provides guidelines for communicating with and interacting wi - **LBEV2 Class**: 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 From 4219decb3f1f31be40c59b3a5bc2fb49a45cba83 Mon Sep 17 00:00:00 2001 From: Ha Quang Minh Date: Thu, 28 Nov 2024 14:34:17 +0700 Subject: [PATCH 2/2] explain lbev2 class --- docs/lbe-v2/lbe-v2.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/lbe-v2/lbe-v2.md b/docs/lbe-v2/lbe-v2.md index 7a651f4..17055fc 100644 --- a/docs/lbe-v2/lbe-v2.md +++ b/docs/lbe-v2/lbe-v2.md @@ -10,7 +10,7 @@ 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**: 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`. @@ -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";