Giter VIP home page Giter VIP logo

bitmessage-node's Introduction

Archived

This project is now archived. Please feel free to fork it if needed.

bitmessage-node

NPM

Bitmessage client for the API written in Node.js.

Install

npm install bitmessage-node

Usage

//establish connection to Bitmessage server
var bm = require('bitmessage-node')(host, port, username, password);

//get inbox list
bm.messages.inbox.list(cb); //returns list of messages

//get message by id
bm.messages.inbox.single(id, cb, read);

//send message
bm.messages.send(toAddress, fromAddress, subject, message, cb);

//get sent messages
bm.messages.sent.list(cb);

//get sent message by id
bm.messages.sent.single(id, cb);

//get sent message by ack
bm.messages.sent.singleByAck(ack, cb);

//move message to trash by id
bm.messages.inbox.moveToTrash(id, cb);

//move message to trash by ack
bm.messages.sent.moveToTrashByAck(ack, cb);

//list identities
bm.addresses.list(cb); //returns identities

//create random address
bm.addresses.createRandom(label, cb); //returns address id

//create deterministic address
bm.addresses.createDeterministic(passphrase, cb); //returns address id

//list subscriptions
bm.subscriptions.list(cb); //returns subscriptions

//subscribe
bm.subscriptions.subscribe(address, label, cb); //returns string with status

//unsubscribe
bm.subscriptions.unsubscribe(address, cb); //returns string with status

//list contacts
bm.addressbook.list(cb); //returns contacts

//add contact
bm.addressbook.addEntry(address, label, cb);

//delete contact
bm.addressbook.deleteEntry(address, cb);

Requirements

A Bitmessage server running on a local machine. Download from Bitmessage.org

If you plan on connecting to a remote Bitmessage server, you should absolutely use SSH tunneling to establish a secure connection and connect via a local port.

ssh -N -L 8442:localhost:8442 <remote-bitmessage-server-hostname>

More info

The MIT License (MIT)

bitmessage-node's People

Contributors

anthonyettinger avatar chovy avatar ralyodio avatar rexmorgan avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

bitmessage-node's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.