Skip to content

Latest commit

 

History

History
150 lines (123 loc) · 5.47 KB

README.md

File metadata and controls

150 lines (123 loc) · 5.47 KB

PAKET Manager

The PAKET Manager is a small collection of scripts used to automatically deploy, test, and run PAKET software.

Setup Your Manager

  1. Create a project directory and enter it:
mkdir paket
cd paket
  1. Clone the repository inside the project directory and enter it:
git clone [email protected]:paket-core/manager
cd manager

Note that this method requires using SSH keys. If you would rather clone the repository over public access simply use:

git clone https://github.com/paket-core/manager
cd manager
  1. Create a python virtual environment:
python3 -m venv venv
  1. Activate the python virtual environment:
. venv/bin/activate
  1. Make sure you are using an updated pip:
pip install --upgrade pip
  1. Make sure your paket.env contains all desired variables and values.

System settings:

  • PAKET_SERVERS - an array of servers you wish to run - recommended value (with parenthesis): (funder api)

Stellar settings:

  • PAKET_ISSUER_PUBKEY - the issuer pubkey (has no default, software will refuse to run without it)
  • PAKET_HORIZON_SERVER - your preferred horizon server (defaults to 'https://horizon-testnet.stellar.org')

Registration settings:

  • PAKET_VERIFY_API_KEY - API key for Verify verification service
  • PAKET_VERIFY_CODE_LENGTH - number of verification digits sent

Payment settings:

  • PAKET_FUNDER_SEED - the seed for an account that sells BUL and XLM
  • PAKET_PAYMENT_XPUB - an x-public-key for generating payment addresses
  • PAKET_HOURLY_FUND_LIMIT - maximum amount of EUR cents allowed for funding per hour
  • PAKET_DAILY_FUND_LIMIT - maximum amount of EUR cents allowed for funding per day
  • PAKET_EUR_XLM_STARTING_BALANCE - amount of XLM stroops in EUR cent equivalent to be funded to new accounts
  • PAKET_EUR_BUL_STARTING_BALANCE - amount of BUL stroops in EUR cent equivalent to be funded to new accounts
  • PAKET_BUL_PRICE - BUL price in EUR
  • PAKET_BASIC_MONTHLY_ALLOWANCE - monthly purchase allowance for a user that passed basic KYC check
  • PAKET_MINUMUM_PAYMENT - minimal acceptable payment in EUR cents
  • PAKET_ETHERSCAN_API_KEY - an API key for monitoring ETH payments

Database (MySQL) access settings:

  • PAKET_DB_HOST - the host of your MySQL server (defaults to '127.0.0.1')
  • PAKET_DB_PORT - the port of your MySQL server (defaults to 3306)
  • PAKET_DB_USER - the user on your MySQL server (defaults to 'root')
  • PAKET_DB_PASSWORD - the user password on your MySQL server (defaults to None)

Util settings:

  • PAKET_GOOGLE_API_KEY - the API key for access Google Places API

Push notifications settings:

  • PAKET_PATH_TO_FIREBASE_CERT - path to Firebase account certificate (which can be downloaded as JSON file from the Firebase console)

Webserver settings:

  • PAKET_SESSIONS_KEY - a secret session key, for securing user sessions (defaults to os.urandom(24) in runtime)
  • PAKET_SERVER_LIMIT - the default rate limit of your servers (defaults to '100 per minute')
  • PAKET_ROUTER_PORT - the port on which the router server will run (defaults to 8000)
  • PAKET_BRIDGE_PORT - the port on which the bridge server will run (defaults to 8001)
  • PAKET_FUNDER_PORT - the port on which the funding server will run (defaults to 8002)

Logging settings:

  • PAKET_LOG_DIR - the path on the filesystem to store the log file in (defaults to './')
  • PAKET_LOG_FILE - the name of the log file (defaults to 'paket.log')
  • PAKET_LOG_FMT - log format, using python logging standartds (defaults to '%(asctime)s %(levelname).3s: %(message)s - %(name)s +%(lineno)03d')
  • PAKET_LOG_DATE_FMT - log date format, using python logging standartds (defaults to '%Y-%m-%d %H:%M:%S')
  • PAKET_LOG_LEVEL - the minimal logging level, using python standartds (defaults to 10, which is logging.DEBUG)

Debugging settings (DO NOT USE THEM ON PRODUCTION ENVIRONMENT):

  • PAKET_ISSUER_SEED - the issuer seed (defaults to None)
  • PAKET_DEBUG - to run PAKET software in debug mode, with debug calls and no signature checking.
  • FLASK_DEBUG - to run the web server in debug mode with auto reloading.
  • PAKET_TEST_LAUNCHER_SEED - secret key of launcher account, used for simulation.
  • PAKET_TEST_COURIER_SEED - secret key of courier account, used for simulation.
  • PAKET_TEST_RECIPIENT_SEED - secret key of recipient account, used for simulation.
  • PAKET_SIMULATION_XLM_START_BALANCE - amount of XLM stroops to be funded to simulation accounts.
  • PAKET_SIMULATION_BUL_START_BALANCE - amount of BUL stroops to be funded to simulation accounts.
  • ROUTER_URL = url of Router server, used for managing packages.

Deploy, Test, and Run PAKET Software

  1. Deploy the software:
./deploy.sh

Note that this will create several directories in the project directory, which is the repository's parent directory.

  1. Initialize the database:
./init_db.sh
  1. Test the software:
./test.sh

If you wish to use pycodestyle and/or pylint in your tests, just install them into your virtual environment and the script will take care of the rest:

pip install pycodestyle pylint
  1. Run the servers:
./run.sh
  1. Access the swagger Web interfaces from a browser (that the ports will change according to your webserver settings):