repository

Repository Pattern

Overview

Rules for implementing Repository pattern in go-crypto-wallet. Repositories abstract data access and map between domain entities and infrastructure.

Applicable Files

• internal/application/ports/repository/**/*.go - Interface definitions (Ports)
• internal/infrastructure/repository/**/*.go - Implementations

Architecture

internal/application/ports/repository/
├── cold/                    # Cold wallet repositories (keygen/sign)
│   ├── account_key.go       # Interface
│   ├── auth.go
│   └── seed.go
└── watch/                   # Watch wallet repositories
    ├── address.go           # Interface
    ├── btc_transaction.go
    └── ...

internal/infrastructure/repository/
├── cold/
│   ├── mysql/               # MySQL implementations
│   │   ├── account_key_sqlc.go
│   │   └── ...
│   └── mocks/               # Test mocks
│       └── mock_*.go
└── watch/
    ├── mysql/
    │   ├── address_sqlc.go
    │   └── ...
    └── mocks/
        └── mock_*.go

Interface Definition (Ports)

Naming Convention

Interface names end with er suffix:

// ✅ GOOD: Descriptive interface names
type AddressRepositorier interface { ... }
type BTCTxRepositorier interface { ... }
type SeedRepositorier interface { ... }

// ❌ BAD: Missing suffix or unclear
type AddressRepository interface { ... }
type AddressRepo interface { ... }

Interface Location

Interfaces MUST be defined in internal/application/ports/repository/:

// internal/application/ports/repository/watch/address.go
package watch

type AddressRepositorier interface {
    GetAll(accountType domainAccount.AccountType) ([]*domainAddress.Address, error)
    GetAllAddress(accountType domainAccount.AccountType) ([]string, error)
    GetOneUnAllocated(accountType domainAccount.AccountType) (*domainAddress.Address, error)
    InsertBulk(ctx context.Context, items []*domainAddress.Address) error
    UpdateIsAllocated(isAllocated bool, Address string) (int64, error)
}