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

update inheritance, add uml #80

Merged
merged 1 commit into from
Sep 20, 2024
Merged

update inheritance, add uml #80

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
- [Join Party](#join-liquidity-party)
- [Leave Party](#leave-party)
- [Swap Router](#swap-router)
- [UML diagram](#uml-diagram)
- [License](#license)

## Installation
Expand Down Expand Up @@ -208,6 +209,10 @@ await BNBSwapRouter.multicall([exactInputData, unwrapWETH9Data])

This section demonstrates how to efficiently perform token swaps using the **Swap Router**, providing an alternative to the `joinParty` and `leaveParty` functions while saving on gas costs

## UML Diagram

![classDiagram](https://github.com/user-attachments/assets/8c102041-7e2a-4804-a7d1-fef2acfefdef)

## License

**BNB-Party** Contracts is released under the [MIT License](https://github.com/bnb-party/BNBParty.Factory/blob/readme/LICENSE).
3 changes: 1 addition & 2 deletions contracts/BNBPartyFactory.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,13 @@ pragma solidity ^0.8.0;

import "./token/ERC20Token.sol";
import "./BNBPartyLiquidity.sol";
import "./BNBPartyManageable.sol";
import "@openzeppelin/contracts/utils/ReentrancyGuard.sol";
import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import "@bnb-party/v3-periphery/contracts/interfaces/IPeripheryPayments.sol";

/// @title BNBPartyFactory
/// @notice This contract is used for creating and managing liquidity pools and custom ERC20 tokens on the Binance Smart Chain (BSC) using Uniswap V3 system.
contract BNBPartyFactory is BNBPartyLiquidity, ReentrancyGuard, BNBPartyManageable {
contract BNBPartyFactory is BNBPartyLiquidity, ReentrancyGuard {
using SafeERC20 for IERC20;

/// @notice Allows the contract to receive BNB
Expand Down
4 changes: 2 additions & 2 deletions contracts/BNBPartyView.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;

import "./BNBPartyFee.sol";
import "./BNBPartyManageable.sol";

/// @title BNBPartyView
/// @notice This abstract contract provides view functions for the BNB Party system, including fee calculations and token checks.
abstract contract BNBPartyView is BNBPartyFee {
abstract contract BNBPartyView is BNBPartyManageable {
/// @notice Checks if WBNB is the token0 in the provided Uniswap V3 pool
/// @param liquidityPool Address of the Uniswap V3 pool to check
/// @return True if WBNB is token0, false otherwise
Expand Down