@gooddollar/goodprotocol 2.0.23 → 2.0.24

package/contracts/utils/BuyGDClone.sol

@@ -138,6 +138,8 @@ contract BuyGDClone is Initializable {
 	error REFUND_FAILED(uint256);
 	error NO_BALANCE();
 
+	event Bought(address inToken, uint256 inAmount, uint256 outAmount);
+
 	ISwapRouter public immutable router;
 	address public constant celo = 0x471EcE3750Da237f93B8E339c536989b8978a438;
 	uint32 public immutable twapPeriod;
@@ -176,12 +178,23 @@ contract BuyGDClone is Initializable {
 	 * @dev If the contract has a balance of cUSD, it will swap cUSD for GD tokens.
 	 * @param _minAmount The minimum amount of GD tokens to receive from the swap.
 	 */
-	function swap(uint256 _minAmount, address payable refundGas) public payable {
+	function swap(
+		uint256 _minAmount,
+		address payable refundGas
+	) public payable returns (uint256 bought) {
 		uint256 balance = address(this).balance;
-		if (balance > 0) return swapCelo(_minAmount, refundGas);
 
+		if (balance > 0) {
+			bought = swapCelo(_minAmount, refundGas);
+			emit Bought(celo, balance, bought);
+			return bought;
+		}
 		balance = ERC20(cusd).balanceOf(address(this));
-		if (balance > 0) return swapCusd(_minAmount, refundGas);
+		if (balance > 0) {
+			bought = swapCusd(_minAmount, refundGas);
+			emit Bought(celo, balance, bought);
+			return bought;
+		}
 
 		revert NO_BALANCE();
 	}
@@ -193,7 +206,7 @@ contract BuyGDClone is Initializable {
 	function swapCelo(
 		uint256 _minAmount,
 		address payable refundGas
-	) public payable {
+	) public payable returns (uint256 bought) {
 		uint256 gasCosts;
 		if (refundGas != owner) {
 			(gasCosts, ) = oracle.quoteAllAvailablePoolsWithTimePeriod(
@@ -216,7 +229,7 @@ contract BuyGDClone is Initializable {
 			amountIn: amountIn,
 			amountOutMinimum: _minAmount
 		});
-		router.exactInput(params);
+		bought = router.exactInput(params);
 		if (refundGas != owner) {
 			(bool sent, ) = refundGas.call{ value: gasCosts }("");
 			if (!sent) revert REFUND_FAILED(gasCosts);
@@ -227,7 +240,10 @@ contract BuyGDClone is Initializable {
 	 * @notice Swaps cUSD for GD tokens.
 	 * @param _minAmount The minimum amount of GD tokens to receive from the swap.
 	 */
-	function swapCusd(uint256 _minAmount, address refundGas) public {
+	function swapCusd(
+		uint256 _minAmount,
+		address refundGas
+	) public returns (uint256 bought) {
 		uint256 gasCosts = refundGas != owner ? 1e17 : 0; //fixed 0.1$
 		uint256 amountIn = ERC20(cusd).balanceOf(address(this)) - gasCosts;
 
@@ -241,7 +257,7 @@ contract BuyGDClone is Initializable {
 			amountIn: amountIn,
 			amountOutMinimum: _minAmount
 		});
-		router.exactInput(params);
+		bought = router.exactInput(params);
 		if (refundGas != owner) {
 			ERC20(cusd).transfer(refundGas, gasCosts);
 		}
@@ -300,6 +316,13 @@ contract BuyGDClone is Initializable {
 contract DonateGDClone is BuyGDClone {
 	error EXEC_FAILED(bytes error);
 
+	event Donated(
+		address donor,
+		address recipient,
+		address tokenDonated,
+		uint256 amountDonated
+	);
+
 	address public recoverTo;
 	bytes public callData;
 
@@ -336,8 +359,11 @@ contract DonateGDClone is BuyGDClone {
 			owner = address(this);
 		}
 		//no perform swap
+		address token;
+		uint256 donated;
 		if (withSwap) {
-			swap(_minAmount, refundGas);
+			token = gd;
+			donated = swap(_minAmount, refundGas);
 			owner = tempOwner;
 		}
 
@@ -348,13 +374,26 @@ contract DonateGDClone is BuyGDClone {
 			uint256 gdBalance = ERC20(gd).balanceOf(address(this));
 			uint256 celoBalance = address(this).balance;
 
-			if (cusdBalance > 0) ERC20(cusd).approve(address(owner), cusdBalance);
-			if (gdBalance > 0) ERC20(gd).approve(address(owner), gdBalance);
-			if (celoBalance > 0) ERC20(celo).approve(address(owner), celoBalance);
+			if (cusdBalance > 0) {
+				ERC20(cusd).approve(address(owner), cusdBalance);
+				token = cusd;
+				donated = cusdBalance;
+			}
+			if (gdBalance > 0) {
+				ERC20(gd).approve(address(owner), gdBalance);
+				token = gd;
+				donated = gdBalance;
+			}
+			if (celoBalance > 0) {
+				ERC20(celo).approve(address(owner), celoBalance);
+				token = celo;
+				donated = celoBalance;
+			}
 
 			(bool success, bytes memory data) = owner.call{ value: 0 }(callData);
 			if (!success) revert EXEC_FAILED(data);
 		}
+		emit Donated(recoverTo, owner, token, donated);
 	}
 
 	/**
@@ -381,6 +420,7 @@ contract BuyGDCloneFactory {
 	error NOT_GD_TOKEN();
 	error INVALID_TWAP();
 	error RECIPIENT_ZERO();
+	error ZERO_MINAMOUNT();
 
 	IQuoterV2 public constant quoter =
 		IQuoterV2(0x82825d0554fA07f7FC52Ab63c961F330fdEFa8E8); // celo quoter
@@ -546,7 +586,8 @@ contract BuyGDCloneFactory {
 			ERC20(gd).transferFrom(msg.sender, address(this), amountIn);
 		}
 
-		if (_minAmount == 0) (_minAmount, ) = minAmountByTWAP(amountIn, gd, 60);
+		if (_minAmount == 0)
+			(_minAmount, ) = minAmountByTWAP(amountIn, gd, cusd, 60);
 
 		ERC20(gd).approve(address(router), amountIn);
 		ISwapRouter.ExactInputParams memory params = ISwapRouter.ExactInputParams({
@@ -558,16 +599,43 @@ contract BuyGDCloneFactory {
 		return router.exactInput(params);
 	}
 
+	/**
+	 * @notice Swaps cUSD for GD tokens.
+	 * @param _minAmount The minimum amount of GD tokens to receive from the swap.
+	 */
+	function swapFromCusd(
+		uint256 amountIn,
+		uint256 _minAmount,
+		address recipient
+	) public returns (uint256) {
+		ERC20(cusd).transferFrom(msg.sender, address(this), amountIn);
+
+		if (_minAmount == 0)
+			(_minAmount, ) = minAmountByTWAP(amountIn, cusd, gd, 60);
+
+		ERC20(cusd).approve(address(router), amountIn);
+		ISwapRouter.ExactInputParams memory params = ISwapRouter.ExactInputParams({
+			path: abi.encodePacked(cusd, uint24(10000), gd),
+			recipient: recipient,
+			amountIn: amountIn,
+			amountOutMinimum: _minAmount
+		});
+		return router.exactInput(params);
+	}
+
 	/**
 	 * @notice Calculates the minimum amount of tokens that can be received for a given amount of base tokens,
 	 * based on the time-weighted average price (TWAP) of the token pair over a specified period of time.
 	 * @param baseAmount The amount of base tokens to swap.
 	 * @param baseToken The address of the base token.
+	 * @param qtToken The address of the quote token.
+
 	 * @return minTwap The minimum amount of G$ expected to receive by twap
 	 */
 	function minAmountByTWAP(
 		uint256 baseAmount,
 		address baseToken,
+		address qtToken,
 		uint32 period
 	) public view returns (uint256 minTwap, uint256 quote) {
 		uint24[] memory fees = new uint24[](1);
@@ -576,7 +644,7 @@ contract BuyGDCloneFactory {
 		(quote, ) = oracle.quoteSpecificFeeTiersWithTimePeriod(
 			toConvert,
 			baseToken,
-			cusd,
+			qtToken,
 			fees,
 			period
 		);
@@ -584,7 +652,7 @@ contract BuyGDCloneFactory {
 		(uint256 curPrice, ) = oracle.quoteSpecificFeeTiersWithTimePeriod(
 			toConvert,
 			baseToken,
-			cusd,
+			qtToken,
 			fees,
 			0
 		);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gooddollar/goodprotocol",
-  "version": "2.0.23",
+  "version": "2.0.24",
   "description": "GoodDollar Protocol",
   "engines": {
     "node": ">=16.x"

package/releases/deployment.json

@@ -487,7 +487,7 @@
         "MpbBridge": "0xa3247276DbCC76Dd7705273f766eB3E8a5ecF4a5",
         "StaticOracle": "0x00851A91a3c4E9a4c1B48df827Bacc1f884bdE28",
         "BuyGDFactory": "0x00e533B7d6255D05b7f15034B1c989c21F51b91C",
-        "BuyGDFactoryV2": "0xBB2Ef9b160741AAC9e7e654E2fAAf8CE0EDe95fe"
+        "BuyGDFactoryV2": "0x1F60C4C7037C6766924A43666B781ED1479587a2"
     },
     "gnosis": {
         "GuardiansSafe": "0x84c10b45fe51bfb4f86c19a47fdbc187d4572fb8"
@@ -517,7 +517,7 @@
         "OneTimePaymentsV2": "0x2cb1c7d50371e277d7a36B171c0ACe9B157518EE",
         "UniswapV3Router": "0x5615CDAb10dc425a742d643d949a7F474C01abc4",
         "BuyGDFactory": "0x00e533B7d6255D05b7f15034B1c989c21F51b91C",
-        "BuyGDFactoryV2": "0xBB2Ef9b160741AAC9e7e654E2fAAf8CE0EDe95fe"
+        "BuyGDFactoryV2": "0x1F60C4C7037C6766924A43666B781ED1479587a2"
     },
     "staging-celo": {
         "network": "staging-celo",
@@ -544,7 +544,7 @@
         "OneTimePaymentsV2": "0x963E7B4c970626Bb103c61fA16b002AFf6E6c2C7",
         "UniswapV3Router": "0x5615CDAb10dc425a742d643d949a7F474C01abc4",
         "BuyGDFactory": "0x00e533B7d6255D05b7f15034B1c989c21F51b91C",
-        "BuyGDFactoryV2": "0xBB2Ef9b160741AAC9e7e654E2fAAf8CE0EDe95fe"
+        "BuyGDFactoryV2": "0x1F60C4C7037C6766924A43666B781ED1479587a2"
     },
     "development-goerli": {
         "ProxyFactory": "0x65D8eACBCd9618b8780C4b444081915a5D54D611",

package/types/contracts/utils/BuyGDClone.sol/BuyGDClone.ts

@@ -108,12 +108,26 @@ export interface BuyGDCloneInterface extends utils.Interface {
   decodeFunctionResult(functionFragment: "twapPeriod", data: BytesLike): Result;
 
   events: {
+    "Bought(address,uint256,uint256)": EventFragment;
     "Initialized(uint8)": EventFragment;
   };
 
+  getEvent(nameOrSignatureOrTopic: "Bought"): EventFragment;
   getEvent(nameOrSignatureOrTopic: "Initialized"): EventFragment;
 }
 
+export interface BoughtEventObject {
+  inToken: string;
+  inAmount: BigNumber;
+  outAmount: BigNumber;
+}
+export type BoughtEvent = TypedEvent<
+  [string, BigNumber, BigNumber],
+  BoughtEventObject
+>;
+
+export type BoughtEventFilter = TypedEventFilter<BoughtEvent>;
+
 export interface InitializedEventObject {
   version: number;
 }
@@ -279,24 +293,35 @@ export interface BuyGDClone extends BaseContract {
       _minAmount: BigNumberish,
       refundGas: string,
       overrides?: CallOverrides
-    ): Promise<void>;
+    ): Promise<BigNumber>;
 
     swapCelo(
       _minAmount: BigNumberish,
       refundGas: string,
       overrides?: CallOverrides
-    ): Promise<void>;
+    ): Promise<BigNumber>;
 
     swapCusd(
       _minAmount: BigNumberish,
       refundGas: string,
       overrides?: CallOverrides
-    ): Promise<void>;
+    ): Promise<BigNumber>;
 
     twapPeriod(overrides?: CallOverrides): Promise<number>;
   };
 
   filters: {
+    "Bought(address,uint256,uint256)"(
+      inToken?: null,
+      inAmount?: null,
+      outAmount?: null
+    ): BoughtEventFilter;
+    Bought(
+      inToken?: null,
+      inAmount?: null,
+      outAmount?: null
+    ): BoughtEventFilter;
+
     "Initialized(uint8)"(version?: null): InitializedEventFilter;
     Initialized(version?: null): InitializedEventFilter;
   };

package/types/contracts/utils/BuyGDClone.sol/BuyGDCloneFactory.ts

@@ -37,7 +37,7 @@ export interface BuyGDCloneFactoryInterface extends utils.Interface {
     "gd()": FunctionFragment;
     "getBaseFee()": FunctionFragment;
     "impl()": FunctionFragment;
-    "minAmountByTWAP(uint256,address,uint32)": FunctionFragment;
+    "minAmountByTWAP(uint256,address,address,uint32)": FunctionFragment;
     "onTokenTransfer(address,uint256,bytes)": FunctionFragment;
     "oracle()": FunctionFragment;
     "predict(address)": FunctionFragment;
@@ -46,6 +46,7 @@ export interface BuyGDCloneFactoryInterface extends utils.Interface {
     "quoteToken(uint256,uint24,address)": FunctionFragment;
     "quoter()": FunctionFragment;
     "router()": FunctionFragment;
+    "swapFromCusd(uint256,uint256,address)": FunctionFragment;
     "swapToCusd(uint256,uint256,address)": FunctionFragment;
   };
 
@@ -69,6 +70,7 @@ export interface BuyGDCloneFactoryInterface extends utils.Interface {
       | "quoteToken"
       | "quoter"
       | "router"
+      | "swapFromCusd"
       | "swapToCusd"
   ): FunctionFragment;
 
@@ -98,7 +100,7 @@ export interface BuyGDCloneFactoryInterface extends utils.Interface {
   encodeFunctionData(functionFragment: "impl", values?: undefined): string;
   encodeFunctionData(
     functionFragment: "minAmountByTWAP",
-    values: [BigNumberish, string, BigNumberish]
+    values: [BigNumberish, string, string, BigNumberish]
   ): string;
   encodeFunctionData(
     functionFragment: "onTokenTransfer",
@@ -120,6 +122,10 @@ export interface BuyGDCloneFactoryInterface extends utils.Interface {
   ): string;
   encodeFunctionData(functionFragment: "quoter", values?: undefined): string;
   encodeFunctionData(functionFragment: "router", values?: undefined): string;
+  encodeFunctionData(
+    functionFragment: "swapFromCusd",
+    values: [BigNumberish, BigNumberish, string]
+  ): string;
   encodeFunctionData(
     functionFragment: "swapToCusd",
     values: [BigNumberish, BigNumberish, string]
@@ -161,6 +167,10 @@ export interface BuyGDCloneFactoryInterface extends utils.Interface {
   decodeFunctionResult(functionFragment: "quoteToken", data: BytesLike): Result;
   decodeFunctionResult(functionFragment: "quoter", data: BytesLike): Result;
   decodeFunctionResult(functionFragment: "router", data: BytesLike): Result;
+  decodeFunctionResult(
+    functionFragment: "swapFromCusd",
+    data: BytesLike
+  ): Result;
   decodeFunctionResult(functionFragment: "swapToCusd", data: BytesLike): Result;
 
   events: {
@@ -251,6 +261,7 @@ export interface BuyGDCloneFactory extends BaseContract {
     minAmountByTWAP(
       baseAmount: BigNumberish,
       baseToken: string,
+      qtToken: string,
       period: BigNumberish,
       overrides?: CallOverrides
     ): Promise<
@@ -291,6 +302,13 @@ export interface BuyGDCloneFactory extends BaseContract {
 
     router(overrides?: CallOverrides): Promise<[string]>;
 
+    swapFromCusd(
+      amountIn: BigNumberish,
+      _minAmount: BigNumberish,
+      recipient: string,
+      overrides?: Overrides & { from?: string }
+    ): Promise<ContractTransaction>;
+
     swapToCusd(
       amountIn: BigNumberish,
       _minAmount: BigNumberish,
@@ -339,6 +357,7 @@ export interface BuyGDCloneFactory extends BaseContract {
   minAmountByTWAP(
     baseAmount: BigNumberish,
     baseToken: string,
+    qtToken: string,
     period: BigNumberish,
     overrides?: CallOverrides
   ): Promise<[BigNumber, BigNumber] & { minTwap: BigNumber; quote: BigNumber }>;
@@ -377,6 +396,13 @@ export interface BuyGDCloneFactory extends BaseContract {
 
   router(overrides?: CallOverrides): Promise<string>;
 
+  swapFromCusd(
+    amountIn: BigNumberish,
+    _minAmount: BigNumberish,
+    recipient: string,
+    overrides?: Overrides & { from?: string }
+  ): Promise<ContractTransaction>;
+
   swapToCusd(
     amountIn: BigNumberish,
     _minAmount: BigNumberish,
@@ -422,6 +448,7 @@ export interface BuyGDCloneFactory extends BaseContract {
     minAmountByTWAP(
       baseAmount: BigNumberish,
       baseToken: string,
+      qtToken: string,
       period: BigNumberish,
       overrides?: CallOverrides
     ): Promise<
@@ -462,6 +489,13 @@ export interface BuyGDCloneFactory extends BaseContract {
 
     router(overrides?: CallOverrides): Promise<string>;
 
+    swapFromCusd(
+      amountIn: BigNumberish,
+      _minAmount: BigNumberish,
+      recipient: string,
+      overrides?: CallOverrides
+    ): Promise<BigNumber>;
+
     swapToCusd(
       amountIn: BigNumberish,
       _minAmount: BigNumberish,
@@ -528,6 +562,7 @@ export interface BuyGDCloneFactory extends BaseContract {
     minAmountByTWAP(
       baseAmount: BigNumberish,
       baseToken: string,
+      qtToken: string,
       period: BigNumberish,
       overrides?: CallOverrides
     ): Promise<BigNumber>;
@@ -566,6 +601,13 @@ export interface BuyGDCloneFactory extends BaseContract {
 
     router(overrides?: CallOverrides): Promise<BigNumber>;
 
+    swapFromCusd(
+      amountIn: BigNumberish,
+      _minAmount: BigNumberish,
+      recipient: string,
+      overrides?: Overrides & { from?: string }
+    ): Promise<BigNumber>;
+
     swapToCusd(
       amountIn: BigNumberish,
       _minAmount: BigNumberish,
@@ -615,6 +657,7 @@ export interface BuyGDCloneFactory extends BaseContract {
     minAmountByTWAP(
       baseAmount: BigNumberish,
       baseToken: string,
+      qtToken: string,
       period: BigNumberish,
       overrides?: CallOverrides
     ): Promise<PopulatedTransaction>;
@@ -656,6 +699,13 @@ export interface BuyGDCloneFactory extends BaseContract {
 
     router(overrides?: CallOverrides): Promise<PopulatedTransaction>;
 
+    swapFromCusd(
+      amountIn: BigNumberish,
+      _minAmount: BigNumberish,
+      recipient: string,
+      overrides?: Overrides & { from?: string }
+    ): Promise<PopulatedTransaction>;
+
     swapToCusd(
       amountIn: BigNumberish,
       _minAmount: BigNumberish,

package/types/contracts/utils/BuyGDClone.sol/DonateGDClone.ts

@@ -139,12 +139,41 @@ export interface DonateGDCloneInterface extends utils.Interface {
   decodeFunctionResult(functionFragment: "twapPeriod", data: BytesLike): Result;
 
   events: {
+    "Bought(address,uint256,uint256)": EventFragment;
+    "Donated(address,address,address,uint256)": EventFragment;
     "Initialized(uint8)": EventFragment;
   };
 
+  getEvent(nameOrSignatureOrTopic: "Bought"): EventFragment;
+  getEvent(nameOrSignatureOrTopic: "Donated"): EventFragment;
   getEvent(nameOrSignatureOrTopic: "Initialized"): EventFragment;
 }
 
+export interface BoughtEventObject {
+  inToken: string;
+  inAmount: BigNumber;
+  outAmount: BigNumber;
+}
+export type BoughtEvent = TypedEvent<
+  [string, BigNumber, BigNumber],
+  BoughtEventObject
+>;
+
+export type BoughtEventFilter = TypedEventFilter<BoughtEvent>;
+
+export interface DonatedEventObject {
+  donor: string;
+  recipient: string;
+  tokenDonated: string;
+  amountDonated: BigNumber;
+}
+export type DonatedEvent = TypedEvent<
+  [string, string, string, BigNumber],
+  DonatedEventObject
+>;
+
+export type DonatedEventFilter = TypedEventFilter<DonatedEvent>;
+
 export interface InitializedEventObject {
   version: number;
 }
@@ -367,24 +396,48 @@ export interface DonateGDClone extends BaseContract {
       _minAmount: BigNumberish,
       refundGas: string,
       overrides?: CallOverrides
-    ): Promise<void>;
+    ): Promise<BigNumber>;
 
     swapCelo(
       _minAmount: BigNumberish,
       refundGas: string,
       overrides?: CallOverrides
-    ): Promise<void>;
+    ): Promise<BigNumber>;
 
     swapCusd(
       _minAmount: BigNumberish,
       refundGas: string,
       overrides?: CallOverrides
-    ): Promise<void>;
+    ): Promise<BigNumber>;
 
     twapPeriod(overrides?: CallOverrides): Promise<number>;
   };
 
   filters: {
+    "Bought(address,uint256,uint256)"(
+      inToken?: null,
+      inAmount?: null,
+      outAmount?: null
+    ): BoughtEventFilter;
+    Bought(
+      inToken?: null,
+      inAmount?: null,
+      outAmount?: null
+    ): BoughtEventFilter;
+
+    "Donated(address,address,address,uint256)"(
+      donor?: null,
+      recipient?: null,
+      tokenDonated?: null,
+      amountDonated?: null
+    ): DonatedEventFilter;
+    Donated(
+      donor?: null,
+      recipient?: null,
+      tokenDonated?: null,
+      amountDonated?: null
+    ): DonatedEventFilter;
+
     "Initialized(uint8)"(version?: null): InitializedEventFilter;
     Initialized(version?: null): InitializedEventFilter;
   };