Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Write doc more detailed #48

Merged
merged 2 commits into from
Nov 28, 2024
Merged

Write doc more detailed #48

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8c1cc96
explain what is LBEV2Worker
m1n999999 Nov 28, 2024
4219dec
explain lbev2 class
m1n999999 Nov 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/lbe-v2/lbe-v2.md
View file
Open in desktop
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