@avelon/types

Shared TypeScript types for the Avelon decentralized lending platform.

Installation

``bash
npm install @avelon/types
`

Usage

`typescript
import {
User,
UserRole,
UserStatus,
Loan,
LoanStatus,
LoanPlan,
CreditTier,
ApiResponse,
ErrorCode,
} from '@avelon/types';
`

Modules

$3

- User, UserRole, UserStatus, KYCLevel, CreditTier
- LoginCredentials, RegisterData, AuthTokens, Session
- Wallet, WalletStatus, WalletAnalysis

$3

- Loan, LoanStatus, CollateralHealth
- LoanPlan, InterestType, PlanEligibility
- LoanTransaction, LoanTransactionType, TransactionStatus

$3

- Document, DocumentType, DocumentStatus
- AIVerificationResult, CreditScoreBreakdown
- FraudFlag, FraudFlagType

$3

- Notification, NotificationType, NotificationPriority
- NotificationPreferences, NotificationChannel

$3

- ApiResponse, PaginatedResponse, ErrorResponse
- ErrorCode, ValidationError
- PaginationParams, ListRequest

$3

- ContractLoan, ContractLoanPlan, ContractAddresses
- ContractEvent, ContractEventLog
- BlockchainTransaction, TransactionReceipt, GasEstimate

Development

`bash

Install dependencies

npm install

Build

npm run build

Type check

npm run typecheck
`

Publishing

`bash

Build and publish to GitHub Packages

npm publish
``

License

MIT