Important
- This SDK is offered as a Professional Services tool and is not an official Fireblocks product. It is provided as-is for customer enablement.
- The SDK is intended for technical users with a working knowledge of Fireblocks and Ripple. Please consult your Fireblocks workspace administrator or account manager if you are unsure about permissions or security controls.
Overview
The Fireblocks XRP SDK is a technical solution provided to Fireblocks customers who need to perform secure, programmable operations on the Ripple (XRPL) network using Fireblocks-managed vault accounts. The SDK simplifies advanced operations on Ripple, such as DEX trading, token issuance, and trust line management, while leveraging Fireblocks’ key management, policy controls, and security.
You can use the SDK directly as a Node.js library in your backend workflows, or interact with the REST API server, which can be deployed as a Docker container in your environment.
Key Capabilities
Using the SDK, customers can:
- Perform XRPL operations such as placing and canceling offers, creating trust lines, freezing and burning assets, and more
- Execute both XRP transfers and advanced token operations directly from Fireblocks vaults
- Choose between two usage options: direct integration as a Node.js SDK or through a REST API container deployed via Docker
Prerequisites
To use the SDK, make sure you have the following:
- Fireblocks workspace with RAW Signing enabled
- Transaction Authorization Policy (TAP) rules that allow RAW transaction signing
- API user credentials (API key and secret key)
- Access to an XRP or XRP_TEST vault in Fireblocks
- Node.js v18+ (for SDK usage)
- Docker (for REST API deployment)
SDK Usage Options
Node.js Library (for Technical Users)
Customers can clone the SDK repo and use it as part of a backend service or script to manage XRPL transactions. This option provides full control over how XRP operations are triggered and managed from code.
- Supports initialization via environment variables or inline parameters
- Covers all major XRPL operations commonly used by Fireblocks customers.
- Includes example scripts for each transaction type
Refer to the README.md file in the repository for complete setup and usage instructions.
REST API Server (Docker)
For teams that prefer HTTP-based interaction, the SDK also includes a REST API server that can be deployed using Docker Compose.
- Offers the same XRPL capabilities as the library, exposed over HTTP
- Easily integrated with internal systems, cloud workflows, or BPM tools
- Environment-based configuration via .env or runtime variables
A Postman collection and cURL examples are available for quick exploration.
Best Practices and Recommendations
- Always enforce appropriate TAP rules and review RAW Signing permissions before usage
- Test thoroughly on XRP_TEST before moving to production with XRP Mainnet
- Monitor transaction results via the Fireblocks Console and log transaction responses for auditability