dworthjs/README.md

Wortheum blockchain RPC client library

# [dworth](https://github.com/wortheumio/dworth) 

Robust [wortheum blockchain](https://wortheum.io) client library that runs in both node.js and the browser.

* [Documentation](https://github.com/wortheumio/dworth/docs)
* [Bug tracker](https://github.com/wortheumio/dworth/issues)

---

**note** As of version 0.7.0 WebSocket support has been removed. The only transport provided now is HTTP(2). For most users the only change required is to swap `wss://` to `https://` in the address. If you run your own full node make sure to set the proper [CORS headers](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing) if you plan to access it from a browser.

---



Installation
------------

### Via npm

For node.js or the browser with [browserify](https://github.com/substack/node-browserify) or [webpack](https://github.com/webpack/webpack).

```
npm install @wortheumio/dworth
```

### From cdn or self-hosted script

Grab `dist/dworth.js` from a [release](https://github.com/wortheumio/dworth/) and include in your html:

```html
<script src="dworth.js"></script>
```

Or from the [unpkg](https://unpkg.com) cdn:

```html
<script src="https://unpkg.com/dworth@^0.8.0/dist/dworth.js"></script>
```

Make sure to set the version you want when including from the cdn, you can also use `dworth@latest` but that is not always desirable. See [unpkg.com](https://unpkg.com) for more information.


Usage
-----

### In the browser

```html
<script src="https://unpkg.com/dworth@latest/dist/dworth.js"></script>
<script>
    var client = new dworth.Client('https://api.wortheum.news')
    client.database.getDiscussions('trending', {tag: 'writing', limit: 1}).then(function(discussions){
        document.body.innerHTML += '<h1>' + discussions[0].title + '</h1>'
        document.body.innerHTML += '<h2>by ' + discussions[0].author + '</h2>'
        document.body.innerHTML += '<pre style="white-space: pre-wrap">' + discussions[0].body + '</pre>'
    })
</script>
```

See the [demo source](https://github.com/wortheumio/dworth/tree/master/examples/comment-feed) for an example on how to setup a livereloading TypeScript pipeline with wintersmith and [browserify](https://github.com/substack/node-browserify).

### In node.js

With TypeScript:

```typescript
import {Client} from 'dworth'

const client = new Client('https://api.wortheum.news')

for await (const block of client.blockchain.getBlocks()) {
    console.log(`New block, id: ${ block.block_id }`)
}
```

With JavaScript:

```javascript
var dworth = require('dworth')

var client = new Client('https://api.wortheum.news')
var key = dworth.PrivateKey.fromLogin('username', 'password', 'posting')

client.broadcast.comment({
    voter: 'username',
    author: 'almost-digital',
    permlink: 'dworth-is-the-best',
    weight: 10000
}, key).then(function(result){
   console.log('Included in block: ' + result.block_num)
}, function(error) {
   console.error(error)
})
```

With ES2016 (node.js 7+):

```javascript
const {Client} = require('dworth')

const client = new Client('https://api.wortheum.news')

async function main() {
    const props = await client.database.getChainProperties()
    console.log(`Maximum blocksize consensus: ${ props.maximum_block_size } bytes`)
    client.disconnect()
}

main().catch(console.error)
```

With node.js streams:

```javascript
var dworth = require('dworth')
var es = require('event-stream') // npm install event-stream
var util = require('util')

var client = new dworth.Client('https://api.wortheum.news')

var stream = client.blockchain.getBlockStream()

stream.pipe(es.map(function(block, callback) {
    callback(null, util.inspect(block, {colors: true, depth: null}) + '\n')
})).pipe(process.stdout)
```


Bundling
--------

The easiest way to bundle dworth (with browserify, webpack etc.) is to just `npm install dworth` and `require('dworth')` which will give you well-tested (see browser compatibility matrix above) pre-bundled code guaranteed to JustWork™. However, that is not always desirable since it will not allow your bundler to de-duplicate any shared dependencies dworth and your app might have.

To allow for deduplication you can `require('dworth/lib/index-browser')`, or if you plan to provide your own polyfills: `require('dworth/lib/index')`. See `src/index-browser.ts` for a list of polyfills expected.

---

*Share and Enjoy!*