xrpl mcp

by RomThpt
Verified
MIT License
3
  • Linux
  • Apple

remote-capable server

The server can be hosted and run remotely because it primarily relies on remote services or has no dependency on the local environment.

Integrations

  • Used for environment variable management and configuration, allowing the server to securely store sensitive data like wallet seeds and network selection.

  • Serves as the runtime environment for the MCP server, with version 18.0.0 or higher required as a prerequisite.

  • Implementation language for the MCP server, providing type safety and modern language features.

XRP 원장 모델 컨텍스트 프로토콜 서버

라이센스: MIT | XRPL Networks | TypeScript | xrpl.js

XRP Ledger 생태계에 블록체인 서비스를 제공하는 포괄적인 모델 컨텍스트 프로토콜(MCP) 서버입니다. 이 서버를 통해 AI 에이전트는 통합 인터페이스를 통해 XRPL MainNet, TestNet 및 DevNet과 상호 작용할 수 있습니다.

📋 목차

🔭 개요

MCP XRPL 서버는 모델 컨텍스트 프로토콜을 활용하여 AI 에이전트에 XRP 원장 서비스를 제공합니다. 다음을 포함한 다양한 서비스를 지원합니다.

  • 원장 상태(잔액, 거래, 계좌 정보 등) 읽기
  • 스마트 계약과 상호 작용(Hooks를 통해)
  • XRP 및 발행된 토큰 전송
  • 토큰 메타데이터 및 잔액 쿼리
  • 분산 식별자(DID) 관리
  • XRPL에서 NFT 작업
  • 자동화된 시장 제작자(AMM) 운영
  • 결제 채널, 에스크로 및 수표
  • Oracle 데이터 작업
  • Trustline 관리

모든 서비스는 MCP 도구와 리소스의 일관된 인터페이스를 통해 노출되므로 AI 에이전트가 XRPL 기능을 쉽게 발견하고 사용할 수 있습니다.

✨ 특징

계정 관리

  • XRPL 네트워크(MainNet, TestNet, DevNet)에 연결
  • 계정 정보 검색
  • 계정 자산 관리
  • 보증금 사전 승인
  • 정기적인 키 관리

XRP 및 토큰 운영

  • 계정 간 XRP 전송
  • 토큰 메타데이터(이름, 기호, 소수점, 공급) 가져오기
  • 토큰 잔액 확인
  • 주소 간 토큰 전송
  • 토큰 지출 승인
  • 토큰 회수

NFT 운영

  • XRP Ledger에서 NFT를 발행하세요
  • NFT 메타데이터 보기
  • NFT 소유권 확인
  • 주소 간 NFT 전송
  • NFT 컬렉션 받기

분산 식별자(DID)

  • XRPL에 DID 생성
  • DID 해결
  • DID 문서 업데이트
  • DID 비활성화

AMM 운영

  • 자동화된 마켓 메이커 만들기
  • AMM에 입금
  • AMM에 입찰하세요
  • AMM 매개변수에 대한 투표
  • AMM 삭제
  • AMM에서 자산 회수

작업 확인

  • 수표 만들기
  • 현금 수표
  • 수표 취소

오퍼/DEX 운영

  • 제안 만들기
  • 제안 취소

오라클 운영

  • 오라클 데이터 설정
  • 오라클 데이터 삭제

결제 채널

  • 결제 채널 생성
  • 펀드 지급 채널
  • 결제 채널에서 청구

조건부 날인 증서

  • 에스크로 생성
  • 에스크로 완료
  • 에스크로 취소

신뢰 라인

  • 신뢰 라인 설정 및 관리

티켓팅

  • 거래 처리를 위한 티켓 생성

🌐 지원 네트워크

  • MainNet : 프로덕션 XRP Ledger 네트워크
  • TestNet : 개발을 위한 테스트 네트워크
  • DevNet : 실험적 기능을 위한 개발 네트워크

🛠️ 필수 조건

  • Node.js 18.0.0 이상

📦 설치

지엑스피1

⚙️ 서버 구성

프로젝트 루트에 다음 변수를 사용하여 .env 파일을 만듭니다.

# Optional: XRPL wallet seed for automatic connection # If not provided, you can connect using the connect-to-xrpl tool DEFAULT_SEED=sEdVoKkRRF8RsNYZ689NDeMyrijiCbg # Example - replace with your own or remove # Network selection (default is "testnet") XRPL_NETWORK=testnet # Options: mainnet, testnet, devnet

🚀 사용법

서버 시작

# Start the server in stdio mode (for CLI tools) npm start

서버에 연결

MCP 호환 클라이언트를 사용하여 이 MCP 서버에 연결하세요. 테스트 및 디버깅에는 MCP Inspector를 사용할 수 있습니다.

📚 API 참조

도구

서버는 에이전트에게 다음과 같은 MCP 도구를 제공합니다.

계정 관리

도구 이름설명주요 매개변수
connect-to-xrpl시드를 사용하여 XRP Ledger에 연결씨앗, 네트워크
get-account-info계정 정보 받기주소, 네트워크
delete-accountXRPL 계정 삭제개인키, 목적지, 네트워크
set-account-properties계정 속성 설정privateKey, 속성, 네트워크
deposit-preauth보증금 사전 승인개인키, 승인, 네트워크
set-regular-key계정에 대한 정기 키 설정개인키, 일반키, 네트워크

XRP 및 토큰 운영

도구 이름설명주요 매개변수
transfer-xrpXRP를 계정으로 보내세요privateKey, 받는 사람, 금액, 네트워크
get-token-metadata토큰 메타데이터 가져오기토큰 주소, 네트워크
check-token-balance토큰 잔액 확인토큰 주소, 소유자 주소, 네트워크
transfer-token토큰 전송privateKey, tokenAddress, 받는 사람, 금액, 네트워크
approve-token-spending토큰 지출 승인privateKey, tokenAddress, limit, network
token-clawback클로백 토큰privateKey, tokenAddress, 발신자, 금액, 네트워크

NFT 운영

도구 이름설명주요 매개변수
nft-mintNFT를 주조하다privateKey, uri, 플래그, 네트워크
get-nft-infoNFT 메타데이터 가져오기토큰ID, 네트워크
check-nft-ownershipNFT 소유권 확인토큰ID, 소유자주소, 네트워크
transfer-nftNFT 전송privateKey, tokenID, to, 네트워크
get-nft-collection컬렉션에서 NFT를 얻으세요주소, 네트워크

DID 운영

도구 이름설명주요 매개변수
create-didDID 생성개인키, 데이터, 네트워크
resolve-didDID 해결했다, 네트워크
update-didDID 업데이트privateKey, did, 데이터, 네트워크
deactivate-didDID 비활성화privateKey, did, 네트워크

AMM 운영

도구 이름설명주요 매개변수
amm-createAMM 만들기privateKey, 자산, 네트워크
amm-depositAMM에 입금privateKey, ammID, 자산, 네트워크
amm-bidAMM에 입찰하기privateKey, ammID, bid, 네트워크
amm-voteAMM 매개변수에 대한 투표privateKey, ammID, 투표, 네트워크
amm-deleteAMM 삭제개인키, ammID, 네트워크
amm-clawbackAMM에서 자산 회수privateKey, ammID, 자산, 네트워크

자원

서버는 다음 MCP 리소스 URI를 통해 XRPL 데이터를 노출합니다.

레저 리소스

리소스 URI 패턴설명
xrpl://{network}/ledger/current현재 원장 정보
xrpl://{network}/ledger/{ledger_index}인덱스별 원장
xrpl://{network}/account/{address}계정 정보
xrpl://{network}/account/{address}/balance계정 XRP 잔액
xrpl://{network}/tx/{tx_hash}거래 세부 정보

토큰 리소스

리소스 URI 패턴설명
xrpl://{network}/token/{currency}/{issuer}토큰 정보
xrpl://{network}/token/{currency}/{issuer}/balanceOf/{address}토큰 잔액
xrpl://{network}/nft/{tokenID}NFT 정보
xrpl://{network}/nft/{tokenID}/ownerNFT 소유권 정보

🔒 보안 고려 사항

  • 지갑 시드는 거래 서명에만 사용되며 안전하게 보관해야 합니다.
  • 프로덕션 사용을 위해 추가 인증 메커니즘 구현을 고려하세요.
  • 고가치 서비스의 경우 확인 단계를 추가하는 것을 고려하세요.
  • 개발 중 안전을 보장하기 위해 기본 작업은 TestNet에서 수행됩니다.
  • 민감한 구성에는 환경 변수를 사용하세요

📁 프로젝트 구조

mcp-xrpl/ ├── src/ │ ├── core/ # Core utilities and services │ │ ├── constants.ts # XRPL network URLs and other constants │ │ ├── state.ts # State management for connected wallet │ │ ├── utils.ts # Helper functions │ │ └── services/ # Service modules │ ├── server/ # MCP server implementation │ ├── transactions/ # XRPL transaction implementation │ │ ├── token/ # Token-related transactions │ │ ├── nft/ # NFT-related transactions │ │ ├── did/ # DID-related transactions │ │ ├── amm/ # AMM-related transactions │ │ ├── check/ # Check-related transactions │ │ ├── offer/ # Offer-related transactions │ │ ├── oracle/ # Oracle-related transactions │ │ ├── payment/ # Payment-related transactions │ │ ├── escrow/ # Escrow-related transactions │ │ └── trust/ # Trust line-related transactions │ └── index.ts # Entry point ├── build/ # Compiled JavaScript output ├── package.json ├── package-lock.json └── tsconfig.json

🛠️ 개발

새로운 도구 추가

새로운 도구를 추가하려면:

  1. src/transactions/ 아래의 적절한 디렉토리에 새 TypeScript 파일을 만듭니다.
  2. server/server.js 에서 서버를 가져옵니다.
  3. server.tool() 사용하여 도구를 정의합니다.
  4. src/index.ts 에 도구를 가져옵니다.

프로젝트 종속성

📄 라이센스

이 프로젝트는 MIT 라이선스 조건에 따라 라이선스가 부여되었습니다.

⚠️ 면책 조항

이 소프트웨어는 교육 및 개발 목적으로만 제공됩니다. 사용에 따른 모든 책임은 사용자에게 있습니다. 메인넷에서 실제 XRP를 사용하기 전에 테스트넷에서 철저히 테스트해 보시기 바랍니다.

-
security - not tested
A
license - permissive license
-
quality - not tested

XRP Ledger와 통합을 제공하는 CP 서버입니다. 이 서버를 통해 AI 비서가 XRP Ledger의 계정 정보, 거래 내역 및 네트워크 데이터에 접근할 수 있으며, 원장 객체 쿼리, 거래 제출 및 네트워크 모니터링 기능을 제공합니다.

  1. 📋 Contents
    1. 🔭 Overview
      1. ✨ Features
        1. Account Management
        2. XRP and Token Operations
        3. NFT Operations
        4. Decentralized Identifier (DID)
        5. AMM Operations
        6. Check Operations
        7. Offer/DEX Operations
        8. Oracle Operations
        9. Payment Channels
        10. Escrow
        11. Trustlines
        12. Ticketing
      2. 🌐 Supported Networks
        1. 🛠️ Prerequisites
          1. 📦 Installation
            1. ⚙️ Server Configuration
              1. 🚀 Usage
                1. Starting the Server
                2. Connecting to the Server
              2. 📚 API Reference
                1. Tools
                2. Resources
              3. 🔒 Security Considerations
                1. 📁 Project Structure
                  1. 🛠️ Development
                    1. Adding New Tools
                    2. Project Dependencies
                  2. 📄 License
                    1. ⚠️ Disclaimer
                      ID: aifp64y484