steemconnect.js

KO | EN

gitlite — search

#android #php #kotlin #python #docker #hacktoberfest #ruby #java #proxy #testing #bot #telegram

steemconnect.js

★ 66 Open GitHub ↗

SteemConnect JavaScript SDK

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![npm](https://img.shields.io/npm/v/steemconnect.svg)](https://www.npmjs.com/package/steemconnect)
![npm](https://img.shields.io/npm/dm/steemconnect.svg)
![CircleCI](https://img.shields.io/circleci/project/github/bonustrack/steemconnect.js.svg)
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/bonustrack/steemconnect.js/master/LICENSE)

# SteemConnect.js

The official SteemConnect JavaScript SDK.

## Getting started

To install and run SteemConnect.js, follow this quick start guide

### Install

SteemConnect.js was designed to work both in the browser and in Node.js.

#### Node.js
To install SteemConnect.js on Node.js, open your terminal and run:
```
npm i steemconnect --save
```

#### Browser

You can create an index.html file and include SteemConnect.js with:

```html
<script src="https://cdn.jsdelivr.net/npm/steemconnect"></script>
```

### Usage

For general information about SteemConnect and setting up your app you can checkout the developer documentation.

**[Developers documentation](https://beta.steemconnect.com/developers)**

## SDK methods

### Init client
Call the Client() method when your app first loads to init the SDK:
```
var steemconnect = require('steemconnect');

var client = new steemconnect.Client({
  app: 'staging.app',
  callbackURL: 'https://demo.steemconnect.com',
  scope: ['vote', 'comment']
});
```
Parameters:
- __app__: This is the name of the app that was registered in the SteemConnect V2 dashboard
- __callbackURL__: This is the URL that users will be redirected to after interacting with SteemConnect. It must be listed in the "Redirect URI(s)" list in the app settings EXACTLY the same as it is specified here
- __accessToken__: If you have an oauth2 access token for this user already you can specify it here, otherwise you can leave it and set it later using steemconnect.setAccessToken(accessToken).
- __scope__: This is a list of operations the app will be able to access on the user's account. For a complete list of scopes see: [https://github.com/bonustrack/steemconnect/wiki/OAuth-2#scopes](https://github.com/bonustrack/steemconnect/wiki/OAuth-2#scopes)

### Universal log in

This method trigger SteemConnect Chrome extension or Steem Keychain for log in, if user don't have Chrome extension enabled it will fallback to SteemConnect website.

```
var params = {};

// The "username" parameter is required prior to log in for "Steem Keychain" users.
if (steemconnect.useSteemKeychain) {
  params = { username: 'fabien' };
}

client.login(params, function(err, token) {
  console.log(err, token)
});
```

### Get login URL for OAuth 2
The following method returns a URL that you can redirect the user to so that they may log in to your app through SteemConnect:
```
var link = client.getLoginURL(state);
// => https://steemconnect.com/oauth2/authorize?client_id=[app]&redirect_uri=[callbackURL]&scope=vote,comment&state=[state]
```
Parameters:
- __state__: Data that will be passed to the callbackURL for your app after the user has logged in.

After logging in, SteemConnect will redirect the user to the "redirect_uri" specified in the login url above and add the following query string parameters for your app to use:
- __access_token__: This is the oauth2 access token that is required to make any Steem API calls on behalf of the current user. Once you have this you need to tell the SteemConnect.js to use it by either specifying it as a parameter to the init() method call or by calling sc2.setAccessToken([accessToken]).
- __expires_in__: The number of seconds until the access token expires.
- __username__: The username of the current user.

### Get user profile
Once a user is logged in to your app you can call the following method to get the details of their account:
```
client.me(function (err, res) {
  console.log(err, res)
});
```
If it is successful, the result will be a JSON object with the following properties:
```
{
  account: { id: 338059, name: "yabapmatt", ...},
  name: "yabapmatt",
  scope: ["vote"],
  user: "yabapmatt",
  _id: "yabapmatt"
}
```

### Logout
The revokeToken() method will log the current user out of your application by revoking the access token provided to your app for that user: 
```
client.revokeToken(function (err, res) {
  console.log(err, res)
});
```

### Vote
The vote() method will cast a vote on the specified post or comment from the current user:
```
client.vote(voter, author, permlink, weight, function (err, res) {
  console.log(err, res)
});
```
Parameters:
- __voter__: The Steem username of the current user.
- __author__: The Steem username of the author of the post or comment.
- __permlink__: The link to the post or comment on which to vote. This is the portion of the URL after the last "/". For example the "permlink" for this post: https://steemit.com/steem/@ned/announcing-smart-media-tokens-smts would be "announcing-smart-media-tokens-smts".
- __weight__: The weight of the vote. 10000 equale a 100% vote.
- __callback__: A function that is called once the vote is submitted and included in a block. If successful the "res" variable will be a JSON object containing the details of the block and the vote operation.

### Comment
The comment() method will post a comment on an existing post or comment from the current user:
```
client.comment(parentAuthor, parentPermlink, author, permlink, title, body, jsonMetadata, function (err, res) {
  console.log(err, res)
});
```
The comment() method is rate limited to 5 minutes per root comment (post), and 20 seconds per non-root comment (reply).

### Delete comment
The deleteComment() method will mark a comment as deleted.
```
client.deleteComment(author, permlink, function (err, res) {
  console.log(err, res)
})
```

### Custom json
```
client.customJson(requiredAuths, requiredPostingAuths, id, json, function (err, res) {
  console.log(err, res)
});
```

### Reblog
```
client.reblog(account, author, permlink, function (err, res) {
  console.log(err, res)
});
```

### Follow
```
client.follow(follower, following, function (err, res) {
  console.log(err, res)
});
```

### Unfollow
```
client.unfollow(unfollower, unfollowing, function (err, res) {
  console.log(err, res)
});
```

### Ignore
```
client.ignore(follower, following, function (err, res) {
  console.log(err, res)
});
```

### Claim reward balance
```
client.claimRewardBalance(account, rewardSteem, rewardSbd, rewardVests, function (err, res) {
  console.log(err, res)
});
```

## Send operation

### Transfer

```
const op = ['transfer', {
  from: '__signer',
  to: 'fabien',
  amount: '0.001 STEEM'
}];
steemconnect.sendOperation(op, {}, function(err, result) {
  console.log(err, result);
});
```

steemconnect.js

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README