ShellOnStark is a bot designed to facilitate the management and visualization of cryptocurrency portfolios.

It offers features such as token swapping and portfolio visualization, making the management of your digital assets simpler and more intuitive.

• AVNU Swap: Allows easy token swapping and scheduling.
• Portfolio Visualization: Add your personal tokens to view your portfolio.

Copy the example file to create your configuration file:

cp .env.example.env

Update this file with your personnal values.

npm install

To start the bot, run the following command:

npm run start

You have the option to add additional tokens of your choice by creating and customizing the files/personal_tokens.json file.

An example configuration is provided in the files/personal_tokens.sample file to guide you through this process.

Just follow the prompt.

To initiate a multiswap, users must provide their swap parameters in the following format:

[CRYPTO_SYMBOL]:[PERCENTAGE_TO_SWAP]->[TARGET_CRYPTO_SYMBOL], ...

eg: eth:80%->usdc, usdc:90%->eth

By default, the scheduler checks every 15 minutes between 01:00 and 05:00 AM UTC if the gas fees exceed $1.

To choose the right timeframe for your Ethereum transactions, you can refer to the heatmap on Etherscan's gas tracker. This tool provides valuable insights to help you determine the best times for making transactions.

Check it out here: Etherscan Gas Tracker Heatmap

To customize these settings:

• Execution Schedule: Edit the ecosystem.config.cjs file:

cron_restart: '0 */15 01-05 * * *'

• Maximum Gas Fees: Update the config.js file:

max_gas_fees_in_usd: 1 // 1$

1. Install PM2 (if not already installed):

npm install pm2 -g

2. Create a Logs Directory:

mkdir logs

3. Start the Application with PM2:

pm2 start ecosystem.config.js

4. Save PM2 Configuration:

pm2 save

5. Set Up PM2 Startup Script (to ensure your processes are restarted after a reboot).

pm2 startup

Important Note

When setting up the PM2 startup script, PM2 will provide you with a command after executing pm2 startup. Do not forget to run this command.

It's essential for ensuring that your processes are restarted after a system reboot.

Run the following command to start the main bot:

npm run start

Navigate to Avnu menu -> Schedule a Swap and follow the prompts.

The main bot creates a file named files/scheduled_swap.json which contains the scheduled swaps.

The created scheduler will process swaps added to files/scheduled_swap.json and log execution reports in files/executed_swap.json.

For more information, check the logs in the ./logs directory.

• Use pm2 monit to monitor processes.
• Use pm2 logs for real-time logs.

To stop the scheduled execution and remove the PM2 startup configuration:

1. Disable PM2 Startup Script: To prevent the application from automatically starting on system boot, run:

   pm2 unstartup systemd

2. Stop the scheduler: If your application is currently running and managed by PM2 (e.g., gas-optimizer), you can stop it using:

   pm2 stop gas-optimizer

The default configuration has the order manager check every 30 minutes.

To change this schedule, one should edit the cron_restart value in the ecosystem.config.cjs file :

...
name: 'order-manager',
script: './orderManager.js',
cron_restart: '0 */30 * * * *', // Cron expression for every 30min
...        

Instructions are given to start the main bot using the command below.

npm run start

Navigate to Avnu menu -> Schedule an order and follow the prompts.

The main bot creates a file named files/scheduled_limit_order.json which contains the scheduled orders.

The created order manager will process orders added to files/scheduled_limit_order.json and log execution reports in files/executed_limit_order.json.

For more information, check the logs in the ./logs directory.

1. Start the Application with PM2:

pm2 start ecosystem.config.js

2. Save PM2 Configuration:

pm2 save

3. Set Up PM2 Startup Script (to ensure your processes are restarted after a reboot).

pm2 startup

Note: You can monitor logs and remove the manager by following the same steps as the scheduler.

Monitoring and Logs

Remove the Order manager

The default configuration has the DCA manager check every day at 05:00AM.

To change this schedule, one should edit the cron_restart value in the ecosystem.config.cjs file :

...
name: 'dca-manager',
script: './dcaManager.js',
cron_restart: '0 0 5 * * *', // Cron expression for every day at 05:00AM
...        

Instructions are given to start the main bot using the command below.

npm run start

Navigate to Avnu menu -> Schedule a DCA and follow the prompts.

Currently, the DCA manager supports daily, weekly, and monthly DCA schedules.

The main bot creates a file named files/dca_order.json which contains the scheduled DCA.

The DCA manager processes orders added to files/dca_order.json and logs execution reports in the same file.

For more information, check the logs in the ./logs directory.

1. Start the Application with PM2:

pm2 start ecosystem.config.js

2. Save PM2 Configuration:

pm2 save

3. Set Up PM2 Startup Script (to ensure your processes are restarted after a reboot).

pm2 startup

Note: You can monitor logs and remove the manager by following the same steps as the scheduler.

Monitoring and Logs

Remove the Order manager

Access the bot menu and select 'Portfolio Visualization' to see your assets.

Please be aware that this bot is in its developmental stages and should be utilized with caution.

It is continuously evolving, and while it aims to be reliable, it may not be fully suited for critical or high-stakes applications at this stage.

We encourage user feedback and contributions to enhance its capabilities and stability.

We are always open to suggestions and ideas from our community.

If you have a feature idea that you would like to see in ShellOnStark, please feel free to contact us or contribute to the project.

@SymbOnStark

This project is licensed under the MIT License. For more details, please see the LICENSE file in this repository.