DEV Community

Cover image for The XUMM SDK in Node/JS - XRP ledger payment requests

The XUMM SDK in Node/JS - XRP ledger payment requests

Wietse Wind
Building on the XRP ledger. โ™ฅ Wife, kids, ๐Ÿฆœ & programming (TS, nodejs, Linux ...) - BDFL at @XRPLLabs
ใƒปUpdated on ใƒป3 min read

The XUMM API will allow developers to deliver sign requests (payloads) to app users. A payload is a JSON formatted transaction template for a transaction on the XRP ledger.

XUMM app users can scan a QR code or receive a push notification to open the sign request for a transaction. A user views the sign request and either authorizes XUMM to sign it or rejects it. If authorized, the sign request will be signed locally via XUMM, if rejected the sign request is destroyed and the transaction does not happen.

If authorized the transaction can then be sent directly to the XRP ledger. The initiating application will get realtime status updates and after signing, the end user will be returned to the initiating platform.

To make it simple to interact with the XUMM API, and to help build intuitive flows for end users to sign their transactions, we have released the XUMM SDK (npm) for Javascript, Typescript and Deno environments.

We have provided a beginners course on setting up a code editor (Visual Studio Code) & interacting with the XRP ledger using Javascript code. This is till available for viewing and instructions.


Before beginning this XUMM SDK tutorial, we assume that you are ready to code with your code environment already set up and if required, you have followed the steps outlined in my previous tutorial.

This tutorial consists of five chapters:

1. Get your XUMM API credentials ๐Ÿ”‘

2. Prepare your project and start coding ๐Ÿ”จ
3. Your first payload ๐Ÿ””
4. Verify the results โ›‘ and push ๐Ÿš€
5. Security & finishing touch ๐ŸŽ‰

Resources ๐Ÿ“š

If you want to learn more about the XUMM SDK, platform, documentation, etc., make sure to check out:

Thank you XRP Community!

... For checking, correcting & testing the SDK & tutorial!
@technotip, @calvincs, @wenusch, @alloyxrp, @rippleitinnz, @Ubbah, @enclavia, @WormholeMech, @Chicles_, @3N0RYM, @XrpSpark, @devnullinator, @Vetjes, @KevinKing64, @Kujistudios, @nodehash, @4thMadHatter, @Vkumzy, @CarpeDiemXRP, @Hex539, @xrplosion1, @chemical_realm, @RossMacFirdeen

Discussion (0)