stellar

n8n community node for Stellar Horizon API integration

Package Information

Released: 6 mo ago
Downloads: 4 weekly / 128 monthly
Latest Version: 1.0.0
Author: Velocity BPA

Available Nodes

Documentation generating…

Documentation

n8n-nodes-stellar

[Velocity BPA Licensing Notice]

This n8n node is licensed under the Business Source License 1.1 (BSL 1.1).

Use of this node by for-profit organizations in production environments requires a commercial license from Velocity BPA.

For licensing information, visit https://velobpa.com/licensing or contact licensing@velobpa.com.

This n8n community node provides comprehensive integration with the Stellar blockchain network, offering access to 7 core resources including accounts, transactions, payments, assets, orderbooks, ledgers, and operations. Build powerful blockchain automation workflows with capabilities for account management, payment processing, asset operations, and detailed blockchain data retrieval.

n8n Community Node
License
TypeScript
Stellar
Payments
DeFi

Features

  • Account Management - Create, query, and monitor Stellar account details and balances
  • Payment Processing - Send XLM and asset payments with memo support and path finding
  • Transaction Operations - Submit, query, and track transaction status with full operation details
  • Asset Management - Create custom assets, manage trustlines, and query asset information
  • Orderbook Integration - Access real-time trading data and market depth information
  • Ledger Analysis - Retrieve historical ledger data and blockchain state information
  • Operation Tracking - Monitor and analyze all operation types across the Stellar network
  • Multi-Network Support - Works with Stellar mainnet, testnet, and custom network configurations

Installation

Community Nodes (Recommended)

  1. Open n8n
  2. Go to Settings → Community Nodes
  3. Click Install a community node
  4. Enter n8n-nodes-stellar
  5. Click Install

Manual Installation

cd ~/.n8n
npm install n8n-nodes-stellar

Development Installation

git clone https://github.com/Velocity-BPA/n8n-nodes-stellar.git
cd n8n-nodes-stellar
npm install
npm run build
mkdir -p ~/.n8n/custom
ln -s $(pwd) ~/.n8n/custom/n8n-nodes-stellar
n8n start

Credentials Setup

Field Description Required
API Key Stellar Horizon server API key for rate limiting and premium features No
Horizon URL Custom Horizon server URL (defaults to Stellar mainnet) No
Network Passphrase Network identifier for transaction signing Yes
Secret Key Account secret key for transaction signing operations No

Resources & Operations

1. Account

Operation Description
Get Details Retrieve account information, balances, and flags
Create Generate new Stellar keypair and fund account
Get Transactions List all transactions for an account
Get Operations Retrieve operations history for an account
Get Payments Get payment history for an account
Get Effects List effects generated by account operations

2. Transaction

Operation Description
Submit Submit a signed transaction to the network
Get Details Retrieve transaction details by hash
Build Create transaction envelope for signing
Sign Sign transaction with account secret key
Get Operations List operations within a transaction
Get Effects Get effects generated by transaction

3. Payment

Operation Description
Send Send XLM or asset payment between accounts
Get Details Retrieve payment operation details
Find Path Discover payment paths for cross-asset transfers
Stream Monitor real-time payment streams
Get History Retrieve payment history with filters
Validate Verify payment parameters before submission

4. Asset

Operation Description
Create Issue new custom asset on Stellar network
Get Details Retrieve asset information and statistics
Get Holders List accounts holding specific asset
Set Trustline Establish trust relationship with asset
Get Trades Retrieve trading history for asset pair
Get Orderbook Get current orderbook for asset trading

5. Orderbook

Operation Description
Get Details Retrieve orderbook depth and spread information
Get Trades List recent trades for asset pair
Stream Monitor real-time orderbook updates
Get Statistics Calculate trading volume and price statistics
Get Candles Retrieve OHLCV candlestick data
Compare Pairs Analyze multiple asset pair orderbooks

6. Ledger

Operation Description
Get Details Retrieve specific ledger information by sequence
Get Latest Get most recent ledger state
Get Transactions List transactions in specific ledger
Get Operations Retrieve operations from ledger
Get Effects Get effects generated in ledger
Stream Monitor new ledger creation in real-time

7. Operation

Operation Description
Get Details Retrieve specific operation details by ID
Get All List operations with pagination and filters
Get by Transaction Retrieve operations from specific transaction
Get by Account List operations for specific account
Get Effects Get effects generated by operation
Stream Monitor real-time operation stream

Usage Examples

// Send XLM payment between accounts
{
  "resource": "Payment",
  "operation": "Send",
  "fromAccount": "GDQNY3PBOJOKYZSRMK2S7LHHGWZIUISD4QORETLMXEWXBI7KFZZMKTL3",
  "toAccount": "GCKFBEIYTKP5RDBQMUPFDN773XZBC7C5CUUYXRUZ2OEEK7DT3FK4XJOY",
  "amount": "100",
  "asset": "native",
  "memo": "Payment for services"
}
// Query account balance and details
{
  "resource": "Account",
  "operation": "Get Details",
  "accountId": "GDQNY3PBOJOKYZSRMK2S7LHHGWZIUISD4QORETLMXEWXBI7KFZZMKTL3"
}
// Create custom asset and establish trustline
{
  "resource": "Asset",
  "operation": "Create",
  "assetCode": "MYTOKEN",
  "issuerAccount": "GDQNY3PBOJOKYZSRMK2S7LHHGWZIUISD4QORETLMXEWXBI7KFZZMKTL3",
  "limit": "1000000"
}
// Monitor real-time transaction stream
{
  "resource": "Transaction",
  "operation": "Stream",
  "cursor": "now",
  "filters": {
    "account": "GDQNY3PBOJOKYZSRMK2S7LHHGWZIUISD4QORETLMXEWXBI7KFZZMKTL3"
  }
}

Error Handling

Error Description Solution
tx_insufficient_balance Account lacks sufficient funds for transaction Verify account balance and reduce transaction amount
tx_bad_seq Transaction sequence number is incorrect Retrieve current account sequence and increment by 1
op_no_trust Destination account doesn't trust asset Create trustline for asset before sending payment
tx_bad_auth Invalid signature or unauthorized operation Verify secret key and signing process
op_underfunded Insufficient balance for operation Check account balance including base reserves
tx_failed Transaction failed during submission Review transaction operations and network status

Development

npm install
npm run build
npm test
npm run lint
npm run dev

Author

Velocity BPA

Licensing

This n8n community node is licensed under the Business Source License 1.1.

Free Use

Permitted for personal, educational, research, and internal business use.

Commercial Use

Use of this node within any SaaS, PaaS, hosted platform, managed service, or paid automation offering requires a commercial license.

For licensing inquiries: licensing@velobpa.com

See LICENSE, COMMERCIAL_LICENSE.md, and LICENSING_FAQ.md for details.

Contributing

Contributions are welcome! Please ensure:

  1. Code follows existing style conventions
  2. All tests pass (npm test)
  3. Linting passes (npm run lint)
  4. Documentation is updated for new features
  5. Commit messages are descriptive

Support

Discussion