Merge pull request #4243 from ethereum/add_template

Add uniswap template

apps/remix-ide-e2e/src/tests/workspace_git.test.ts

@@ -339,6 +339,36 @@ module.exports = {
     .waitForElementVisible('[data-id="treeViewDivtreeViewItemrecursive/plugins/build"]')
   },
 
+   // GIT SUBMODULES E2E ENDS
+
+   // GIT WORKSPACE E2E STARTS
+
+   'Should create a git workspace (uniswapV4Periphery) #group4': function (browser: NightwatchBrowser) {
+    browser
+      .click('*[data-id="workspacesMenuDropdown"]')
+      .click('*[data-id="workspacecreate"]')
+      .waitForElementVisible('*[data-id="modalDialogCustomPromptTextCreate"]')
+      .waitForElementVisible('[data-id="fileSystemModalDialogModalFooter-react"] > button')
+      .click('select[id="wstemplate"]')
+      .click('select[id="wstemplate"] option[value=uniswapV4Periphery]')
+      .waitForElementPresent('[data-id="fileSystemModalDialogModalFooter-react"] .modal-ok')
+      .execute(function () { (document.querySelector('[data-id="fileSystemModalDialogModalFooter-react"] .modal-ok') as HTMLElement).click() })
+      .pause(100)
+      .waitForElementVisible('*[data-id="treeViewLitreeViewItemcontracts"]')
+      .openFile('contracts')
+      .openFile('contracts/hooks')
+      .openFile('contracts/hooks/examples')
+      .openFile('contracts/hooks/examples/FullRange.sol')
+      .pause(1000)
+      .getEditorValue((content) => {
+        browser.assert.ok(content.indexOf(`contract FullRange is BaseHook`) !== -1,
+          'Incorrect content')
+      })
+  }, 
+
+  // GIT WORKSPACE E2E ENDS
+
+
   tearDown: sauce,
 }
 

apps/remix-ide/src/app/tabs/locales/en/filePanel.json

@@ -106,6 +106,8 @@
   "filePanel.semaphore": "Semaphore",
   "filePanel.hashchecker": "Hash Checker",
   "filePanel.rln": "Rate-Limiting Nullifier",
+  "filePanel.breakthroughLabsUniswapv4Hooks": "Breakthrough-Labs Uniswapv4Hooks",
+  "filePanel.uniswapV4Periphery": "Uniswap v4 Periphery",
   "filePanel.transparent": "Transparent",
   "filePanel.initGitRepoTitle": "Check option to initialize workspace as a new git repository",
   "filePanel.switchToBranchTitle1": "Checkout new branch from remote branch",

libs/remix-ui/home-tab/src/lib/components/homeTabGetStarted.tsx

@@ -1,7 +1,7 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
 import React, {useEffect, useRef, useContext} from 'react'
 import {useIntl, FormattedMessage} from 'react-intl'
-import {TEMPLATE_NAMES} from '@remix-ui/workspace'
+import {TEMPLATE_NAMES,TEMPLATE_METADATA} from '@remix-ui/workspace'
 import {ThemeContext} from '../themeContext'
 import Carousel from 'react-multi-carousel'
 import WorkspaceTemplate from './workspaceTemplate'
@@ -58,9 +58,13 @@ function HomeTabGetStarted({plugin}: HomeTabGetStartedProps) {
   }
 
   const createWorkspace = async (templateName) => {
-    await plugin.appManager.activatePlugin('filePanel')
-    const timeStamp = Date.now()
     let templateDisplayName = TEMPLATE_NAMES[templateName]
+    const metadata = TEMPLATE_METADATA[templateName]
+    if (metadata) {
+      await plugin.call('dGitProvider', 'clone', {url: metadata.url, branch: metadata.branch}, templateDisplayName)
+      return
+    }
+    await plugin.appManager.activatePlugin('filePanel')    
     templateDisplayName = await plugin.call('filePanel', 'getAvailableWorkspaceName', templateDisplayName)
     await plugin.call('filePanel', 'createWorkspace', templateDisplayName, templateName)
     await plugin.call('filePanel', 'setWorkspace', templateDisplayName)

libs/remix-ui/workspace/src/lib/actions/workspace.ts

@@ -1,6 +1,7 @@
 import React from 'react'
 import { bufferToHex } from '@ethereumjs/util'
 import { hash } from '@remix-project/remix-lib'
+import { TEMPLATE_METADATA, TEMPLATE_NAMES } from '../utils/constants'
 import axios, { AxiosResponse } from 'axios'
 import {
   addInputFieldSuccess,
@@ -190,10 +191,13 @@ export const createWorkspace = async (
 }
 
 export const createWorkspaceTemplate = async (workspaceName: string, template: WorkspaceTemplate = 'remixDefault') => {
+  const metadata = TEMPLATE_METADATA[template]
   if (!workspaceName) throw new Error('workspace name cannot be empty')
   if (checkSpecialChars(workspaceName) || checkSlash(workspaceName)) throw new Error('special characters are not allowed')
   if ((await workspaceExists(workspaceName)) && template === 'remixDefault') throw new Error('workspace already exists')
-  else {
+  else if (metadata) {
+    await plugin.call('dGitProvider', 'clone', {url: metadata.url, branch: metadata.branch}, workspaceName)
+  } else {
     const workspaceProvider = plugin.fileProviders.workspace
     await workspaceProvider.createWorkspace(workspaceName)
   }

libs/remix-ui/workspace/src/lib/remix-ui-workspace.tsx

@@ -757,8 +757,15 @@ export function Workspace() {
               {intl.formatMessage({id: 'filePanel.rln'})}
             </option>
           </optgroup>
+          <optgroup style={{fontSize: 'medium'}} label="Uniswap">
+            <option style={{fontSize: 'small'}} value="uniswapV4Periphery">
+              {intl.formatMessage({id: 'filePanel.uniswapV4Periphery'})}
+            </option>
+            <option style={{fontSize: 'small'}} value="breakthroughLabsUniswapv4Hooks">
+              {intl.formatMessage({id: 'filePanel.breakthroughLabsUniswapv4Hooks'})}
+            </option>           
+          </optgroup>
         </select>
-
         <div id="ozcustomization" data-id="ozCustomization" ref={displayOzCustomRef} style={{display: 'none'}} className="mb-2">
           <label className="form-check-label d-block mb-2" style={{fontWeight: 'bolder'}}>
             <FormattedMessage id="filePanel.customizeTemplate" />

libs/remix-ui/workspace/src/lib/types/index.ts

@@ -17,7 +17,7 @@ export interface JSONStandardInput {
   }
 }
 export type MenuItems = action[]
-export type WorkspaceTemplate = 'gist-template' | 'code-template' | 'remixDefault' | 'blank' | 'ozerc20' | 'zeroxErc20' | 'ozerc721' | 'playground' | 'semaphore' | 'hashchecker' | 'rln'
+export type WorkspaceTemplate = 'gist-template' | 'code-template' | 'remixDefault' | 'blank' | 'ozerc20' | 'zeroxErc20' | 'ozerc721' | 'playground' | 'semaphore' | 'hashchecker' | 'rln' | 'breakthroughLabsUniswapv4Hooks' | 'uniswapV4Periphery'
 export interface WorkspaceProps {
   plugin: FilePanelType
 }

libs/remix-ui/workspace/src/lib/utils/constants.ts

@@ -84,5 +84,18 @@ export const TEMPLATE_NAMES = {
   'playground': 'Playground',
   'semaphore': 'Semaphore',
   'hashchecker': 'Hash Checker',
-  'rln': 'Rate-Limiting Nullifier'
+  'rln': 'Rate-Limiting Nullifier',
+  'breakthroughLabsUniswapv4Hooks': 'Breakthrough-Labs Uniswapv4Hooks',
+  'uniswapV4Periphery': 'Uniswap v4 Periphery',
+}
+
+export const TEMPLATE_METADATA = {
+  'breakthroughLabsUniswapv4Hooks': {
+    url: 'https://github.com/Breakthrough-Labs/Uniswapv4Hooks',
+    branch: 'foundry_pure'
+  },
+  'uniswapV4Periphery': {
+    url: 'https://github.com/Uniswap/v4-periphery',
+    branch: 'main'
+  }
 }