Skip to content

Commit

Permalink
Write doc more detailed (#48)
Browse files Browse the repository at this point in the history
* explain what is LBEV2Worker

* explain lbev2 class
  • Loading branch information
m1n999999 authored Nov 28, 2024
1 parent 3955648 commit b4d72d4
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/lbe-v2/lbe-v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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";
Expand Down

0 comments on commit b4d72d4

Please sign in to comment.