Steem.js

Steem.js the JavaScript API for Steem blockchain

Documentation

📖 Full documentation: https://blazeapps007.github.io/steem-js/

The site covers 100% of the library. The API and Broadcast references are generated from the library source, so they always list every method in the installed version.

• Guide — install, configuration, broadcasting, streaming, auth, memo, formatter, utils
• API reference (steem.api)
• Broadcast reference (steem.broadcast)

Docs sources live in /docs; regenerate the reference with npm run docs:generate.

Browser

<script src="./steem.min.js"></script>
<script>
steem.api.getAccounts(['ned', 'dan'], function(err, response){
    console.log(err, response);
});
</script>

CDN

https://cdn.jsdelivr.net/npm/@blazeapps/steem/dist/steem.min.js

<script src="https://cdn.jsdelivr.net/npm/@blazeapps/steem/dist/steem.min.js"></script>

Webpack

Please have a look at the webpack usage example.

Server

Install

$ npm install @blazeapps/steem --save

RPC Servers

https://api.steemit.com By Default

Examples

Broadcast Vote

var steem = require('@blazeapps/steem');

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

Broadcast Vote with Promises

var steem = require('@blazeapps/steem');

var wif = steem.auth.toWif(username, password, 'posting');
// Using Promises
steem.broadcast.vote(wif, voter, author, permlink, weight)
  .then(result => console.log(result))
  .catch(error => console.error(error));

// Or using async/await
async function castVote() {
  try {
    const result = await steem.broadcast.vote(wif, voter, author, permlink, weight);
    console.log(result);
  } catch (error) {
    console.error(error);
  }
}

Get Accounts

steem.api.getAccounts(['ned', 'dan'], function(err, result) {
	console.log(err, result);
});

Get State

steem.api.getState('/trends/funny', function(err, result) {
	console.log(err, result);
});

Reputation Formatter

var reputation = steem.formatter.reputation(user.reputation);
console.log(reputation);

Steem Testnet

Steem-js requires some configuration to work on the public Steem testnet.

You need to set two Steem API options, address_prefix and chain_id.

steem.api.setOptions({
  address_prefix: 'TST',
  chain_id: '46d82ab7d8db682eb1959aed0ada039a6d49afa1602491f93dde9cac3e8e6c32',
  useTestNet: true,
});

The Chain ID could change. If it does, it may not be reflected here, but will be documented on any testnet launch announcements.

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. If you would like to contribute, but don't know what to work on, check the issues list.

Issues

When you find issues, please report them!

License

MIT