On this page

xrpGetAddress

Ripple: get address

Derives and returns the address at the specified path. When showOnOneKey is true, the user must confirm the address on the device.


const response = await HardwareSDK.xrpGetAddress(connectId, deviceId, params)

Params

Optional common params

Single address

path - required string | Array<number> SDK minimum length is 3. more information
showOnOneKey - optional boolean Whether to display the address on the device. Defaults to true.

Multiple addresses

bundle - array of objects with path and showOnOneKey fields

Example

Display the address for the first ripple account:


HardwareSDK.xrpGetAddress(connectId, deviceId, {
    path: "m/44'/144'/0'/0/0"
});

Return a bundle of ripple addresses without displaying them on the device:


HardwareSDK.xrpGetAddress(connectId, deviceId, {
    bundle: [
        { path: "m/44'/144'/0'/0/0", showOnOneKey: false }, // account 1
        { path: "m/44'/144'/1'/0/0", showOnOneKey: false }, // account 2
        { path: "m/44'/144'/2'/0/0", showOnOneKey: false }  // account 3
    ]
});

Result

Single-address response


{
    success: true,
    payload: {
        address: string,     // displayed address
        publicKey: string,   // account public key
        path: string  // serialized BIP32 path
    }
}

Batch response, in the same order as the request


{
    success: true,
    payload: [
        { address: string, publicKey: string, path: string }, // account 1
        { address: string, publicKey: string, path: string }, // account 2
        { address: string, publicKey: string, path: string }  // account 3
    ]
}

Error


{
    success: false,
    payload: {
        error: string, // error message
        code?: string | number // error code
    }
}