Merge pull request #455 from superform-xyz/spNameSymbol

feat: add name and symbol to SP
superform-xyz · Jan 23, 2024 · 174992f · 174992f
2 parents 3f63afa + 61cb3c8
commit 174992f
Show file tree

Hide file tree

Showing 7 changed files with 23 additions and 12 deletions.
diff --git a/foundry.toml b/foundry.toml
@@ -16,7 +16,7 @@ verbosity = 0
 ffi = false
 libs = ["lib"]
 fs_permissions = [{ access = "read-write", path = "./script/" }]
-remappings = ["solmate/=lib/ERC1155A/lib/solmate/src/"]
+remappings = ["solmate/=lib/ERC1155A/lib/solmate/src/","ERC1155A/=lib/ERC1155A/src/"]
 
 [profile.localdev]
 solc_version = "0.8.23" # Override for the solc version (setting this ignores `auto_detect_solc`)
@@ -30,7 +30,7 @@ verbosity = 0
 ffi = false
 libs = ["lib"]
 fs_permissions = [{ access = "read-write", path = "./script/" }]
-remappings = ["solmate/=lib/ERC1155A/lib/solmate/src/"]
+remappings = ["solmate/=lib/ERC1155A/lib/solmate/src/","ERC1155A/=lib/ERC1155A/src/"]
 
 [profile.coverage]
 fuzz = { runs = 1, max_test_rejects = 350_000 }

diff --git a/lib/ERC1155A b/lib/ERC1155A
diff --git a/script/Abstract.Deploy.Single.s.sol b/script/Abstract.Deploy.Single.s.sol
@@ -574,7 +574,9 @@ abstract contract AbstractDeploySingle is Script {
         vars.superPositions = address(
             new SuperPositions{ salt: salt }(
                 "https://ipfs-gateway.superform.xyz/ipns/k51qzi5uqu5dg90fqdo9j63m556wlddeux4mlgyythp30zousgh3huhyzouyq8/JSON/",
-                vars.superRegistry
+                vars.superRegistry,
+                "SuperPositions",
+                "SP"
             )
         );
 

diff --git a/src/SuperPositions.sol b/src/SuperPositions.sol
@@ -119,7 +119,14 @@ contract SuperPositions is ISuperPositions, ERC1155A, Broadcastable {
 
     /// @param dynamicURI_  URL for external metadata of ERC1155 SuperPositions
     /// @param superRegistry_ the superform registry contract
-    constructor(string memory dynamicURI_, address superRegistry_) {
+    constructor(
+        string memory dynamicURI_,
+        address superRegistry_,
+        string memory name_,
+        string memory symbol_
+    )
+        ERC1155A(name_, symbol_)
+    {
         if (block.chainid > type(uint64).max) {
             revert Error.BLOCK_CHAIN_ID_OUT_OF_BOUNDS();
         }
@@ -369,8 +376,8 @@ contract SuperPositions is ISuperPositions, ERC1155A, Broadcastable {
         }
         (address superform,,) = id.getSuperform();
 
-        string memory name = string.concat("SuperPositions AERC20 ", IBaseForm(superform).superformYieldTokenName());
-        string memory symbol = string.concat("aERC20-", IBaseForm(superform).superformYieldTokenSymbol());
+        string memory name = IBaseForm(superform).superformYieldTokenName();
+        string memory symbol = IBaseForm(superform).superformYieldTokenSymbol();
         uint8 decimal = uint8(IBaseForm(superform).getVaultDecimals());
         aErc20Token = address(new aERC20(name, symbol, decimal));
         /// @dev broadcast and deploy to the other destination chains

diff --git a/src/forms/ERC4626FormImplementation.sol b/src/forms/ERC4626FormImplementation.sol
@@ -135,12 +135,12 @@ abstract contract ERC4626FormImplementation is BaseForm, LiquidityHandler {
 
     /// @inheritdoc BaseForm
     function superformYieldTokenName() external view virtual override returns (string memory) {
-        return string(abi.encodePacked("Superform ", IERC20Metadata(vault).name()));
+        return string(abi.encodePacked(IERC20Metadata(vault).name(), " SuperPosition"));
     }
 
     /// @inheritdoc BaseForm
     function superformYieldTokenSymbol() external view virtual override returns (string memory) {
-        return string(abi.encodePacked("SUP-", IERC20Metadata(vault).symbol()));
+        return string(abi.encodePacked("sp-", IERC20Metadata(vault).symbol()));
     }
 
     /// @inheritdoc BaseForm

diff --git a/test/unit/superform-forms/superform-form.ERC4626Form.t.sol b/test/unit/superform-forms/superform-form.ERC4626Form.t.sol
@@ -86,7 +86,7 @@ contract SuperformERC4626FormTest is ProtocolActions {
 
         string memory symbol = ERC4626Form(payable(superformCreated)).superformYieldTokenSymbol();
 
-        assertEq(symbol, "SUP-Mock");
+        assertEq(symbol, "sp-Mock");
     }
 
     function test_superformVaultSharesAmountToUnderlyingAmount() public {
@@ -357,7 +357,7 @@ contract SuperformERC4626FormTest is ProtocolActions {
 
         string memory tokenName = ERC4626Form(payable(superformCreated)).superformYieldTokenName();
 
-        assertEq(tokenName, "Superform Mock Vault");
+        assertEq(tokenName, "Mock Vault SuperPosition");
     }
 
     function test_superformDirectDepositWithoutAllowance() public {

diff --git a/test/utils/BaseSetup.sol b/test/utils/BaseSetup.sol
@@ -690,7 +690,9 @@ abstract contract BaseSetup is DSTest, StdInvariant, Test {
             vars.superPositions = address(
                 new SuperPositions{ salt: salt }(
                     "https://ipfs-gateway.superform.xyz/ipns/k51qzi5uqu5dg90fqdo9j63m556wlddeux4mlgyythp30zousgh3huhyzouyq8/JSON/",
-                    vars.superRegistry
+                    vars.superRegistry,
+                    "SuperPositions",
+                    "SP"
                 )
             );
+1 −0		.env.example
+142 −0		broadcast/DeployTestERC1155A.s.sol/80001/deploy-latest.json
+142 −0		broadcast/DeployTestERC1155A.s.sol/80001/run-1706004511.json
+21 −0		script/DeployTestERC1155A.s.sol
+6 −0		script/deploy.sh
+17 −0		src/ERC1155A.sol
+29 −12		src/interfaces/IERC1155A.sol
+6 −2		src/test/ERC1155.t.sol
+1 −1		src/test/ERC1155_A.t.sol
+2 −0		src/test/mocks/MockERC1155A.sol