From 38446ed147b5b562e68ac859196a894f8344e7ec Mon Sep 17 00:00:00 2001 From: Dev-Anky07 Date: Wed, 12 Apr 2023 09:57:44 +0530 Subject: [PATCH] Made changes to readme file --- README.md | 46 +++++++++++++++++++++++++++------------------- 1 file changed, 27 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index dda412e5..dfa17ff7 100644 --- a/README.md +++ b/README.md @@ -2,22 +2,27 @@ ## Statement -- Orbiter Module is quick developmenting, If you find a problem, please send a [new issue](https://github.com/OrbiterCross/OrbitalModule/issues/new) -- 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. +- Orbiter Module is still under production, If you find an error, please submit an [issue](https://github.com/OrbiterCross/OrbitalModule/issues/new) report and we'll fix it. + +- The risk of using this piece of software will be borne sorely by the User. The author (Orbiter Module) does not bear any responsibility for the losses incurred while running this program, be that financial or material. + +- The author of the software (Orbiter Module) does not bear any responsibility for service interruption or other defects caused by black swan events such as malicious attacks, communication line interruption, etc., which cause a disruption to the service, but will try to minimize either the chances of something like that happening or the resulting damage to users. + +- For issues not covered by this statement, please refer to the relevant national laws and regulations. If there's a conflict 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. +- OrbitalModule has been deployed on chain and the code will be made open-source. +- The Docker project is written in js, deployed in the EC2 server, and has no external port. +- It 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. +- By adjusting the parameters, the project can optimize the economic and time savings that users can achieve with Orbiter when configuring the rollup dynamics. + +- Once the user initiates payment through the front-end wallet, real-time monitoring of transaction data for each rollup will be enabled, providing timely feedback on the status of the user's cross-rollup transfer. ## Design @@ -32,7 +37,7 @@ #### 1. Set backend/src/config/maker.ts - Copy [backend/src/config/maker_backend.ts](./backend/src/config/maker_backup.ts) as maker.ts -- Replace the [Your Key] part with your key +- Replace [Your Key] with your key - replace `makerAddress` value #### 2. Set trade maker address and token address at this file @@ -48,9 +53,9 @@ #### 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) +- If you intend on using Maker services only, set `ORBITER_SCENE=maker` +- If you intend on using dashboard service only, set `ORBITER_SCENE=dashboard` +- If you intend on using all services, set `ORBITER_SCENE=all` (default) - Warnning: if you run maker service, please do not expose your ip or port on the public network ``` @@ -58,13 +63,15 @@ docker-compose up [-d] ``` -#### And, when you run maker service, also need to set maker privateKey +#### Set maker privateKey +Note : This is only applicable if you're running the maker serv +And, when you run maker service, also need to s ``` 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 +#### Clear shell history ``` # Editor ~/.bash_history, clear shell's privatekey info @@ -74,13 +81,14 @@ vim ~/.bash_history history -r ``` -#### Also, you can run `privatekey_input.py` set privatekey +#### Set privatekey +Run `privatekey_input.py` ``` ./privatekey_input.py ``` -##### When you need it run in backend, use `screen` +##### Use `screen` to run it on the backend ``` screen -S privatekey_input @@ -90,7 +98,7 @@ screen -S privatekey_input ./privatekey_input.py ``` -##### End do it and input keys, close privatekey_input screen. In vscode terminal, you can close tab +##### Enter Input keys ``` screen -ls # Show all screen @@ -100,5 +108,5 @@ exit # Quit sreen ## Licence -Orbiter Module is open source software licensed as -[MIT](./LICENSE). +Orbiter Module comes under the +[MIT](./LICENSE) license.