Skip to content

Commit 83442bd

Browse files
Merge pull request #80 from bnb-party/issue-73
update inheritance, add uml
2 parents b34cdb9 + 14b38a1 commit 83442bd

File tree

3 files changed

+8
-4
lines changed

3 files changed

+8
-4
lines changed

README.md

+5
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
- [Join Party](#join-liquidity-party)
1414
- [Leave Party](#leave-party)
1515
- [Swap Router](#swap-router)
16+
- [UML diagram](#uml-diagram)
1617
- [License](#license)
1718

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

209210
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
210211

212+
## UML Diagram
213+
214+
![classDiagram](https://github.com/user-attachments/assets/8c102041-7e2a-4804-a7d1-fef2acfefdef)
215+
211216
## License
212217

213218
**BNB-Party** Contracts is released under the [MIT License](https://github.com/bnb-party/BNBParty.Factory/blob/readme/LICENSE).

contracts/BNBPartyFactory.sol

+1-2
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,13 @@ pragma solidity ^0.8.0;
33

44
import "./token/ERC20Token.sol";
55
import "./BNBPartyLiquidity.sol";
6-
import "./BNBPartyManageable.sol";
76
import "@openzeppelin/contracts/utils/ReentrancyGuard.sol";
87
import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
98
import "@bnb-party/v3-periphery/contracts/interfaces/IPeripheryPayments.sol";
109

1110
/// @title BNBPartyFactory
1211
/// @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.
13-
contract BNBPartyFactory is BNBPartyLiquidity, ReentrancyGuard, BNBPartyManageable {
12+
contract BNBPartyFactory is BNBPartyLiquidity, ReentrancyGuard {
1413
using SafeERC20 for IERC20;
1514

1615
/// @notice Allows the contract to receive BNB

contracts/BNBPartyView.sol

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
// SPDX-License-Identifier: MIT
22
pragma solidity ^0.8.0;
33

4-
import "./BNBPartyFee.sol";
4+
import "./BNBPartyManageable.sol";
55

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

0 commit comments

Comments
 (0)