Skip to content

Commit

Permalink
chore(docs): remove core entities and technical specifications section
Browse files Browse the repository at this point in the history
  • Loading branch information
thevaibhav-dixit committed Dec 10, 2024
1 parent 9b9c5c8 commit 9fcdda2
Showing 1 changed file with 0 additions and 75 deletions.
75 changes: 0 additions & 75 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,81 +18,6 @@ Cala is a robust ledger system developed by Galoy, designed to handle complex fi
- **Transaction Templates**: Customizable transaction templates for common financial operations
- **Multi-Currency Support**: Handle transactions across different currencies

### Core Entities

#### Accounts

- Unique identification via UUID and optional external IDs
- Configurable normal balance type (debit/credit)
- Version-controlled with status tracking (active/locked)
- Rich metadata support with JSON fields
- Balance queries with currency and time-range filtering

#### Account Sets

- Hierarchical account grouping with nested set support
- Journal-scoped for organizational separation
- Consolidated balance reporting across member accounts
- Flexible member management (add/remove operations)

#### Journals

- Independent ledger contexts for transaction isolation
- Support for multiple concurrent journals
- Transaction correlation and external ID tracking

#### Transactions

- Template-based transaction creation
- Effective dating support
- Correlation ID for transaction linking
- Multi-layer support (settled/pending/encumbrance)
- Rich metadata and external ID tracking

#### Velocity Controls

- Configurable transaction limits
- Balance-based and time-based controls
- Multiple limit aggregation support
- Flexible control attachment to accounts/sets

### Technical Specifications

#### Query Interface

- Point lookups by UUID, external ID, and code
- Cursor-based pagination with configurable page sizes
- Balance queries with time range support
- Comprehensive transaction search

#### Type System

- Strong typing with custom scalars (UUID, Timestamp, Date)
- JSON support for flexible metadata
- Decimal type for precise financial calculations
- Expression-based template parameters

#### Implementation Details

- Consistent versioning across all entities
- Optimistic concurrency control
- Immutable audit fields (createdAt, modifiedAt)
- Rich error handling and validation

#### Developer Experience

- Interactive GraphQL playground at `http://localhost:2252/graphql`
- Built-in schema documentation
- Query validation and type checking

## Components

- `cala-ledger`: Core ledger implementation
- `cala-server`: Server implementation handling API requests
- `cala-nodejs`: Node.js bindings for integration with JavaScript/TypeScript applications
- `cala-cel-interpreter` & `cala-cel-parser`: Common Expression Language (CEL) support
- `cala-tracing`: Tracing and monitoring functionality

## Developing

### Dependencies
Expand Down

0 comments on commit 9fcdda2

Please sign in to comment.