Merge pull request #1638 from bancorprotocol/issue-#1637

Hide terms & privacy if not carbon

README.md

@@ -193,10 +193,10 @@ where `spread` (fee tier in the UI) is in percentage, and `value` is the number
 
 ## Change Network
 
-1. Create a new folder under `src/config` with the name of the network (ex: "polygon")
-2. Copy and paste the files from `src/config/ethereum` into your folder
+1. Create a new folder under [`src/config`](src/config) with the name of the network (ex: "polygon")
+2. Copy and paste the files from [`src/config/demo`](src/config/demo) into your folder
 3. Update the `common.ts`, `production.ts` & `development.ts` files with your config, pointing to the CarbonDeFi contracts in that network, as well as setting the rpc.url and rpc.headers (rpc.url must match the one found in [Chain Lists](https://chainlist.org/)).
-4. Update the `src/config/index.ts` files to import your files
+4. Update the [`src/config/index.ts`](src/config/index.ts) files to import your files
    `index.ts`
 
 As an example on adding Polygon network:
@@ -272,6 +272,8 @@ The file `common.ts` with type [`AppConfig`](src/config/types.ts) contains impor
   - `useGradientBranding`: Flag to enable gradient styles for buttons.
   - `tradeCount`: Display the amount of trades in the explorer page.
   - `currencyMenu`: Display the currency menu to switch between currencies.
+  - `showTerms`: Display the terms page & links. ⚠️ If you set it to true, you need to change the content of the page ⚠️
+  - `showPrivacy`: Display the privacy page & links. ⚠️ If you set it to true, you need to change the content of the page ⚠️
 
 #### Gas token different than native token
 

src/components/core/menu/mainMenu/MainMenuRightBurger/useBurgerMenuItems.tsx

@@ -53,57 +53,62 @@ export const useBurgerMenuItems = () => {
         </NewTabLink>
       ),
     },
-    {
+  ];
+  if (config.ui.showTerms) {
+    mainItems.push({
       content: (
         <Link className="flex" to="/terms">
           Terms of Use
         </Link>
       ),
-    },
-    {
+    });
+  }
+  if (config.ui.showPrivacy) {
+    mainItems.push({
       content: (
         <Link className="flex" to="/privacy">
           Privacy Policy
         </Link>
       ),
-    },
-    {
-      content: (
-        <div className="flex w-full items-center justify-between">
-          <NewTabLink
-            to={externalLinks.x}
-            className="rounded-6 p-6 md:hover:bg-black"
-          >
-            <IconX className={iconStyles} />
-          </NewTabLink>
-          <NewTabLink
-            to={externalLinks.youtube}
-            className="rounded-6 p-6 md:hover:bg-black"
-          >
-            <IconYoutube className={iconStyles} />
-          </NewTabLink>
-          <NewTabLink
-            to={externalLinks.discord}
-            className="rounded-6 p-6 md:hover:bg-black"
-          >
-            <IconDiscord className={iconStyles} />
-          </NewTabLink>
-          <NewTabLink
-            to={externalLinks.telegram}
-            className="rounded-6 p-6 md:hover:bg-black"
-          >
-            <IconTelegram className={iconStyles} />
-          </NewTabLink>
-        </div>
-      ),
-    },
-  ];
+    });
+  }
+  mainItems.push({
+    content: (
+      <div className="flex w-full items-center justify-between">
+        <NewTabLink
+          to={externalLinks.x}
+          className="rounded-6 p-6 md:hover:bg-black"
+        >
+          <IconX className={iconStyles} />
+        </NewTabLink>
+        <NewTabLink
+          to={externalLinks.youtube}
+          className="rounded-6 p-6 md:hover:bg-black"
+        >
+          <IconYoutube className={iconStyles} />
+        </NewTabLink>
+        <NewTabLink
+          to={externalLinks.discord}
+          className="rounded-6 p-6 md:hover:bg-black"
+        >
+          <IconDiscord className={iconStyles} />
+        </NewTabLink>
+        <NewTabLink
+          to={externalLinks.telegram}
+          className="rounded-6 p-6 md:hover:bg-black"
+        >
+          <IconTelegram className={iconStyles} />
+        </NewTabLink>
+      </div>
+    ),
+  });
   if (config.ui.currencyMenu) {
     mainItems.unshift({
       subMenu: 'currency',
       content: <CurrencyMenuItemContent />,
     });
   }
+
   menuMap.set('main', { items: mainItems });
 
   const currencyItems = useMemo(

src/config/blast/common.ts

@@ -132,5 +132,7 @@ export const commonConfig: AppConfig = {
     useGradientBranding: true,
     tradeCount: false,
     currencyMenu: false,
+    showTerms: false,
+    showPrivacy: false,
   },
 };

src/config/celo/common.ts

@@ -143,5 +143,7 @@ export const commonConfig: AppConfig = {
     useGradientBranding: true,
     tradeCount: true,
     currencyMenu: false,
+    showTerms: true,
+    showPrivacy: true,
   },
 };

src/config/configSchema.ts

@@ -109,5 +109,7 @@ export const AppConfigSchema = v.object({
     useGradientBranding: v.optional(v.boolean()),
     tradeCount: v.optional(v.boolean()),
     currencyMenu: v.optional(v.boolean()),
+    showTerms: v.optional(v.boolean()),
+    showPrivacy: v.optional(v.boolean()),
   }),
 });

src/config/demo/common.ts

@@ -0,0 +1,96 @@
+import { AppConfig } from 'config/types';
+
+const addresses = {
+  ZERO: '0x0000000000000000000000000000000000000000',
+};
+
+export const commonConfig: AppConfig = {
+  hidden: true,
+  mode: 'development',
+  appName: '',
+  appUrl: '',
+  carbonApi: '',
+  selectedConnectors: ['MetaMask'],
+  blockedConnectors: [],
+  walletConnectProjectId: '',
+  isSimulatorEnabled: false,
+  policiesLastUpdated: '',
+  network: {
+    name: 'Demo Network',
+    logoUrl: '',
+    chainId: 0,
+    blockExplorer: {
+      name: '',
+      url: '',
+    },
+    rpc: {
+      url: import.meta.env.VITE_CHAIN_RPC_URL,
+    },
+    defaultLimitedApproval: true,
+    gasToken: {
+      name: '',
+      symbol: '',
+      decimals: 18,
+      address: '',
+      logoURI: '',
+    },
+  },
+  sdk: {
+    cacheTTL: 0,
+  },
+  defaultTokenPair: ['', ''],
+  popularPairs: [],
+  popularTokens: {
+    base: [],
+    quote: [],
+  },
+  addresses: {
+    tokens: addresses,
+    carbon: {
+      carbonController: '',
+      voucher: '',
+    },
+  },
+  utils: {
+    multicall3: {
+      address: '0x...',
+      blockCreated: 0,
+    },
+  },
+  tokenListOverride: [],
+  tokenLists: [],
+  tenderly: {
+    nativeTokenDonorAccount: '',
+    faucetAmount: 1000,
+    faucetTokens: [
+      {
+        donorAccount: '',
+        tokenContract: '',
+        decimals: 18,
+        symbol: '',
+      },
+      {
+        donorAccount: '',
+        tokenContract: '',
+        decimals: 6,
+        symbol: '',
+      },
+      {
+        donorAccount: '',
+        tokenContract: '',
+        decimals: 6,
+        symbol: '',
+      },
+    ],
+  },
+  ui: {
+    priceChart: 'tradingView',
+    useGradientBranding: false,
+    tradeCount: false,
+    currencyMenu: false,
+    /* ⚠️ If you set it to true, you need to change the content of the page 'src/pages/terms/index.tsx' ⚠️ */
+    showTerms: false,
+    /* ⚠️ If you set it to true, you need to change the content of the page 'src/pages/privacy/index.tsx' ⚠️ */
+    showPrivacy: false,
+  },
+};

src/config/demo/development.ts

@@ -0,0 +1,8 @@
+import { AppConfig } from '../types';
+import { commonConfig } from './common';
+
+const config: AppConfig = {
+  ...commonConfig,
+  mode: 'development',
+};
+export default config;

src/config/demo/production.ts

@@ -0,0 +1,9 @@
+import { AppConfig } from '../types';
+import { commonConfig } from './common';
+
+const config: AppConfig = {
+  ...commonConfig,
+  mode: 'production',
+  sentryDSN: '',
+};
+export default config;

src/config/ethereum/common.ts

@@ -218,5 +218,7 @@ export const commonConfig: AppConfig = {
     useGradientBranding: true,
     tradeCount: false,
     currencyMenu: true,
+    showTerms: true,
+    showPrivacy: true,
   },
 };

src/config/sei/common.ts

@@ -119,5 +119,7 @@ export const commonConfig: AppConfig = {
     useGradientBranding: true,
     tradeCount: true,
     currencyMenu: false,
+    showTerms: true,
+    showPrivacy: true,
   },
 };

src/pages/privacy/index.tsx

@@ -573,6 +573,7 @@ const content = [
 ];
 
 export const PrivacyPage = () => {
+  if (!config.ui.showPrivacy) return;
   return (
     <Page title={'Privacy Policy'}>
       <>

src/pages/terms/index.tsx

@@ -1052,6 +1052,7 @@ const content = [
 ];
 
 export const TermsPage = () => {
+  if (!config.ui.showTerms) return;
   return (
     <Page title="Terms of Use">
       <>