erc20-pool

commit 6199080c097b80180b638cfbe3c7be260b3ad691
parent d244cc05eca4d2d13d63e9e88c1a0ec543eb0726
Author: Mohammed Sohail <sohailsameja@gmail.com>
Date:   Mon,  8 Apr 2024 12:54:09 +0800

fix: typo in events, add docs

Diffstat:
M
solidity/SwapPool.sol
 | 
10
+++++-----

1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/solidity/SwapPool.sol b/solidity/SwapPool.sol
@@ -36,7 +36,7 @@ contract SwapPool {
 	// EIP173
 	event OwnershipTransferred(address indexed previousOwner, address indexed newOwner); // EIP173
 
-	// Swap
+	// Emitted after a successful swap
   	event Swap(
   		address indexed initiator,
   	  	address indexed tokenIn,
@@ -46,16 +46,16 @@ contract SwapPool {
 	  	uint256 fee
   	);
 
-	// Deposit
+	// Emitted only after a liquidity donation
 	event Deposit(
-		address indexed initator,
+		address indexed initiator,
 		address indexed tokenIn,
 		uint256 amountIn
 	);
 
-	// Collect
+	// Emitted when collecting fees to the set feeAddress
 	event Collect(
-		address indexed feeAdress,
+		address indexed feeAddress,
 		address tokenOut,
 		uint256 amountOut
 	);