nony0007/OrbiterModule

Orbiter Module

Statement

• Orbiter Module is quick developmenting, If you find a problem, please send a new issue
• The risk of using this software will be entirely borne by him, and the author of the software (Orbiter Module) does not bear any responsibility.
• The author of the software (Orbiter Module) does not bear any responsibility for service interruption or other defects caused by force majeure or uncontrollable reasons such as hacker attacks, communication line interruption, etc., which cause users to be unable to use normally, but will try to reduce the resulting damage to users(Loss or impact).
• For issues not covered by this statement, please refer to the relevant national laws and regulations. When this statement conflicts with the relevant national laws and regulations, the national laws and regulations shall prevail.

Project

• OrbitalModule has been deployed and will be open-source soon.
• A Docker project is written in js, deployed in the EC2 server, and has no external exposed port.
• It is always online and responds to the Sender’s needs via RPC data. It is a tool provided to Navigator.

Functional

• Running this project requires setting the necessary parameters, such as localProvider and localWSProvider, which support each rollup node.

• By configuring the parameters, the project can realize the economic and time savings that users can make by Orbiter when configuring the rollup dynamics. After the user initiates payment through the front-end wallet, it will monitor the transaction data of each rollup in real time and feed back the real-time status of the user's cross-rollup transfer in time.

Design

backend - Navigator's auto script and Dashboard's api services.

frontend - Dashboard's frontend. Based on Vue3 + Element Plus

Project setup

Change config

1. Set backend/src/config/maker.ts

• Copy backend/src/config/maker_backend.ts as maker.ts
• Replace the [Your Key] part with your key
• replace makerAddress value

2. Set trade maker address and token address at this file

./backend/src/util/maker/maker_list.ts

Install docker and docker-compose

• Install docker
• Install docker-compose

Build docker image and run docker

Set backend's ORBITER_SCENE

• When you only maker service, set ORBITER_SCENE=maker
• When you only dashboard service, set ORBITER_SCENE=dashboard
• When you only all service, set ORBITER_SCENE=all (default)
• Warnning: if you run maker service, please do not expose your ip or port on the public network

# When you need run at daemon, add -d
docker-compose up [-d]

And, when you run maker service, also need to set maker privateKey

curl -i -X POST -H 'Content-type':'application/json' -d '{"privatekey":"your privatekey"}' http://localhost:[port(default:3002)]/maker/privatekey

Next, you also need to clear shell history

# Editor ~/.bash_history, clear shell's privatekey info
vim ~/.bash_history

# Clear cache
history -r

Also, you can run privatekey_input.py set privatekey

./privatekey_input.py

When you need it run in backend, use screen

screen -S privatekey_input

./privatekey_input.py

End do it and input keys, close privatekey_input screen. In vscode terminal, you can close tab

screen -ls # Show all screen
screen -x [screenId] # Into screen by id
exit # Quit sreen

Licence

Orbiter Module is open source software licensed as MIT.