@gooddollar/goodprotocol 2.0.17 → 2.0.19

package/contracts/utils/BuyGDClone.sol

@@ -125,10 +125,7 @@ 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
-	) external payable {
+	function swap(uint256 _minAmount, address payable refundGas) public payable {
 		uint256 balance = address(this).balance;
 		if (balance > 0) return swapCelo(_minAmount, refundGas);
 
@@ -235,7 +232,7 @@ contract BuyGDClone is Initializable {
 	 * @notice Recovers tokens accidentally sent to the contract.
 	 * @param token The address of the token to recover. Use address(0) to recover ETH.
 	 */
-	function recover(address token) external {
+	function recover(address token) external virtual {
 		if (token == address(0)) {
 			(bool sent, ) = payable(owner).call{ value: address(this).balance }("");
 			if (!sent) revert REFUND_FAILED(address(this).balance);
@@ -245,12 +242,89 @@ contract BuyGDClone is Initializable {
 	}
 }
 
+contract DonateGDClone is BuyGDClone {
+	error EXEC_FAILED(bytes error);
+
+	address public recoverTo;
+	bytes public callData;
+
+	constructor(
+		ISwapRouter _router,
+		address _cusd,
+		address _gd,
+		IStaticOracle _oracle
+	) BuyGDClone(_router, _cusd, _gd, _oracle) {}
+
+	/**
+	 * @notice Initializes the contract with the owner's address.
+	 * @param _recoverTo The address of the owner of the contract that can recover stuck funds
+	 * @param _donateTo The address of the funds target
+	 */
+	function initialize(
+		address _recoverTo,
+		address _donateTo,
+		bytes memory _callData
+	) external initializer {
+		owner = _donateTo;
+		recoverTo = _recoverTo;
+		callData = _callData;
+	}
+
+	function exec(
+		uint256 _minAmount,
+		address payable refundGas,
+		bool withSwap
+	) public payable {
+		// in case we need to swap and call a contract, we redirect funds here
+		address tempOwner = owner;
+		if (withSwap && callData.length > 0) {
+			owner = address(this);
+		}
+		//no perform swap
+		if (withSwap) {
+			swap(_minAmount, refundGas);
+			owner = tempOwner;
+		}
+
+		//now exec
+		if (callData.length > 0) {
+			// approve spend of the different possible tokens, before calling the target contract
+			uint256 cusdBalance = ERC20(cusd).balanceOf(address(this));
+			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);
+
+			(bool success, bytes memory data) = owner.call{ value: 0 }(callData);
+			if (!success) revert EXEC_FAILED(data);
+		}
+	}
+
+	/**
+	 * @notice Recovers tokens accidentally sent to the contract.
+	 * @param token The address of the token to recover. Use address(0) to recover ETH.
+	 */
+	function recover(address token) external virtual override {
+		if (token == address(0)) {
+			(bool sent, ) = payable(recoverTo).call{ value: address(this).balance }(
+				""
+			);
+			if (!sent) revert REFUND_FAILED(address(this).balance);
+		} else {
+			ERC20(token).transfer(recoverTo, ERC20(token).balanceOf(address(this)));
+		}
+	}
+}
+
 /**
  * @title BuyGDCloneFactory
  * @notice Factory contract for creating clones of BuyGDClone contract
  */
 contract BuyGDCloneFactory {
 	address public immutable impl;
+	address public immutable donateImpl;
 
 	/**
 	 * @notice Initializes the BuyGDCloneFactory contract with the provided parameters.
@@ -266,6 +340,8 @@ contract BuyGDCloneFactory {
 		IStaticOracle _oracle
 	) {
 		impl = address(new BuyGDClone(_router, _cusd, _gd, _oracle));
+		donateImpl = address(new DonateGDClone(_router, _cusd, _gd, _oracle));
+
 		_oracle.prepareAllAvailablePoolsWithTimePeriod(_gd, _cusd, 600);
 	}
 
@@ -274,24 +350,57 @@ contract BuyGDCloneFactory {
 	 * @param owner The address of the owner of the new BuyGDClone contract.
 	 * @return The address of the new BuyGDClone contract.
 	 */
-	function create(address owner) external returns (address) {
+	function create(address owner) public returns (address) {
 		bytes32 salt = keccak256(abi.encode(owner));
 		address clone = ClonesUpgradeable.cloneDeterministic(impl, salt);
 		BuyGDClone(payable(clone)).initialize(owner);
 		return clone;
 	}
 
+	/**
+	 * @notice Creates a new clone of the BuyGDClone contract with the provided owner address.
+	 * @param owner The address of the owner of the new DoanteGDClone contract that can recover funds.
+	 * @param donateOrExecTo The address of the target for funds
+	 * @param callData a payload to execute on the target donateOrExecTo instead of simple transfers (using approve instead)
+	 *
+	 * @return The address of the new BuyGDClone contract.
+	 */
+	function createDonation(
+		address owner,
+		address donateOrExecTo,
+		bytes memory callData
+	) public returns (address) {
+		bytes32 salt = keccak256(abi.encode(owner, donateOrExecTo, callData));
+		address clone = ClonesUpgradeable.cloneDeterministic(donateImpl, salt);
+		DonateGDClone(payable(clone)).initialize(owner, donateOrExecTo, callData);
+		return clone;
+	}
+
 	function createAndSwap(
 		address owner,
 		uint256 minAmount
 	) external returns (address) {
-		bytes32 salt = keccak256(abi.encode(owner));
-		address clone = ClonesUpgradeable.cloneDeterministic(impl, salt);
-		BuyGDClone(payable(clone)).initialize(owner);
+		address clone = create(owner);
 		BuyGDClone(payable(clone)).swap(minAmount, payable(msg.sender));
 		return clone;
 	}
 
+	function createDonationAndSwap(
+		address owner,
+		address donateOrExecTo,
+		bool withSwap,
+		uint256 minAmount,
+		bytes memory callData
+	) external returns (address) {
+		address clone = createDonation(owner, donateOrExecTo, callData);
+		DonateGDClone(payable(clone)).exec(
+			minAmount,
+			payable(msg.sender),
+			withSwap
+		);
+		return clone;
+	}
+
 	/**
 	 * @notice Predicts the address of a new clone of the BuyGDClone contract with the provided owner address.
 	 * @param owner The address of the owner of the new BuyGDClone contract.
@@ -304,6 +413,26 @@ contract BuyGDCloneFactory {
 			ClonesUpgradeable.predictDeterministicAddress(impl, salt, address(this));
 	}
 
+	/**
+	 * @notice Predicts the address of a new clone of the BuyGDClone contract with the provided owner address.
+	 * @param owner The address of the owner of the new BuyGDClone contract.
+	 * @return The predicted address of the new BuyGDClone contract.
+	 */
+	function predictDonation(
+		address owner,
+		address donateOrExecTo,
+		bytes memory callData
+	) external view returns (address) {
+		bytes32 salt = keccak256(abi.encode(owner, donateOrExecTo, callData));
+
+		return
+			ClonesUpgradeable.predictDeterministicAddress(
+				donateImpl,
+				salt,
+				address(this)
+			);
+	}
+
 	function getBaseFee() external view returns (uint256) {
 		return block.basefee;
 	}

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@gooddollar/goodprotocol",
-  "version": "2.0.17",
+  "version": "2.0.19",
   "description": "GoodDollar Protocol",
   "engines": {
-    "node": "18.x"
+    "node": ">=16.x"
   },
   "main": "dist/test-sdk/index.js",
   "scripts": {
@@ -93,7 +93,7 @@
     "@nomiclabs/hardhat-ethers": "^2.2.1",
     "@nomiclabs/hardhat-etherscan": "^3.1.0",
     "@nomiclabs/hardhat-waffle": "^2.0.3",
-    "@swc/core": "^1.2.196",
+    "@swc/core": "1.3.96",
     "@swc/helpers": "^0.3.16",
     "@typechain/ethers-v5": "^11.1.1",
     "@types/mocha": "*",
@@ -133,5 +133,11 @@
     "typechain": "^8.3.1",
     "typescript": "^5.2.2"
   },
-  "packageManager": "yarn@3.6.0"
+  "packageManager": "yarn@3.6.0",
+  "resolutions": {
+    "@swc/core": "1.3.96"
+  },
+  "overrides": {
+    "@swc/core": "1.3.96"
+  }
 }

package/releases/deployment.json

@@ -486,7 +486,8 @@
         "CommunitySafe": "0x437C699887779D0A95aD6349CFDE7DFA716C005D",
         "MpbBridge": "0xa3247276DbCC76Dd7705273f766eB3E8a5ecF4a5",
         "StaticOracle": "0x00851A91a3c4E9a4c1B48df827Bacc1f884bdE28",
-        "BuyGDFactory": "0x00e533B7d6255D05b7f15034B1c989c21F51b91C"
+        "BuyGDFactory": "0x00e533B7d6255D05b7f15034B1c989c21F51b91C",
+        "BuyGDFactoryV2": "0x513927BE0b48D3134716D09f1a23983F6E201e95"
     },
     "gnosis": {
         "GuardiansSafe": "0x84c10b45fe51bfb4f86c19a47fdbc187d4572fb8"
@@ -514,7 +515,9 @@
         "GuardiansSafe": "0x84C10B45fE51bfB4f86c19A47Fdbc187d4572Fb8",
         "OneTimePayments": "0xB23e54fd8c2f35F9d38884Fc1611F5e9004f10ea",
         "OneTimePaymentsV2": "0x2cb1c7d50371e277d7a36B171c0ACe9B157518EE",
-        "UniswapV3Router": "0x5615CDAb10dc425a742d643d949a7F474C01abc4"
+        "UniswapV3Router": "0x5615CDAb10dc425a742d643d949a7F474C01abc4",
+        "BuyGDFactory": "0x00e533B7d6255D05b7f15034B1c989c21F51b91C",
+        "BuyGDFactoryV2": "0x513927BE0b48D3134716D09f1a23983F6E201e95"
     },
     "staging-celo": {
         "network": "staging-celo",
@@ -539,7 +542,9 @@
         "GuardiansSafe": "0x84C10B45fE51bfB4f86c19A47Fdbc187d4572Fb8",
         "OneTimePayments": "0x514820Af2DaE5F537dE16E576471528176318113",
         "OneTimePaymentsV2": "0x963E7B4c970626Bb103c61fA16b002AFf6E6c2C7",
-        "UniswapV3Router": "0x5615CDAb10dc425a742d643d949a7F474C01abc4"
+        "UniswapV3Router": "0x5615CDAb10dc425a742d643d949a7F474C01abc4",
+        "BuyGDFactory": "0x00e533B7d6255D05b7f15034B1c989c21F51b91C",
+        "BuyGDFactoryV2": "0x513927BE0b48D3134716D09f1a23983F6E201e95"
     },
     "development-goerli": {
         "ProxyFactory": "0x65D8eACBCd9618b8780C4b444081915a5D54D611",
@@ -588,5 +593,8 @@
         "GReputation": "0x3647469733C01713A7d9bdf6834bd4aBd59D66fa",
         "GoodDollarMintBurnWrapper": "0x69d9c8d240E282a4ec0058CF0AC4E9D8ac7a11ac",
         "GoodDollarStaking": "0xC9a3DdadC753e6a7675Aa125991096623d06c437"
+    },
+    "development-mainnet": {
+        "networkId": 1
     }
 }

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

@@ -26,18 +26,26 @@ export interface BuyGDCloneFactoryInterface extends utils.Interface {
   functions: {
     "create(address)": FunctionFragment;
     "createAndSwap(address,uint256)": FunctionFragment;
+    "createDonation(address,address,bytes)": FunctionFragment;
+    "createDonationAndSwap(address,address,bool,uint256,bytes)": FunctionFragment;
+    "donateImpl()": FunctionFragment;
     "getBaseFee()": FunctionFragment;
     "impl()": FunctionFragment;
     "predict(address)": FunctionFragment;
+    "predictDonation(address,address,bytes)": FunctionFragment;
   };
 
   getFunction(
     nameOrSignatureOrTopic:
       | "create"
       | "createAndSwap"
+      | "createDonation"
+      | "createDonationAndSwap"
+      | "donateImpl"
       | "getBaseFee"
       | "impl"
       | "predict"
+      | "predictDonation"
   ): FunctionFragment;
 
   encodeFunctionData(functionFragment: "create", values: [string]): string;
@@ -45,21 +53,50 @@ export interface BuyGDCloneFactoryInterface extends utils.Interface {
     functionFragment: "createAndSwap",
     values: [string, BigNumberish]
   ): string;
+  encodeFunctionData(
+    functionFragment: "createDonation",
+    values: [string, string, BytesLike]
+  ): string;
+  encodeFunctionData(
+    functionFragment: "createDonationAndSwap",
+    values: [string, string, boolean, BigNumberish, BytesLike]
+  ): string;
+  encodeFunctionData(
+    functionFragment: "donateImpl",
+    values?: undefined
+  ): string;
   encodeFunctionData(
     functionFragment: "getBaseFee",
     values?: undefined
   ): string;
   encodeFunctionData(functionFragment: "impl", values?: undefined): string;
   encodeFunctionData(functionFragment: "predict", values: [string]): string;
+  encodeFunctionData(
+    functionFragment: "predictDonation",
+    values: [string, string, BytesLike]
+  ): string;
 
   decodeFunctionResult(functionFragment: "create", data: BytesLike): Result;
   decodeFunctionResult(
     functionFragment: "createAndSwap",
     data: BytesLike
   ): Result;
+  decodeFunctionResult(
+    functionFragment: "createDonation",
+    data: BytesLike
+  ): Result;
+  decodeFunctionResult(
+    functionFragment: "createDonationAndSwap",
+    data: BytesLike
+  ): Result;
+  decodeFunctionResult(functionFragment: "donateImpl", data: BytesLike): Result;
   decodeFunctionResult(functionFragment: "getBaseFee", data: BytesLike): Result;
   decodeFunctionResult(functionFragment: "impl", data: BytesLike): Result;
   decodeFunctionResult(functionFragment: "predict", data: BytesLike): Result;
+  decodeFunctionResult(
+    functionFragment: "predictDonation",
+    data: BytesLike
+  ): Result;
 
   events: {};
 }
@@ -102,11 +139,36 @@ export interface BuyGDCloneFactory extends BaseContract {
       overrides?: Overrides & { from?: string }
     ): Promise<ContractTransaction>;
 
+    createDonation(
+      owner: string,
+      donateOrExecTo: string,
+      callData: BytesLike,
+      overrides?: Overrides & { from?: string }
+    ): Promise<ContractTransaction>;
+
+    createDonationAndSwap(
+      owner: string,
+      donateOrExecTo: string,
+      withSwap: boolean,
+      minAmount: BigNumberish,
+      callData: BytesLike,
+      overrides?: Overrides & { from?: string }
+    ): Promise<ContractTransaction>;
+
+    donateImpl(overrides?: CallOverrides): Promise<[string]>;
+
     getBaseFee(overrides?: CallOverrides): Promise<[BigNumber]>;
 
     impl(overrides?: CallOverrides): Promise<[string]>;
 
     predict(owner: string, overrides?: CallOverrides): Promise<[string]>;
+
+    predictDonation(
+      owner: string,
+      donateOrExecTo: string,
+      callData: BytesLike,
+      overrides?: CallOverrides
+    ): Promise<[string]>;
   };
 
   create(
@@ -120,12 +182,37 @@ export interface BuyGDCloneFactory extends BaseContract {
     overrides?: Overrides & { from?: string }
   ): Promise<ContractTransaction>;
 
+  createDonation(
+    owner: string,
+    donateOrExecTo: string,
+    callData: BytesLike,
+    overrides?: Overrides & { from?: string }
+  ): Promise<ContractTransaction>;
+
+  createDonationAndSwap(
+    owner: string,
+    donateOrExecTo: string,
+    withSwap: boolean,
+    minAmount: BigNumberish,
+    callData: BytesLike,
+    overrides?: Overrides & { from?: string }
+  ): Promise<ContractTransaction>;
+
+  donateImpl(overrides?: CallOverrides): Promise<string>;
+
   getBaseFee(overrides?: CallOverrides): Promise<BigNumber>;
 
   impl(overrides?: CallOverrides): Promise<string>;
 
   predict(owner: string, overrides?: CallOverrides): Promise<string>;
 
+  predictDonation(
+    owner: string,
+    donateOrExecTo: string,
+    callData: BytesLike,
+    overrides?: CallOverrides
+  ): Promise<string>;
+
   callStatic: {
     create(owner: string, overrides?: CallOverrides): Promise<string>;
 
@@ -135,11 +222,36 @@ export interface BuyGDCloneFactory extends BaseContract {
       overrides?: CallOverrides
     ): Promise<string>;
 
+    createDonation(
+      owner: string,
+      donateOrExecTo: string,
+      callData: BytesLike,
+      overrides?: CallOverrides
+    ): Promise<string>;
+
+    createDonationAndSwap(
+      owner: string,
+      donateOrExecTo: string,
+      withSwap: boolean,
+      minAmount: BigNumberish,
+      callData: BytesLike,
+      overrides?: CallOverrides
+    ): Promise<string>;
+
+    donateImpl(overrides?: CallOverrides): Promise<string>;
+
     getBaseFee(overrides?: CallOverrides): Promise<BigNumber>;
 
     impl(overrides?: CallOverrides): Promise<string>;
 
     predict(owner: string, overrides?: CallOverrides): Promise<string>;
+
+    predictDonation(
+      owner: string,
+      donateOrExecTo: string,
+      callData: BytesLike,
+      overrides?: CallOverrides
+    ): Promise<string>;
   };
 
   filters: {};
@@ -156,11 +268,36 @@ export interface BuyGDCloneFactory extends BaseContract {
       overrides?: Overrides & { from?: string }
     ): Promise<BigNumber>;
 
+    createDonation(
+      owner: string,
+      donateOrExecTo: string,
+      callData: BytesLike,
+      overrides?: Overrides & { from?: string }
+    ): Promise<BigNumber>;
+
+    createDonationAndSwap(
+      owner: string,
+      donateOrExecTo: string,
+      withSwap: boolean,
+      minAmount: BigNumberish,
+      callData: BytesLike,
+      overrides?: Overrides & { from?: string }
+    ): Promise<BigNumber>;
+
+    donateImpl(overrides?: CallOverrides): Promise<BigNumber>;
+
     getBaseFee(overrides?: CallOverrides): Promise<BigNumber>;
 
     impl(overrides?: CallOverrides): Promise<BigNumber>;
 
     predict(owner: string, overrides?: CallOverrides): Promise<BigNumber>;
+
+    predictDonation(
+      owner: string,
+      donateOrExecTo: string,
+      callData: BytesLike,
+      overrides?: CallOverrides
+    ): Promise<BigNumber>;
   };
 
   populateTransaction: {
@@ -175,6 +312,24 @@ export interface BuyGDCloneFactory extends BaseContract {
       overrides?: Overrides & { from?: string }
     ): Promise<PopulatedTransaction>;
 
+    createDonation(
+      owner: string,
+      donateOrExecTo: string,
+      callData: BytesLike,
+      overrides?: Overrides & { from?: string }
+    ): Promise<PopulatedTransaction>;
+
+    createDonationAndSwap(
+      owner: string,
+      donateOrExecTo: string,
+      withSwap: boolean,
+      minAmount: BigNumberish,
+      callData: BytesLike,
+      overrides?: Overrides & { from?: string }
+    ): Promise<PopulatedTransaction>;
+
+    donateImpl(overrides?: CallOverrides): Promise<PopulatedTransaction>;
+
     getBaseFee(overrides?: CallOverrides): Promise<PopulatedTransaction>;
 
     impl(overrides?: CallOverrides): Promise<PopulatedTransaction>;
@@ -183,5 +338,12 @@ export interface BuyGDCloneFactory extends BaseContract {
       owner: string,
       overrides?: CallOverrides
     ): Promise<PopulatedTransaction>;
+
+    predictDonation(
+      owner: string,
+      donateOrExecTo: string,
+      callData: BytesLike,
+      overrides?: CallOverrides
+    ): Promise<PopulatedTransaction>;
   };
 }