Numerous Pulsating Martians
    Have ideas to improve npm?Join in the discussion! »

    @steemit/steem-js

    0.7.11 • Public • Published

    GitHub license Steem.js channel on steemit.chat

    Steem.js

    Steem.js the JavaScript API for Steem blockchain

    Documentation

    Here is full documentation: https://github.com/steemit/steem-js/tree/master/doc

    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/steem/dist/steem.min.js

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

    Webpack

    Please have a look at the webpack usage example.

    Server

    Install

    $ npm install steem --save
    

    RPC Servers

    https://api.steemit.com By Default
    https://node.steem.ws
    https://this.piston.rocks

    Examples

    Broadcast Vote

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

    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 or on Steemit Chat channel #steemjs https://steemit.chat/channel/steemjs.

    Issues

    When you find issues, please report them!

    License

    MIT

    Install

    npm i @steemit/steem-js

    DownloadsWeekly Downloads

    26

    Version

    0.7.11

    License

    MIT

    Unpacked Size

    17.5 MB

    Total Files

    83

    Last publish

    Collaborators

    • avatar
    • avatar