Service and commands¶
Cryptoassets helper service is a standalone process responsible for communication between cryptocurrency networks, cryptocurrency API providers and your application.
Primarily Cryptoassets helper service
- Broadcasts new outgoing transactions to the cryptocurrency network
- Gets transaction notifications from cryptocurrency daemons and APIs and then notifies your application about the transaction updates
Even if network connections go down, you lose connection to APIs or cryptocurrency networks, cryptoassets library continuous to work somewhat indepedently. The users can send and receive transactions, which are buffered until the network becomes available again. Some functions, which are synchronous by nature, like creating new addresses, might not be available.
Besides providing a daemon for communications additional helping commands are available
- Initialize database
- Rescan wallet for missed transations
This command is the service helper process. The service process must be running on the background for your application to receive external deposit transactions and broadcast outgoing transctions.
After installing cryptoassets.core to your virtualenv you should be able to run the cryptoassets helper service as following:
cryptoassets-helper-service <your YAML config file>
If you are running a Django application, a special Django management command is provided by cryptoassets.django library.
- Cryptoassets helper service* comes with a built-in mini status server. You can use this to
- Diagnose to see that cryptoassets helper service process is alive and runnign well
- Debug incoming and outgoing transaction issues
Status server is designed only for testing and diagnostics purpose and does not scale to production use.
It is not safe to expose status server to the Internet. Make sure you have authenticating proxy set up or only expose this to localhost.
To have automatic start/stop and other functionality for cryptoassets helper service, use something akin systemd or supervisord.
SIGTERM signal to the service for graceful shutdown. Give the service 45 seconds to gracefully shutdown its own threads until sending
SIGKILL if the service has not terminated itself.
The clean shutdown is indicated by exit code
In the case of any of the service threads dying the service will shutdown itself with exit code
Further system exit codes coming in upcoming releases.
This command will create database tables for different cryptocurrencies as described in the configuration file. Usually you need to do this only once when setting up the database.
Rescan all receiving addresses for missed deposit transactions.
This is also performed automatically on startup of cryptoassets helper service.
For more information see
At the moment it is not recommended to run this command while cryptoassetshelper is running on background.