Skip to content

💰 Currency / PublicAPI / Audit

🎯 Purpose

The Audit folder provides supported helpers for reading and observing currency audit data.

These APIs allow consumers to inspect past operations or subscribe to live changes without depending on internal implementations.

⚠️ Important Notes

  • Audit is an optional capability
  • These helpers do not enable auditing
  • Behaviour depends on the composed service stack
  • APIs degrade safely when audit capabilities are not present

🧩 What Lives Here

CurrencyAudit

  • Read recent audit entries
  • Filter by currency or operation type
  • Returns empty results when audit is not available

CurrencyAuditLive

  • Subscribe to live audit events
  • Returns a no-op subscription when unsupported

🧠 Usage Guidance

Mental model

  • Audit is a capability, not a guarantee
  • These helpers provide read/observe access only
  • Availability depends on implemented service capabilities

Required capabilities:

  • ICurrencyAuditReader for history
  • ICurrencyAuditEvents for live events

⚠️ Important Notes

  • No dependency on internal audit storage
  • No assumptions about implementation details
  • Safe to call regardless of capability presence

🚫 Internal Use Only

These helpers are part of the public API surface.

Do not:

  • Depend on internal audit implementations
  • Assume audit data is always available

🧹 Safe to Remove

This folder may be removed if audit functionality is not required.

Core Currency functionality will continue to operate without audit helpers.

  • PublicAPI / Helpers — composition and service helpers
  • Abstractions — audit interfaces
  • Internal — audit implementation