How lerianstudio/midaz-sdk-golang works
Midaz Go SDK is a typed client for the ledger’s /v1 and /v2 APIs. The principal workflow is application code constructing a client, choosing a versioned service facade, and making typed requests that return decoded results or structured errors. Other documented capabilities include OAuth or anonymous authentication, pagination, retries, idempotency, observability, transaction batching, generators, and validation. The graph follows README-described wiring and excerpted calls; several implementation links remain absent because the client constructor and many runtime modules were not sampled.
Main entry points: operation_routes_facade.go Operation routes · transaction_routes_facade.go Transaction routes · model.go Typed models · midaz_options.go Client options
Components 24
Client and services
- Client construction
midaz.go - Client options
midaz_options.go - V1 services
entities - V2 services
entities - Operation routes
entities/operation_routes_facade.go - Transaction routes
entities/transaction_routes_facade.go - Typed models
models/model.go - List pagination
entities/iter.go
Transport and resilience
- HTTP response layer
entities/http.go - Access Manager auth
pkg/auth/access_manager.go - HTTP retries
pkg/retry/http.go - Structured errors
pkg/errors/errors.go
Ledger workflows
- Route generators
pkg/generator/operation_routes_generator.go - Transaction batches
pkg/transaction/batch.go - Account helpers
pkg/accounts/accounts.go - Enhanced validation
pkg/validation/enhanced.go - Ledger integrity
pkg/integrity/checker.go - Value formatting
pkg/format/format.go
Shared capabilities
- HTTP batching
pkg/concurrent/http_batch.go - Performance batching
pkg/performance/batch.go - OpenTelemetry
pkg/observability/observability.go - Request context
pkg/sdkctx/sdkctx.go
Other components
- SDK consumer
- Midaz ledger API
Connections 33
- SDK consumer → Client construction: constructs
README.md - Client construction → Client options: accepts options
midaz_options.go - SDK consumer → V1 services: uses
README.md - SDK consumer → V2 services: uses
README.md - V1 services → Midaz ledger API: requests `/v1`
README.md - V2 services → Midaz ledger API: requests `/v2`
README.md - Operation routes → Midaz ledger API: calls endpoints
entities/operation_routes_facade.go - Transaction routes → Midaz ledger API: calls endpoints
entities/transaction_routes_facade.go - Operation routes → Typed models: uses typed inputs
entities/operation_routes_facade.go - Transaction routes → Typed models: uses typed inputs
entities/transaction_routes_facade.go - V1 services → Operation routes: exposes service
- V2 services → Operation routes: exposes service
- V1 services → Transaction routes: exposes service
- V2 services → Transaction routes: exposes service
- Operation routes → HTTP response layer: decodes responses
entities/operation_routes_facade.go - Transaction routes → HTTP response layer: decodes responses
entities/transaction_routes_facade.go - HTTP response layer → Structured errors: reports failures
- Client options → Access Manager auth: configures auth
- Client options → OpenTelemetry: configures provider
midaz_options.go - Client options → HTTP retries: configures retries
midaz_options.go - Operation routes → List pagination: supports list pages
- Transaction routes → List pagination: supports list pages
- Route generators → Operation routes: creates routes
pkg/generator/operation_routes_generator.go - Route generators → Transaction routes: creates routes
- Route generators → Typed models: validates inputs
pkg/generator/operation_routes_generator.go - Transaction batches → Typed models: processes transactions
pkg/transaction/batch.go - Transaction batches → Request context: reads request context
pkg/transaction/batch.go - Account helpers → Value formatting: formats values
pkg/accounts/accounts.go - Enhanced validation → Typed models: validates transaction data
- Ledger integrity → Typed models: checks ledger entities
pkg/integrity/checker.go - HTTP batching → HTTP retries: configures HTTP retries
pkg/concurrent/http_batch.go - Performance batching → Structured errors: returns structured errors
pkg/performance/batch.go - Performance batching → OpenTelemetry: reports telemetry