Xaman

https://github.com/xrpl-labs/developer-help-center
Admin
Xaman is a powerful platform and wallet developed by XRPL Labs that allows developers to integrate...
Tokens:32,000
Snippets:412
Trust Score:8.2
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install and Run Localtunnel

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/environments/xapps-dapps/xappbuilder/connecting-localhost-to-xappbuilder.md

Commands to install the Localtunnel package globally and expose a local port to the internet.

```bash
npm install -g localtunnel
```

```bash
sudo npm install -g localtunnel
```

```bash
lt --port 5500
```

--------------------------------

### Initialize Xumm SDK in HTML

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/environments/browser-web3/README.md

Demonstrates basic setup using the browserified Xumm SDK, including authorization, logout, and event handling for user account retrieval.

```html
<html lang="en">
  <body>
    <h1 id="accountaddress">...</h1>
    <button id="signinbutton" onclick="xumm.authorize()">Login</button>
    <button id="logoutbutton" onclick="xumm.logout()">Logout</button>
        
    <script src="https://xumm.app/assets/cdn/xumm.min.js"></script>
    <script>
      var xumm = new Xumm('your-api-key')
      
      xumm.on("ready", () => console.log("Ready (e.g. hide loading state of page)"))
      
      // We rely on promises in the `success` event: fired again if a user
      // logs out and logs back in again (resets all promises)
      xumm.on("success", async () => {
        xumm.user.account.then(account => {
          document.getElementById('accountaddress').innerText = account
        })
      })

      xumm.on("logout", async () => {
        document.getElementById('accountaddress').innerText = '...'
      })
    </script>
  </body>
</html>
```

--------------------------------

### Implement Xumm Destination Picker in xApp

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/environments/xapps-dapps/xumm-ui-interaction.md

This example demonstrates initializing the Xumm SDK and handling the destination picker event to update the UI.

```html
<html lang="en">
  <body>
    <div id="destinationname">...</div>
    <input id="destinationaddress" value="" placeholder="Destination address" />
    <button onclick="xumm.xapp.selectDestination()">Pick destination account</button>

    <script src="https://xumm.app/assets/cdn/xumm.min.js"></script>
    <script>
      var xumm = new Xumm('your-api-key')

      xumm.xapp.on('destination', data => {
        if (data.destination.address) {
          document.getElementById('destinationname').innerText = data.destination.name
          document.getElementById('destinationaddress').value = data.destination.address
        } else {
          console.log('No destination selected', data.reason)
        }
      })
    </script>
  </body>
</html>
```

--------------------------------

### Navigate to an xApp

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/js-ts-sdk/sdk-syntax/xumm.xapp/navigate.md

Example usage of the navigate method to redirect to the Xumm support xApp.

```javascript
xumm.xapp.navigate({ xApp: 'xumm.support' })
```

--------------------------------

### Open Transaction Details Syntax

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/js-ts-sdk/sdk-syntax/xumm.xapp/tx.md

Example usage of the xumm.xapp.tx method to display transaction details.

```javascript
xumm.xapp.tx({
  account: 'rwietsevLFg8XSmG3bEZzFein1g8RBqWDZ',
  tx: '250DC3E83946EFE965DE36B3F9AE8608CD7ED793657BDEC5B794B665B2DCBC0E',
  network: 'MAINNET',
})
```

--------------------------------

### Install jsonwebtoken dependency

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/environments/xapps-dapps/your-own-backend-auth.md

Install the required npm package for JWT verification.

```bash
npm install jsonwebtoken
```

--------------------------------

### Example Payload Object Structure

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/js-ts-sdk/sdk-syntax/xumm.payload/create.md

A sample payload object containing transaction details, return URLs, and custom metadata.

```javascript
{
  txjson: {
    TransactionType: "Payment",
    Destination: "r...",
    Amount: "1000000"
  },
  options: {
    return_url: {
      app: "https://sample.test/?...",
      web: "https://sample.test/?id={id}"
    },
    force_network: "MAINNET"
  },
  custom_meta: {
    identifier: "123123",
    instruction: "Please sign this to..."
  }
}
```

--------------------------------

### Example ping() response structure

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/js-ts-sdk/sdk-syntax/xumm.helpers/ping.md

The response object contains application details and quota information.

```javascript
{
  quota: {},
  application: {
    uuidv4: '00000000-1111-2222-3333-aaaaaaaaaaaa',
    name: 'My XUMM APP',
    webhookurl: '',
    disabled: 0
  },
  call: { uuidv4: 'bbbbbbbb-cccc-dddd-eeee-111111111111' }
}
```

--------------------------------

### GET /.well-known/openid-configuration

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/environments/identity-oauth2-openid/README.md

The OpenID Connect metadata endpoint.

```APIDOC
## GET /.well-known/openid-configuration

### Description
Returns the OpenID Connect configuration metadata.

### Method
GET

### Endpoint
https://oauth2.xumm.app/.well-known/openid-configuration
```

--------------------------------

### Constructing a Xumm OAuth2 Authentication URL

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/environments/identity-oauth2-openid/README.md

Example of an authentication URL incorporating client ID, redirect URI, network enforcement, and specific signer addresses.

```text
https://oauth2.xumm.app/auth
  ?client_id=47fdfcb7-8362-47fe-9a89-a2efc55e86d5
  &redirect_uri=https://dev.wietse.com
  &response_type=token
  &force_network=MAINNET
  &signers=rwietsevLFg8XSmG3bEZzFein1g8RBqWDZ,rTeLeproT3BVgjWoYrDYpKbBLXPaVMkge
```

--------------------------------

### Retrieve userstore value with JavaScript

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/js-ts-sdk/sdk-syntax/xumm.userstore/get.md

Use the get method to retrieve a stored object by its key. The method returns a promise that resolves with the stored data.

```javascript
xumm.userstore.get('userdetails').then(storedObject => ...)
```

--------------------------------

### Example getRates response

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/js-ts-sdk/sdk-syntax/xumm.helpers/getrates.md

The structure of the JSON object returned by the getRates method.

```json
{
	"USD": 1,
	"XRP": 0.52069,
	"__meta": {
		"currency": {
			"en": "US Dollar",
			"code": "USD",
			"symbol": "$",
			"isoDecimals": 4
		}
	}
}
```

--------------------------------

### Batch transaction structure with multiple inner signers

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/concepts/special-transaction-types/batch-multiple-inner-signers.md

Example of a Batch transaction containing multiple inner transactions with specific requirements like zero fees and inner batch flags.

```json
{
    "TransactionType": "Batch",
    "Flags": 65536,
    "Fee": "1337",
    "RawTransactions": [
      {
        "RawTransaction": {
          "TransactionType": "Payment",
          "Account": "rnMsCBhSWeK3ngU7JWkejHsYZs3UVWqNoQ",
          "Destination": "r38xHAWRdc5enrYsHKQxUzHf6javKrV3i4",
          "Amount": "100",
          "Sequence": 36969,
          "Fee": "0",
          "Flags": 1073741824,
          "SigningPubKey": ""
        }
      },
      {
        "RawTransaction": {
          "TransactionType": "CredentialCreate",
          "Expiration": 889004799,
          "Account": "r38xHAWRdc5enrYsHKQxUzHf6javKrV3i4",
          "Subject": "rwietsevLFg8XSmG3bEZzFein1g8RBqWDZ",
          "URI": "CAFEBABE",
          "CredentialType": "4B5943CAFEBABE",
          "Sequence": 36971,
          "Flags": 1073741824,
          "Fee": "0",
          "SigningPubKey": ""
        }
      }
    ]
}
```

--------------------------------

### Initialize xApp with Xumm SDK

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/environments/xapps-dapps/README.md

Basic HTML structure demonstrating how to initialize the Xumm SDK and retrieve the user's account address.

```html
<html lang="en">
  <body>
    <h1 id="accountaddress">...</h1>
        
    <script src="https://xumm.app/assets/cdn/xumm.min.js"></script>
    <script>
      var xumm = new Xumm('your-api-key')
      
      xumm.on("ready", () => console.log("Ready (e.g. hide loading state of xApp)"))
  
      // Account can't change (like Web3 logout/login) so we can rely on the promise
      xumm.user.account.then(account => {
        document.getElementById('accountaddress').innerText = account
      })
    </script>
  </body>
</html>
```

--------------------------------

### Payload Get Method Signature

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/js-ts-sdk/sdk-syntax/xumm.payload/get.md

The TypeScript signature for the get method, showing parameters and return type.

```typescript
async Sdk.payload.get (
  payload: string | CreatedPayload,
  returnErrors: boolean = false
): Promise<XummPayload | null>
```

--------------------------------

### Initialize Xumm SDK and perform operations

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/environments/backend-sdk-api.md

Demonstrates SDK initialization and basic usage for pinging the service and creating a sign-in payload.

```typescript
import { Xumm } from "xumm";

const xumm = new Xumm("some-api-key", "some-secret-key");

(async () => {
  console.log("pong", await xumm.ping());

  const transaction = { TransactionType: 'SignIn' };
  console.log("payload", await xumm.payload?.create(transaction)) 
})()
```

```javascript
const { Xumm } = require('xumm')

const xumm = new Xumm('apikey', 'apisecret')

xumm.ping().then(pong => console.log(pong))

const transaction = { TransactionType: "SignIn" }
xumm.payload?.create(transaction).then(payload => console.log(payload))
```

--------------------------------

### GET /auth

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/environments/identity-oauth2-openid/README.md

The authorization endpoint used to initiate the OAuth2 flow.

```APIDOC
## GET /auth

### Description
Initiates the OAuth2 authorization flow.

### Method
GET

### Endpoint
https://oauth2.xumm.app/auth
```

--------------------------------

### Create a Sign Request Payload

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/js-ts-sdk/examples-user-stories/misc-todo.md

Demonstrates how to initialize the SDK and create a sign request payload for different environments.

```typescript
import { Xumm } from "xumm"

const Sdk = new Xumm(process.env.XUMM_KEY, process.env.XUMM_SECRET)
const pong = await Sdk?.ping()
const payload = await Sdk.payload?.create({
  custom_meta: {
    instruction: "Sign request from " + pong?.application.name,
  },
  txjson: {
    TransactionType: "SignIn",
  },
})

console.log(payload)
```

```javascript
const { Xumm } = require("xumm")

const Sdk = new Xumm(process.env.XUMM_KEY, process.env.XUMM_SECRET)
Sdk.ping().then(pong => {
  Sdk.payload.create({
    custom_meta: {
      instruction: "Sign request from " + pong.application.name,
    },
    txjson: {
      TransactionType: "SignIn",
    }
  }).then(payload => {
    // Done
    console.log(payload)
  })
})
```

```javascript
const Sdk = new Xumm('some-api-key')

Sdk.authorize()

Sdk.on("ready", () => {
  Sdk.ping().then(pong => {
    Sdk.payload.create({
      custom_meta: {
        instruction: "Sign request from " + pong.application.name,
      },
      txjson: {
        TransactionType: "SignIn",
      }
    }).then(payload => {
      // Done
      console.log(payload)
    })
  })
})
```

--------------------------------

### GET /certs

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/environments/identity-oauth2-openid/README.md

The JWKS endpoint providing public keys for token verification.

```APIDOC
## GET /certs

### Description
Provides the JSON Web Key Set (JWKS) for verifying JWTs.

### Method
GET

### Endpoint
https://oauth2.xumm.app/certs
```

--------------------------------

### GET /userinfo

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/environments/identity-oauth2-openid/README.md

The userinfo endpoint used to retrieve claims about the authenticated user.

```APIDOC
## GET /userinfo

### Description
Retrieves claims about the authenticated user.

### Method
GET

### Endpoint
https://oauth2.xumm.app/userinfo
```

--------------------------------

### Initialize Xumm SDK and retrieve bearer

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/environments/xapps-dapps/your-own-backend-auth.md

Initialize the Xumm SDK and extract the JWT bearer token from the environment.

```javascript
const xumm = new Xumm(apiKey, xAppToken)
```

```javascript
const bearer = await xumm.environment.bearer
```

--------------------------------

### Dynamically Load Theme Stylesheet

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/environments/xapps-dapps/style-guide.md

Use this script in the document head to detect the xAppStyle parameter and inject the corresponding Bootstrap stylesheet.

```html
<script>
  var theme = ((new URLSearchParams(document.location.href))
               .get('xAppStyle') || 'light').toLowerCase()
  var link = document.createElement('link')
  link.href = 'https://xumm.app/assets/themes/xapp/xumm-'
    + theme + '/bootstrap.min.css'
  link.type = 'text/css'
  link.rel = 'stylesheet'
  document.getElementsByTagName('head')[0].appendChild(link)
</script>
```

--------------------------------

### Curated Assets Response Structure

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/js-ts-sdk/sdk-syntax/xumm.helpers/getcuratedassets.md

Example of the data structure returned by the getCuratedAssets method.

```javascript
{
  curatedAssets: {
    issuers: [ 'Bitstamp', 'GateHub' ],
    currencies: [ 'USD', 'BTC', 'EUR', 'ETH' ],
    details: {
      Bitstamp: [Object],
      GateHub: [Object]
    }
  }
}
```

--------------------------------

### xumm.xapp.share({ text })

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/js-ts-sdk/sdk-syntax/xumm.xapp/share.md

Invokes the native OS share dialog with the provided text content.

```APIDOC
## xumm.xapp.share({ text })

### Description
Triggers the native operating system share dialog to allow the user to share text or a URL.

### Syntax
`xumm.xapp.share({ text: 'Some text to share' })`

### Parameters
- **text** (string) - Required - The text or URL content to be shared via the OS dialog.
```

--------------------------------

### xApp URL Parameter Structure

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/environments/xapps-dapps/style-guide.md

The xApp launch URL receives an xAppStyle query parameter indicating the active theme on the client device.

```text
https://my.app.local/some/app
```

```text
https://my.app.local/some/app?xAppStyle={THEME}
```

--------------------------------

### Sample Payload Resolve Message

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/concepts/payloads-sign-requests/status-updates/websocket.md

Example of the JSON object received when a payload is resolved via Websocket.

```json
{
  "payload_uuidv4": "<some-uuid>",
  "reference_call_uuidv4": "<some-uuid>",
  "return_url":{
    "app": "<some-url>",
    "web": "<some-url>",
  },
  "signed": true,
  "opened_by_deeplink": false,
  "user_token": true,
  "custom_meta":{
    "identifier": "<some-identifier>",
    "blob": {},
    "instruction": "<some-instruction>"
  },
  "txid": "<some-tx-hash>"
}
```

--------------------------------

### xumm.xapp.navigate({ xApp })

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/js-ts-sdk/sdk-syntax/xumm.xapp/navigate.md

Navigates the user to a specified xApp by its identifier.

```APIDOC
## xumm.xapp.navigate

### Description
Navigates the user to another xApp using the provided xApp identifier. This method is permissioned and requires prior approval from Xumm support.

### Syntax
`xumm.xapp.navigate({ xApp: '...' })`

### Parameters
- **xApp** (string) - Required - The valid xApp identifier to navigate to.

### Example
```javascript
xumm.xapp.navigate({ xApp: 'xumm.support' })
```
```

--------------------------------

### Create and Subscribe to a Payload

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/js-ts-sdk/sdk-syntax/xumm.payload/createandsubscribe.md

Demonstrates creating a payment transaction payload and handling subscription events such as opening and signing.

```javascript
xumm.payload.createAndSubscribe({
  TransactionType: 'Payment',
  Destination: 'rfHn6cB5mmqZ6fHZ4fdemCDSxqLTijgMwo',
  Amount: String(1000000) // one million drops, 1 XRP
}, eventMessage => {
  if (Object.keys(eventMessage.data).indexOf('opened') > -1) {
    // Update the UI? The payload was opened.
  }
  if (Object.keys(eventMessage.data).indexOf('signed') > -1) {
    // The `signed` property is present, true (signed) / false (rejected)
    return eventMessage
  }
})
  .then(({ created, resolved }) => {
    console.log('Payload URL:', created.next.always)
    console.log('Payload QR:', created.refs.qr_png)

    return resolved // Return payload promise for the next `then`
  })
  .then(payload => console.log('Payload resolved', payload))
  // This is where you can do `xumm.payload.get(...)` to fetch details
```

--------------------------------

### xumm.userstore.list()

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/js-ts-sdk/sdk-syntax/xumm.userstore/list.md

Retrieves an array of keys stored in the userstore for the current user.

```APIDOC
## xumm.userstore.list()

### Description
Returns a Promise that resolves to an array of keys stored in the userstore for the application and user associated with the current JWT.

### Method
SDK Method

### Signature
`xumm.userstore.list(): Promise<string[]>`

### Example
```javascript
xumm.userstore.list().then(storedKey => {
  console.log(storedKey)
})
```

--------------------------------

### Verify User Tokens in TypeScript

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/js-ts-sdk/sdk-syntax/xumm.helpers/verifyusertokens.md

Demonstrates checking multiple tokens using verifyUserTokens and a single token using verifyUserToken to determine the appropriate sign request flow.

```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
}
```

--------------------------------

### Trigger QR Scanner and Listen for Result

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/js-ts-sdk/sdk-syntax/xumm.xapp/scanqr.md

Initiates the QR scanner and sets up an event listener to handle the scanned data.

```javascript
xumm.xapp.scanQr()
xumm.xapp.on('qr', data => {
    console.log('QR', data)
})
```

--------------------------------

### Call ready() to dismiss the Xumm loader

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/js-ts-sdk/sdk-syntax/xumm.xapp/ready.md

Invoke this method once the application has finished fetching data and is ready to render. Ensure the 'Xumm loader till SDK ready() is called' option is enabled in the Xumm Developer Console.

```javascript
xumm.xapp.ready()
```

--------------------------------

### xumm.xapp.ready()

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/js-ts-sdk/sdk-syntax/xumm.xapp/ready.md

Call this method to remove the Xumm native loading screen once your xApp is fully hydrated and ready to be displayed.

```APIDOC
## xumm.xapp.ready()

### Description
Signals that the xApp is ready to be displayed. Calling this method removes the native Xumm loading screen, which is useful when the 'Xumm loader till SDK ready() is called' option is enabled in the Xumm Developer Console.

### Syntax
```javascript
xumm.xapp.ready()
```

### Exception Flows
- **Debugging**: If the xApp fails to load, Xumm in Developer Mode displays a 'Proceed to xApp' button to allow users to bypass the loader and view the underlying error.
- **Timeout**: If `ready()` is not called within approximately 6 seconds, a 'xApp is slow to respond' message appears with a button linking to the developer's support URL.
```

--------------------------------

### Create and Subscribe to Payload

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/js-ts-sdk/examples-user-stories/sign-requests-payloads/browser.md

Use createAndSubscribe to initiate a transaction and listen for real-time events like payload opening or signing.

```javascript
xumm.payload.createAndSubscribe({
  TransactionType: 'Payment',
  Destination: 'rfHn6cB5mmqZ6fHZ4fdemCDSxqLTijgMwo',
  Amount: String(1000000) // one million drops, 1 XRP
}, eventMessage => {
  if ('opened' in eventMessage.data) {
    // Update the UI? The payload was opened.
  }
  if ('signed' in eventMessage.data) {
    // The `signed` property is present, true (signed) / false (rejected)
    return eventMessage
  }
})
  .then(({ created, resolved }) => {
    console.log('Payload URL:', created.next.always)
    console.log('Payload QR:', created.refs.qr_png)

    return resolved // Return payload promise for the next `then`
  })
  .then(payload => console.log('Payload resolved', payload))
  // This is where you can do `xumm.payload.get(...)` to fetch details
```

```typescript
const { created, resolved } = await xumm.payload.createAndSubscribe({
  TransactionType: 'Payment',
  Destination: 'rfHn6cB5mmqZ6fHZ4fdemCDSxqLTijgMwo',
  Amount: String(1000000) // one million drops, 1 XRP
}, eventMessage => {
  if ('opened' in eventMessage.data) {
    // Update the UI? The payload was opened.
  }
  if ('signed' in eventMessage.data) {
    // The `signed` property is present, true (signed) / false (rejected)
    return eventMessage
  }
})

console.log('Payload URL:', created.next.always)
console.log('Payload QR:', created.refs.qr_png)

const payload = await resolved

console.log('Resolved', payload)
```

--------------------------------

### openSignRequest Syntax

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/js-ts-sdk/sdk-syntax/xumm.xapp/opensignrequest.md

Use this syntax to create a payload and immediately open the sign request interface.

```javascript
xumm.payload.create({
  TransactionType: 'Payment',
  Destination: 'rfHn6cB5mmqZ6fHZ4fdemCDSxqLTijgMwo',
  Amount: String(1)
}).then(payload => {
  xumm.xapp.openSignRequest(payload)
})
```

--------------------------------

### Share Method Syntax

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/js-ts-sdk/sdk-syntax/xumm.xapp/share.md

Invoke the share dialog by calling the share method on the xumm.xapp object.

```javascript
xumm.xapp.share({ text: 'Some text to share' })
```

--------------------------------

### xumm.xapp.on(event, callback)

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/js-ts-sdk/sdk-syntax/xumm.xapp/on-event-fn.md

Registers an event handler for specific xApp events. Supported events include 'payload', 'qr', 'destination', and 'networkswitch'.

```APIDOC
## xumm.xapp.on(event, callback)

### Description
Subscribes to events emitted to the xApp. When the specified event occurs, the provided callback function is executed with the event data.

### Parameters
- **event** (string) - The name of the event to listen for ('payload', 'qr', 'destination', 'networkswitch').
- **callback** (function) - The function to execute when the event is emitted, receiving the event data as an argument.

### Usage Example
```javascript
var xumm = new Xumm('your-api-key');

xumm.xapp.on('payload', data => {
  console.log('Payload resolved', data);
});
```
```

--------------------------------

### xumm.xapp.tx()

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/js-ts-sdk/sdk-syntax/xumm.xapp/tx.md

Opens the Transaction Details panel for a specific transaction hash.

```APIDOC
## xumm.xapp.tx({ ... })

### Description
Opens the Transaction Details panel for a specified transaction hash within the Xumm xApp.

### Parameters
- **account** (string) - Required - The XRPL account address.
- **tx** (string) - Required - The transaction hash.
- **network** (string) - Optional - The network identifier (e.g., 'MAINNET', 'TESTNET', 'XAHAU').

### Syntax
```javascript
xumm.xapp.tx({
  account: 'rwietsevLFg8XSmG3bEZzFein1g8RBqWDZ',
  tx: '250DC3E83946EFE965DE36B3F9AE8608CD7ED793657BDEC5B794B665B2DCBC0E',
  network: 'MAINNET',
})
```

### Requirements
- The specified `account` must be imported in Xumm.
- Xumm must be connected to the network where the transaction exists.
```

--------------------------------

### Manage App Storage with Xumm SDK

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/js-ts-sdk/sdk-syntax/xumm.backendstore/README.md

Demonstrates setting, retrieving, and deleting a JSON object in the XUMM API backend storage.

```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
```

--------------------------------

### Xumm.authorize()

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/js-ts-sdk/sdk-syntax/xumm.authorize.md

Triggers the sign-in flow for users in browser environments.

```APIDOC
## Xumm.authorize()

### Description
Triggers the sign-in flow in Browser environments. This method is used to initiate the authentication process for the user.

### Syntax
`Xumm.authorize()`
```

--------------------------------

### Sdk.payload.create(payload, returnErrors)

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/js-ts-sdk/sdk-syntax/xumm.payload/create.md

Creates a new XUMM payload for signing. The payload can contain transaction details, options for return URLs, and custom metadata.

```APIDOC
## Sdk.payload.create

### Description
Creates a payload for an XRPL transaction. You can provide a `txjson` object or a `txblob` string. The method returns a `CreatedPayload` object containing URLs for user interaction and QR code references.

### Signature
`async Sdk.payload.create(payload: CreatePayload, returnErrors: boolean = false): Promise<CreatedPayload | null>`

### Parameters
- **payload** (CreatePayload) - Required - The payload object containing transaction data (txjson or txblob), options, and custom_meta.
- **returnErrors** (boolean) - Optional - Defaults to false. If true, returns errors instead of throwing.

### Request Example
{
  "txjson": {
    "TransactionType": "Payment",
    "Destination": "r...",
    "Amount": "1000000"
  },
  "options": {
    "return_url": {
      "app": "https://sample.test/?...",
      "web": "https://sample.test/?id={id}"
    },
    "force_network": "MAINNET"
  },
  "custom_meta": {
    "identifier": "123123",
    "instruction": "Please sign this to..."
  }
}

### Response
- **uuid** (string) - The unique identifier for the created payload.
- **next** (object) - Contains URLs for user redirection (always, no_push_msg_received).
- **refs** (object) - Contains QR code references and the websocket status URL.
- **pushed** (boolean) - Indicates if the payload was pushed to the end user.

### Response Example
{
  "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
}
```

--------------------------------

### Calculate XRPL Account Reserve Requirements

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/concepts/implementation-checklist/protocol-specific-checks.md

Use these formulas to determine the owner reserve based on account data and server-provided reserve constants.

```ini
ownerwnerCount = accountInfo.account_data.OwnerCount
reserveBase = serverInfo.info.validated_ledger.reserve_base_native || serverInfo.info.validated_ledger.reserve_base_xrp
reserveInc = serverInfo.info.validated_ledger.reserve_inc_native || serverInfo.info.validated_ledger.reserve_inc_xrp
```

--------------------------------

### Verify API connectivity with ping()

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/js-ts-sdk/sdk-syntax/xumm.helpers/ping.md

Use this method to confirm that the SDK is correctly authenticated and the XUMM platform is reachable.

```typescript
const pong = await Sdk.ping();
```

--------------------------------

### List userstore keys with JavaScript

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/js-ts-sdk/sdk-syntax/xumm.userstore/list.md

Retrieves an array of stored keys for the user associated with the current JWT.

```javascript
xumm.userstore.list().then(storedKey => {
  console.log(storedKey)
})
```

--------------------------------

### Payload with Return URL

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/concepts/payloads-sign-requests/payload-return-url.md

Define return URLs for both app and web environments within the payload options.

```json
{
  "txjson": {
    "TransactionType": "..."
  },
  "options": {
    "return_url": {
      "app": "https://...",
      "web": "https://..."
    }
  }
}
```

--------------------------------

### Open URL in Browser

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/js-ts-sdk/sdk-syntax/xumm.xapp/openbrowser.md

Triggers the browser to open the specified URL, prompting the user for confirmation.

```javascript
xumm.xapp.openBrowser({ url: 'https://wietse.com' })
```

--------------------------------

### ping()

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/js-ts-sdk/sdk-syntax/xumm.helpers/ping.md

Verifies API access and returns information about the XUMM application.

```APIDOC
## ping()

### Description
The `ping` method allows you to verify API access (valid credentials) and returns information regarding your XUMM application.

### Signature
`const pong = await Sdk.ping();`

### Returns
Returns an `ApplicationDetails` object containing:
- **quota** (object) - Information regarding API usage limits.
- **application** (object) - Details about the XUMM application including `uuidv4`, `name`, `webhookurl`, and `disabled` status.
- **call** (object) - The unique identifier for the current call.

### Response Example
{
  "quota": {},
  "application": {
    "uuidv4": "00000000-1111-2222-3333-aaaaaaaaaaaa",
    "name": "My XUMM APP",
    "webhookurl": "",
    "disabled": 0
  },
  "call": { "uuidv4": "bbbbbbbb-cccc-dddd-eeee-111111111111" }
}
```

--------------------------------

### xumm.xapp.openBrowser

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/js-ts-sdk/sdk-syntax/xumm.xapp/openbrowser.md

Opens a specified URL in the device's default browser. Note that this action typically triggers a confirmation dialog for the user.

```APIDOC
## xumm.xapp.openBrowser({ url })

### Description
Opens an external URL in the OS default browser. This action triggers a confirmation dialog for the end user to confirm leaving the xApp.

### Syntax
`xumm.xapp.openBrowser({ url: 'https://example.com' })`

### Parameters
- **url** (string) - Required - The URL to be opened in the external browser.
```

--------------------------------

### xumm.userstore.set(key, value)

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/js-ts-sdk/sdk-syntax/xumm.userstore/set-....md

Stores a key/value pair in the Xumm userstore. The value must be an object.

```APIDOC
## xumm.userstore.set(key, value)

### Description
Stores a persistent key/value record specific to your application and the user. The data is stored on the Xumm backend and persists across xApp loads.

### Parameters
- **key** (string) - Required - The key identifier for the data record.
- **value** (object) - Required - The data object to store. Must be an object.

### Example
```javascript
xumm.userstore.set('userdetails', { name: 'Jane', gender: 'F' })
```
```

--------------------------------

### Verify a Transaction using xrpl-txdata

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/concepts/payloads-sign-requests/verify-transactions.md

Initializes a connection to multiple XRPL nodes and waits for a specified duration to verify a transaction hash.

```javascript
const {TxData} = require('xrpl-txdata')

const TxHash = '8F3CE0481EF31A1BE44AD7D744D286B0F440780CD0056951948F93A803D47F8B'

const VerifyTx = new TxData([
  'wss://xrplcluster.com',
  'wss://xrpl.link',
  // Or:
  // 'wss://testnet.xrpl-labs.com'
], {
  OverallTimeoutMs: 6000,
  EndpointTimeoutMs: 1500,
  // If using testnet, see above:
  // AllowNoFullHistory: true
})

// Specify the transaction hash to verify and the # of seconds
// to wait & monitor the XRPL if not found initially.
VerifyTx.getOne(TxHash, 20)
  .then(tx => {
    console.log(`Got the TX, details:`, tx)
  })
```

--------------------------------

### Link to transaction by hash

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/concepts/payloads-sign-requests/tx-explorer-s.md

Construct a URL using the network type and transaction hash.

```text
https://xumm.app/explorer/{network}/{txhash}
```

--------------------------------

### Navigate method parameters

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/js-ts-sdk/sdk-syntax/xumm.xapp/navigate.md

The navigate function accepts an object containing the target xApp identifier.

```javascript
{ xApp: '...' }
```

--------------------------------

### xumm.userstore.get(key)

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/js-ts-sdk/sdk-syntax/xumm.userstore/get.md

Retrieves the object stored for a specific key in the userstore.

```APIDOC
## xumm.userstore.get(key)

### Description
Retrieves a previously stored object from the userstore associated with the provided key. The method returns a promise that resolves to the stored object.

### Parameters
- **key** (string) - Required - The unique key identifier for the stored data.

### Example
```javascript
xumm.userstore.get('userdetails').then(storedObject => {
  console.log(storedObject);
});
```
```

--------------------------------

### Retrieve Curated Assets

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/js-ts-sdk/sdk-syntax/xumm.helpers/getcuratedassets.md

Fetches the list of trusted issuers and currencies from the Xumm SDK.

```typescript
const curatedAssets = await Sdk.getCuratedAssets();
```

--------------------------------

### Xumm.on(event, fn)

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/js-ts-sdk/sdk-syntax/xumm.on-event-fn.md

Registers a callback function to be executed when a specific SDK event occurs.

```APIDOC
## Xumm.on(event, fn)

### Description
Registers an event listener for the Xumm SDK. The method triggers the provided callback function when the specified event is fired.

### Parameters
- **event** (string) - Required - The name of the event to listen for (e.g., 'retrieved', 'success', 'ready', 'retrieving', 'logout', 'loggedout', 'error', 'qr', 'payload', 'destination', 'networkswitch').
- **fn** (function) - Required - The callback function to execute when the event occurs.

### Supported Events
- **retrieved**: A valid signed in Xumm SDK session has been retrieved (xApp, Web3).
- **success**: A user is successfully identified and signed in (xApp, Web3).
- **ready**: The SDK is ready for application rendering (xApp, Web3).
- **retrieving**: The SDK is trying to retrieve & verify an existing session (Web3).
- **logout**: The SDK is destroying a pending signed in session (Web3).
- **loggedout**: The SDK destroyed a signed in session (Web3).
- **error**: An error occurred (Web3).
- **qr**: The QR code scan dialog has been closed (xApp).
- **payload**: A Sign Request (payload) has been resolved (xApp).
- **destination**: The Destination Picker dialog has been closed (xApp).
- **networkswitch**: The user switched the selected network in Xumm (xApp).
```

--------------------------------

### Create a Sign Request Payload

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/js-ts-sdk/examples-user-stories/sign-requests-payloads/backend.md

Initializes the Xumm SDK with credentials and creates a payload with transaction details, return URLs, and custom metadata.

```typescript
import { Xumm } from "xumm"

const xumm = new Xumm("some-api-key", "some-secret-key")

const payload = await xumm.payload?.create({
  user_token: "xxxxxxxxxx",
  txjson: {
    TransactionType: "SignIn"
  },
  options: {
    return_url: {
      app: "https://sample.test/?...",
      web: "https://sample.test/?id={id}"
    },
    force_network: "MAINNET"
  },
  custom_meta: {
    identifier: "123123",
    instruction: "Please sign this to..."
  }
}))
```

--------------------------------

### Create and Open Sign Request in xApp

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/js-ts-sdk/examples-user-stories/sign-requests-payloads/xapp.md

Use the Xumm SDK to create a transaction payload and immediately open it as a sign request within the xApp interface.

```html
<html lang="en">
  <head>
    <script src="https://xumm.app/assets/cdn/xumm.min.js"></script>
  </head>
  <body>
    <pre id="payload">...</pre>

    <script>
      var xumm = new Xumm('your-api-key')

      xumm.on('payload', event => {
        document.getElementById('payload').innerHTML = JSON.stringify(event, null, 2)
      })

      xumm.payload
        .create({
          txjson: {
            TransactionType: "Payment",
            Destination: "r...",
            Amount: "1000000"
          },
          options: {
            return_url: {
              app: "https://sample.test/?...",
              web: "https://sample.test/?id={id}"
            },
            force_network: "MAINNET"
          },
          custom_meta: {
            identifier: "123123",
            instruction: "Please sign this to..."
          }
        })
        .then(payload => {
          document.getElementById('payload').innerHTML = JSON.stringify(payload, null, 2)
          xumm.xapp.openSignRequest(payload)
        })
    </script>
  </body>
</html>
```

```typescript
const payload = await xumm.payload?.create({
  txjson: {
    TransactionType: "Payment",
    Destination: "r...",
    Amount: "1000000"
  },
  options: {
    return_url: {
      app: "https://sample.test/?...",
      web: "https://sample.test/?id={id}"
    },
    force_network: "MAINNET"
  },
  custom_meta: {
    identifier: "123123",
    instruction: "Please sign this to..."
  }
})

xumm.xapp?.openSignRequest(payload)
```

--------------------------------

### Craft a Pay With Anything Payload

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/concepts/pay-with-anything.md

Define a transaction payload with pathfinding enabled to allow users to pay with any asset while ensuring the destination receives the specified amount.

```mjs
{
  options: {
    force_network: 'MAINNET',
    pathfinding: true
  },
  custom_meta: {
    instruction: 'Pay for this and that...'
  },
  txjson: {
    TransactionType: 'Payment',
    Destination: 'r...YourAddress...',
    Amount: {
      currency: '524C555344000000000000000000000000000000',
      issuer: 'rMxCKbEDwqr76QuheSUMdEGf4B9xJ8m5De',
      value: '15'
    }
  }
}
```

--------------------------------

### Sdk.Push.event(data: EventPushPostBody)

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/js-ts-sdk/sdk-syntax/xumm.push/event.md

Sends a push notification and publishes an xApp event to the user's Event List.

```APIDOC
## Sdk.Push.event

### Description
Sends a push notification and publishes an xApp Event in the Event List of the end user. When the notification is tapped, the xApp opens; if dismissed, the event remains accessible in the XUMM Event list.

### Method
SDK Method

### Signature
`async Sdk.Push.event(data: EventPushPostBody): Promise<EventResponse>`

### Parameters
- **data** (EventPushPostBody) - Required - The payload containing the push notification and event details.
```

--------------------------------

### xumm.xapp.scanQr()

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/js-ts-sdk/sdk-syntax/xumm.xapp/scanqr.md

Triggers the QR code scanner. The result is returned by subscribing to the 'qr' event.

```APIDOC
## xumm.xapp.scanQr()

### Description
Triggers the QR code scanner within the xApp. The scanned data is returned via an event listener.

### Syntax
`xumm.xapp.scanQr()`

### Events
- **qr**: Emitted when a QR code is scanned. Subscribe using `xumm.xapp.on('qr', callback)`.

### Example
```javascript
xumm.xapp.scanQr();

xumm.xapp.on('qr', data => {
    console.log('QR', data);
});
```
```

--------------------------------

### getRates(currency)

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/js-ts-sdk/sdk-syntax/xumm.helpers/getrates.md

Fetches the exchange rates for a requested currency pair against XRP.

```APIDOC
## getRates(currency)

### Description
The `getRates` method allows you to get the exchange rates for an `XRP` <> requested pair. The source information is aggregated from several data providers.

### Signature
`await Sdk.getRates(currency: string)`

### Parameters
- **currency** (string) - Required - The currency code to fetch the exchange rate for.

### Example Usage
```typescript
const rate = await Sdk.getRates('BTC');
```

### Response Example
```json
{
	"USD": 1,
	"XRP": 0.52069,
	"__meta": {
		"currency": {
			"en": "US Dollar",
			"code": "USD",
			"symbol": "$",
			"isoDecimals": 4
		}
	}
}
```
```

--------------------------------

### Invoke Destination Picker and Handle Response

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/js-ts-sdk/sdk-syntax/xumm.xapp/selectdestination.md

Trigger the destination picker and subscribe to the destination event to retrieve the selected account data.

```javascript
xumm.xapp.selectDestination({ ignoreDestinationTag: false })
xumm.xapp.on('destination', data => {
    console.log('Destination', data.destination)
})
```

--------------------------------

### Sdk.Push.event method signature

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/js-ts-sdk/sdk-syntax/xumm.push/event.md

The method signature for sending a push notification and creating an xApp event.

```typescript
async Sdk.Push.event (
  data: EventPushPostBody
): Promise<EventResponse>
```

--------------------------------

### Sdk.storage.get()

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/js-ts-sdk/sdk-syntax/xumm.backendstore/README.md

Retrieves the stored JSON object from the XUMM API platform.

```APIDOC
## Sdk.storage.get()

### Description
Retrieves the previously stored JSON object associated with the API credentials.

### Returns
- **object|null** - The stored JSON object, or null if no data exists.
```

--------------------------------

### xApp close parameters

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/js-ts-sdk/sdk-syntax/xumm.xapp/close.md

Configuration object for the close method, allowing an optional refresh of event lists.

```javascript
{ refreshEvents: true }
```

--------------------------------

### xumm.xapp.selectDestination

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/js-ts-sdk/sdk-syntax/xumm.xapp/selectdestination.md

Triggers the Xumm destination picker interface. Developers can optionally ignore the destination tag requirement.

```APIDOC
## xumm.xapp.selectDestination

### Description
Opens the Xumm destination picker to allow users to select, find, or scan an XRPL destination account (r-address, slug, or PayString).

### Syntax
`xumm.xapp.selectDestination({ ignoreDestinationTag: boolean })`

### Parameters
- **ignoreDestinationTag** (boolean) - Optional - If true, skips the destination tag requirement check and input. Defaults to false.

### Response
Returns a 'destination' event containing the selected destination data. Subscribe to this event using the `on` method.
```

--------------------------------

### Xumm.ping() Sample Response

Source: https://github.com/xrpl-labs/developer-help-center/blob/main/js-ts-sdk/sdk-syntax/xumm.ping.md

The JSON response returned by the ping method, containing authentication details and application metadata.

```json
{
  "pong": true,
  "auth": {
    "quota": {},
    "application": {
      "uuidv4": "8525e32b-1bd0-4839-af2f-f794874a80b0",
      "name": "Some App",
      "webhookurl": "https://webhook.site/3e5dee90-a654-4e34-8112-c4391247a8ee",
      "disabled": 0
    },
    "call": {
      "uuidv4": "4b97cf7a-1837-471f-baed-2ebebcf5adb4"
    }
  }
}
```
Tokens:
Raw