Release Dev PRs (2024-07-15) (#38)

Co-authored-by: aquariuslt <[email protected]>

Author: 0xashu

.env.example

@@ -4,11 +4,11 @@
 PRIVATE_KEY=
 
 # RPC URLs
-OPTIMISM_SEPOLIA_RPC=
-OPTIMISM_MAINNET_RPC=
+OPTIMISM_TESTNET_RPC=https://sepolia.optimism.io
+OPTIMISM_MAINNET_RPC=https://mainnet.optimism.io
 
-CYBER_SEPOLIA_RPC=
-CYBER_MAINNET_RPC=
+CYBER_TESTNET_RPC=https://cyber-testnet.alt.technology
+CYBER_MAINNET_RPC=https://cyber.alt.technology
 
 # Etherscan API keys
 ETHEREUM_ETHERSCAN_API_KEY=

Makefile

@@ -1,17 +1,20 @@
-.PHONY: deploy-testnet deploy-mainnet deploy-aave
+SHELL := /bin/bash
+.PHONY: deploy-testnet deploy-mainnet deploy-aave-mainnet
 
 DEPLOY_CMD=source .env && forge script scripts/Deploy.s.sol:DeployScript
 DEPLOY_AAVE_CMD=source .env && forge script scripts/DeployAave.s.sol:DeployAaveScript
 VERIFY_CMD=--etherscan-api-key $$OPTIMISM_ETHERSCAN_API_KEY --verify
 
 deploy-testnet:
 	${DEPLOY_CMD} --rpc-url $$OPTIMISM_TESTNET_RPC --broadcast ${VERIFY_CMD} -vvvv
-	${DEPLOY_CMD} --rpc-url $$CYBER_TESTNET_RPC --broadcast -vvvv
+	#${DEPLOY_CMD} --rpc-url $$CYBER_TESTNET_RPC --broadcast -vvvv
 
 deploy-mainnet:
 	${DEPLOY_CMD} --rpc-url $$OPTIMISM_MAINNET_RPC --broadcast ${VERIFY_CMD} -vvvv
-	${DEPLOY_CMD} --rpc-url $$CYBER_MAINNET_RPC --broadcast -vvvv
+	#${DEPLOY_CMD} --rpc-url $$CYBER_MAINNET_RPC --broadcast -vvvv
 
-deploy-aave:
+deploy-aave-testnet:
 	${DEPLOY_AAVE_CMD} --rpc-url $$OPTIMISM_TESTNET_RPC --broadcast ${VERIFY_CMD} -vvvv
-	${DEPLOY_AAVE_CMD} --rpc-url $$OPTIMISM_MAINNET_RPC --broadcast ${VERIFY_CMD} -vvvv
+
+deploy-aave-mainnet:
+	${DEPLOY_AAVE_CMD} --rpc-url $$OPTIMISM_MAINNET_RPC --broadcast ${VERIFY_CMD} -vvvv

README.md

@@ -11,7 +11,8 @@
 
 ##
 
-**A payment protocol designed for creators**, it bridges the gap between creators and fans, where fans can **donate, sponsor, subscribe**, and more, while creators receive **fees and yield**.
+**A payment protocol designed for creators**, it bridges the gap between creators and fans, where fans can **donate,
+sponsor, subscribe**, and more, while creators receive **fees and yield**.
 
 - For fans, pay early and earn more;
 - For creators, long-term income from fees and yield;
@@ -21,20 +22,25 @@
 - Made for creators like startups, indie hackers and KOLs.
 
 ## Bug Bounty
+
 If you are interested in the smart contracts, here's a simple bug bounty:
 
-- Discover [hign / medium](https://docs.sherlock.xyz/audit/judging/judging#iv.-how-to-identify-a-high-issue) issues - $1200 *cc [email protected]*
+- Discover [hign / medium](https://docs.sherlock.xyz/audit/judging/judging#iv.-how-to-identify-a-high-issue) issues -
+  $1200 *cc [email protected]*
 - Add/optimize test cases - $100 / PR
 
 ## How it works？
 
-The contract uses a sigmoid bonding curve for dynamic pricing. When you buy, it mints tokens and drives prices up, then when you sell, it burns tokens and drives prices down. The staked ETH is allocated in an interest-rate market to generate sustainable rewards, which are then redistributed to the creators.
+The contract uses a sigmoid bonding curve for dynamic pricing. When you buy, it mints tokens and drives prices up, then
+when you sell, it burns tokens and drives prices down. The staked ETH is allocated in an interest-rate market to
+generate sustainable rewards, which are then redistributed to the creators.
 
 <div align="center">
-  <img src="images/curve.gif" width="80%">
+  <img alt="curve" src="images/curve.gif" width="80%">
 </div>
 
 ## Why is it better?
+
 <div align="center">
 
 | Features           | V4V   | Friendtech | Patreon | Coinbase Commerce |
@@ -51,36 +57,41 @@ The contract uses a sigmoid bonding curve for dynamic pricing. When you buy, it
 
 ### NFT
 
-> The token is a standard ERC1155 contract, with NFTs acting as shares in the bonding curve. When you trade shares, NFTs are minted or burned.
+> The token is a standard ERC1155 contract, with NFTs acting as shares in the bonding curve. When you trade shares, NFTs
+> are minted or burned.
 
-| Network          | Address                                    |
-|------------------|--------------------------------------------|
-| Optimism Mainnet | N/A                                        |
-| Optimism Sepolia | 0x4aCF2aF23f51b7008dF3518A1511871F87083C38 |
-| Cyber Mainnet    | N/A                                        |
-| Cyber Sepolia    | 0x552d348657fafd661372f5864093dd9555a2ef06 |
+| Network          | Address                                                                                                                                |
+|------------------|----------------------------------------------------------------------------------------------------------------------------------------|
+| Optimism Mainnet | N/A                                                                                                                                    |
+| Optimism Sepolia | [0x02a04ee779587afbbe7f844180ff760bc5e73039](https://sepolia-optimism.etherscan.io/address/0x02a04ee779587afbbe7f844180ff760bc5e73039) |
+| Cyber Mainnet    | N/A                                                                                                                                    |
+| Cyber Sepolia    |                                                                                                                                        |
 
 ### Shares
 
-> SharesFactory is the core contract that contains the bonding curve and yield aggregator logic where you can mint, buy, and sell shares, as well as change yield strategies and claim yields.
+> SharesFactory is the core contract that contains the bonding curve and yield aggregator logic where you can mint, buy,
+> and sell shares, as well as change yield strategies and claim yields.
 
-| Network          | Address                                    |
-|------------------|--------------------------------------------|
-| Optimism Mainnet | N/A                                        |
-| Optimism Sepolia | 0x9F94C75341D23EAb48793b2879F6062a400132e3 |
-| Cyber Mainnet    | N/A                                        |
-| Cyber Sepolia    | 0x1b05f188388b49ee9053914d3109119d228060b5 |
+| Network          | Address                                                                                                                                |
+|------------------|----------------------------------------------------------------------------------------------------------------------------------------|
+| Optimism Mainnet | N/A                                                                                                                                    |
+| Optimism Sepolia | [0x4509932e2f18b622f454cf73fac8069901fbbebc](https://sepolia-optimism.etherscan.io/address/0x4509932e2f18b622f454cf73fac8069901fbbebc) |
+| Cyber Mainnet    | N/A                                                                                                                                    |
+| Cyber Sepolia    | 0x1b05f188388b49ee9053914d3109119d228060b5                                                                                             |
 
 ### Yield
 
-> YieldAggregator is a yield strategy contract that provides a common interface for SharesFactory to use, such as deposit, withdraw, and claimable. However, the underlying logic can be any yield strategy, such as Aave, Pendle and LRT, or nothing at all.
+> YieldAggregator is a yield strategy contract that provides a common interface for SharesFactory to use, such as
+> deposit, withdraw, and claimable. However, the underlying logic can be any yield strategy, such as Aave, Pendle and
+> LRT,
+> or nothing at all.
 
-| Network          | Address                                    |
-|------------------|--------------------------------------------|
-| Optimism Mainnet | N/A                                        |
-| Optimism Sepolia | 0xc1eB8f8119De78Da6852F2607d5525d849FCBaaE |
-| Cyber Mainnet    | N/A                                        |
-| Cyber Sepolia    | 0xba2553060e90551c797bebd48ee04909606bb04f |
+| Network          | Address                                                                                                                                |
+|------------------|----------------------------------------------------------------------------------------------------------------------------------------|
+| Optimism Mainnet | N/A                                                                                                                                    |
+| Optimism Sepolia | [0xa77fc72fbb2e7f6c4ba4f97f0f6eeee9f46a2b97](https://sepolia-optimism.etherscan.io/address/0xa77fc72fbb2e7f6c4ba4f97f0f6eeee9f46a2b97) |
+| Cyber Mainnet    | N/A                                                                                                                                    |
+| Cyber Sepolia    | 0xba2553060e90551c797bebd48ee04909606bb04f                                                                                             |
 
 ## Test and Deploy
 
@@ -100,4 +111,7 @@ deploy
 
 ## Acknowledgement
 
-Thanks to [Simon de la Rouviere](https://docs.google.com/document/d/1VNkBjjGhcZUV9CyC0ccWYbqeOoVKT2maqX0rK3yXB20), whose ideas inspired *V4V* to combine curated market with bonding curves, and to the ideal S-curve model from [sound protocol](https://github.com/soundxyz/sound-protocol), we’ve also learned the principle of minimalism from [friend tech](https://www.friend.tech) and [bodhi](https://bodhi.wtf).
+Thanks to [Simon de la Rouviere](https://docs.google.com/document/d/1VNkBjjGhcZUV9CyC0ccWYbqeOoVKT2maqX0rK3yXB20), whose
+ideas inspired *V4V* to combine curated market with bonding curves, and to the ideal S-curve model
+from [sound protocol](https://github.com/soundxyz/sound-protocol), we’ve also learned the principle of minimalism
+from [friend tech](https://www.friend.tech) and [bodhi](https://bodhi.wtf).

contracts/core/SharesERC1155.sol

@@ -11,6 +11,7 @@ import { IShare } from "../interface/IShare.sol";
 contract SharesERC1155 is ERC1155Supply, Ownable, IShare {
     address public _FACTORY_;
     string private _baseURI;
+    mapping(uint256 => string) public tokenURIs;
 
     event Mint(address indexed user, uint256 indexed id, uint256 amount);
     event Burn(address indexed user, uint256 indexed id, uint256 amount);
@@ -32,6 +33,10 @@ contract SharesERC1155 is ERC1155Supply, Ownable, IShare {
         _baseURI = newURI;
     }
 
+    function setTokenURI(uint256 tokenId, string memory tokenURI) public onlyFactory {
+        tokenURIs[tokenId] = tokenURI;
+    }
+
     function shareMint(address to, uint256 id, uint256 amount) public onlyFactory {
         _mint(to, id, amount, "");
         emit Mint(to, id, amount);

contracts/core/SharesFactoryV1.sol

@@ -48,7 +48,7 @@ contract SharesFactoryV1 is Ownable2Step, ReentrancyGuard {
     event ClaimYield(uint256 amount, address indexed to);
     event SetCurve(uint8 indexed curveType);
     event SetFee(uint256 indexed feePercent, string feeType);
-    event Mint(uint256 indexed id, address indexed creator, uint8 indexed curveType);
+    event Mint(uint256 indexed id, address indexed creator, uint8 indexed curveType, string uri);
     event Buy(uint256 indexed id, address indexed buyer, uint32 quantity, uint256 totalPrice);
     event Sell(uint256 indexed id, address indexed seller, uint32 quantity, uint256 totalPrice);
 
@@ -182,24 +182,26 @@ contract SharesFactoryV1 is Ownable2Step, ReentrancyGuard {
      * @notice Mint a share and buy it in one transaction.
      * @param curveType The type of the curve.
      * @param quantity The quantity of shares.
+     * @param uri The URI of the share. Arweave, IPFS or any permanent id.
      * @param referral The address of the referral fee recipient.
      */
-    function mintAndBuyShare(uint8 curveType, uint32 quantity, address referral) public payable {
-        mintShare(curveType);
+    function mintAndBuyShare(uint8 curveType, uint32 quantity, string memory uri, address referral) public payable {
+        mintShare(curveType, uri);
         buyShare(shareIndex - 1, quantity, referral);
     }
 
     /**
      * @notice Mint a share with an auto-incremented ID.
      * @dev The share ID is identical to the ERC1155 ID.
      */
-    function mintShare(uint8 curveType) public {
+    function mintShare(uint8 curveType, string memory uri) public {
         require(curvesMap[curveType].exists, "Invalid curveType");
 
         Share memory newShare = Share({ creator: msg.sender, curveType: curveType });
         sharesMap[shareIndex] = newShare;
+        IShare(ERC1155).setTokenURI(shareIndex, uri);
 
-        emit Mint(shareIndex, msg.sender, curveType);
+        emit Mint(shareIndex, msg.sender, curveType, uri);
 
         shareIndex++;
     }

contracts/interface/IShare.sol

@@ -3,6 +3,8 @@
 pragma solidity 0.8.25;
 
 interface IShare {
+    function setTokenURI(uint256 tokenId, string memory tokenURI) external;
+
     function shareMint(address to, uint256 id, uint256 amount) external;
 
     function shareBurn(address from, uint256 id, uint256 amount) external;

scripts/Base.s.sol

@@ -24,24 +24,29 @@ contract BaseScript is Script {
         // set the factory address here so that the yieldAggregator can be deployed.
 
         // Optimism Sepolia
-        SHARES_FACTORY[OPTIMISM_TESTNET] = 0x9F94C75341D23EAb48793b2879F6062a400132e3;
+        SHARES_FACTORY[OPTIMISM_TESTNET] = 0x4509932e2f18b622F454cf73FAc8069901fbbebC;
         WETH[OPTIMISM_TESTNET] = 0x4200000000000000000000000000000000000006;
         AAVE_POOL[OPTIMISM_TESTNET] = 0xb50201558B00496A145fE76f7424749556E326D8;
         AAVE_WETH_GATEWAY[OPTIMISM_TESTNET] = 0x589750BA8aF186cE5B55391B0b7148cAD43a1619;
 
         // Optimism Mainnet
-        SHARES_FACTORY[OPTIMISM_MAINNET] = address(0);
+        SHARES_FACTORY[OPTIMISM_MAINNET] = 0x3eC4241152E5CEc606E1F0FB45448251221104E7;
         WETH[OPTIMISM_MAINNET] = 0x4200000000000000000000000000000000000006;
         AAVE_POOL[OPTIMISM_MAINNET] = 0x794a61358D6845594F94dc1DB02A252b5b4814aD;
         AAVE_WETH_GATEWAY[OPTIMISM_MAINNET] = 0xe9E52021f4e11DEAD8661812A0A6c8627abA2a54;
 
-        // Cyber Sepolia
+        // Cyber Testnet
         WETH[CYBER_TESTNET] = 0x4200000000000000000000000000000000000006;
         SHARES_FACTORY[CYBER_TESTNET] = address(0);
+        AAVE_POOL[CYBER_TESTNET] = address(0);
+        AAVE_WETH_GATEWAY[CYBER_TESTNET] = address(0);
 
         // Cyber Mainnet
-        WETH[CYBER_MAINNET] = address(0);
         SHARES_FACTORY[CYBER_MAINNET] = address(0);
+        WETH[CYBER_MAINNET] = 0x4200000000000000000000000000000000000006;
+        AAVE_POOL[CYBER_MAINNET] = address(0);
+        AAVE_WETH_GATEWAY[CYBER_MAINNET] = address(0);
+
     }
 
     modifier broadcast() {

test/integration/BaseIntegrationTest.t.sol

@@ -132,7 +132,7 @@ contract BaseIntegrationTest is Test {
         vm.deal(LONG_TERM_TRADER, 100 ether);
 
         vm.prank(DAILY_TRADER);
-        sharesFactory.mintShare(DEFAULT_CURVE_TYPE);
+        sharesFactory.mintShare(DEFAULT_CURVE_TYPE, '');
         uint256 shareId = sharesFactory.shareIndex() - 1;
 
         for (uint32 i = 0; i < tradeCount; i++) {

test/integration/IncomeSimulator.t.sol

@@ -216,7 +216,7 @@ contract IncomeSimulator is BaseIntegrationTest, LogUtil {
 
         // mint shares
         vm.prank(FACTORY_OWNER);
-        sharesFactory.mintShare(curveType);
+        sharesFactory.mintShare(curveType, '');
 
         // record start balance
         uint256 founderBalanceBefore = aWETH.balanceOf(address(SHARES_FOUNDER));

test/integration/handlers/BoundedIntegrationContextHandler.t.sol

@@ -56,7 +56,7 @@ contract BoundedIntegrationContextHandler is StdUtils {
         uint256 shareId = 0;
 
         vm.prank(factoryOwner);
-        sharesFactory.mintShare(0);
+        sharesFactory.mintShare(0, '');
 
         vm.prank(TRADER);
 

test/unit/SharesERC1155.t.sol

@@ -37,6 +37,17 @@ contract ERC1155Tests is BaseTest {
         assertEq(userBal, 10);
     }
 
+    function test_setTokenURI() public {
+        vm.expectRevert(bytes("Caller is not the factory"));
+        sharesNFT.setTokenURI(0, "https://vv.com/0");
+
+        vm.prank(address(sharesFactory));
+        sharesNFT.setTokenURI(0, "https://vv.com/0");
+
+        string memory tokenURI = sharesNFT.tokenURIs(0);
+        assertEq(tokenURI, "https://vv.com/0");
+    }
+
     function test_shareMint() public {
         vm.prank(address(sharesFactory));
         sharesNFT.shareMint(addrUser, 0, 10);

test/unit/SharesFactory.t.sol

@@ -8,6 +8,8 @@ import { IYieldAggregator } from "contracts/interface/IYieldAggregator.sol";
 import { BaseTest } from "../BaseTest.t.sol";
 
 contract SharesFactoryTests is BaseTest {
+    string private constant URI = "https://vv.com/uri/";
+
     function setUp() public {
         createFactory();
         _setUpShare();
@@ -19,7 +21,7 @@ contract SharesFactoryTests is BaseTest {
 
         // Alice mint & buy 1 share with 0 id
         vm.prank(addrAlice);
-        sharesFactory.mintShare(defaultCurveType);
+        sharesFactory.mintShare(defaultCurveType, URI);
         _buyShare(addrAlice, 0, 1, referralReceiver);
 
         // Bob mintAndBuy 1 share with 1 id
@@ -39,16 +41,18 @@ contract SharesFactoryTests is BaseTest {
 
     function test_mintShare() public {
         vm.prank(addrAlice);
-        sharesFactory.mintShare(defaultCurveType);
+        sharesFactory.mintShare(defaultCurveType, URI);
 
         uint256 shareIndex = sharesFactory.shareIndex();
         (address creator, uint8 curveType) = sharesFactory.getShare(shareIndex - 1);
+        string memory tokenURI = sharesNFT.tokenURIs(shareIndex - 1);
 
         assertEq(creator, addrAlice);
         assertEq(curveType, defaultCurveType);
+        assertEq(tokenURI, URI);
 
         vm.expectRevert(bytes("Invalid curveType"));
-        sharesFactory.mintShare(99);
+        sharesFactory.mintShare(99, URI);
     }
 
     function test_minAndBuyShare() public {
@@ -59,10 +63,12 @@ contract SharesFactoryTests is BaseTest {
         uint256 shareId = sharesFactory.shareIndex() - 1;
         uint256 bobShareBal = sharesNFT.shareBalanceOf(addrBob, shareId);
         (address creator, uint8 curveType) = sharesFactory.getShare(shareId);
+        string memory tokenURI = sharesNFT.tokenURIs(shareId);
 
         assertEq(creator, addrBob);
         assertEq(curveType, defaultCurveType);
         assertEq(bobShareBal, 99);
+        assertEq(tokenURI, URI);
     }
 
     function test_buyShares() public {
@@ -534,7 +540,7 @@ contract SharesFactoryTests is BaseTest {
         uint256 buyPrice = sharesFactory.getSubTotal(0, quantity, curveType);
 
         vm.prank(address(sender));
-        sharesFactory.mintAndBuyShare{ value: buyPrice * 110 / 100 }(curveType, quantity, referral);
+        sharesFactory.mintAndBuyShare{ value: buyPrice * 110 / 100 }(curveType, quantity, URI, referral);
     }
 
     function _buyShare(address sender, uint256 shareId, uint32 quantity, address referral) internal {