XRPL Generate Wallet Tool

Introduction

The XRPL Generate Wallet Tool is a process tool plugin that allows you to generate a wallet on the XRP Ledger and store the account data in a form and/or workflow variable within Joget.

Note that freshly created wallets must be funded according to the reserve requirement for the ledger to be aware of their existence.
Check the Fund Test Wallet plugin property if you are using the devnet or testnet.

To learn more about the reserve requirement, see the XRPL reserve documentation.

Plugin information

This tool integrates with multiple XRP Ledger networks, such as:

  • Mainnet: Uses real-world XRP.
  • Devnet: For development and testing purposes.
  • Testnet: This is for testing without the need for real XRP.
  • Custom Server: Allows the use of your own XRPL server.

To learn more about network types and public servers, see:

Get started

Prerequisites / Assumptions

  • You have Joget installed and configured.
  • You have access to XRP Ledger networks (e.g., Mainnet, Devnet, Testnet, or your own rippled server).
  • You understand the reserve requirement for wallets on the XRPL.

Where to get the plugin

You can download the XRP Ledger Pack from the JogetOSS Github repository.

How to install

  1. Click Download on this plugin screen (It will be a .jar file).
  2. Go to your Joget localhost or server. In the Joget Console, go to Admin Bar > Systems Settings > Manage Plugins and click the Upload Plugins button.
  3. Under Upload Plugin, select the plugin .jar file you downloaded and click Upload.
  4. Depending on the plugin type, you can now view your new plugin in your form, List, or UI Builder.
  5. Remember to uninstall the old plugin before uploading a new version.
  6. The Joget Knowledge Base has more information on managing and developing plugins.

Configure XRPL generate wallet tool properties

  • rippled Server: Select the network to create the wallet:
    • General Purpose Mainnet
    • Full History Mainnet
    • Devnet
    • Testnet
    • Custom Server

      Mainnet uses real-world XRP.
      Use testnet or devnet or your own test rippled server for testing purposes.

      The selectable networks here connect to official XRPL public servers.
      To learn more about all the network types and public servers available, see:

  • rippled URL: Only available if Custom Server is selected for rippled Server property.

    If you have setup your own rippled server, key in its URL here.

  • Fund Test Wallet: Only available if Devnet or Testnet is selected for rippled Server property.

    Check this option to fund the test wallet automatically upon wallet creation.

Store data to form

  • Form: Select a form to store the wallet data to.

    All fields from the selected form will be available for field mapping in the section below.

Field mapping
  • Wallet Seed: This is the secret key used to perform actions with the wallet.

    If wallet data is lost, this seed value can be used on a qualified wallet to recover the account. This value is stored as an encrypted value in the database.
    To learn more about wallet seed, see Cryptographic Keys - Seed.

    Caution: The wallet seed must be kept secure at all times. Anyone who possesses the seed can control the wallet and may cause irreparable damage.
  • Wallet Owner Field: The field to store the owner of this wallet.
  • Wallet Owner Value: To store the wallet owner value based on the field selected on the Wallet Owner Field property.
    Hash Variable
    is accepted here. Typically, it points to an actual Joget user, e.g., a Joget username.
  • Is Test Wallet Flag: To indicate if this is a real or test wallet.
  • Wallet Public Key: The wallet's master public key.
  • Wallet X-Address: The wallet’s X-Address. To learn more about X-Address formats, see the XRPL Account Documentation.

Store response to workflow variable

  • Response Status: Indicates if the wallet generation was successful.
  • Is Test Wallet Flag: Indicates whether the wallet is a real or test wallet.

Download plugin

Created by Julieth Last modified by Aadrian on Nov 19, 2024