https://github.com/bobanetwork/gateway
Frontend to Boba Network
https://github.com/bobanetwork/gateway
Last synced: 6 months ago
JSON representation
Frontend to Boba Network
- Host: GitHub
- URL: https://github.com/bobanetwork/gateway
- Owner: bobanetwork
- Created: 2023-09-26T12:20:21.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-18T16:39:40.000Z (6 months ago)
- Last Synced: 2024-11-18T17:58:06.203Z (6 months ago)
- Language: TypeScript
- Homepage: https://gateway.boba.network/
- Size: 6.67 MB
- Stars: 5
- Watchers: 4
- Forks: 4
- Open Issues: 12
-
Metadata Files:
- Readme: readme.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
Boba Gateway
The Boba Gateway helps users to bridge cryptos tokens from L1 to L2 and vice versa.
# Coverage report
# Contributing
Follow these instructions to set up your local development environment.
## :rocket: Getting started
Clone the repo
```bash
$ git clone [email protected]:bobanetwork/gateway.git
$ cd gateway
```
## Dependencies
You'll need the following:
- [Git](https://git-scm.com/downloads)
- [NodeJS](https://nodejs.org/en/download/)
- [Yarn](https://classic.yarnpkg.com/en/docs/install)
Ensure that you have installed and are using nodejs v16.16.0:
```bash
$ node --version
v16.16.0
```
If you have multiple versions of node installed and use nvm, ensure you are using nodejs v16.16.0
```bash
$ nvm use
```
Install nodejs packages with `yarn`:
```bash
$ yarn
$ yarn prepare # to setup husky on your local.
```
## Environment variable configuration.
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 |
### To start local dev-server
```bash
$ yarn start
```
### To fix formating
```bash
$ yarn format:fix
```
### To fix linting
```bash
$ yarn lint:fix
```
## Running Tests
Tests are executed via `yarn`:
```shell
$ yarn test
```
Run specific tests by giving a path to the file you want to run:
```shell
$ yarn test ./path-to-file/file.spec.ts
```
Watch for test file change with coverage report locally at same time.
```bash
$ yarn test:w --coverage --collectCoverageFrom=
```
eg.
```bash
$ yarn test:w src/components/layout/Footer/GasWatcher/index.test.tsx --coverage --collectCoverageFrom=src/components/layout/Footer/GasWatcher/index.tsx
```
## Measuring test coverage:
```bash
$ yarn test:coverage
```
The output is most easily viewable by opening the html file in your browser:
```bash
$ open ./coverage/index.html
```
## Integration Tests
[Follow Integration Docs](./e2e-tests/README.md)
## Directory Structure
```
┌── .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
```
## Naming branches
We are following branch names like `/-`
```shell
# 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 changes
```
example
```shell
add/14-includes-readme
```
## Abi to Human readable abi.
Install boba network contracts and core contracts node packages.
```shell
yarn add @bobanetwork/core_contracts bobanetwork/contracts
```
```shell
node ./bin/abiCompressor.ts
```