@point3/ledger-tool

@point3/ledger-tool

포인트3 원장(Ledger) 시스템을 관리하고 상호작용하기 위한 통합 도구입니다.

이 프로젝트는 TigerBeetle을 기반으로 한 포인트3 원장 시스템의 CLI 도구와 Node.js SDK를 제공합니다.

주요 기능

• Commander 기반 CLI: 계정 생성, 조회, ID 변환 등 다양한 관리 기능 제공
• TypeScript SDK: NestJS 등 애플리케이션에 쉽게 통합 가능한 Repository 패턴 제공
• Interactive Mode: 연속적인 작업을 위한 대화형 쉘 환경 지원
• Type Safety: TypeScript로 작성되어 안전한 타입 시스템 제공

설치 (Installation)

프로젝트 내 개발 의존성으로 설치 (Recommended)

프로젝트 내부에서만 CLI를 사용하려면 devDependencies로 설치할 수 있습니다.

npm install -D @point3/ledger-tool

설치 후 npx를 통해 실행할 수 있습니다.

npx point3-ledger [command]

저장소 클론 후 직접 실행

이 저장소를 클론하여 CLI 도구를 직접 사용할 수도 있습니다.

# 저장소 클론 및 의존성 설치
git clone https://github.com/violetpay-org/point3-ledger-tool.git
cd point3-ledger-tool
npm install

# 빌드
npm run build:dev

# 전역 명령어로 등록 (선택사항)
npm link

라이브러리로 사용 시

다른 Node.js 프로젝트에서 SDK로 사용할 수 있습니다.

npm install @point3/ledger-tool

빠른 시작 (Quick Start)

로컬 TigerBeetle 실행

개발 및 테스트를 위해 로컬에 TigerBeetle 인스턴스를 실행할 수 있는 스크립트를 제공합니다.

npm run tigerbeetle:docker

CLI 사용

설치 후 point3-ledger 명령어를 통해 다양한 작업을 수행할 수 있습니다.

# 헬프 메시지 확인
point3-ledger --help

# 대화형 모드 진입
point3-ledger interactive

# 설정 확인
point3-ledger config tigerbeetle show

👉 자세한 내용은 CLI 사용 가이드를 참고하세요.

SDK 사용

TigerBeetleAccountRepository를 통해 원장 데이터에 쉽게 접근할 수 있습니다.

import { createClient } from "tigerbeetle-node";
import { TigerBeetleAccountRepository } from "@point3/ledger-tool/account";

// 1. TigerBeetle 클라이언트 연결
const client = createClient({
  cluster_id: 0n,
  replica_addresses: ["127.0.0.1:3000"]
});

// 2. 레포지토리 초기화
const repo = new TigerBeetleAccountRepository(client);

// 3. 계정 조회 예시
const account = await repo.get(id);

👉 자세한 내용은 라이브러리 사용 가이드를 참고하세요.

문서 (Documentation)

더 자세한 정보는 docs 디렉토리의 문서를 확인해주세요.

• 📖 CLI 사용 가이드: 커맨드라인 도구 상세 사용법
• 📦 라이브러리 사용 가이드: SDK 통합 및 API 사용법

라이선스

ISC