Interact with the Xumm Developer API
npm install xumm-sdkInteract with the XUMM SDK from Javascript / Typescript environments.
#### Part of the "Xumm Universal SDK", which is the preferred way of interacting with the Xumm ecosystem from JS/TS environments: https://www.npmjs.com/package/xumm - https://github.com/XRPL-Labs/Xumm-Universal-SDK
Do you have questions? Want Docs? All of that is available at https://xumm.readme.io.
A browserified version (latest) is available at JSDelivr & directly from the xumm.app domain:
``html`
#### Please note! The XUMM SDK (XUMM API in general) is for BACKEND USE only. Please DO NOT use your API credentials in a FRONTEND environment.
XummSdkJwtGet the SDK straight from npm: npm install xumm-sdk.
Initialize the SDK in Javascript (backend use):
`javascript`
const { XummSdk } = require("xumm-sdk");
Initialize the SDK in Javascript (xApp frontend use):
`javascript`
const { XummSdkJwt } = require("xumm-sdk");
... or in Typescript:
`typescript`
import { XummSdk } from "xumm-sdk";
// Or with types:
// import {XummSdk, XummTypes} from 'xumm-sdk'
// Or for xApp frontend code:
// import {XummSdkJwt} from 'xumm-sdk'
Now continue by constructing the XummSdk object:
`typescriptxAppToken
const Sdk = new XummSdk();
// Or with manually provided credentials (instead of using dotenv (see note further down)):
// const Sdk = new XummSdk('someAppKey', 'someAppSecret')
//
// Or when using this SDK in xApp frontend code:
// const Sdk = new XummSdkJwt('someAppKey', 'OTTxAppToken')
// > Then the SDK is used in a browser env. (frontend), the second
// param can be omitted as the SDK will pick up on the URL
// Query param () automatically.`
// > Sample: https://github.com/XRPL-Labs/XUMM-SDK/blob/master/samples/dev-ott-jwt.js
//
// Or when using this SDK with a raw JWT (e.g. from the OAuth2 flow)
// const Sdk = new XummSdkJwt('someJwt...')
// > No other params should be added
// > Sample: https://github.com/XRPL-Labs/XUMM-SDK/blob/master/samples/dev-jwt.js
#### If you are using this SDK in your xApp frontend code (more about this here):
Use the XummSdkJwt class instead of the XummSdk class. You don't need your ownXummSdkJwt
backend in this case. The is a drop in replacement for the XummSdk class, except passing xApp OTT credentials to the constructor is mandatory (more later).
Please note not all methods are available on the xApp JWT endpoints. For the available endpoints, see the xApp JWT Endpoint documentation.
#### In case of backend use
The SDK will look in your environment for the XUMM_APIKEY and XUMM_APISECRET environment values. A .env.sample file is provided in this repository. A sample dotenv file looks like this. Alternatively you can provide your XUMM API Key & Secret by passing them to the XummSdk constructor.
Please note that you will have to load dotenv yourself, when running on the command line, you can run dotenv to parse a .env file like this:`
node --require dotenv/config dist/samples/dev.js
If you include xumm-sdk in a node project, make sure to include and call the config() method of dotenv before constructing the XummSdk:`
import {XummSdk} from 'xumm-sdk'
import * as dotenv from 'dotenv'
dotenv.config()
const sdk = new XummSdk()
`
If both your environment and the SDK constructor contain credentials, the values provided to the constructor will be used.
#### In case of xApp frontend use
If you are using the XummSdkJwt class in your xApp frontend, passing params to the constructor is mandatory. The first argument stays the same: your XUMM API Key. The second argument MUST NOT BE your XUMM API Secret, but the OTT (One Time Token) available in the xAppToken URL Query parameter passed by XUMM to your xApp URL.
Create your app and get your XUMM API credentials at the XUMM Developer Console:
- https://apps.xumm.dev
More information about the XUMM API, payloads, the API workflow, sending Push notifications, etc. please check the XUMM API Docs:
- https://xumm.readme.io/docs
After constructing the SDK, you can call the methods:
- Sdk.* for the helper methods (see below)Sdk.payload.*
- to get/update/create payloads for users to signSdk.storage.*
- for your XUMM app storage (to store meta info for headless applications)
Please note all snippets below assume you constructed the XUMM SDK into the Sdk constant, as the How to use the XUMM SDK section outlines.
#### Helper methods
##### Sdk.ping()
The ping method allows you to verify API access (valid credentials) and returns some info on your XUMM APP:
`typescript`
const pong = await Sdk.ping();
`javascript`
{
quota: {},
application: {
uuidv4: '00000000-1111-2222-3333-aaaaaaaaaaaa',
name: 'My XUMM APP',
webhookurl: '',
disabled: 0
},
call: { uuidv4: 'bbbbbbbb-cccc-dddd-eeee-111111111111' }
}
##### Sdk.getCuratedAssets()
The getCuratedAssets method allows you to get the list of trusted issuers and IOU's. This is the same list used to
populate the "Add Asset" button on the XUMM home screen.
`typescript`
const curatedAssets = await Sdk.getCuratedAssets();
`javascript`
{
curatedAssets: {
issuers: [ 'Bitstamp', 'GateHub' ],
currencies: [ 'USD', 'BTC', 'EUR', 'ETH' ],
details: {
Bitstamp: [Object],
GateHub: [Object]
}
}
}
##### Sdk.getKycStatus()
The getKycStatus return the KYC status of a user based on a user_token, issued after the
user signed a Sign Request (from your app) before (see Payloads - Intro).
If a user token specified is invalid, revoked, expired, etc. the method will always
return NONE, just like when a user didn't go through KYC. You cannot distinct a non-KYC'd user
from an invalid token.
Alternatively, KYC status can be retrieved for an XPRL account address: the address selected in
XUMM when the session KYC was initiated by.
`typescript`
const kycStatus = await Sdk.getKycStatus(
"00000000-0000-0000-0000-000000000000"
);
... or using an account address:
`typescript`
const kycStatus = await Sdk.getKycStatus("rwu1dgaUq8DCj3ZLFXzRbc1Aco5xLykMMQ");
###### Notes on KYC information
- Once an account has successfully completed the XUMM KYC flow, the KYC flag will be applied to the account even if the identity document used to KYC expired. The flag shows that the account was once KYC'd by a real person with a real identity document.
- Please note that the KYC flag provided by XUMM can't be seen as a "all good, let's go ahead" flag: it should be used as one of the data points to determine if an account can be trusted. There are situations where the KYC flag is still true, but an account can no longer be trusted. Eg. when account keys are compromised and the account is now controlled by a 3rd party. While unlikely, depending on the level of trust required for your application you may want to mitigate against these kinds of fraud.
##### Sdk.getTransaction()
The getTransaction method allows you to get the transaction outcome (mainnet)
live from the XRP ledger, as fetched for you by the XUMM backend.
Note: it's best to retrieve these results yourself instead of relying on the XUMM platform to get live XRPL transaction information! You can use the xrpl-txdata package to do this:
`typescript`
const txInfo = await Sdk.getTransaction(txHash);
##### Sdk.getNftokenDetail()
> This method is only available when using the SDK in a JWT context!
The getNftokenDetail method allows you to get basic XLS20 token information
as fetched/parsed/cached for you by the XUMM backend.
Note: it's best to retrieve these results yourself instead of relying on the XUMM platform to get live XRPL transaction information!
`typescript`
const txInfo = await Sdk.getNftokenDetail(tokenId);
##### Sdk.getRails()
The getRails method allows you to get the network information for all networks known to Xumm.
`typescript`
const rails = await Sdk.getRails();
##### Sdk.getHookHash(hookHash: string)
The getHookHash method allows you to get meta information for a specific Hook hash (64 hex chars)
`typescript`
const hookInfo = await Sdk.getHookHash('64hexchars');
##### Sdk.getHookHashes()
The getHookHashes allows you to get all meta information for all Hooks known to Xumm.
`typescript`
const hookHashes = await Sdk.getHookHashes();
##### Sdk.verifyUserTokens(string[]) / Sdk.verifyUserToken(string)
The verifyUserTokens (or single token: verifyUserToken) method allows you to verify one or more User Tokens obtained
from previous sign requests. This allows you to detect if you will be able to push your next Sign Request to specific users.
`typescript
const someToken = '691d5ae8-968b-44c8-8835-f25da1214f35')
const tokenValidity = Sdk.verifyUserTokens([
someToken,
'b12b59a8-83c8-4bc0-8acb-1d1d743871f1',
'51313be2-5887-4ae8-9fda-765775a59e51'
])
if ((await Sdk.verifyUserToken(someToken).active) {
// Push, use user_token in payload`
} else {
// QR or Redirect (deeplink) flow
}
Returns: [Promise or Promise
#### App Storage
App Storage allows you to store a JSON object at the XUMM API platform, containing max 60KB of data.
Your XUMM APP storage is stored at the XUMM API backend, meaning it persists until you overwrite or delete it.
This data is private, and accessible only with your own API credentials. This private JSON data can be used to store credentials / config / bootstrap info / ... for your headless application (eg. POS device).
`typescript
const storageSet = await Sdk.storage.set({
name: "Wietse",
age: 32,
male: true,
});
console.log(storageSet);
// true
const storageGet = await Sdk.storage.get();
console.log(storageGet);
// { name: 'Wietse', age: 32, male: true }
const storageDelete = await Sdk.storage.delete();
console.log(storageDelete);
// true
const storageGetAfterDelete = await Sdk.storage.get();
console.log(storageGetAfterDelete);
// null
`
#### Payloads
##### Intro
Payloads are the primary reason for the XUMM API (thus this SDK) to exist. The XUMM API Docs explain 'Payloads' like this:
An XRPL transaction "template" can be posted to the XUMM API. Your transaction template to sign (so: your "sign request") will be persisted at the XUMM API backend. We now call it a Payload. XUMM app user(s) can open the Payload (sign request) by scanning a QR code, opening deeplink or receiving push notification and resolve (reject or sign) on their own device.
A payload can contain an XRPL transaction template. Some properties may be omitted, as they will be added by the XUMM app when a user signs a transaction. A simple payload may look like this:
`javascript`
{
txjson: {
TransactionType : 'Payment',
Destination : 'rwiETSee2wMz3SBnAG8hkMsCgvGy9LWbZ1',
Amount: '1337'
}
}
As you can see the payload looks like a regular XRPL transaction, wrapped in an txjson object, omitting the mandatory Account, Fee and Sequence properties. They will be added containing the correct values when the payload is signed by an app user.
Optionally (besides txjson) a payload can contain these properties (TS definition):
- options to define payload options like a return URL, expiration, etc.custom_meta
- to add metadata, user instruction, your own unique ID, ...user_token
- to push the payload to a user (after obtaining a user specific token)
A more complex payload could look like this. A reference for payload options & custom meta can be found in the API Docs.
Instead of providing a txjson transaction, a transaction formatted as HEX blob (string) can be provided in a txblob property.
##### Sdk.payload.get
`typescript`
async Sdk.payload.get (
payload: string | CreatedPayload,
returnErrors: boolean = false
): Promise
To get payload details, status and if resolved & signed: results (transaction, transaction hash, etc.) you can get() a payload.
Note! Please don't use _polling_! The XUMM API offers Webhooks (configure your Webhook endpoint in the Developer Console) or use a subscription to receive live payload updates (for non-SDK users: Webhooks).
You can get() a payload by:
- Payload UUID
`javascript`
const payload = await Sdk.payload.get("aaaaaaaa-bbbb-cccc-dddd-1234567890ab");
- Passing a created Payload object (see: Sdk.payload.create)
`javascript`
const newPayload: XummTypes.CreatePayload = {txjson: {...}}
const created: XummTypes.CreatedPayload = await Sdk.payload.create(newPayload)
const payload: XummTypes.XummPayload = await Sdk.payload.get(created)
If a payload can't be fetched (eg. doesn't exist), null will be returned, unless a second param (boolean) is provided to get the SDK to throw an Error in case a payload can't be retrieved:
`javascript`
await Sdk.payload.get("aaaaaaaa-bbbb-cccc-dddd-1234567890ab", true);
##### Sdk.payload.create
`typescript`
async Sdk.payload.create (
payload: CreatePayload,
returnErrors: boolean = false
): Promise
To create a payload, a txjson XRPL transaction can be provided. Alternatively, a transaction formatted as HEX blob (string) can be provided in a txblob property. See the intro for more information about payloads. Take a look at the Developer Docs for more information about payloads.
The response (see: Developer Docs) of a Sdk.payload.create() operation, a object, looks like this:
`json`
{
"uuid": "1289e9ae-7d5d-4d5f-b89c-18633112ce09",
"next": {
"always": "https://xumm.app/sign/1289e9ae-7d5d-4d5f-b89c-18633112ce09",
"no_push_msg_received": "https://xumm.app/sign/1289e9ae-7d5d-4d5f-b89c-18633112ce09/qr"
},
"refs": {
"qr_png": "https://xumm.app/sign/1289e9ae-7d5d-4d5f-b89c-18633112ce09_q.png",
"qr_matrix": "https://xumm.app/sign/1289e9ae-7d5d-4d5f-b89c-18633112ce09_q.json",
"qr_uri_quality_opts": ["m", "q", "h"],
"websocket_status": "wss://xumm.app/sign/1289e9ae-7d5d-4d5f-b89c-18633112ce09"
},
"pushed": true
}
The next.always URL is the URL to send the end user to, to scan a QR code or automatically open the XUMM app (if on mobile). If a user_token has been provided as part of the payload data provided to Sdk.payload.create(), you can see if the payload has been pushed to the end user. A button "didn't receive a push notification" could then take the user to the next.no_push_msg_received URL. The
Alternatively user routing / instruction flows can be custom built using the QR information provided in the refs object, and a subscription for live status updates (opened, signed, etc.) using a WebSocket client can be setup by connecting to the refs.websocket_status URL. Please note: this SDK already offers subscriptions. There's no need to setup your own WebSocket client, see Payload subscriptions: live updates. There's more information about the payload workflow and a payload lifecycle in the Developer Docs.
##### Sdk.payload.cancel
`typescript`
async Sdk.payload.cancel (
payload: string | XummPayload | CreatedPayload,
returnErrors: boolean = false
): Promise
To cancel a payload, provide a payload UUID (string), a (by performing a Sdk.payload.get() first) or a (by using the response of a Sdk.payload.create() call). By cancelling an existing payload, the payload will be marked as expired and can no longer be opened by users.
Please note: _if a user already opened the payload in XUMM APP, the payload cannot be cancelled: the user may still be resolving the payload in the XUMM App, and should have a chance to complete that process_.
A response (generic API types here) looks like:
`javascript`
{
result: {
cancelled: boolean;
reason: XummCancelReason;
}
meta: XummPayloadMeta;
custom_meta: XummCustomMeta;
}
#### Payload subscriptions: live updates
To subscribe to live payload status updates, the XUMM SDK can setup a WebSocket connection and monitor live status events. Emitted events include:
- The payload is opened by a XUMM App user (webpage)
- The payload is opened by a XUMM App user (in the app)
- Payload expiration updates (remaining time in seconds)
- The payload was resolved by rejecting
- The payload was resolved by accepting (signing)
More information about the status update events & sample event data can be found in the Developer Docs.
Status updates can be processed by providing a _callback function_ to the Sdk.payload.subscribe() method. Alternatively, the (by the Sdk.payload.subscribe() method) returned raw websocket can be used to listen for WebSocket onmessage events.
The subscription will be closed by either:
- Returning non-void in the _callback function_ passed to the Sdk.payload.subscribe() method
- Manually calling on the object returned by the Sdk.payload.subscribe() method
##### Sdk.payload.subscribe
`typescript`
async Sdk.payload.subscribe (
payload: string | XummPayload | CreatedPayload,
callback?: onPayloadEvent
): Promise
If a callback function is not provided, the subscription will stay active until the method is called manually, eg. based on handling events.
When a callback function is provided, for every payload specific event the callback function will be called with property contains parsed JSON containing event information. Either by calling or by returning a non-void value in the _callback function_ the subscription will be ended, and the promise will resolve with the value returned or passed to the method.
Resolving (by returning non-void in the callback or calling resolve() manually) closes the WebSocket client the XUMM SDK sets up 'under the hood'.
`javascript`
{
payload: XummPayload,
resolved: Promise
resolve: (resolveData?: unknown) => void
websocket: WebSocket
}
Examples:
- Async process after returning data in the callback function
- Await based on returning data in the callback function
- Await based on resolving a callback event
- Await based on resolving without using a callback function
##### Sdk.payload.createAndSubscribe
`typescript`
async Sdk.payload.createAndSubscribe (
payload: CreatePayload,
callback?: onPayloadEvent
): Promise
The property:
All information that applies on Sdk.payload.create() and Sdk.payload.subscribe() applies. Differences are:
1. The input for a Sdk.payload.createAndSubscribe() call isn't a payload UUID / existing payload, but a payload to create.
2. The response object also contains () the response obtained when creating the payload.
#### Userdata endpoints (for JWT auth. only: xApp / OAuth2 (PKCE/Implicit))
##### Sdk.jwtUserdata.list
List all keys stored for this user
`typescript`
async Sdk.jwtUserdata.list (): Promise
##### Sdk.jwtUserdata.get
Get one or more values for specified keys. If one key is specified, the data is immediately returned. If multiple keys are supplied in string[] (Array) format, an object with those keys will be returned, with their respective value(s).
`typescript`
async Sdk.jwtUserdata.get (
keys: string | string[]
): Promise
##### Sdk.jwtUserdata.set
Store an arbitrary JSON object for a specific key. Returns a Boolean with the success state (persisted).
`typescript`
async Sdk.jwtUserdata.set (
key: string,
data: AnyJson
): Promise
##### Sdk.jwtUserdata.delete
Remove an object for a specific key. Returns a Boolean with the success state (removed).
`typescript`
async Sdk.jwtUserdata.delete (
key: string
): Promise
#### xApp/Push endpoints
##### Intro
When building an xApp, there are a couple of extra methods available. These endpoints only work for xApp enabled API credentials, and can be used to e.g. push notifications and context to XUMM, opening your xApp.
Because xApps are user related, they must always be supplied a user_token, or be called from JWT context. Alternatively, if granted extra permissions, a push destinationuser_uuid
can also be: / user_account.
##### Sdk.Push.event
To send a push notification & publish an xApp Event in the Event List of the end user. When tapped, the xApp opens. When the push notification is tapped, the xApp will open. When the push notification is dismissed, the user can still find it in the XUMM Event list.
`typescript`
async Sdk.Push.event (
data: EventPushPostBody
): Promise
##### Sdk.Push.notification
To send a (native) push notification to an end user. When the push notification is tapped, the xApp will open. When the push notification is dismissed, the user can't access this event anymore.
`typescript`
async Sdk.Push.notification (
data: EventPushPostBody
): Promise
##### User storage
When an xApp is opened and the XUMM SDK is used from a client side (xApp) context using the JWT flow, your xApp can read, write & delete key/value data that persists on the XUMM platform. This way, even if client side storage (cookies, localstorage, etc.) is cleared, your client related data is still available. This is useful for 3rd party platform credentials and state like "did the user pass xApp onboarding".
The XUMM SDK will emit debugging info when invoked with a debug environment variable configured like: DEBUG=xumm-sdk*
You'll see the XUMM SDK debug messages if you invoke your script instead of this:
`
node myApp.js
like this:
`
DEBUG=xumm-sdk* node myApp.js
Please note: you most likely just want to use the XUMM SDK, to do so, fetch the xumm-sdk package from NPM using npm install --save xumm-sdk.
If you actually want to change/test/develop/build/contribute (to) the source of the XUMM SDK:
##### Build
Please note: at least Typescript version 3.8+ is required!
To build the code, run tsc. To build automatically on file changes (watch): tsc -w.
##### Lint & test
Lint the code using npm run lint, run tests (jest) using npm run test
##### Run development code:
Build, run, show debug output & watch dist/samples/dev.js, compiled from samples/dev.ts using npm run dev. The samples/dev.ts file is not included by default.