# @blurtfoundation/blurtjs

> Blurt.js the JavaScript API for Blurt blockchain

Latest version **1.0.0** (published 2021-12-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install @blurtfoundation/blurtjs
pnpm add @blurtfoundation/blurtjs
yarn add @blurtfoundation/blurtjs
bun add @blurtfoundation/blurtjs
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; large bundle.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2021-12-28 |
| First published | 2020-06-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 18 |
| Unpacked size | 17.9 MB |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| Author | Loki |
| Maintainers | megadrive8, saboin, jacobgadikian, baabeetaa |
| Keywords | blurt, blockchain, blurtjs |

## Links

- npm: https://www.npmjs.com/package/@blurtfoundation/blurtjs
- Repository: https://gitlab.com/blurt/blurt
- Homepage: https://gitlab.com/blurt/blurt/-/tree/dev/client-libs/blurtjs
- Issues: https://gitlab.com/blurt/blurt/-/issues
- npm.io page: https://npm.io/package/@blurtfoundation/blurtjs

## Dependencies (18)

- [ws](https://npm.io/package/ws.md) ^3.3.2
- [bigi](https://npm.io/package/bigi.md) ^1.4.2
- [bs58](https://npm.io/package/bs58.md) ^4.0.0
- [debug](https://npm.io/package/debug.md) ^2.6.8
- [retry](https://npm.io/package/retry.md) ^0.12.0
- [buffer](https://npm.io/package/buffer.md) ^5.0.6
- [ecurve](https://npm.io/package/ecurve.md) ^1.0.5
- [lodash](https://npm.io/package/lodash.md) ^4.16.4
- [bluebird](https://npm.io/package/bluebird.md) ^3.5.5
- [cross-env](https://npm.io/package/cross-env.md) ^5.0.0
- [bytebuffer](https://npm.io/package/bytebuffer.md) ^5.0.1
- [create-hash](https://npm.io/package/create-hash.md) ^1.1.2
- [create-hmac](https://npm.io/package/create-hmac.md) ^1.1.4
- [cross-fetch](https://npm.io/package/cross-fetch.md) ^1.1.1
- [detect-node](https://npm.io/package/detect-node.md) ^2.0.3
- [secure-random](https://npm.io/package/secure-random.md) ^1.1.2
- [browserify-aes](https://npm.io/package/browserify-aes.md) ^1.0.6
- [@steemit/rpc-auth](https://npm.io/package/@steemit/rpc-auth.md) ^1.1.1

## Recent versions

- 1.0.0 (latest) — 2021-12-28
- 0.1.3 — 2021-10-13
- 0.1.2 — 2021-03-02
- 0.1.1 — 2020-07-05
- 0.1.0 — 2020-06-22

## README

[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://gitlab.com/blurt/blurt/-/blob/dev/client-libs/blurtjs/LICENSE)

# Blurt.js

Blurt.js the Official JavaScript API for Blurt blockchain

# Documentation

-   [Install](https://gitlab.com/blurt/blurt/-/tree/dev/client-libs/blurtjs/doc#install)
-   [Browser](https://gitlab.com/blurt/blurt/-/tree/dev/client-libs/blurtjs/doc#browser)
-   [Config](https://gitlab.com/blurt/blurt/-/tree/dev/client-libs/blurtjs/doc#config)
-   [Database API](https://gitlab.com/blurt/blurt/-/tree/dev/client-libs/blurtjs/doc#api)
    -   [Subscriptions](https://gitlab.com/blurt/blurt/-/tree/dev/client-libs/blurtjs/doc#subscriptions)
    -   [Tags](https://gitlab.com/blurt/blurt/-/tree/dev/client-libs/blurtjs/doc#tags)
    -   [Blocks and transactions](https://gitlab.com/blurt/blurt/-/tree/dev/client-libs/blurtjs/doc#blocks-and-transactions)
    -   [Globals](https://gitlab.com/blurt/blurt/-/tree/dev/client-libs/blurtjs/doc#globals)
    -   [Keys](https://gitlab.com/blurt/blurt/-/tree/dev/client-libs/blurtjs/doc#keys)
    -   [Accounts](https://gitlab.com/blurt/blurt/-/tree/dev/client-libs/blurtjs/doc#accounts)
    -   [Authority / validation](https://gitlab.com/blurt/blurt/-/tree/dev/client-libs/blurtjs/doc#authority--validation)
    -   [Votes](https://gitlab.com/blurt/blurt/-/tree/dev/client-libs/blurtjs/doc#votes)
    -   [Content](https://gitlab.com/blurt/blurt/-/tree/dev/client-libs/blurtjs/doc#content)
    -   [Witnesses](https://gitlab.com/blurt/blurt/-/tree/dev/client-libs/blurtjs/doc#witnesses)
-   [Login API](https://gitlab.com/blurt/blurt/-/tree/dev/client-libs/blurtjs/doc#login)
-   [Follow API](https://gitlab.com/blurt/blurt/-/tree/dev/client-libs/blurtjs/doc#follow-api)
-   [Broadcast API](https://gitlab.com/blurt/blurt/-/tree/dev/client-libs/blurtjs/doc#broadcast-api)
-   [Broadcast](https://gitlab.com/blurt/blurt/-/tree/dev/client-libs/blurtjs/doc#broadcast)
-   [Auth](https://gitlab.com/blurt/blurt/-/tree/dev/client-libs/blurtjs/doc#auth)

Here is full documentation:
https://gitlab.com/blurt/blurt/-/tree/dev/client-libs/blurtjs/doc

## Browser

```html
<script src="./blurt.min.js"></script>
<script>
    blurt.api.getAccounts(
        ["baabeetaa", "jacobgadikian"],
        function (err, response) {
            console.log(err, response);
        }
    );
</script>
```

## CDN

https://cdn.jsdelivr.net/npm/@blurtfoundation/blurtjs/dist/blurt.min.js<br/>

```html
<script src="https://cdn.jsdelivr.net/npm/@blurtfoundation/blurtjs/dist/blurt.min.js"></script>
```

## Webpack

[Please have a look at the webpack usage example.](https://gitlab.com/blurt/blurt/-/tree/dev/client-libs/blurtjs/examples/webpack-example)

## Server

## Install

```
$ npm install @blurtfoundation/blurtjs --save
```

## RPC Servers

https://rpc.blurt.world By Default<br/>
<sub>[List of Blurt nodes](https://ecosynthesizer.com/blurt/nodes)</sub><br/>

## Examples

### Broadcast Vote

```js
var blurt = require("@blurtfoundation/blurtjs");

var wif = blurt.auth.toWif(username, password, "posting");
blurt.broadcast.vote(
    wif,
    voter,
    author,
    permlink,
    weight,
    function (err, result) {
        console.log(err, result);
    }
);
```

### Get Accounts

```js
blurt.api.getAccounts(["megadrive", "jacobgadikian"], function (err, result) {
    console.log(err, result);
});
```

### Get State

```js
blurt.api.getState("/trends/funny", function (err, result) {
    console.log(err, result);
});
```

## Contributions

Patches are welcome! Contributors are listed in the package.json file. Please run the tests before opening a pull request and make sure that you are passing all of them.

## Issues

When you find issues, please report them!

## License

MIT

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