The Boba Gateway helps users to bridge cryptos tokens from L1 to L2 and vice versa.
Follow these instructions to set up your local development environment.
Clone the repo
$ git clone [email protected]:bobanetwork/gateway.git
$ cd gatewayYou'll need the following:
Ensure that you have installed and are using nodejs v16.16.0:
$ node --version
v16.16.0If you have multiple versions of node installed and use nvm, ensure you are using nodejs v16.16.0
$ nvm useInstall nodejs packages with yarn:
$ yarn
$ yarn prepare # to setup husky on your local.Copy .env.example file and name by excluding .example and populate the variables listed below
| Environment Vars | Required | Default Value | Description |
|---|---|---|---|
| REACT_APP_POLL_INTERVAL | Yes | 20000 | Interval to poll the fetch API about the records |
| REACT_APP_WALLET_VERSION | Yes | N/A | This will be useful while preparing the build. |
| REACT_APP_ENV | Yes | dev | This will be used for Sentry configuration. |
| REACT_APP_GA4_MEASUREMENT_ID | Yes | N/A | Google Analytics API key |
| REACT_APP_SENTRY_DSN | Yes | N/A | Sentry DSN URL to catch errors on the frontend |
| REACT_APP_GAS_POLL_INTERVAL | Yes | 30000 | Poll interval to fetch the gas price status |
| REACT_APP_WC_PROJECT_ID | Yes | N/A | Wallet Connect project ID |
| NETWORK_NAME | Yes | sepolia | Starting network for the wallet |
| REACT_APP_THE_GRAPH_API_KEY | Yes | N/A | API key for the graph application to fetch data from the subgraph |
| REACT_APP_ONRAMP_APP_URL | Yes | N/A | On ramp network widget url |
| REACT_APP_ONRAMP_API_KEY | Yes | N/A | API key for onramp.network |
$ yarn start$ yarn format:fix$ yarn lint:fixTests are executed via yarn:
$ yarn testRun specific tests by giving a path to the file you want to run:
$ yarn test ./path-to-file/file.spec.tsWatch for test file change with coverage report locally at same time.
$ yarn test:w <path-to-test-file> --coverage --collectCoverageFrom=<path-to-component/class>
eg.
$ yarn test:w src/components/layout/Footer/GasWatcher/index.test.tsx --coverage --collectCoverageFrom=src/components/layout/Footer/GasWatcher/index.tsx
$ yarn test:coverageThe output is most easily viewable by opening the html file in your browser:
$ open ./coverage/index.html┌── .github/workflows # Settings for GitHub Actions
├── .vscode # VSCode settings for ESLint auto-fix function
├── build # Bundled JS and TS declaration file for deployed npm package
├── public # Public file which
├── e2e-tests # Integration tests.
├── src # All source code
│ ├── src/actions # Redux Actions.
│ ├── src/api # React axios instance of api
│ ├── src/assets # React assets includes files and images.
│ ├── src/components # React components
│ ├── src/containers # React containers
│ ├── src/deployment # Contracts ABI
│ ├── src/fonts # Application fonts
│ ├── src/hooks # React hooks
│ ├── src/layout # React Layout
│ ├── src/reducers # Redux reducers
│ ├── src/selectors # Redux selectors
│ ├── src/services # React services
│ ├── src/store # Redux Store
│ ├── src/themes # Application theme
│ ├── src/types # Custom typings for js modules if corresponding types are not found
│ ├── src/util # Util files
│ └── index.tsx # Production entry that exports all components
├── .babelrc.json # babel configuration
├── .env.example # Sample env file
├── .eslintignore # Excluded files for ignoring Eslint
├── .eslintrc.js # ESLint settings
├── .gitignore # Excluded files for ignoring Git version control
├── .prettierignore # Excluded files for ignoring while running Prettier
├── .prettierrc.js # Prettier settings
├── README.md # README
├── yarn.json # Package settings that locked the version of dependencies packages
├── package.json # Package settings that listed dependencies packages, npm scripts, project name etc.
├── config-overrides.js # settings for react app rewired
└── tsconfig.json # TypeScript settings
We are following branch names like <type>/<issue>-<change-hint>
# Type can be one of the following
add/ #adding new stuff
feat/ #adding new feature
chore/ #refactoring, removing, cleanup or documentation update
fix/ #fix for breaking changesexample
add/14-includes-readmeInstall boba network contracts and core contracts node packages.
yarn add @bobanetwork/core_contracts bobanetwork/contracts
node ./bin/abiCompressor.ts