Core is a Kotlin based cryptocurrency exchange and matching engine from the OPEX project. This extendable and microservice project work as a vanilla core for running cryptocurrency exchanges.
You need to have Maven and Docker installed on your machine.
- Clone the repository.
cdto the cloned directory.- Create
.envfile in the root directory of the project and add the required environment variables. - Run
mvn clean installcommand to build the project. - After successful build, create docker images using
docker compose -f docker-compose.yml -f docker-compose.override.yml -f docker-compose.build.yml -f docker-compose.local.yml build. - Run the project using
docker compose -f docker-compose.yml -f docker-compose.override.yml -f docker-compose.build.yml -f docker-compose.local.yml up -d. - Now run
docker pscommand to see if services are healthy.
APP_NAME=Opex-local
APP_BASE_URL=localhost:8080
PANEL_PASS=admin
BACKEND_USER=admin
KEYCLOAK_ADMIN_USERNAME=opex
KEYCLOAK_ADMIN_PASSWORD=hiopex
SMTP_PASSWORD=x
API_KEY_CLIENT_SECRET=x
KEYCLOAK_FRONTEND_URL=http://localhost:8083/auth
KEYCLOAK_ADMIN_URL=http://localhost:8083/auth
KEYCLOAK_VERIFY_REDIRECT_URL=http://localhost:8080/verify
KEYCLOAK_FORGOT_REDIRECT_URL=http://localhost:8080/forgot
WHITELIST_REGISTER_ENABLED=true
WHITELIST_LOGIN_ENABLED=true
WALLET_BACKUP_ENABLED=false
OPEX_ADMIN_KEYCLOAK_CLIENT_SECRET=x
TAG=debug
| Variable | Description |
|---|---|
| APP_NAME APP_BASE_URL |
Application metadata used by Keycloak |
| PANEL_PASS | Vault's admin panel password |
| BACKEND_USER | Username used by services to access vault data. Also used as the username for Vault admin panel |
| KEYCLOAK_ADMIN_USERNAME | Username for Keycloak admin panel |
| KEYCLOAK_ADMIN_PASSWORD | Password for Keycloak admin panel |
| SMTP_PASSWORD | SMTP password used by keycloak to send emails for various operations (e.g. user verification, reset password) |
| API_KEY_CLIENT_SECRET | In order to access the api key feature, please follow the steps below: 1. Go to Keycloak admin panel located at http://localhost:8083/auth/admin/master/console/#/realms/opex/clients 2. Login with the username and password you provided in the .env file (KEYCLOAK_ADMIN_USERNAME and KEYCLOAK_ADMIN_PASSWORD)3. Go to clients section on the left menu 4. Click on opex-api-key client 5. In the credentials section, click on Regenerate Secret button 6. Copy the generated secret and paste it into this section |
| KEYCLOAK_FRONTEND_URL KEYCLOAK_ADMIN_URL KEYCLOAK_VERIFY_REDIRECT_URL KEYCLOAK_FORGOT_REDIRECT_URL |
Replace localhost with your server's IP if you're not running on local machine. Do not change the rest. |
| WHITELIST_REGISTER_ENABLED | Allows registration only for whitelisted emails |
| WHITELIST_LOGIN_ENABLED | Allows login only for whitelisted emails |
| WALLET_BACKUP_ENABLED | Enables wallet data backup to google drive folder. In order to use this feature, you need to have drive-key.json file (obtained from google drive API panel) in the root directory of project |
| OPEX_ADMIN_KEYCLOAK_CLIENT_SECRET | Ignore this for now. Will be removed soon |
| Tag | Labels locally built docker images |
Deployed at app.opex.dev.
graph LR
USER_MANAGMENT(User Management)
KAFKA(Kafka)
ZOOKEEPER(Zookeeper)
REDIS[(Redis)]
ACCOUNTANT_POSTGRESQL[(PSQL)]
REFERRAL_POSTGRESQL[(PSQL)]
USER_MANAGMENT_POSTGRESQL[(PSQL)]
WALLET_POSTGRESQL[(PSQL)]
BC_GATEWAY_POSTGRESQL[(PSQL)]
EVENTLOG_POSTGRESQL[(PSQL)]
ACCOUNTANT(Accountant)
API(API)
WALLET(Wallet)
MATCHING_ENGINE(Matching Engine)
MATCHING_GATEWAY(Matching Gateway)
REFERRAL(Referral)
STORAGE(Storage)
BC_GATEWAY(Blockchain Gateway)
WEBSOCKET(Websocket)
ADMIN(Admin)
CAPTCHA(Captcha)
EVENTLOG(Event Log)
API-->MATCHING_GATEWAY
API-->WALLET
API-->REFERRAL
API-->STORAGE
API-->BC_GATEWAY
API-->ACCOUNTANT
MATCHING_ENGINE-->REDIS
USER_MANAGMENT-->USER_MANAGMENT_POSTGRESQL
BC_GATEWAY-->BC_GATEWAY_POSTGRESQL
REFERRAL-->REFERRAL_POSTGRESQL
WALLET-->WALLET_POSTGRESQL
ACCOUNTANT-->ACCOUNTANT_POSTGRESQL
EVENTLOG-->EVENTLOG_POSTGRESQL
subgraph MESSAGING
KAFKA
ZOOKEEPER
end
subgraph MATCHING DOMAIN
MATCHING_GATEWAY-->MATCHING_ENGINE
end
subgraph ACCOUNTANT DOMAIN
ACCOUNTANT-->WALLET
REFERRAL-->WALLET
end
subgraph DATA STORE
BC_GATEWAY_POSTGRESQL
REFERRAL_POSTGRESQL
ACCOUNTANT_POSTGRESQL
WALLET_POSTGRESQL
USER_MANAGMENT_POSTGRESQL
EVENTLOG_POSTGRESQL
REDIS
end
We want to make contributing to this project as easy and transparent as possible, and we are grateful to the developer for contributing bug fixes and improvements.
OPEX is MIT licensed.