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

📦 주요 기능(폴더)별 README

PermissionedDomains

About XRPL

XRPL Dev Source

Program Q&A

PermissionedDomains

주요 내용

도메인 생성·정책 관리

폴더명

PermissionedDomains

스크립트 실행 명령어

#1) 특정 Credential 소유자만 접근 가능한 Domain 생성
$npx ts-node xrpl/PermissionedDomains/createDomain.ts
#2) Domain 삭제
$npx ts-node xrpl/PermissionedDomains/deleteDomain.ts
#3) 해당 Domain에 접근 가능한 Credential 및 소유자 리스트 보기 (Optional)
$npx ts-node xrpl/PermissionedDomains/AcceptedCredentials.ts

#여기서는 생성 후 출력되는 DomainID(created): 2A65BCCE9715703A09460B44812BB65D41B9406A42D0CC66979E385C5788#### 를 나머지 스크립트에 넣어서 사용해야 합니다.
Bash
복사

1. Permissioned Domain이란?

Permissioned Domain은 접근 정책(Access Policy)을 온체인에 등록하는 기능이다.

스스로는 아무 행동도 하지 않지만, 다른 리소스(예: Permissioned DEX, Lending Vault 등)에 도메인 ID를 연결하면

해당 리소스가 이 도메인의 규칙을 따라 트랜잭션을 허용하거나 거부할 수 있다.

•

도메인의 규칙 = AcceptedCredentials

1~10개의 “허용 자격”을 나열한다.

각 자격은 발급자(Issuer)와 CredentialType(hex)의 조합이다.

•

접근 허용 조건

트랜잭션을 보내는 계정이 이 도메인에서 허용한 Credential을 최소 1개 이상 가지고 있어야 한다.

해당 Credential은 수락됨(accepted) 상태이며 만료되지 않아야 한다.

2. 왜 필요한가?

•

규제 준수

금융 서비스, KYC/AML 요구사항이 있는 프로젝트에서 필수.

•

정책 분리

정책 변경 시, 리소스 코드나 주소를 수정할 필요 없이 도메인 규칙만 업데이트하면 된다.

•

운영 유연성

발급/수락/만료를 통해 실시간으로 접근자 목록이 변동될 수 있다.

•

소유권 명확

도메인을 만든 계정(오너)만 규칙 변경·삭제 가능.

3. 시나리오: createDomain → deleteDomain

시나리오에서는 도메인 생성과 삭제만 다룬다.

Credential 발급/수락 시나리오와 조합하면, 도메인의 실제 접근제한 효과까지 확인할 수 있다.

Step 1. 도메인 생성

•

주체: ADMIN(도메인 오너)

•

행동: PermissionedDomainSet 트랜잭션 전송

•

내용:

◦

AcceptedCredentials: {Issuer: ADMIN, CredentialType: "KYC(hex)"}

→ ADMIN이 발급한 KYC Credential을 가진 계정만 이 도메인에 접근 가능

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

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

// 문자열을 hex 인코딩하는 헬퍼 함수
const toHex = (s: string) => Buffer.from(s, "utf8").toString("hex")

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

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

  // 발행자(Admin) 지갑 로드
  const admin = Wallet.fromSeed(ADMIN_SEED)

  try {
    // PermissionedDomainSet 트랜잭션 구성
    const tx: Transaction = {
      TransactionType: "PermissionedDomainSet",
      Account: admin.address,
      // 새로운 Domain 생성 시 DomainID는 생략
      AcceptedCredentials: [
        {
          Credential: {
            Issuer: admin.address,
            CredentialType: toHex("KYC"), // "KYC" → hex 인코딩
          },
        },
      ],
    }

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

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

    // 전체 응답 로그 출력
    console.log(JSON.stringify(result, null, 2))

    // meta 데이터에서 생성된 PermissionedDomain 객체 탐색
    const out = result.result ?? result
    const created = (out.meta?.AffectedNodes || []).find(
      (n: any) => n.CreatedNode?.LedgerEntryType === "PermissionedDomain"
    )
    const domainId =
      created?.CreatedNode?.LedgerIndex ||
      created?.CreatedNode?.NewFields?.DomainID ||
      null

    if (domainId) {
      console.log("✅ DomainID(created):", domainId)
    } else {
      console.warn("⚠️ Could not locate DomainID in meta. Check node support/fields.")
    }

    return result
  } catch (err) {
    console.error("❌ 도메인 생성 실패:", err)
    throw err
  } finally {
    await client.disconnect()
    console.log("🔄 연결 종료")
  }
}

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

•

콘솔에 생성된 도메인 ID(따로 복사해 도메인 삭제 및 Credential 조회 등에 사용)

DomainID(created): 2A65BCCE9715703A09460B44812BB65D41B9406A42D0CC66979E385C5788####
Bash
복사

•

DomainID : Permissioned Domain을 고유하게 식별하는 32바이트(256비트) 해시 값으로, 64자리 hex 문자열로 표시됨

Step 2. 도메인 삭제

•

주체: ADMIN

•

행동: PermissionedDomainDelete 트랜잭션 전송

•

내용: DomainID 지정 → 해당 도메인의 정책 자체가 사라짐

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

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

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

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

  // 발행자(Admin) 지갑 로드
  const admin = Wallet.fromSeed(ADMIN_SEED)

  // ✅ createDomain 실행 결과 로그에서 복사한 DomainID 입력
  const DOMAIN_ID =
    "2A65BCCE9715703A09460B44812BB65D41B9406A42D0CC66979E385C5788####"

  try {
    // PermissionedDomainDelete 트랜잭션 구성
    const tx: Transaction = {
      TransactionType: "PermissionedDomainDelete",
      Account: admin.address,
      DomainID: DOMAIN_ID,
    }

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

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

    // 전체 응답 출력
    console.log(JSON.stringify(result, null, 2))

    return result
  } catch (err) {
    console.error("❌ 도메인 삭제 실패:", err)
    throw err
  } finally {
    await client.disconnect()
    console.log("🔄 연결 종료")
  }
}

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

(옵션)Step 3. 특정 도메인의 Accepted Credentials 정보 조회

import { Client } from "xrpl"

async function inspectDomain() {
  // XRPL Devnet 연결
  const client = new Client("wss://s.devnet.rippletest.net:51233")
  await client.connect()

  try {
    //  createDomain 실행 로그에서 복붙한 DomainID
    const DOMAIN_ID =
      "5771BD9BD9B9BC01816103C9E435E54630AFF83B607DC9BCB0005D'''''''''"

    // ledger_entry 명령으로 Domain 객체 조회
    const r = await client.request({
      command: "ledger_entry",
      index: DOMAIN_ID,
    })

    // 결과를 JSON 포맷으로 출력
    console.log(JSON.stringify(r, null, 2))
  } catch (err) {
    console.error("❌ 도메인 조회 실패:", err)
  } finally {
    // 연결 종료
    await client.disconnect()
    console.log("🔄 연결 종료")
  }
}

// 직접 실행된 경우 함수 실행
inspectDomain().catch((e) => {
  console.error(e)
  process.exit(1)
})
TypeScript
복사

•

해당 도메인의 AcceptedCredentials 정보를 콘솔에 출력