How generalbytescom/batm_public works
This repository is an open extension ecosystem for General Bytes Bitcoin ATM products, especially BATM Server (CAS), rather than the CAS runtime itself. The principal workflow is an operator or developer implementing an extension against the published API, packaging it for CAS to discover, and exposing a capability such as a wallet, exchange, rate source, payment processor, compliance provider, or REST service. The tree also includes reference integrations, a sample operator sell website, a verification helper, and an SSH tunnel. Relationships among unsampled subsystems are limited to documented capabilities; the diagram does not imply unseen runtime wiring.
Main entry points: VerificationController.java Verification endpoints · IExtension.java Extension contract · IExtensionContext.java CAS context · IRestService.java REST service API
Components 20
Extension API
- Extension contract
server_extensions_api/src/main/java/com/generalbytes/batm/server/extensions/IExtension.java - CAS context
server_extensions_api/src/main/java/com/generalbytes/batm/server/extensions/IExtensionContext.java - Wallet API
server_extensions_api/src/main/java/com/generalbytes/batm/server/extensions/IWallet.java - Exchange API
server_extensions_api/src/main/java/com/generalbytes/batm/server/extensions/IExchange.java - Rate source API
server_extensions_api/src/main/java/com/generalbytes/batm/server/extensions/IRateSource.java - Payment processor API
server_extensions_api/src/main/java/com/generalbytes/batm/server/extensions/IPaymentProcessor.java - AML and watchlists
server_extensions_api/src/main/java/com/generalbytes/batm/server/extensions/aml/IAMLProvider.java - REST service API
server_extensions_api/src/main/java/com/generalbytes/batm/server/extensions/IRestService.java - Transaction listeners
server_extensions_api/src/main/java/com/generalbytes/batm/server/extensions/ITransactionListener.java
Reference Integrations
- Reference extensions
server_extensions_extra/src/main/java/com/generalbytes/batm/server/extensions/extra - Travel rule providers
server_extensions_extra/src/main/java/com/generalbytes/batm/server/extensions/travelrule/sumsub/SumsubService.java - Lightning LNURL
server_extensions_extra/src/main/java/com/generalbytes/batm/server/extensions/extra/lightningbitcoin/lnurl/LnurlRestService.java - Veriff webhook
server_extensions_extra/src/main/java/com/generalbytes/batm/server/extensions/extra/identityverification/veriff/VeriffRestService.java
Operator Services
- Operator sell website
operators_sample_website/website/app/Http/Controllers/SellController.php - CAS terminal client
operators_sample_website/website/app/GBlib/Terminals.php
Supporting Services
- Verification endpoints
verification_site/src/main/java/com/generalbytes/verification/controller/VerificationController.java - Applicant token cache
verification_site/src/main/java/com/generalbytes/verification/service/ApplicantService.java - SSH tunnel
batm_ssh_tunnel/src/main/java/com/generalbytes/batm/sshtunnel/Main.java
Other components
- Operator developer
- BATM Server CAS
Connections 21
- Operator developer → Extension contract: implements
README.md - Extension contract → CAS context: receives on init
README.md - BATM Server CAS → Extension contract: discovers extensions
README.md - Operator developer → Wallet API: implements
README.md - Operator developer → Exchange API: implements
README.md - Operator developer → Rate source API: implements
README.md - Operator developer → Payment processor API: implements
README.md - Operator developer → AML and watchlists: implements
README.md - Operator developer → REST service API: implements
README.md - Operator developer → Transaction listeners: implements
README.md - Reference extensions → Wallet API: demonstrates
README.md - Reference extensions → Exchange API: demonstrates
README.md - Travel rule providers → CAS context: uses
server_extensions_extra/src/main/java/com/generalbytes/batm/server/extensions/travelrule/sumsub/SumsubService.java - Lightning LNURL → CAS context: uses
server_extensions_extra/src/main/java/com/generalbytes/batm/server/extensions/extra/lightningbitcoin/lnurl/LnurlRestService.java - Lightning LNURL → REST service API: implements
server_extensions_extra/src/main/java/com/generalbytes/batm/server/extensions/extra/lightningbitcoin/lnurl/LnurlRestService.java - Veriff webhook → REST service API: implements
server_extensions_extra/src/main/java/com/generalbytes/batm/server/extensions/extra/identityverification/veriff/VeriffRestService.java - Operator sell website → CAS terminal client: requests terminals
operators_sample_website/website/app/Http/Controllers/SellController.php - CAS terminal client → BATM Server CAS: calls CAS services
- BATM Server CAS → Verification endpoints: registers applicant
verification_site/src/main/java/com/generalbytes/verification/controller/VerificationController.java - Verification endpoints → Applicant token cache: stores and retrieves
verification_site/src/main/java/com/generalbytes/verification/controller/VerificationController.java - Verification endpoints → BATM Server CAS: submits check
verification_site/src/main/java/com/generalbytes/verification/controller/VerificationController.java