# @xelis/sdk

> Xelis software development kit for JS

Latest version **0.12.7** (published 2026-09-29) · 0 weekly downloads

## Install

```sh
npm install @xelis/sdk
pnpm add @xelis/sdk
yarn add @xelis/sdk
bun add @xelis/sdk
```

## Health

**Score 60/100 (C)** — status: active.

Positive: esm support; no vulnerabilities; recently updated; high maintenance score.

Warnings: low downloads; no types; pre 1.0.

## Facts

| | |
|---|---|
| Version | 0.12.7 |
| Published | 2026-09-29 |
| First published | 2023-09-28 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 7 |
| Unpacked size | 431.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Maintainers | g45t345rt |

## Links

- npm: https://www.npmjs.com/package/@xelis/sdk
- Repository: https://github.com/xelis-project/xelis-js-sdk
- Homepage: https://github.com/xelis-project/xelis-js-sdk#readme
- Issues: https://github.com/xelis-project/xelis-js-sdk/issues
- npm.io page: https://npm.io/package/@xelis/sdk

## Dependencies (7)

- [ws](https://npm.io/package/ws.md) ^8.12.1
- [react](https://npm.io/package/react.md) ^18.2.0
- [qrcode](https://npm.io/package/qrcode.md) ^1.5.4
- [js-base64](https://npm.io/package/js-base64.md) ^3.7.6
- [await-to-js](https://npm.io/package/await-to-js.md) ^3.0.0
- [json-bigint](https://npm.io/package/json-bigint.md) ^1.0.0
- [isomorphic-ws](https://npm.io/package/isomorphic-ws.md) ^5.0.0

## Recent versions

- 0.12.7 (latest) — 2026-09-29
- 0.12.5 (dev) — 2026-08-08
- 0.12.6 — 2026-09-23
- 0.12.4 — 2026-07-21
- 0.12.3 — 2026-07-16
- 0.12.2 — 2026-07-16
- 0.12.1 — 2026-07-16
- 0.12.0 — 2026-07-16
- 0.11.44 — 2026-06-16
- 0.11.43 — 2026-06-07
- 0.11.42 — 2026-02-15
- 0.11.41 — 2026-01-09
- 0.11.40 — 2026-01-08
- 0.11.39 — 2025-12-27
- 0.11.38 — 2025-12-27
- … 95 more at https://npm.io/package/@xelis/sdk/versions

## README

# XELIS-JS-SDK

Xelis software development kit for JS.

## Install

Install library with NPM.

`npm i @xelis/sdk`

## Usage

Import library and start working :).

Use Daemon HTTP RPC connection.

```js
// ESM
import { TESTNET_NODE_RPC } from '@xelis/sdk/config'
import DaemonRPC from '@xelis/sdk/daemon/rpc'
// CommonJS
// const { TESTNET_NODE_RPC } = require('@xelis/sdk/config')
// const { RPC: DaemonRPC } = require('@xelis/sdk/daemon/rpc')

const main = async () => {
  const daemon = new DaemonRPC(TESTNET_NODE_RPC)
  const info = await daemon.getInfo()
  console.log(info)
}

main()
```

Use Daemon WebSocket RPC connection.

```js
// ESM
import { TESTNET_NODE_WS } from '@xelis/sdk/config.js'
import DaemonWS from '@xelis/sdk/daemon/websocket.js'
// CommonJS
// const { TESTNET_NODE_RPC } = require('@xelis/sdk/config')
// const { WS: DaemonWS } = require('@xelis/sdk/daemon/websocket')

const main = async () => {
  const daemon = new DaemonWS()
  await daemon.connect(TESTNET_NODE_WS)
  const info = await daemon.methods.getInfo()
  console.log(info)
}

main()
```

Use Wallet WebSocket RPC connection.

```js
// ESM
import { LOCAL_WALLET_WS } from '@xelis/sdk/config.js'
import DaemonWS from '@xelis/sdk/wallet/websocket.js'
// CommonJS
// const { LOCAL_WALLET_WS } = require('@xelis/sdk/config')
// const { WS: WalletWS } = require('@xelis/sdk/wallet/websocket')

const main = async () => {
  const wallet = new WalletWS(`test`, `test`) // username, password
  await wallet.connect(LOCAL_WALLET_WS)
  const address = await wallet.methods.getAddress()
  console.log(address)
}

main()
```

Use XSWD protocol.

```js
// ESM
import { LOCAL_XSWD_WS } from '@xelis/sdk/config.js'
import XSWD from '@xelis/sdk/xswd/websocket.js'
// CommonJS
// const { LOCAL_XSWD_WS } = require('@xelis/sdk/config')
// const { WS: XSWD } = require('@xelis/sdk/xswd/websocket')

const main = async () => {
  const xswd = new XSWD()
  await xswd.connect(LOCAL_XSWD_WS)
  const info = await xswd.daemon.getInfo()
  console.log(info)
  const address = await xswd.wallet.getAddress()
  console.log(address)
}

main()
```

## Tests

To run single test function, use jest or npm script.
`jest -t <describe> <test>`  

Ex: `jest -t "DaemonRPC getInfo"` or `npm run test-func "DaemonRPC getInfo"`

---
_Source: https://npm.io/package/@xelis/sdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
