Write to a burn-stream
JavaScript
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
.gitignore
.travis.yml
README.md
app-config.json
index.js
package.json

README.md

Burn-stream-writer lets you write to a burn-stream.

Build Status npm

Burn-stream-writer writes to a burn-stream by connecting to a Bitcoin client over RPC.

Usage

  1. Set up a Bitcoin client with RPC enabled.
  2. Get a burn-stream JSON app config file (see burn-stream for more info).
  3. Make a JSON file that matches the configuration of your Bitcoin client. Take care not to accidentally share the password for your Bitcoin client! An example:
{
    "host": "localhost",
    "port": "18332",
    "user": "user",
    "pass": "real secure"
}

To write from the command line, run bin/write.js. It will ask for confirmation before writing. An example command:

node bin/write.js --amount 100000 --message sup

About the args:

  • --clientConfig defaults to client-config.json
  • --appConfig defaults to app-config.json
  • You can set --fee to specify a fee
  • You can set --changeAddress to specify a change address
  • You can set --amount min to send the minimum allowed amount

To write from Javascript code, you can require burn-stream-writer (see bin/write.js for an example).