/ergoMixBack

Mix your ergs and tokens with ErgoMixer.

Primary LanguageScala


Logo

Ergo Mixer
Explore the docs »

View Demos · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Notes
  5. Roadmap
  6. Contributing
  7. License
  8. Contact
  9. Acknowledgements

About The Project

ErgoMixer is a web application for mixing ergs and tokens based on Ergo platform. ErgoMixer is completely serverless; It only needs to connect to the explorer and a node (any node! no api_key is needed). For more information on how it works see here.

ErgoMixer Screen Shot

Getting Started

To get the Mixer up and running you have a few options:

  1. Quick Start Shell Script - Build from source or run the latest jar. (UNIX systems)
  2. Docker Quick Start
  3. Download the latest .jar
  4. Build from source

Usage

When you open the Mixer, the home page displays information about the system and how each component works. There will also be a ErgoMixer dropdown available from your menu bar when running.

ErgoMixerMenu

Video Tutorial

Installation

Quick Start Shell Script

Open your favourite terminal and enter the following to build from source or download and run the latest .jar:

wget https://raw.githubusercontent.com/ergoMixer/ergoMixBack/master/sh/install.sh
chmod +x install.sh
./install.sh

If you encounter any permission errors when attempting to run the script, please run chmod +x install.sh from within the same directory.

Docker Quick Start

To run the ErgoMixer with default config (A Node and Explorer in Mainnet network) use:

$ docker run -p 127.0.0.1:9000:9000 \
    --restart=always \
    -v /path/on/host/to/ergo/database_and_logfile:/home/ergo/ergoMixer \
    -d ergomixer/mixer:latest

To run the ErgoMixer with a custom config file use:

$ docker run -p 127.0.0.1:9000:9000 \
    --restart=always \
    -v /path/on/host/to/ergo/database_and_logfile:/home/ergo/ergoMixer \
    -v <path-your-config-file>/yourConfig.conf:/home/ergo/mixer/application.conf \
    -d ergomixer/mixer:latest

The database and log file will be in your host directory /path/on/host/to/ergo/database_and_logfile ; you can use 9000 port locally to load the mixer.

NOTE: The /path/on/host/to/ergo/database_and_logfile directory must have 777 permission or have owner/group numeric id equal to 9052 to be writable by the container.

Manual Installation

Prerequisites

  • OpenJDK 8

    Install an appropriate version of OpenJDK 8 from Here based on your OS.

  • SBT 1.2.7

    Depending on your OS, you can follow instructions in this page to install sbt.

Build the ErgoMixer:

  • Frontend

    Use the following command to get the latest frontend:

    $ git submodule update --init

    Then build the ergomixfront by following these instructions.

    Then, use the built front in the backend by using the following command in ergomixback directory:

    $ mv ergomixfront/build/ mixer/public

  • Backend

    Finally, build the backend:

    $ cd ./mixer
$ sbt assembly

    The jar file will appear in target/scala-2.12/ directory.

Run mixer

After building the project or downloading jar file, to run the ErgoMixer with default config (A node and explorer in Mainnet network) use:

$ java -jar ergoMixer-*.jar

Also to run the ErgoMixer with a custom config file use:

$ java -jar -D"config.file"=<path-your-config>/customConfig.conf ergoMixer-*.jar

You can use this config file and change it as you want.

The database will be saved in your home directory. This database contains all the information and secrets being used by the mixer, So, take good care of it.

Notes

Stealth Address

  • Stealth Address documentation (to be updated soon) here.
  • Use this tool to generate a new payment address from any Stealth Addresses.

Breaking Change

  • From version 3.0.0 database scheme is changed; So, please consider binding to a different location if you have previously used an older version.

  • In order to buy SigmaUSD/SigmaRSV directly from the mixer, DO NOT SET withdrawal address when creating the mix/covert address and use "Set Later" option. Later, at the moment of buying SigmaUSD/SigmaRSV, set withdraw address and choose "SIG USD" option. Only completed boxes can be used for buying SigmaUSD/SigmaRSV.

  • If you are using manual config file for running mixer, make sure to add this setting in the config file, under section play.http, in order to use SigmaUSD/SigmaRSV support:

    play: {
  http {
        filters="filters.CorsFilters",
        fileMimeTypes = ${play.http.fileMimeTypes} """
                 wasm=application/wasm
                """
       }
  filters {
    hosts {
      # Allow requests to example.com, its subdomains, and localhost:9000.
      allowed = ["localhost", "127.0.0.1"]
    }
    cors {
      pathPrefixes = ["/"]
      allowedOrigins = null,
      allowedHttpMethods = ["GET", "POST"]
      allowedHttpHeaders = null
    }
  }
}

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Acknowledgements