xrpl

n8n community nodes for XRP Ledger (XRPL) - payments, DEX, NFTs, escrows, and more

Package Information

Released: 6 mo ago
Downloads: 7 weeklyΒ /Β 49 monthly
Latest Version: 0.1.0
Author: Velocity BPA

Documentation

n8n-nodes-xrpl

Community nodes for interacting with the XRP Ledger (XRPL) in n8n.

This package provides comprehensive XRPL integration for n8n, enabling you to build powerful blockchain automation workflows including payments, NFTs, DEX trading, escrows, AMM pools, and more.

XRPL + n8n
License
Node Version

Features

πŸ”„ XRPL Node (Action Node)

Execute operations on the XRP Ledger:

Resource Operations
Account Get info, balances, trust lines, NFTs, transaction history
Payment Send XRP, send issued currencies, cross-currency pathfinding
Trust Line Create, modify, remove trust lines
DEX Create/cancel offers, get order books, view account offers
NFT (XLS-20) Mint, burn, create/accept/cancel offers, get offers
Escrow Create time/conditional escrows, finish, cancel, list escrows
Check Create, cash, cancel checks
Payment Channel Create, fund, claim, list channels
AMM Create pools, deposit, withdraw, swap, vote on fees, bid for slots
Utility Convert XRP/drops, validate addresses, lookup transactions, get fees

⚑ XRPL Trigger Node

Real-time event subscriptions:

  • Account Transactions β€” Trigger on any transaction affecting an account
  • Payment Received β€” Trigger on incoming payments with amount filtering
  • NFT Offers β€” Trigger when someone creates a buy offer for your NFTs
  • Ledger Closed β€” Trigger on each new validated ledger

Installation

Community Nodes (Recommended)

  1. Go to Settings > Community Nodes
  2. Click Install a community node
  3. Enter n8n-nodes-xrpl
  4. Click Install

Manual Installation

cd ~/.n8n/nodes
pnpm install n8n-nodes-xrpl

Then restart n8n.

Configuration

Credentials

Create XRPL API credentials with:

Field Description
Network Mainnet, Testnet, Devnet, AMM Devnet, or Custom
Custom WebSocket URL For custom/private nodes
Wallet Seed Your secret seed (sXXX...) for signing transactions
Account Address Your r-address for read-only operations

⚠️ Security: Never share your wallet seed. Use environment variables or n8n's credential encryption for production.

Usage Examples

Send XRP Payment

  1. Add an XRPL node
  2. Select Payment > Send XRP
  3. Enter destination address and amount
  4. Execute!

Monitor Incoming Payments

  1. Add an XRPL Trigger node
  2. Select Payment Received
  3. Optionally set minimum amount filter
  4. Connect to your workflow

Create NFT and List for Sale

[XRPL: Mint NFT] β†’ [XRPL: Create Sell Offer]

DEX Arbitrage Monitor

[XRPL Trigger: Ledger Closed] β†’ [XRPL: Get Order Book] β†’ [IF: Price Difference] β†’ [XRPL: Create Offer]

Escrow-Based Milestone Payments

[Webhook] β†’ [XRPL: Create Escrow] β†’ [Wait] β†’ [XRPL: Finish Escrow]

Network Support

Network WebSocket URL Use Case
Mainnet wss://xrplcluster.com Production
Testnet wss://s.altnet.rippletest.net:51233 Testing
Devnet wss://s.devnet.rippletest.net:51233 Development
AMM Devnet wss://amm.devnet.rippletest.net:51233 AMM testing

Resources

Development

Prerequisites

  • Node.js >= 18.10
  • pnpm >= 9.1

Setup

git clone https://github.com/velocitybpa/n8n-nodes-xrpl.git
cd n8n-nodes-xrpl
pnpm install
pnpm build

Testing Locally

# Link to your n8n installation
pnpm link --global
cd ~/.n8n/nodes
pnpm link --global n8n-nodes-xrpl

# Restart n8n
n8n start

Linting

pnpm lint
pnpm lintfix

Contributing

Contributions are welcome! Please:

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Run pnpm lint and fix any issues
  5. Submit a pull request

License

MIT

Disclaimer

This software is provided "as is" without warranty. Always test thoroughly on testnet before using on mainnet. The authors are not responsible for any financial losses incurred through use of this software.

Support


Built with ❀️ by Velocity BPA

Discussion