Shared Types for Aphexplorer

TypeScript type definitions shared across all Aphexplorer services.

Overview

This package provides common interfaces and types for:

• API - REST and GraphQL request/response types
• Blockchain - Block, transaction, address, and contract types
• Database - Entity interfaces and configuration types
• Messages - Kafka message formats for inter-service communication

Installation

npm install @aphexplorer/shared-types

Usage

import { 
  BlockData, 
  TransactionData, 
  APIResponse 
} from '@aphexplorer/shared-types';

// Use in your service
const block: BlockData = {
  hash: '0x...',
  number: 12345,
  timestamp: Date.now()
};

const response: APIResponse<BlockData> = {
  success: true,
  data: block
};

Development

Setup

npm install

Build

npm run build

Development with Watch Mode

npm run dev

Package Structure

src/
├── api/           # API request/response types
├── blockchain/    # Blockchain entity types
├── database/      # Database configuration types
├── messages/      # Kafka message formats
└── index.ts       # Main exports

Type Categories

API Types

• APIResponse<T> - Standard API response wrapper
• APIError - Error response format
• Request/response types for all endpoints

Blockchain Types

• BlockData - Block information
• TransactionData - Transaction details
• AddressData - Address information
• ContractData - Smart contract data

Message Types

• BlockMessage - Block data for Kafka
• TransactionMessage - Transaction data for Kafka
• ContractEventMessage - Contract event data

Versioning

This package follows Semantic Versioning:

• Patch (1.0.X) - Add optional fields, fix typos
• Minor (1.X.0) - Add new types, extend interfaces
• Major (X.0.0) - Breaking changes, remove fields

Publishing

# Update version
npm version patch|minor|major

# Publish to registry
npm publish

Services Using This Package

• aphexplorer-api - REST/GraphQL API service
• aphexplorer-agent - Blockchain data collection
• aphexplorer-ingestion - Data processing service

Contributing

1. Add new types to appropriate category in src/
2. Export from src/index.ts
3. Update version in package.json
4. Update CHANGELOG.md with changes
5. Test with dependent services before publishing

License

MIT