welurirish/shellonstark

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.

ShellOnStark

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.

Features

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

Initial Setup

Add .env file

Copy the example file to create your configuration file:

cp .env.example.env

Update this file with your personnal values.

Install dependencies

npm install

Usage

Starting the bot

To start the bot, run the following command:

npm run start

AVNU swap

Just follow the prompt.

AVNU multiswap

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

Portfolio visualization

1. 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.
2. Access the bot menu and select 'Portfolio Visualization' to see your assets.

Your Feedback Matters!

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

License

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