SortOrder represents the sort direction.

Action represents the allowed actions on a resource. Actions include read, write, delete, and wildcard (*).

LogicalOperator represents how multiple filters are combined.

Resource represents a protected API resource that can be accessed via API keys. Each resource corresponds to a specific API endpoint category.

APIError represents a custom error structure for the API. It includes an error code, message, and optional details to provide additional context for t

Account represents a financial account linked to a balance, identity, and ledger.

AlertCondition specifies the field, operator, value, and precision for a balance monitor alert threshold.

Allocation represents the amount allocated from a specific shadow balance during debit processing. Fields: - BalanceID string: The ID of the shadow b

Api represents the API structure for handling requests.

AuthMiddleware handles authentication and authorization for API routes. It supports both master key and API key authentication using the X-LedgerForge

BackupManager manages database backups, supporting both local disk and S3 storage.

Balance represents a financial balance with credit, debit, inflight, and queued sub-balances.

BalanceFilter defines filter criteria for querying balances by range, currency, ledger, and time period.

BalanceLineage represents the complete fund lineage for a balance. Fields: - BalanceID string: The ID of the balance being queried. - TotalWithLineag

BalanceMonitor defines a condition-based alert that triggers a callback when a balance meets the specified criteria.

BalanceTracker tracks in-memory balance state and access frequency for hot-path optimization.

BatchJobResult represents the result of processing a transaction in a batch job. Fields: - Txn *model.Transaction: A pointer to the processed Transac

BulkTransactionRequest encapsulates the data needed for a bulk transaction request.

BulkTransactionResult represents the outcome of a bulk transaction operation.

Cache interface provides the basic operations for a cache system. It includes methods for setting, getting, and deleting cached data.

CollectionConfig holds configuration for a specific collection.

Distribution defines how a transaction amount is allocated to a specific source or destination.

ErrorCode defines a string type to represent specific error codes used in the API.

FilterRequest represents the JSON body for filter endpoints. It allows clients to pass filters directly as JSON instead of query parameters.

FilterResponse wraps the response with optional count.

Hook represents a webhook configuration.

HookManager defines the interface for managing hooks.

HookPayload represents the data sent to webhook endpoints.

HookResponse represents the expected response from webhook endpoints.

HookTaskPayload represents the payload for a queued hook task.

IDataSource defines the interface for data source operations, grouping related functionalities.

IndexBatch represents a batch of items to be indexed in dependency order. Dependencies are indexed first, then the primary item is indexed. This ensur

IndexItem represents a single item to be indexed in Typesense.

LedgerForge represents the main struct for the LedgerForge application.

LedgerForge represents the CLI application, encapsulating the root Cobra command.

LineageMapping tracks the relationship between a balance, its fund provider, and associated shadow/aggregate balances.

LineageOutbox represents a pending lineage processing task. It is inserted atomically with the main transaction to ensure no lineage work is lost.

LineageOutboxPayload contains the transaction data needed for deferred lineage processing.

LineageOutboxProcessor processes pending lineage outbox entries. It polls the database for pending entries and processes them asynchronously, ensuring

LineageSource represents a source of funds available for allocation during lineage debit processing. Fields: - BalanceID string: The ID of the shadow

Locker represents a distributed lock using Redis. The lock is identified by a unique key and value, where the value is used to ensure that only the lo

MetadataRequest represents the structure for metadata update requests. It contains a required metadata field that holds key-value pairs for updating e

MockConfigFetcher is a mock for the config fetching

MockDataSource is a mock implementation of the IDataSource interface

MultiLocker manages multiple distributed locks with deterministic ordering. It acquires locks in lexicographic order to prevent deadlocks when multipl

MultiSearchRequest represents a request for multiple searches

NewWebhook represents the structure of a webhook notification. It includes an event type and associated payload data.

NotificationPayload represents the payload structure for notifications, containing the table and data.

Operator represents supported filter operators.

PoolConfig holds Redis connection pool settings.

ProviderBreakdown represents the fund breakdown for a specific provider in a balance's lineage. Fields: - Provider string: The name/identifier of the

QueryOptions contains sorting and pagination options for queries.

Queue represents a queue for handling various tasks.

Redis struct holds the Redis client and addresses of Redis instances. It supports both single-instance Redis connections and Redis Cluster setups.

RedisCache implements the Cache interface, using Redis as the underlying cache store. It leverages both Redis and local in-memory caching for efficien