Giter Club home page Giter Club logo

escrow-service-bot's Introduction


Logo

Escrow Service Bot

An awesome bot to ensure fast and secure trades with a hundred percent transparency

View Demo · Report Bug · Request New Feature

Contributors Forks Stargazers Issues MIT License LinkedIn

Version Documentation

Table of Contents

Problem Solved

In the world we live in now, business is mostly done on the internet and customers are more unwilling to buy products from sellers they do not trust or have no personal reference to. Knowing they could be mislead or scammed of their money with no trace for refunds.

This is a growing problem and my Escrow Service Bot is aimed at eradicating the problem, thereby giving large trade group owners and sellers more business. And, also giving buyers the confidence to purchase goods without risk involved.

About The Project

The Escrow Service Bot offers an automated service acting as an escrow platform, able to facilitate a completely save trade environment on which both the seller and buyer can thrive and do business happily.

All payments are being made directly to the respective parties, either through Bitcoin, Ethereum, Litecoin, Ripplecoin or Bitcoin Cash cryptocurrency which ofcourse is predefined by the seller's choice of local currency from the following:

  • US Dollars (USD)
  • Euros (EUR)
  • British Pound (GBP)
  • Canadian Dollar (CAD)
  • Japanese Yen (JPY)
  • The Swiss Franc (CHF)

With an affiliate program being part of the structure, administrators of different Telegram Group platforms are also able to use the Escrow Service Bot in conducting save and fast business transactions within their groups smoothly, with each transaction being completed secured and easily traceable. Also, each registered group admin is entitled to a charge on every trade carried out by the group members.

Ideal Users

  • Group Administration (Software As A Service)
  • Business Owners
  • Freelancers
  • Crypto-Traders
  • Generally anybody with goods to sell and customers to buy

Built With

This section should list any frameworks/APIs used to build this project application.

Getting Started

This section covers how you can get the Escrow Service Bot up and running locally with your own credentials in no time. All you need are the following.

Prerequisites

Here is the list of needed dependencies to have available on your machine(PC)

  • python > 3.6 - Goto link to download it
  • pip
pip install --upgrade pip

Installation

  1. Open the project's github page and star this project by tapping on the star button at the top right of the page.

  2. Get a bot token key from @BotFather

  3. Create a Coinbase account and retrieve your API information. This would be used to set up payment systems for your service bot instance.

  4. Clone this repository

git clone https://github.com/Pycomet/escrow-service-bot.git
  1. Open the project directory
cd escrow-service-bot
  1. Create a virtual environment to install all the app dependencies
python -m venv env

// Enter into the virtual environment (Linux)
source env/bin/activate
  1. Install the dependencies
pip install -r requirements.txt
  1. Create a .env file to house all your credentials
// Bot token from @Botfather
TOKEN=""

// Coinbase API credentials
API_KEY=""
API_SECRET=""

// Your telegram user id
ADMIN_ID=""

// Database url (here would be based on your personal choice for your database)
DATABASE_URL=""
  1. You are ready to start the application
python main.py

ENJOY!

Usage

Please refer to this article to know more about this project and how the bot is used -> Documentation

Roadmap

See the open issues for a list of proposed features (and known issues). Here is the shortlisted prospects;

  • More Country Currencies (Added Successfully!)

  • More Crytocurrencies for trading (For example; Ripplecoin and others) (Added Successfully!)

  • User account rating based on previous trades

  • Website to showcase more details information on the bot along with a dashboard to monitor trades

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

Donation

If you are impressed with my project and wish to buy me a cup of coffee, you can donate to the project through any of the means below

  • Bitcoin(BTC) -> 3Lr6duZ7ai4G8KpEqAmeiPSKTcUBt31iZ5
  • Etherium(ETH) -> 0x56B7534EED80591033F63DD8D5dCaa3efAC4a92B
  • Bitcoin Cash(BCH) -> qqqvhf966xhtv2ak4t9jpey5tq2f4v54dg0ezwdp5t
  • Dodgecoin(DOGE) -> DHMy5s96gCx1vwGLQEsYHZeumPbjQzsWUJ

Thanks

License

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

Author

  • Alfred Emmanuel Inyang (Codefred) - [My Website]

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.