XRPL 핵심 기능별 샘플 코드(Typescript)

📦 주요 기능(폴더)별 README

Credential

About XRPL

XRPL Dev Source

Program Q&A

Credential

주요 내용

온체인 신원/권한 증명

폴더명

Credentials

스크립트 실행 명령어

#1) Credential 발급 (Admin -> User)
$npx ts-node xrpl/Credential/createCredential.ts 
#2) Credential 수락 (User)
$npx ts-node xrpl/Credential/acceptCredential.ts
#3) Credential 삭제 (User)
$npx ts-node xrpl/Credential/deleteCredential.ts
#4) Credential 조회 (누구나,Optional)
$npx ts-node xrpl/Credential/checkCredential.ts
Bash
복사

1. Credential이란?

Credential은 XRPL 원장에 저장되는 “발급자 → 피발급자” 신원·권한 증명 레코드다.

타입, 만료, 참조 URI 같은 메타데이터를 포함한다.

•

발급(Create): 발급자(issuer) 지갑이 수행

•

수락(Accept): 피발급자(subject) 지갑이 수행

•

도메인 정책 연계: 도메인의 AcceptedCredentials와 결합해 접근 제어에 사용

•

주요 필드 예

◦

Subject: 피발급자 주소

◦

CredentialType: 예 "KYC" → hex 인코딩 문자열

◦

Expiration: 만료 시각(리플 에폭 기준 초)

◦

URI: 참조 리소스의 hex 인코딩 URL

헬퍼: toHex("KYC"), toHex("https://...") 같은 간단한 hex 인코더를 스크립트에 포함해 쓰면 편함.

2. 왜 필요한가?

•

규제 준수: KYC/AML 충족 계정만 서비스·거래 접근 허용

•

접근 통제: 특정 Credential 보유자만 도메인/오더북/기능 참여

•

정책 분리: 자산·오퍼에 직접 제약을 박지 않고 도메인 정책에서 일괄 관리

•

유연성/상호운용: 타입/만료/URI를 조합해 다양한 접근 모델 구성

3. 시나리오: create → accept → check → delete

Step 1. Credential 발급 (Create)

•

주체: 발급자(관리자)

•

행동: CredentialCreate 트랜잭션 전송

•

내용:

◦

Subject: 피발급자 주소

◦

CredentialType: 예 hex("KYC")

◦

Expiration: 예 now + 3600

◦

URI: 참조 링크의 hex

import { Client, Wallet, Transaction, CredentialCreate } from "xrpl"
import path from "path"
import dotenv from "dotenv"

// .env 파일 로드
dotenv.config({ path: path.join(__dirname, "..", ".env") })

// 문자열 → hex 변환 (예: "KYC" → "4B5943")
const toHex = (s: string) => Buffer.from(s, "utf8").toString("hex")
// 현재 시간 (리플 에폭 초 단위)
const now = () => Math.floor(Date.now() / 1000)

export async function createCredential() {
  const client = new Client("wss://s.devnet.rippletest.net:51233")
  await client.connect()

  const ADMIN_SEED = process.env.ADMIN_SEED
  const USER_SEED = process.env.USER_SEED
  if (!ADMIN_SEED || !USER_SEED) {
    throw new Error("Missing env: ADMIN_SEED, USER_SEED")
  }

  try {
    const issuer = Wallet.fromSeed(ADMIN_SEED) // ✅ 발급자(서명자)
    const subject = Wallet.fromSeed(USER_SEED) // 피발급자

    // CredentialCreate 트랜잭션 구성
    const tx: CredentialCreate = {
      TransactionType: "CredentialCreate",
      Account: issuer.address,      // 발급자(서명자)
      Subject: subject.address,     // 피발급자
      CredentialType: toHex("KYC"), // "KYC" → hex
      Expiration: now() + 3600,     // 1시간 후 만료
      URI: toHex("https://example.com/credentials/kyc/user") // 참조 리소스 URL(hex)
    }

    // 트랜잭션 자동 보완 & 서명
    const prepared = await client.autofill(tx)
    const signed = issuer.sign(prepared)

    // 제출 후 결과 확인
    const res = await client.submitAndWait(signed.tx_blob)
    console.log(JSON.stringify(res.result, null, 2))

    return res.result
  } catch (err) {
    console.error("❌ Credential 발급 실패:", err)
    throw err
  } finally {
    await client.disconnect()
    console.log("🔄 연결 종료")
  }
}

// 단독 실행 시 동작
if (require.main === module) {
  createCredential().catch((e) => {
    console.error(e)
    process.exit(1)
  })
}
TypeScript
복사

•

만료가 지나면 도메인 정책에서 해당 Credential을 부적격으로 간주할 수 있음.

Step 2. Credential 수락 (Accept)

•

주체: 피발급자(사용자)

•

행동: CredentialAccept 트랜잭션 전송

•

내용:

◦

Account: 피발급자(서명자)

◦

Issuer: 발급자 주소

◦

CredentialType: Create 단계와 동일한 hex 타입

import { Client, Wallet, Transaction } from "xrpl"
import path from "path"
import dotenv from "dotenv"

// .env 로드
dotenv.config({ path: path.join(__dirname, "..", ".env") })

// 문자열을 hex로 변환 (예: "KYC" → 4B5943)
const toHex = (s: string) => Buffer.from(s, "utf8").toString("hex")

export async function acceptCredential() {
  const client = new Client("wss://s.devnet.rippletest.net:51233")
  await client.connect()

  const ADMIN_SEED = process.env.ADMIN_SEED
  const USER_SEED = process.env.USER_SEED
  if (!ADMIN_SEED || !USER_SEED) {
    throw new Error("Missing env: ADMIN_SEED, USER_SEED")
  }

  // 발급자 = Admin, 피발급자 = User
  const issuer = Wallet.fromSeed(ADMIN_SEED)
  const subject = Wallet.fromSeed(USER_SEED) // ✅ 서명자 = 피발급자

  try {
    // CredentialAccept 트랜잭션 구성
    const tx: Transaction = {
      TransactionType: "CredentialAccept",
      Account: subject.address, // ✅ 피발급자 서명/전송
      Issuer: issuer.address,
      CredentialType: toHex("KYC"), // createCredential.ts와 동일
    }

    // 자동 보완 & 서명
    const prepared = await client.autofill(tx)
    const signed = subject.sign(prepared)

    // 제출 & 결과 대기
    const result = await client.submitAndWait(signed.tx_blob)

    console.log(JSON.stringify(result, null, 2))
    return result
  } catch (err) {
    console.error("❌ Credential 수락 실패:", err)
    throw err
  } finally {
    await client.disconnect()
    console.log("🔄 연결 종료")
  }
}

// 단독 실행 시 동작
if (require.main === module) {
  acceptCredential().catch((e) => {
    console.error(e)
    process.exit(1)
  })
}
TypeScript
복사

•

 일부 도메인은 수락(accept) 된 Credential만 유효로 인정할 수 있음.

Step 3. Credential 조회 (Check)

•

주체: 누구나(공개 원장 조회)

•

행동: account_objects RPC → LedgerEntryType === "Credential" 필터

import { Client, Wallet } from "xrpl"
import path from "path"
import dotenv from "dotenv"

// .env 파일 로드
dotenv.config({ path: path.join(__dirname, "..", ".env") })

export async function checkCredential() {
  const client = new Client("wss://s.devnet.rippletest.net:51233")
  await client.connect()

  const USER_SEED = process.env.USER_SEED
  if (!USER_SEED) throw new Error("Missing env: USER_SEED")

  try {
    const subject = Wallet.fromSeed(USER_SEED) // ✅ 조회 대상 = User

    const all: any[] = []
    let marker: any = undefined

    // account_objects 페이지네이션 조회
    do {
      const r: any = await client.request({
        command: "account_objects",
        account: subject.address, // 조회할 계정 주소
        limit: 400,               // 최대 400개
        ...(marker ? { marker } : {})
      })

      // Credential 타입만 필터링
      const creds = (r.result.account_objects || []).filter(
        (o: any) => o.LedgerEntryType === "Credential"
      )

      all.push(...creds)
      marker = r.result.marker
    } while (marker)

    // 결과 출력
    console.log(JSON.stringify(all, null, 2))
    return all
  } catch (err) {
    console.error("❌ Credential 조회 실패:", err)
    throw err
  } finally {
    await client.disconnect()
    console.log("🔄 연결 종료")
  }
}

// 단독 실행 시 동작
if (require.main === module) {
  checkCredential().catch((e) => {
    console.error(e)
    process.exit(1)
  })
}
TypeScript
복사

•

Issuer, CredentialType, Expiration 등을 기준으로 유효 Credential만 골라서 표시.

Step 4. Credential 삭제 (Delete)

•

주체: 피발급자(본인)

•

행동: CredentialDelete 트랜잭션 전송

•

내용:

◦

Account: 피발급자(서명자)

◦

Issuer: 발급자 주소

◦

Subject: 피발급자 주소

◦

CredentialType: 삭제할 타입(hex)

import { Client, Wallet, Transaction } from "xrpl"
import path from "path"
import dotenv from "dotenv"

// .env 파일 로드
dotenv.config({ path: path.join(__dirname, "..", ".env") })

// 문자열을 hex 인코딩으로 변환 (CredentialType, URI 등에 사용)
const toHex = (s: string) => Buffer.from(s, "utf8").toString("hex")

export async function deleteCredential() {
  const client = new Client("wss://s.devnet.rippletest.net:51233")
  await client.connect()
  
  const ADMIN_SEED = process.env.ADMIN_SEED   // 발급자 (Issuer, 지정용)
  const USER_SEED  = process.env.USER_SEED    // ✅ 삭제 주체(본인, Subject)
  if (!ADMIN_SEED || !USER_SEED) throw new Error("Missing env: ADMIN_SEED, USER_SEED")

  try {
    const issuer  = Wallet.fromSeed(ADMIN_SEED)
    const subject = Wallet.fromSeed(USER_SEED) // ✅ 본인(Subject)

    // Credential 삭제 트랜잭션
    const tx: Transaction = {
      TransactionType: "CredentialDelete",
      Account: subject.address,        // ✅ 본인이 서명/전송
      Issuer: issuer.address,          // 발급자 주소 (명시 권장)
      Subject: subject.address,        // 피발급자 본인 주소 (명시 권장)
      CredentialType: toHex("KYC")     // create/accept과 동일한 hex 타입
    }

    const prepared = await client.autofill(tx)    // 자동 필드 채움(수수료, 시퀀스 등)
    const signed   = subject.sign(prepared)       // ✅ 본인(Subject) 서명
    const result   = await client.submitAndWait(signed.tx_blob)

    console.log(JSON.stringify(result, null, 2))
    return result
  } catch (err) {
    console.error("❌ Credential 삭제 실패:", err)
    throw err
  } finally {
    await client.disconnect()
    console.log("🔄 연결 종료")
  }
}

// 직접 실행 시 동작
if (require.main === module) {
  deleteCredential().catch((e) => { console.error(e); process.exit(1) })
}
TypeScript
복사

•

 도메인 정책이 “보유 중” Credential을 요구하는 경우, 삭제 후엔 접근이 제한될 수 있음.