Skip to content

Commit

Permalink
init
Browse files Browse the repository at this point in the history
  • Loading branch information
Николай Скиба authored and Николай Скиба committed Jun 1, 2024
0 parents commit 73ea078
Show file tree
Hide file tree
Showing 1,330 changed files with 394,808 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
*/**/node_modules/
node_modules/
.yarn
58 changes: 58 additions & 0 deletions .gitlab-ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
stages:
- frontend
- backend
- contracts

frontend:
stage: frontend
trigger:
include: $FRONTEND_DIR/.gitlab-ci.yml
strategy: depend

backend_rwa:
stage: backend
trigger:
include: $BACKEND_DIR/.gitlab-ci.yml
strategy: depend

backend_usdt:
stage: backend
variables:
BACKEND_URL_PREFIX: "usdt-"
BACKEND_DIR: backend-usdt
trigger:
include: $BACKEND_DIR/.gitlab-ci.yml
strategy: depend

backend_usdc:
stage: backend
variables:
BACKEND_URL_PREFIX: "usdc-"
BACKEND_DIR: backend-usdc
trigger:
include: $BACKEND_DIR/.gitlab-ci.yml
strategy: depend

backend_wnt:
stage: backend
variables:
BACKEND_URL_PREFIX: "wnt-"
BACKEND_DIR: backend-wnt
trigger:
include: $BACKEND_DIR/.gitlab-ci.yml
strategy: depend

backend_weth:
stage: backend
variables:
BACKEND_URL_PREFIX: "weth-"
BACKEND_DIR: backend-weth
trigger:
include: $BACKEND_DIR/.gitlab-ci.yml
strategy: depend

contracts:
stage: contracts
trigger:
include: $CONTRACTS_DIR/.gitlab-ci.yml
strategy: depend
93 changes: 93 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
# xend-multitoken



## Getting started

To make it easy for you to get started with GitLab, here's a list of recommended next steps.

Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!

## Add your files

- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:

```
cd existing_repo
git remote add origin https://gitlab.com/gotbitio/blockchain/a-team/frontend-wl/xend-multitoken.git
git branch -M main
git push -uf origin main
```

## Integrate with your tools

- [ ] [Set up project integrations](https://gitlab.com/gotbitio/blockchain/a-team/frontend-wl/xend-multitoken/-/settings/integrations)

## Collaborate with your team

- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)

## Test and Deploy

Use the built-in continuous integration in GitLab.

- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)

***

# Editing this README

When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.

## Suggestions for a good README

Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.

## Name
Choose a self-explaining name for your project.

## Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.

## Badges
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.

## Visuals
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.

## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.

## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.

## Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.

## Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.

## Contributing
State if you are open to contributions and what your requirements are for accepting them.

For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.

You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.

## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.

## License
For open source projects, say how it is licensed.

## Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
8 changes: 8 additions & 0 deletions backend-usdc/.dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
node_modules/
dist/

.gitignore
.git/
.env
.env.local

3 changes: 3 additions & 0 deletions backend-usdc/.env.examle
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
PROD=false
PRIVATE_KEY="7eb433edd85f1774c4a15f460e822071729b6177bdb2418f67e3d9e50c773d2a"
VITE_BACKEND_LINK="https://gotbit-xend-multitoken-backend-dev.dev.gotbit.app"
4 changes: 4 additions & 0 deletions backend-usdc/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
dist/
.env
node_modules/
coverage
26 changes: 26 additions & 0 deletions backend-usdc/.gitlab-ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
stages:
- test
- build
- deploy

# variables:
# SKIP_COMPONENTS_TEST: 'true'
# SKIP_BUILD_TEST: 'true'
# SKIP_TYPECHECK_TEST: 'true'

include:
- project: '$DEVOPS_PROJECT_PATH'
ref: 'main'
file: 'gitlabci/build/backend/.gitlab-ci.yml'

- project: '$DEVOPS_PROJECT_PATH'
ref: 'main'
file: 'clients/build/backend/aws/.gitlab-ci.yml'

- project: '$DEVOPS_PROJECT_PATH'
ref: 'main'
file: 'gitlabci/deploy/backend/.gitlab-ci.yml'

- project: '$DEVOPS_PROJECT_PATH'
ref: 'main'
file: 'gitlabci/test/backend/.gitlab-ci.yml'
14 changes: 14 additions & 0 deletions backend-usdc/.prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"semi": false,
"printWidth": 90,
"singleQuote": true,
"overrides": [
{
"files": "*.sol",
"options": {
"printWidth": 90,
"tabWidth": 4
}
}
]
}
15 changes: 15 additions & 0 deletions backend-usdc/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
FROM node:16

ARG PROD
ARG PRIVATE_KEY
COPY package.json ./
COPY yarn.lock ./

RUN yarn

COPY . .
RUN yarn build


EXPOSE 3000
CMD yarn serve
108 changes: 108 additions & 0 deletions backend-usdc/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
# CREO Bridge backend

## Description

Bridge is a decentralized application that consists of front-end, back-end, and smart contracts on every blockchain network used in the Bridge.


## Getting Started

Recommended Node version is 16.20.0.

Generate `.env` file

```bash
$ cp .env.example .env
```

Add .env file to the project root.

To add the private key of a relayer account, assign the following variable and add `PROD` variable (`true` to setup mainnet or `false` to setup testnet)

```
PRIVATE_KEY=
PROD=
```

```bash
$ yarn
$ yarn build
$ yarn serve
```

## Project Structure

This a typescript backend with `express`.

This backend does not use the database and does not listen to events

Endpoint `/transactions` receiving the user's address from the frontend at the moment of request runs through all used networks and gets the user's transactions using the `getUserTransactions()` function on the contract. After that, the backend finds pairs among them, which indicates that the transaction is labeled and the remaining transactions are not picked up on the destined networks. Having received the final list of transactions, the backend gives them to the frontend

Endpoint `/sign` receiving as input the parameters
`fromChain: string`,
`fromUser: string`,
`index: string`
finds the required transaction on the source network, checks that the required number of confirmation blocks has passed and if the check has passed, signs it and returns it to the user.

### Contracts

Smart contracts abis are found in `./src/contracts/contracts.json`.

### Confirmations blocks

List of amount confirmations block are found in `./src/confirmations.json`.
You can change them by replace `0` to anoter number for the corresponding chainId.

For example if you set `"1": 15` - after send to Ethereum mainnet you need to wait `15` blocks before `claim`

### Endpoints

/transactions - get all transactions by user
params:
user - address

/sign - get signature of selected transaction
params:
fromChain - source chain (evm.1)
fromUser - sender address
index - tx index

/health - check server health

### Backend structure

This is a backend written in typesctipt using gotbit tools template.

You have 2 environment variables that must be defined in the .env file.

All networks, contracts and rpc supported by the project are defined in the ./src/gotbit-config.ts file.

There are 2 sets of rpc "universalRpc" and "extraRpc".
The first set is defined in src/gotbit-tools/node/rpc.ts
The second is defined in src/gotbit-tools/node/utils/node.ts
You can change them as you wish

All endpoints are located in the src/routes folder

There is also a file confirmations.json in which the number of confirmations blocks for each chainId is defined.
You can increase the number of confirmations blocks to prevent frontrunner attacks.
Increasing the number of blocks will allow the user to pick up the money on the receiving network only after it has passed.


You can see more details about gotbit-tools in /frontend/src/gotbit-tools/README.md

### Security

Вo not show the private key used to sign transactions to anyone.
If an intruder gets this key, he can sign a fake transaction with it and withdraw all the money from your bridge.

### Scheme

![alt text](https://github.com/gotbitlabs/creo-bridge/blob/main/bridge_scheme.jpg?raw=true)







13 changes: 13 additions & 0 deletions backend-usdc/docker/backend.dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
FROM node:16

COPY package.json ./
COPY yarn.lock ./

RUN yarn

COPY . .
RUN yarn build


EXPOSE 3000
CMD yarn serve
Loading

0 comments on commit 73ea078

Please sign in to comment.