Memeooorr Quickstart

🚨 WARNING: repository deprecated 🚨

This repository has been deprecated and will not be supported until further notice Please use the new Quickstart

The Memeooorr agent currently operates on the following chains:

• Base
• Celo

See here and here for what it does.

Terms and Conditions Disclaimer

⚠️ Warning
The code within this repository is provided without any warranties. It leverages third party APIs and 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.

Compatible Systems

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

System Requirements

Ensure your machine satisfies the requirements:

• Python ==3.10
• Poetry >=1.4.0
• Docker Engine
• Docker Compose

Setup Requirements

• For the initial setup you will need to fund certain addresses with the following funds when requested: 0.05 ETH (Base chain) or x CELO (Celo chain). These quantities are based on the gas prices seen on the 1st half of Sept 2024 and may need to be revised. Additionally some quantity of OLAS bridged to Base or Celo if you want to stake.

• You need 1 RPC for your agent instance for either Base or Celo.

• A Gemini API key

• An X account including email and password

Run the Service

1. Clone this repository:

   git clone git@github.com:dvilelaf/meme-ooorr-quickstart.git
   

2. Create the virtual environment:

   cd meme-ooorr-quickstart
   poetry shell
   poetry install
   

3. Run the quickstart:

   python run_service.py

When prompted, add the requested info, send funds to the prompted address and you're good to go!

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...

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 Optimism Chain.

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

Notes:

• Staking is currently in a testing phase, so the number of trader agents that can be staked might be 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 approxiamtely 45 minutes of activity.
• In case a service becomes inactive and remains so for more than 2 staking periods (approx. 48 hours), it faces eviction from the staking program and ceases to accrue additional rewards.

Service is Running

Once the command has completed, i.e. the service is running, you can see the live logs with:

docker logs memeooorr_abci_0 --follow

To stop your agent, use:

./stop_service.sh

Update between versions

Simply pull the latest script:

git pull origin

Then continue above with "Run the script".

What's New

...

Advice for Mac users

In Docker Desktop make sure that in Settings -> Advanced the following boxes are ticked

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.

Known issues

Twitter login failed due to a known issue with the login flow

This is a known issue coming from the Twikit library, which we use in order to communicate with Twitter. While the issue is being solved, if you experience this error you will need to extract Twitter cookies from your Twitter session following these steps:

1. Visit this link to install the "Export cookie JSON file for Puppeteer" browser extension (it is open-source).

2. In the install section, click on either Google Chrome or Firefox and proceed to install the extension. You will need to install one of those browsers if you are using something else like Safari or Opera.

3. Once the extension is installed, login into the desired Twitter account.

4. With the Twitter tab open, go into the browser extension menu and click on Export cookie JSON file for Puppeteer.

5. Click on Export cookies as JSON. A file caller x.com.cookies.json will be downloaded. If the name is different, please rename it to that.

6. Paste the file into the Memeooorr repo root. The quickstart should extract your cookies, login into Twitter and continue.