# rmb-sdk-ts

> This is a `Typescript` client that can be used to build both **services**, and **clients** that can talk over the `rmb`.

Latest version **1.1.3** (published 2023-03-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install rmb-sdk-ts
pnpm add rmb-sdk-ts
yarn add rmb-sdk-ts
bun add rmb-sdk-ts
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.3 |
| Published | 2023-03-28 |
| First published | 2023-02-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 10 |
| Unpacked size | 148.8 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | amiraabouhadid |
| Maintainers | threefolddev |

## Links

- npm: https://www.npmjs.com/package/rmb-sdk-ts
- Repository: https://github.com/threefoldtech/rmb-sdk-ts
- npm.io page: https://npm.io/package/rmb-sdk-ts

## Dependencies (10)

- [ws](https://npm.io/package/ws.md) ^8.12.0
- [uuid](https://npm.io/package/uuid.md) ^8.3.2
- [bip39](https://npm.io/package/bip39.md) ^3.1.0
- [buffer](https://npm.io/package/buffer.md) ^6.0.3
- [base64url](https://npm.io/package/base64url.md) ^3.0.1
- [crypto-js](https://npm.io/package/crypto-js.md) ^4.1.1
- [@polkadot/api](https://npm.io/package/@polkadot/api.md) ^8.9.1
- [js-crypto-aes](https://npm.io/package/js-crypto-aes.md) ^1.0.4
- [google-protobuf](https://npm.io/package/google-protobuf.md) ^3.21.2
- [@noble/secp256k1](https://npm.io/package/@noble/secp256k1.md) ^1.7.1

## Recent versions

- 1.1.3 (latest) — 2023-03-28
- 1.1.2 — 2023-03-26
- 1.1.1 — 2023-03-21
- 1.1.0 — 2023-03-21
- 1.0.11 — 2023-03-08
- 1.0.10 — 2023-03-02
- 1.0.9 — 2023-02-23
- 1.0.8 — 2023-02-21
- 1.0.7 — 2023-02-20
- 1.0.6 — 2023-02-19
- 1.0.5 — 2023-02-19
- 1.0.4 — 2023-02-16
- 1.0.3 — 2023-02-15
- 1.0.2 — 2023-02-15
- 1.0.1 — 2023-02-15
- … 1 more at https://npm.io/package/rmb-sdk-ts/versions

## README

## RMB TS CLIENT
This is a `Typescript` client that can be used to build both **services**, and **clients**
that can talk over the `rmb`.

[RMB](https://github.com/threefoldtech/rmb-rs) is a message bus that enable secure
and reliable `RPC` calls across the globe.

This client can do the following: 
- send requests over the distrubed `rmb-relay`.
- receive and verify responses to sent requests.

An example of this client usage is defined under
[examples](examples/direct/node.ts).

### Built with 
- Typescript

### Getting Started

To get a local copy up and running following these simple steps: 
- Open Terminal
- Change the current working directory to the location you want the cloned directory.
- Enter the following:
``` 
git clone https://github.com/threefoldtech/rmb-sdk-ts.git
```
- Press Enter to create your local clone.

- Navigate to the cloned repository by running:

```
cd rmb-sdk-ts
```
- Then run the following to start the client:
```
yarn install
yarn start
```
### Prerequisites:
- Node.js
- Git
- Yarn

### Contributors

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/threefoldtech/rmb-sdk-ts/issues).

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