@mcptoolshop/xrpl-lab
v2.5.0
Published
XRPL training workbook — zero-prerequisite npx install (verified binary launcher)
Downloads
91
Maintainers
Readme
XRPL 训练手册——通过实践学习,通过成果证明。
每个模块教授一项 XRPL 技能,并生成一个可验证的成果:交易 ID、已签名的收据或诊断报告。无需账户、无需冗余信息、无需云服务——只需掌握技能和获得凭证。
安装
pipx install xrpl-lab或者使用 pip:
pip install xrpl-lab需要 Python 3.11 或更高版本。
快速入门
xrpl-lab start引导式启动程序将指导您完成钱包设置、资金充值和第一个模块的学习。
离线模式
xrpl-lab start --dry-run无需网络连接。模拟交易用于学习工作流程。
模块
共有 32 个模块,分为十个主题:基础知识、NFT、令牌、支付、身份验证、去中心化交易所 (DEX)、储备金、审计、自动做市商 (AMM) 和综合项目。 先决条件明确——命令行界面和代码检查工具会强制执行这些条件。
# 列与 xrpl-lab list 显示的顺序相匹配(规范主题顺序)。
| # | 模块 | 主题 | 模式 | 先决条件 | 生成内容 | |---|--------|-------|------|---------------|----------| | 1 | 收据解读 | 基础知识 | 测试网络 | — | txid、报告 | | 2 | 失败案例解读 | 基础知识 | 测试网络 | 收据解读 | txid、报告 | | 3 | 信任关系 101:已发行货币作为关系 | 基础知识 | 测试网络 | — | txid、报告 | | 4 | 调试信任关系 | 基础知识 | 测试网络 | 信任关系 101:已发行货币作为关系 | txid、报告 | | 5 | 多重签名金库(SignerListSet):N-of-M 控制工作室钱包 | 基础知识 | 测试网络 | 收据解读 | txid、报告 | | 6 | NFT 铸造 101:您的第一个游戏资产 | nft | 测试网络 | — | txid、报告 | | 7 | NFT 市场 101:交易具有强制版税的资产 | nft | 测试网络 | — | txid、报告 | | 8 | 动态 NFT 101:一个可以升级的游戏物品 | nft | 测试网络 | — | txid、报告 | | 9 | MPT 发行 101:一次性完成的游戏货币发行 | 令牌 | 测试网络 | — | txid、报告 | | 10 | MPT 分发 101:将货币分发给玩家 | 令牌 | 测试网络 | MPT 发行 101:一次性完成的游戏货币发行 | txid、报告 | | 11 | 令牌冻结 101:发行者的暂停按钮 | 令牌 | 测试网络 | — | txid、报告 | | 12 | 召回 101:发行者的召回机制 | 令牌 | 测试网络 | — | txid、报告 | | 13 | 托管 101:时间锁定的 XRP | 支付 | 测试网络 | — | txid、报告 | | 14 | 托管完成 101:释放锁定的 XRP | 支付 | 测试网络 | 托管 101:时间锁定的 XRP | txid、报告 | | 15 | 令牌托管(XLS-85):锁定 IOU,而不仅仅是 XRP | 支付 | 测试网络 | 信任关系 101:已发行货币作为关系,托管 101:时间锁定的 XRP | txid、报告 | | 16 | 支票 101:延迟支付(CheckCreate / CheckCash / CheckCancel) | 支付 | 测试网络 | 收据解读 | txid、报告 | | 17 | 支付通道 101:一次签名,多次结算 | 支付 | 测试网络 | — | txid、报告 | | 18 | 已交付金额:部分支付漏洞 | 支付 | 测试网络 | 信任关系 101:已发行货币作为关系 | txid、报告 | | 19 | 托管玩家充值:一个共享钱包,多个玩家(目标标签) | 支付 | 测试网络 | 已交付金额:部分支付漏洞 | txid、报告 | | 20 | DID 101:链上身份 | 身份验证 | 测试网络 | — | txid、报告 | | 21 | 凭据 101(XLS-70):链上 KYC 和年龄证明 | 身份验证 | 测试网络 | DID 101:链上身份 | txid、报告 | | 22 | 权限域和受限 DEX(XLS-80/81):符合法规、基于凭据的交易 | 身份验证 | 测试网络 | 凭据 101(XLS-70):链上 KYC 和年龄证明 | txid、报告 | | 23 | 存款门控(DepositAuth + DepositPreauth):基于凭据的金库存款 | 身份验证 | 测试网络 | 凭据 101(XLS-70):链上 KYC 和年龄证明 | txid、报告 | | 24 | DEX 基础知识:报价、订单簿和取消 | dex | 测试网络 | 信任关系 101:已发行货币作为关系 | txid、报告 | | 25 | DEX 市场做市商 101:从订单簿中赚取价差 | dex | 测试网络 | DEX 基础知识:报价、订单簿和取消 | txid、报告 | | 26 | DEX 库存保障措施:避免出现单边风险 | dex | 测试网络 | DEX 市场做市商 101:从订单簿中赚取价差 | txid、报告 | | 27 | 储备金 101:您的 XRP“去向” | 储备金 | 测试网络 | 信任关系 101:已发行货币作为关系 | txid、报告 | | 28 | 账户维护:释放储备金并清理对象 | 储备金 | 测试网络 | 储备金 101:您的 XRP“去向” | txid、报告 | | 29 | 审计模式:大规模验证收据 | 审计 | 测试网络 | 收据解读 | 报告、audit_pack | | 30 | AMM 流动性 101:提供流动性和赚取费用 | amm | dry-run | 信任关系 101:已发行货币作为关系 | txid、报告 | | 31 | DEX 与 AMM 风险解读:比较交易策略 | amm | dry-run | DEX 市场做市商 101:从订单簿中赚取价差,AMM 流动性 101:提供流动性和赚取费用 | txid、报告 | | 32 | 综合项目:在 XRPL 上构建一个最小化的游戏经济系统 | 综合项目 | 测试网络 | MPT 发行 101:一次性完成的游戏货币发行,NFT 铸造 101:您的第一个游戏资产,托管 101:时间锁定的 XRP,审计模式:大规模验证收据 | txid、报告、audit_pack |
“生成内容”列显示了每个模块生成的成果类型(txid、report、audit_pack);请参阅手册中每个模块的页面,以获取完整的技能讲解以及您在链上证明的内容。
主题
- 基础知识——钱包、支付、信任关系、错误处理
- nft——NFT 游戏资产:铸造、市场结算、动态 NFT(XLS-20)
- 令牌——多用途令牌 (MPT) 游戏货币发行和召回(XLS-33)
- 支付——托管和时间锁定的价值
- 身份验证——去中心化标识符 (DID, XLS-40)
- dex——报价、订单簿、市场做市、库存管理
- 储备金——账户储备金、所有者数量、清理
- 审计——批量验证、审计报告
- amm——自动做市商流动性、DEX 与 AMM 比较
- 综合项目——将各个主题的技能组合到一个游戏经济系统中
模式
- 测试网络——在 XRPL 测试网上进行真实交易
- dry-run——离线沙盒,使用模拟交易(无需网络连接)
命令
xrpl-lab start Guided launcher
xrpl-lab list Show all modules with status and progression
xrpl-lab run <module_id> Run a specific module
xrpl-lab status [--json] Progress, curriculum position, blockers, track progress
xrpl-lab cohort-status [--dir DIR] [--format FORMAT] Aggregate per-learner status across a cohort directory (facilitator)
xrpl-lab session-export [--dir DIR] [--format FORMAT] [--outfile FILE] Archive all learner artifacts with a SHA-256 manifest
xrpl-lab tracks Track-level completion summaries
xrpl-lab recovery Diagnose stuck states, show recovery commands
xrpl-lab lint [glob] [--json] [--no-curriculum] Validate module files and curriculum
xrpl-lab proof-pack Export shareable proof pack
xrpl-lab proof generate Export shareable proof pack (alias of proof-pack)
xrpl-lab proof verify <file> Verify a proof pack's integrity (SHA-256)
xrpl-lab certificate Export completion certificate
xrpl-lab cert-verify <file> Verify a completion certificate's integrity
xrpl-lab doctor Run diagnostic checks
xrpl-lab self-check Alias for doctor
xrpl-lab feedback Generate support bundle (markdown)
xrpl-lab support-bundle [--json] [--verify FILE] Generate or verify support bundles
xrpl-lab audit Batch verify transactions
xrpl-lab audit-verify <file> Verify an audit pack's SHA-256 integrity
xrpl-lab last-run Show last module run + audit command
xrpl-lab serve [--port N] [--host H] [--dry-run] Start web dashboard and API server
xrpl-lab reset [--module MODULE_ID] Wipe local state OR reset a single module (requires confirmation)
xrpl-lab module init --id ID --track TRACK --title TITLE --time TIME Scaffold a lint-passing module skeleton
xrpl-lab wallet create Create a new wallet
xrpl-lab wallet show Show wallet info (no secrets)
xrpl-lab fund Fund wallet from testnet faucet
xrpl-lab send --to <address> --amount <xrp> [--memo <text>] Send a payment
xrpl-lab verify --tx <id> Verify a transaction on-ledger所有命令都支持 --dry-run 用于适用情况下的离线模式。
研讨会使用
XRPL Lab 专为实际教学环境设计。无需账户、无需遥测数据、无需云服务。一切都在本地运行。
讲师状态
xrpl-lab status # Where is this learner? What's blocked? What's next?
xrpl-lab status --json # Machine-readable for scripting
xrpl-lab tracks # Track-level completion: what was actually practiced
xrpl-lab recovery # Stuck? See exactly what to run next支持交接
xrpl-lab support-bundle # Human-readable markdown bundle
xrpl-lab support-bundle --json # Machine-parseable JSON
xrpl-lab support-bundle --verify bundle.json # Verify a received bundle讲师可以从支持包中诊断任何学习者的所有问题,而无需重现整个会话。不包含任何秘密信息。
研讨会流程
完全离线沙盒——无需网络连接:
xrpl-lab wallet create
xrpl-lab start --dry-run混合离线 + 测试网络——对于基础知识进行真实交易,对于高级内容使用沙盒:
xrpl-lab wallet create
xrpl-lab fund
xrpl-lab start“训练营”→“实验室”流程——从 xrpl-camp 开始:
xrpl-lab start # auto-detects camp wallet and certificate成果物
证明包(xrpl_lab_proof_pack.json):可共享的已完成模块记录、交易 ID 和资源链接。包含 SHA-256 完整性哈希值。不包含任何敏感信息。
证书(xrpl_lab_certificate.json):精简的完成记录。
报告(reports/*.md):对您所做的工作和证明的可读摘要。
审计包(audit_pack_*.json):包含 SHA-256 完整性哈希值的批量验证结果。
安全与信任模型
XRPL 实验室访问的数据:
- 钱包种子(以明文 JSON 格式存储在
~/.xrpl-lab/wallet.json中——POSIX 模式下,权限为0o600/0o700;或在 Windows 上,只有所有者才能访问;不进行加密) - 模块进度和交易 ID(存储在
~/.xrpl-lab/state.json中,通过临时文件 + 重命名方式进行原子写入) - XRPL 测试网 RPC(公共端点,事务在提交前本地签名)
- 测试网水龙头(公共 HTTP,仅发送您的地址)
XRPL 实验室不访问的数据:
- 不使用主网。仅使用测试网。
- 不收集任何形式的遥测数据、分析数据或“回传”数据。
- 不使用云帐户、不进行注册,也不使用第三方 API。
- 证明包、证书、报告或支持包中绝不会包含任何敏感信息。
权限和存储层级:
- 主目录
~/.xrpl-lab/——私有密钥层(POSIX 模式下,权限为0o700/0o600;或在 Windows 上,只有所有者才能访问)。存储钱包种子、日志文件和审计包。 - 工作区
./.xrpl-lab/——设计为可共享的层级,目录权限为 0o755。存储模块报告、证明包和证书。协调员无需提升权限即可查看。 - 文件系统:仅读取/写入上述两个位置。
- 网络:仅使用 XRPL 测试网 RPC 和水龙头(两者都可以通过环境变量覆盖,并且都是可选的,使用
--dry-run)。 - 不需要任何提升的权限。
仪表板界面(当xrpl-lab serve正在运行时):
- WebSocket 运行器端点强制执行 Origin 允许列表(关闭未在允许列表中连接,返回代码 4003)。
- 所有错误帧都发出结构化的信封(
code、message、hint、severity、icon_hint)——不泄露路径信息,也不泄露内部状态。 - 每个连接都有一个有界的消息队列,并记录了反压行为。
有关完整的安全策略和研讨会设置指南,请参阅 SECURITY.md。
要求
- Python 3.11+
- 用于测试网的互联网连接(或者使用
--dry-run以完全离线模式运行)
许可证
MIT
由 MCP Tool Shop 构建。
