Reporting KMS Errors

To help us diagnose and resolve issues with Tatum KMS efficiently, please follow these steps before submitting a support request.

Required Information

  1. Verify Your KMS Version

    • Ensure you have installed the latest KMS version.
    • Check the latest version of Tatum KMS HERE.
  2. Generate a Debugging Report

    • Use the report command to generate a detailed system report. This report includes:
      • Your KMS version
      • Node.js version
      • Signature_ID storage type general details (Mnemonic or PrivateKey-based).
      • Any warnings identified

    Example request:

       $ tatum-kms e3015fc0-2112-4c8a-b8bf-353b86f63ba5,11115fc0-2112-4c8a-b8bf-353b86f63111
       {
         "system": {
           "kmsVersion": "7.0.6",
           "nodeVersion": "v18.18.2",
           "store": {
             "type": "LOCAL",
             "exists": true
           }
         },
         "wallets": {
           "e3015fc0-2112-4c8a-b8bf-353b86f63ba5": {
             "type": "PRIVATE_KEY",
             "chain": "BTC",
             "testnet": true
           },
           "11115fc0-2112-4c8a-b8bf-353b86f63111": {
             "type": "MNEMONIC",
             "chain": "ETH",
             "testnet": true,
             "warnings": [
               "No xpub found"
             ]
           }
         },
         "apiKey": "t-6111***************************************222222",
         "warnings": [
           "Wallets file is not accessible"
         ]
       }
    
  3. Explore Additional Resources

🚧

Attention

  • Tickets submitted without the KMS report file will be rejected.
  • Submissions with a KMS version older than the current version will also be rejected.

Why This Information Matters

Providing a KMS report, error details, and current version information allows us to identify potential misconfigurations or compatibility issues. Without this data, troubleshooting may be significantly delayed or unfeasible.

  • Outdated versions may not include recent bug fixes or security updates.
  • The KMS report gives a snapshot of your system setup, helping us diagnose potential issues quickly.
  • Security-related concerns often require specific details to ensure compliance with best practices.

By following this guide, you help us resolve your issue as efficiently as possible.