Skip to content

Latest commit

 

History

History
236 lines (146 loc) · 8.61 KB

README.md

File metadata and controls

236 lines (146 loc) · 8.61 KB
Raw

Olas Modius Quickstart

⚠️ Warning
The code within this repository is provided without any warranties. It is important to note that the code has not been audited for potential security vulnerabilities. Using this code could potentially lead to loss of funds, compromised data, or asset risk. Exercise caution and use this code at your own risk. Please refer to the LICENSE file for details about the terms and conditions.

Olas Modius Agent: Functionality Overview

Olas Modius is an autonomous trader that operates in the crypto ecosystem on users' behalf. It requires minimum intervention by you as an end user--it is enough that you fund the agent with initial investment assets and let it run. Modius will intelligentely invest crypto assets in DEXs on your behalf and grow your portfolio.

Modius trades on Balancer over the Mode chain. If you choose to run your Modius agent with staking, in addition to trading profits Modius will also accrue rewards in Olas.

Operational Process: Similar to its human user counterpart, Modius' time is divided in epoch days-periods of 24 hours. Throughout one epoch, the agent:

  1. Identifies trading opportunities in investment pools advertised through campaigns on the Merkl platform across the supported DEXs.
  2. Grabs the most interesting one and invests in it: Starts off by picking the most convenient investment pool amongst the ones with Annual Percentage Yield (APY) higher than 5%. Switches from one investment pool to another when the corresponding APY exceeds that of the previous investment.
  3. Tracks transactions on the staking chain to accrue Olas staking rewards: Transactions on Mode serve as key performance indicators (KPIs) for Olas Staking Rewards; in order to collect the corresponding rewards within each epoch, Modius needs to perform a well defined (as per the staking contract) number of them.

Notes:

  • Staking is currently in a testing phase, so the number of trader agents that can be staked is limited.
  • Within each staking period (24hrs) staking happens after the agent has reached its staking contract's KPIs. In the current agent's version, this takes approximately 45 minutes of activity.
  • In case a service becomes inactive and remains so for more than 2 staking periods (approx. 48 hours), it faces temporary eviction from the staking program and ceases to accrue additional rewards.

Minimal Funding Requirements

For the initial setup you will need to provide your agent with assets for gas (to cover the costs of the transactions over the operating chain) and for investment funds.

  • The initial gas funds amount suggested for Mode is 0.00516 ETH--based on the gas prices observed between Sept 2024 and Nov 2024 included, and may need to be revised.
  • The investment fund suggested is of 20 USD (about 20 USDC at the time of the writing).

Additionally, if you choose to run your agent with staking, you will need a total of 40 Olas bridged to Mode.

Compatible Systems

  • Windows 10/11: WSL2
  • Mac ARM / Intel
  • Linux
  • Raspberry Pi 4

System Requirements

Ensure your machine satisfies the requirements:

Running the Service: Initial setup

Clone this repository locally and execute:

chmod +x run_service.sh
./run_service.sh

Tenderly and Price Data Source

As part of its trading strategies, the agent uses Tenderly to simulate routes for bridges/swaps and pick the best available route at the moment of investment.

Please enter your Tenderly API Key:
Please enter your Tenderly Account Slug:
Please enter your Tenderly Project Slug:

Refer to the Tenderly Documentation for more info https://docs.tenderly.co/account/projects.

CoinGecko is used as a price source to compute the initial investment assets you will need to provide the agent with. You will be asked for your CoinGecko API Key. You can get your own at https://www.coingecko.com/. Note that, you can also press enter to skip this step. In that case, the agent will fallback to pre-computed values as per the prices observed in Nov 2024.

Please enter your CoinGecko API Key. Get one at https://www.coingecko.com/:

Minimum investment amount

Successively you will be asked to make a decision on your traded assets limit parameter--the minimum amount to be invested in trades. A pre-computed minimum amount is pompted to you and you can opt to increase it to a value of your choice. Note that this parameter will determine the initial funds requested in a further step by the agent.

The minimum investment amount is 15 USD on both USDC and ETH Tokens
Do you want to increase the minimum investment amount? (y/n):

Staking

The agent will need your answer on staking. If you plan to run it as a non-staking agent, please answer n to the question below. Otherwise, please answer y and, consequently when prompted, fund your agent with the required number of bridged Olas in the target staking chain.

Do you want to stake your service? (y/n):

Investment Activity Chain RPC

You will be asked for the corresponding RPC for your agent instance. Enter your Mode RPC of preference when you are be prompted with the following request:

Please enter a Mode RPC URL:

Creating a local user account

When run for the first time, the agent will setup for you a password protected local account. You will be asked to enter and confirm a password as below. Please be mindful of storing it in a secure space, for future use. Hint: If you do not want to use a password just press Enter when asked to enter and confirm your password.

Creating a new local user account...
Please enter a password: 
Please confirm your password: 
Creating the main wallet...

Finally, when prompted, send the corresponding funds for gas and investment to the corresponding address and you're good to go!

Service is Running

Once the ./run_service.sh has completed, i.e. the service is running, you can check out the live logs of your Modius agent.

Check the name of your running container with:

docker ps

Copy the name which should be similar to 'optimus_abci_0', then run:

docker logs [name] --follow

To inspect the tree state transition of the current run of your agent run:

poetry run autonomy analyse logs --from-dir .olas-modius/services/[service-hash]/deployment/persistent_data/logs/
  --agent aea_0 --fsm --reset-db

where [service-hash] is the onchain representation of the agent code that you're running. You can get such hash through the following ls command:

ls .olas-modius/services

Service Report Additionally, you can execute the service report command to view a summary of the service status, balances, and anything in relation to Olas Staking and accrual of rewards:

poetry run python report.py

Funding Report Finally, you can execute the funding report command to check out balances for each of the chains your service is deployed onto.

poetry run python suggest_funding_report.py

The report will also give you insights on the latest observed gas prices per chain and, if necessary, suggest gas funding values to keep your agent active.

Stopping your agent To stop your agent, use:

./stop_service.sh

Update between versions

Simply pull the latest script:

git pull origin

Then run again your service with:

./run_service.sh

Advice for Windows users on installing Windows Subsystem for Linux version 2 (WSL2)

  1. Open a Command Prompt terminal as an Administrator.

  2. Run the following commands:

    dism.exe /online /enable-feature /featurename:Microsoft-Windows-Subsystem-Linux /all /norestart
    dism.exe /online /enable-feature /featurename:VirtualMachinePlatform /all /norestart

  3. Then restart the computer.

  4. Open a Command Prompt terminal.

  5. Make WSL2 the default version by running:

    wsl --set-default-version 2

  6. Install Ubuntu 22.04 by running:

    wsl --install -d Ubuntu-22.04

  7. Follow the on-screen instructions and set a username and password for your Ubuntu installation.

  8. Install Docker Desktop and enable the WSL 2 backend by following the instructions from Docker here.