@openocean.finance/widget 1.0.0

package/package.json

@@ -0,0 +1,82 @@
+{
+  "name": "@openocean.finance/widget",
+  "version": "1.0.0",
+  "description": "Openocean Widget for cross-chain bridging and swapping. It will drive your multi-chain strategy and attract new users from everywhere.",
+  "type": "module",
+  "main": "./src/index.ts",
+  "types": "./src/index.d.ts",
+  "sideEffects": false,
+  "scripts": {
+    "watch": "tsc -w -p ./tsconfig.json",
+    "build": "pnpm clean && pnpm build:version && pnpm build:esm && pnpm build:clean",
+    "build:esm": "tsc --build",
+    "build:prerelease": "node ../../scripts/prerelease.js && cpy '../../*.md' .",
+    "build:postrelease": "node ../../scripts/postrelease.js && rm -rf *.md",
+    "build:version": "node ../../scripts/version.js",
+    "build:clean": "rm -rf tsconfig.tsbuildinfo ./dist/tsconfig.tsbuildinfo",
+    "release:build": "pnpm build",
+    "clean": "pnpm build:clean && rm -rf dist",
+    "check:types": "tsc --noEmit",
+    "check:circular-deps": "madge --circular $(find ./src -name '*.ts' -o -name '*.tsx')",
+    "check:circular-deps-graph": "madge --circular $(find ./src -name '*.ts' -o -name '*.tsx') --image graph.svg",
+    "link:bigmi": "pnpm link --global @bigmi/client",
+    "unlink:bigmi": "pnpm link --global @bigmi/client",
+    "link:sdk": "pnpm link --global @openocean.finance/sdk",
+    "unlink:sdk": "pnpm unlink --global @openocean.finance/sdk",
+    "test": "vitest run"
+  },
+  "author": "Eugene Chybisov <@openocean.finance>",
+
+  "license": "Apache-1.0",
+  "keywords": [
+    "widget",
+    "openocean-widget",
+    "bridge",
+    "swap",
+    "cross-chain",
+    "multi-chain",
+    "metamask",
+    "ethereum",
+    "web3",
+    "openocean"
+  ],
+  "dependencies": {
+    "@bigmi/client": "^0.1.1",
+    "@bigmi/core": "^0.1.1",
+    "@emotion/react": "^11.14.0",
+    "@emotion/styled": "^11.14.0",
+    "@lifi/sdk": "3.6.2",
+    "@openocean.finance/wallet-management": "workspace:^",
+    "@mui/icons-material": "6.0.2",
+    "@mui/material": "^6.4.8",
+    "@mui/system": "^6.4.8",
+    "@solana/wallet-adapter-base": "^0.9.24",
+    "@solana/web3.js": "^1.98.0",
+    "@tanstack/react-virtual": "^3.13.4",
+    "i18next": "^24.2.3",
+    "microdiff": "^1.5.0",
+    "mitt": "^3.0.1",
+    "react-i18next": "^15.4.1",
+    "react-intersection-observer": "^9.16.0",
+    "react-router-dom": "^6.30.0",
+    "viem": "^2.23.12",
+    "zustand": "^5.0.3"
+  },
+  "devDependencies": {
+    "cpy-cli": "^5.0.0",
+    "madge": "^8.0.0",
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0",
+    "typescript": "^5.8.2",
+    "vitest": "^3.0.9"
+  },
+  "peerDependencies": {
+    "@bigmi/react": ">=0.1.0",
+    "@solana/wallet-adapter-react": "^0.15.35",
+    "@tanstack/react-query": "^5.62.0",
+    "react": ">=18",
+    "react-dom": ">=18",
+    "wagmi": "^2.14.0"
+  },
+  "files": ["dist/**", "src/**", "!tsconfig.json"]
+}

package/src/App.tsx

@@ -0,0 +1,45 @@
+'use client'
+import { forwardRef, useMemo } from 'react'
+import { AppDefault } from './AppDefault.js'
+import type { WidgetDrawer } from './AppDrawer.js'
+import { AppDrawer } from './AppDrawer.js'
+import { AppProvider } from './AppProvider.js'
+import type { WidgetConfig, WidgetProps } from './types/widget.js'
+
+export const App = forwardRef<WidgetDrawer, WidgetProps>((props, ref) => {
+  const config: WidgetConfig = useMemo(() => {
+    const config = { ...props, ...props.config }
+    if (config.variant === 'drawer') {
+      config.theme = {
+        ...config.theme,
+        container: {
+          height: '100%',
+          ...config.theme?.container,
+        },
+      }
+    }
+    return config
+  }, [props])
+
+  if (config.variant === 'drawer') {
+    return (
+      <AppProvider config={config} formRef={props.formRef}>
+        <AppDrawer
+          ref={ref}
+          elementRef={props.elementRef}
+          config={config}
+          open={props.open}
+          onClose={props.onClose}
+        >
+          <AppDefault />
+        </AppDrawer>
+      </AppProvider>
+    )
+  }
+
+  return (
+    <AppProvider config={config} formRef={props.formRef}>
+      <AppDefault />
+    </AppProvider>
+  )
+})

package/src/AppDefault.tsx

@@ -0,0 +1,33 @@
+'use client'
+import { AppRoutes } from './AppRoutes.js'
+import {
+  AppContainer,
+  AppExpandedContainer,
+  FlexContainer,
+} from './components/AppContainer.js'
+import { Header } from './components/Header/Header.js'
+import { Initializer } from './components/Initializer.js'
+// import { RoutesExpanded } from './components/Routes/RoutesExpanded.js'
+// import { useWideVariant } from './hooks/useWideVariant.js'
+import { useWidgetConfig } from './providers/WidgetProvider/WidgetProvider.js'
+import { ElementId, createElementId } from './utils/elements.js'
+
+export const AppDefault = () => {
+  const { elementId } = useWidgetConfig()
+  // const wideVariant = useWideVariant()
+
+  return (
+    <AppExpandedContainer
+      id={createElementId(ElementId.AppExpandedContainer, elementId)}
+    >
+      <AppContainer>
+        <Header />
+        <FlexContainer disableGutters>
+          <AppRoutes />
+        </FlexContainer>
+        <Initializer />
+      </AppContainer>
+      {/* {wideVariant ? <RoutesExpanded /> : null} */}
+    </AppExpandedContainer>
+  )
+}

package/src/AppDrawer.style.tsx

@@ -0,0 +1,12 @@
+import { IconButton, styled } from '@mui/material'
+
+export const CloseButtonLayout = styled(IconButton)(() => ({
+  position: 'absolute',
+  top: '12px',
+  right: '26px',
+  zIndex: 1,
+  height: '40px',
+  width: '40px',
+  alignItems: 'center',
+  justifyContent: 'center',
+}))

package/src/AppDrawer.tsx

@@ -0,0 +1,96 @@
+import { Drawer } from '@mui/material'
+import type { PropsWithChildren } from 'react'
+import {
+  forwardRef,
+  useCallback,
+  useImperativeHandle,
+  useMemo,
+  useRef,
+  useState,
+} from 'react'
+import type { WidgetDrawerContext } from './AppDrawerContext.js'
+import { DrawerContext } from './AppDrawerContext.js'
+import type { WidgetDrawerProps } from './types/widget.js'
+
+export interface WidgetDrawer {
+  isOpen(): void
+  toggleDrawer(): void
+  openDrawer(): void
+  closeDrawer(): void
+}
+
+export const AppDrawer = forwardRef<
+  WidgetDrawer,
+  PropsWithChildren<WidgetDrawerProps>
+>(({ elementRef, open, onClose, children }, ref) => {
+  const openRef = useRef(Boolean(open))
+  const [drawerOpen, setDrawerOpen] = useState(Boolean(open))
+
+  const toggleDrawer = useCallback(() => {
+    setDrawerOpen((open) => {
+      openRef.current = !open
+      return openRef.current
+    })
+    if (!openRef.current) {
+      onClose?.()
+    }
+  }, [onClose])
+
+  const openDrawer = useCallback(() => {
+    setDrawerOpen(true)
+    openRef.current = true
+  }, [])
+
+  const closeDrawer = useCallback(() => {
+    setDrawerOpen(false)
+    openRef.current = false
+    onClose?.()
+  }, [onClose])
+
+  useImperativeHandle(
+    ref,
+    () => ({
+      isOpen: () => openRef.current,
+      toggleDrawer,
+      openDrawer,
+      closeDrawer,
+    }),
+    [closeDrawer, openDrawer, toggleDrawer]
+  )
+
+  const drawerContext: WidgetDrawerContext = useMemo(
+    () => ({
+      closeDrawer,
+    }),
+    [closeDrawer]
+  )
+
+  return (
+    <DrawerContext.Provider value={drawerContext}>
+      <Drawer
+        ref={elementRef}
+        anchor="right"
+        open={drawerOpen}
+        onClose={closeDrawer}
+        slotProps={{
+          backdrop: {
+            sx: {
+              backgroundColor: 'rgb(0 0 0 / 48%)',
+              backdropFilter: 'blur(3px)',
+            },
+          },
+        }}
+        PaperProps={{
+          sx: (theme) => ({
+            width: theme?.container?.width ?? '100%',
+            minWidth: theme?.container?.minWidth ?? theme.breakpoints.values.xs,
+            maxWidth: theme?.container?.maxWidth ?? theme.breakpoints.values.sm,
+          }),
+        }}
+        keepMounted
+      >
+        {children}
+      </Drawer>
+    </DrawerContext.Provider>
+  )
+})

package/src/AppDrawerContext.ts

@@ -0,0 +1,9 @@
+import { createContext, useContext } from 'react'
+
+export interface WidgetDrawerContext {
+  closeDrawer?(): void
+}
+
+export const DrawerContext = createContext<WidgetDrawerContext>({})
+
+export const useDrawer = (): WidgetDrawerContext => useContext(DrawerContext)

package/src/AppProvider.tsx

@@ -0,0 +1,65 @@
+import { QueryClientProvider } from '@tanstack/react-query'
+import type { PropsWithChildren } from 'react'
+import { Fragment } from 'react'
+import {
+  MemoryRouter,
+  type MemoryRouterProps,
+  useInRouterContext,
+} from 'react-router-dom'
+import { PageEntered } from './components/PageEntered.js'
+import { queryClient } from './config/queryClient.js'
+import { I18nProvider } from './providers/I18nProvider/I18nProvider.js'
+import { ThemeProvider } from './providers/ThemeProvider/ThemeProvider.js'
+import { WalletProvider } from './providers/WalletProvider/WalletProvider.js'
+import {
+  WidgetProvider,
+  useWidgetConfig,
+} from './providers/WidgetProvider/WidgetProvider.js'
+import { StoreProvider } from './stores/StoreProvider.js'
+import { URLSearchParamsBuilder } from './stores/form/URLSearchParamsBuilder.js'
+import type { WidgetConfigProps } from './types/widget.js'
+
+export const AppProvider: React.FC<PropsWithChildren<WidgetConfigProps>> = ({
+  children,
+  config,
+  formRef,
+}) => {
+  return (
+    <QueryClientProvider client={queryClient}>
+      <WidgetProvider config={config}>
+        <I18nProvider>
+          <ThemeProvider>
+            <WalletProvider>
+              <StoreProvider config={config} formRef={formRef}>
+                <AppRouter>{children}</AppRouter>
+              </StoreProvider>
+            </WalletProvider>
+          </ThemeProvider>
+        </I18nProvider>
+      </WidgetProvider>
+    </QueryClientProvider>
+  )
+}
+
+const memoryRouterProps: MemoryRouterProps = {
+  future: {
+    v7_startTransition: true,
+    v7_relativeSplatPath: true,
+  },
+}
+
+export const AppRouter: React.FC<PropsWithChildren> = ({ children }) => {
+  const { buildUrl } = useWidgetConfig()
+  const inRouterContext = useInRouterContext()
+  const Router = inRouterContext ? Fragment : MemoryRouter
+
+  const routerProps = inRouterContext ? undefined : memoryRouterProps
+
+  return (
+    <Router {...routerProps}>
+      {children}
+      {buildUrl ? <URLSearchParamsBuilder /> : null}
+      <PageEntered />
+    </Router>
+  )
+}

package/src/AppRoutes.tsx

@@ -0,0 +1,112 @@
+import type { RouteObject } from 'react-router-dom'
+import { useRoutes } from 'react-router-dom'
+import { NotFound } from './components/NotFound.js'
+import { ActiveTransactionsPage } from './pages/ActiveTransactionsPage/ActiveTransactionsPage.js'
+import { LanguagesPage } from './pages/LanguagesPage.js'
+import { MainPage } from './pages/MainPage/MainPage.js'
+import { RoutesPage } from './pages/RoutesPage/RoutesPage.js'
+import { SelectChainPage } from './pages/SelectChainPage/SelectChainPage.js'
+import { SelectEnabledToolsPage } from './pages/SelectEnabledToolsPage.js'
+import { SelectTokenPage } from './pages/SelectTokenPage/SelectTokenPage.js'
+import { BookmarksPage } from './pages/SendToWallet/BookmarksPage.js'
+import { ConnectedWalletsPage } from './pages/SendToWallet/ConnectedWalletsPage.js'
+import { RecentWalletsPage } from './pages/SendToWallet/RecentWalletsPage.js'
+import { SendToConfiguredWalletPage } from './pages/SendToWallet/SendToConfiguredWalletPage.js'
+import { SendToWalletPage } from './pages/SendToWallet/SendToWalletPage.js'
+import { SettingsPage } from './pages/SettingsPage/SettingsPage.js'
+import { TransactionDetailsPage } from './pages/TransactionDetailsPage/TransactionDetailsPage.js'
+import { TransactionHistoryPage } from './pages/TransactionHistoryPage/TransactionHistoryPage.js'
+import { TransactionPage } from './pages/TransactionPage/TransactionPage.js'
+import { navigationRoutes } from './utils/navigationRoutes.js'
+
+const routes: RouteObject[] = [
+  {
+    path: '/',
+    element: <MainPage />,
+  },
+  {
+    path: navigationRoutes.settings,
+    element: <SettingsPage />,
+  },
+  {
+    path: `${navigationRoutes.settings}/${navigationRoutes.bridges}`,
+    element: <SelectEnabledToolsPage type="Bridges" />,
+  },
+  {
+    path: `${navigationRoutes.settings}/${navigationRoutes.exchanges}`,
+    element: <SelectEnabledToolsPage type="Exchanges" />,
+  },
+  {
+    path: `${navigationRoutes.settings}/${navigationRoutes.languages}`,
+    element: <LanguagesPage />,
+  },
+  {
+    path: navigationRoutes.fromToken,
+    element: <SelectTokenPage formType="from" />,
+  },
+  {
+    path: navigationRoutes.toToken,
+    element: <SelectTokenPage formType="to" />,
+  },
+  {
+    path: navigationRoutes.toTokenNative,
+    element: <SelectChainPage formType="to" selectNativeToken />,
+  },
+  {
+    path: `${navigationRoutes.fromToken}?/${navigationRoutes.fromChain}`,
+    element: <SelectChainPage formType="from" />,
+  },
+  {
+    path: `${navigationRoutes.toToken}?/${navigationRoutes.toChain}`,
+    element: <SelectChainPage formType="to" />,
+  },
+  {
+    path: navigationRoutes.routes,
+    element: <RoutesPage />,
+  },
+  {
+    path: navigationRoutes.activeTransactions,
+    element: <ActiveTransactionsPage />,
+  },
+  {
+    path: navigationRoutes.sendToWallet,
+    element: <SendToWalletPage />,
+  },
+  {
+    path: `${navigationRoutes.sendToWallet}/${navigationRoutes.bookmarks}`,
+    element: <BookmarksPage />,
+  },
+  {
+    path: `${navigationRoutes.sendToWallet}/${navigationRoutes.recentWallets}`,
+    element: <RecentWalletsPage />,
+  },
+  {
+    path: `${navigationRoutes.sendToWallet}/${navigationRoutes.connectedWallets}`,
+    element: <ConnectedWalletsPage />,
+  },
+  {
+    path: navigationRoutes.configuredWallets,
+    element: <SendToConfiguredWalletPage />,
+  },
+  {
+    path: navigationRoutes.transactionHistory,
+    element: <TransactionHistoryPage />,
+  },
+  {
+    path: `${navigationRoutes.transactionHistory}?/${navigationRoutes.routes}?/${navigationRoutes.transactionExecution}?/${navigationRoutes.transactionDetails}`,
+    element: <TransactionDetailsPage />,
+  },
+  {
+    path: `${navigationRoutes.routes}?/${navigationRoutes.activeTransactions}?/${navigationRoutes.transactionExecution}`,
+    element: <TransactionPage />,
+  },
+  {
+    path: '*',
+    element: <NotFound />,
+  },
+]
+
+export const AppRoutes = () => {
+  const element = useRoutes(routes)
+  return element
+}

package/src/components/ActiveTransactions/ActiveTransactionItem.tsx

@@ -0,0 +1,105 @@
+import { ArrowForward, ErrorRounded, InfoRounded } from '@mui/icons-material'
+import { ListItemAvatar, ListItemText, Typography } from '@mui/material'
+import { useNavigate } from 'react-router-dom'
+import { useProcessMessage } from '../../hooks/useProcessMessage.js'
+import { useRouteExecution } from '../../hooks/useRouteExecution.js'
+import { RouteExecutionStatus } from '../../stores/routes/types.js'
+import { navigationRoutes } from '../../utils/navigationRoutes.js'
+import { TokenAvatarGroup } from '../Avatar/Avatar.style.js'
+import { TokenAvatar } from '../Avatar/TokenAvatar.js'
+import { RouteTimer } from '../Timer/RouteTimer.js'
+import { ListItem, ListItemButton } from './ActiveTransactions.style.js'
+
+export const ActiveTransactionItem: React.FC<{
+  routeId: string
+  dense?: boolean
+}> = ({ routeId, dense }) => {
+  const navigate = useNavigate()
+  const { route, status } = useRouteExecution({
+    routeId,
+    executeInBackground: true,
+  })
+
+  const lastActiveStep = route?.steps.findLast((step) => step.execution)
+  const lastActiveProcess = lastActiveStep?.execution?.process.at(-1)
+
+  const { title } = useProcessMessage(lastActiveStep, lastActiveProcess)
+
+  if (!route || !lastActiveStep) {
+    return null
+  }
+
+  const handleClick = () => {
+    navigate(navigationRoutes.transactionExecution, { state: { routeId } })
+  }
+
+  const getStatusComponent = () => {
+    switch (lastActiveProcess?.status) {
+      case 'ACTION_REQUIRED':
+        return <InfoRounded color="info" fontSize="small" />
+      case 'FAILED':
+        return <ErrorRounded color="error" fontSize="small" />
+      default:
+        return (
+          <Typography
+            sx={{
+              fontSize: 14,
+              fontWeight: 600,
+            }}
+          >
+            <RouteTimer route={route} />
+          </Typography>
+        )
+    }
+  }
+
+  const ListItemComponent = dense ? ListItem : ListItemButton
+
+  return (
+    <ListItemComponent onClick={handleClick} dense disableRipple={dense}>
+      <ListItemAvatar>
+        <TokenAvatarGroup total={2}>
+          <TokenAvatar token={route.fromToken} />
+          <TokenAvatar token={route.toToken} />
+        </TokenAvatarGroup>
+      </ListItemAvatar>
+      <ListItemText
+        sx={{ margin: 0 }}
+        disableTypography
+        primary={
+          <Typography
+            sx={{
+              fontWeight: 500,
+              lineHeight: 1,
+              display: 'flex',
+              alignItems: 'center',
+              marginLeft: 2,
+              height: 16,
+            }}
+          >
+            {route.fromToken.symbol}
+            <ArrowForward sx={{ paddingX: 0.5 }} />
+            {route.toToken.symbol}
+          </Typography>
+        }
+        secondary={
+          status !== RouteExecutionStatus.Done ? (
+            <Typography
+              sx={{
+                fontWeight: 400,
+                fontSize: 12,
+                color: 'text.secondary',
+                lineHeight: 1,
+                mt: 0.75,
+                ml: 2,
+              }}
+            >
+              {title}
+            </Typography>
+          ) : null
+        }
+      />
+      {getStatusComponent()}
+    </ListItemComponent>
+  )
+}

package/src/components/ActiveTransactions/ActiveTransactions.style.ts

@@ -0,0 +1,39 @@
+import {
+  Button,
+  ListItem as MuiListItem,
+  ListItemButton as MuiListItemButton,
+  listItemSecondaryActionClasses,
+  styled,
+} from '@mui/material'
+import { getContrastAlphaColor } from '../../utils/colors.js'
+
+export const ListItemButton = styled(MuiListItemButton)(({ theme }) => ({
+  borderRadius: theme.shape.borderRadius,
+  paddingLeft: theme.spacing(1.5),
+  paddingRight: theme.spacing(1.5),
+  height: 64,
+  '&:hover': {
+    backgroundColor: getContrastAlphaColor(theme, 0.04),
+  },
+}))
+
+export const ListItem = styled(MuiListItem, {
+  shouldForwardProp: (prop) => prop !== 'disableRipple',
+})(({ theme }) => ({
+  padding: theme.spacing(0, 2),
+  [`.${listItemSecondaryActionClasses.root}`]: {
+    right: theme.spacing(3),
+  },
+  '&:hover': {
+    cursor: 'pointer',
+  },
+}))
+
+export const ShowAllButton = styled(Button)(({ theme }) => ({
+  background: 'none',
+  '&:hover': {
+    background: 'none',
+  },
+  padding: theme.spacing(0.75, 2),
+  fontSize: '0.875rem',
+}))

package/src/components/ActiveTransactions/ActiveTransactions.tsx

@@ -0,0 +1,48 @@
+import type { CardProps } from '@mui/material'
+import { Stack } from '@mui/material'
+import { useTranslation } from 'react-i18next'
+import { useNavigate } from 'react-router-dom'
+import { useExecutingRoutesIds } from '../../stores/routes/useExecutingRoutesIds.js'
+import { navigationRoutes } from '../../utils/navigationRoutes.js'
+import { Card } from '../Card/Card.js'
+import { CardTitle } from '../Card/CardTitle.js'
+import { ActiveTransactionItem } from './ActiveTransactionItem.js'
+import { ShowAllButton } from './ActiveTransactions.style.js'
+
+export const ActiveTransactions: React.FC<CardProps> = (props) => {
+  const { t } = useTranslation()
+  const navigate = useNavigate()
+  const executingRoutes = useExecutingRoutesIds()
+
+  if (!executingRoutes?.length) {
+    return null
+  }
+
+  const handleShowAll = () => {
+    navigate(navigationRoutes.activeTransactions)
+  }
+
+  const hasShowAll = executingRoutes?.length > 2
+
+  return (
+    <Card type="selected" selectionColor="secondary" {...props}>
+      <CardTitle>{t('header.activeTransactions')}</CardTitle>
+      <Stack
+        spacing={1.5}
+        sx={{
+          pt: 1.5,
+          pb: hasShowAll ? 0 : 2,
+        }}
+      >
+        {executingRoutes.slice(0, 2).map((routeId) => (
+          <ActiveTransactionItem key={routeId} routeId={routeId} dense />
+        ))}
+      </Stack>
+      {hasShowAll ? (
+        <ShowAllButton disableRipple fullWidth onClick={handleShowAll}>
+          {t('button.showAll')}
+        </ShowAllButton>
+      ) : null}
+    </Card>
+  )
+}