Skip to content

Latest commit

 

History

History
1225 lines (926 loc) · 28.7 KB

Conveyor.md

File metadata and controls

1225 lines (926 loc) · 28.7 KB
Raw

Conveyor

An api which handles various stemit rpc requests.
This api follows the json-rpc 2.0 specification. More information available at http://www.jsonrpc.org/specification.

Drafts

Drafts provide ability to store and resume editing posts.

Feature Flags

Feature flags allows our apps (condenser mainly) to hide certain features behind flags.
Flags can be set individually for users or probabilistically to roll out a feature incrementally, for example set_flag_probability orange_theme 0.5 will enable the flag for ~50% of our users. Changing the flag probability does not re-randomize the user selection so that a user that had their flag enabled at 0.5 will still have it enabled when going to 0.75. This is achieved by seeding a PRNG with the shasum of username+flag.
Flags set individually per user always takes precedence.

User Data

Conveyor is the central point for storing sensitive user data (email, phone, etc). No other services should store this data and should instead query for it here every time.

Tags

Tagging mechanism for other services, allows defining and assigning tags to accounts (or other identifiers) and querying for them.

Version 1.0

conveyor.list_drafts

List stored drafts for account.

Description

Authenticated: requires signature of account or an admin account.

Parameters

Name Type Description
params object
params.account string steem blockchain account

Result

Name Type Description
result array
result[#] object
result[#]?.title string
result[#]?.body string
result[#]?.uuid string

Examples

Request

{
  "jsonrpc": "2.0",
  "id": "1234567890",
  "method": "conveyor.list_drafts",
  "params": {
    "account": "steemit"
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": "1234567890",
  "result": [
    {
      "title": "example draft title",
      "body": "example draft body",
      "uuid": "dce998f6-b811-4181-a056-19886a6db7c6"
    }
  ]
}

conveyor.save_draft

Save draft for account.

Description

Authenticated: requires signature of account or an admin account.

Parameters

Name Type Description
params object
params.account string steem blockchain account
params.draft object
params.draft?.title string
params.draft?.body string

Result

Name Type Description
result object
result?.uuid string

Examples

Request

{
  "jsonrpc": "2.0",
  "id": "1234567890",
  "method": "conveyor.save_draft",
  "params": {
    "account": "steemit",
    "draft": {
      "title": "example draft title",
      "body": "example draft body"
    }
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": "1234567890",
  "result": {
    "uuid": "dce998f6-b811-4181-a056-19886a6db7c6"
  }
}

conveyor.remove_draft

Delete saved draft with uuid for account.

Description

Authenticated: requires signature of account or an admin account.

Parameters

Name Type Description
params object
params.account string steem blockchain account
params.uuid string

Result

Name Type Description
result object
result?.uuid string

Examples

Request

{
  "jsonrpc": "2.0",
  "id": "1234567890",
  "method": "conveyor.remove_draft",
  "params": {
    "account": "steemit",
    "uuid": "dce998f6-b811-4181-a056-19886a6db7c6"
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": "1234567890",
  "result": {
    "uuid": "dce998f6-b811-4181-a056-19886a6db7c6"
  }
}

conveyor.get_feature_flag

Get specific flag for the username account.

Description

Authenticated: requires signature of account or an admin account.

Parameters

Name Type Description
params object
params.account string steem blockchain account
params.flag string

Result

Name Type Description
result object

Examples

Request

{
  "jsonrpc": "2.0",
  "id": "1234567890",
  "method": "conveyor.get_feature_flag",
  "params": {
    "account": "steemit",
    "flag": "example-flag"
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": "1234567890",
  "result": {}
}

conveyor.set_feature_flag

Set a flag override for the username account.

Description

Authenticated: requires signature of account or an admin account.

Parameters

Name Type Description
params object
params.account string steem blockchain account
params.flag string
params.value

Result

Name Type Description
result object

Examples

Request

{
  "jsonrpc": "2.0",
  "id": "1234567890",
  "method": "conveyor.set_feature_flag",
  "params": {
    "account": "steemit",
    "flag": "example-flag"
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": "1234567890",
  "result": {}
}

conveyor.get_feature_flags

Get feature flags object for the username account

Description

Authenticated: requires signature of account or an admin account.

Parameters

Name Type Description
params object
params.account string steem blockchain account

Result

Name Type Description
result object

Examples

Request

{
  "jsonrpc": "2.0",
  "id": "1234567890",
  "method": "conveyor.get_feature_flags",
  "params": {
    "account": "steemit"
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": "1234567890",
  "result": {}
}

conveyor.set_feature_flag_probability

Set the probability expressed as a fraction 0.0 to 1.0 that a flag will resolve to true.

Description

Authenticated: requires signature of account or an admin account.

Parameters

Name Type Description
params object
params.flag string
params.probability number

Result

Name Type Description
result object

Examples

Request

{
  "jsonrpc": "2.0",
  "id": "1234567890",
  "method": "conveyor.set_feature_flag_probability",
  "params": {
    "flag": "example-flag",
    "probability": 0.5
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": "1234567890",
  "result": {}
}

conveyor.get_feature_flag_probabilities

Get all the set flag probabilities.

Description

Authenticated: requires signature of account or an admin account.

Parameters

Name Type Description
params object

Result

Name Type Description
result object

Examples

Request

{
  "jsonrpc": "2.0",
  "id": "1234567890",
  "method": "conveyor.get_feature_flag_probabilities",
  "params": {}
}

Response

{
  "jsonrpc": "2.0",
  "id": "1234567890",
  "result": {}
}

conveyor.get_user_data

Return user data for account, returns an error if the account is not found.

Description

Authenticated: requires signature of account or an admin account.

Parameters

Name Type Description
params object
params.account string steem blockchain account

Result

Name Type Description
result object
result?.email string
result?.phone string

Examples

Request

{
  "jsonrpc": "2.0",
  "id": "1234567890",
  "method": "conveyor.get_user_data",
  "params": {
    "account": "steemit"
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": "1234567890",
  "result": {
    "email": "steemit@steemit.com",
    "phone": "+10008675309"
  }
}

conveyor.set_user_data

Set user data for account.

Description

Authenticated: requires signature of account or an admin account.

Parameters

Name Type Description
params object
params.account string steem blockchain account
params.userData object
params.userData?.email string
params.userData?.phone string

Result

Name Type Description
result object

Examples

Request

{
  "jsonrpc": "2.0",
  "id": "1234567890",
  "method": "conveyor.set_user_data",
  "params": {
    "account": "steemit",
    "userData": {
      "email": "steemit@steemit.com",
      "phone": "+10008675309"
    }
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": "1234567890",
  "result": {}
}

conveyor.is_email_registered

Check if the email address is in the database.

Description

Authenticated: requires signature of account or an admin account.

Parameters

Name Type Description
params object
params.email string

Result

Name Type Description
result boolean

Examples

Request

{
  "jsonrpc": "2.0",
  "id": "1234567890",
  "method": "conveyor.is_email_registered",
  "params": {
    "email": "steemit@steemit.com"
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": "1234567890",
  "result": false
}

conveyor.is_phone_registered

Check if the phone number is in the database.

Description

Authenticated: requires signature of account or an admin account.

Parameters

Name Type Description
params object
params.phone string

Result

Name Type Description
result boolean

Examples

Request

{
  "jsonrpc": "2.0",
  "id": "1234567890",
  "method": "conveyor.is_phone_registered",
  "params": {
    "phone": "+10008675309"
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": "1234567890",
  "result": false
}

conveyor.define_tag

Description

Authenticated: requires signature of admin account.

Parameters

Name Type Description
params object
params.tag string
params.description string

Result

Name Type Description
result boolean

Examples

Request

{
  "jsonrpc": "2.0",
  "id": "1234567890",
  "method": "conveyor.define_tag",
  "params": {
    "tag": "example-tag",
    "description": "tag-string is an example tag"
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": "1234567890",
  "result": false
}

conveyor.list_tags

List all defined tags.

Description

Authenticated: requires signature of admin account.

Parameters

Name Type Description
params object

Result

Name Type Description
result array
result[#] string

Examples

Request

{
  "jsonrpc": "2.0",
  "id": "1234567890",
  "method": "conveyor.list_tags",
  "params": {}
}

Response

{
  "jsonrpc": "2.0",
  "id": "1234567890",
  "result": ["example-tag"]
}

conveyor.assign_tag

Assign tag to user, throws if tag is not defined.

Description

Authenticated: requires signature of admin account.

Parameters

Name Type Description
params object
params.uid string
params.tag string
params?.memo string

Result

Name Type Description
result array
result[#] string

Examples

Request

{
  "jsonrpc": "2.0",
  "id": "1234567890",
  "method": "conveyor.assign_tag",
  "params": {
    "uid": "1001",
    "tag": "example-tag",
    "memo": "this is a tag memo"
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": "1234567890",
  "result": [null]
}

conveyor.unassign_tag

Remove tag from user.

Description

Authenticated: requires signature of admin account.

Parameters

Name Type Description
params object
params.uid string
params.tag string

Result

Name Type Description
result object

Examples

Request

{
  "jsonrpc": "2.0",
  "id": "1234567890",
  "method": "conveyor.unassign_tag",
  "params": {
    "uid": "1001",
    "tag": "example-tag"
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": "1234567890",
  "result": {}
}

conveyor.get_users_by_tags

Get a list of users that has tags assigned.

Description

tags can be either a string or an array of strings in which case the user must have all the tags givento be included in the response. Authenticated: requires signature of an admin account.

Parameters

Name Type Description
params object
params.tags

Result

Name Type Description
result array
result[#] string

Examples

Request

{
  "jsonrpc": "2.0",
  "id": "1234567890",
  "method": "conveyor.get_users_by_tags",
  "params": {}
}

Response

{
  "jsonrpc": "2.0",
  "id": "1234567890",
  "result": ["1001"]
}

conveyor.get_tags_for_user

Get a list of tags assigned to uid.

Description

Authenticated: requires signature of an admin account.

Parameters

Name Type Description
params object
params.uid string
params.audit boolean

Result

Name Type Description
result array
result[#] string

Examples

Request

{
  "jsonrpc": "2.0",
  "id": "1234567890",
  "method": "conveyor.get_tags_for_user",
  "params": {
    "uid": "1001",
    "audit": false
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": "1234567890",
  "result": [null]
}

conveyor.get_account

Lookup a user by account name

Parameters

Name Type Description
params object
params.account string steem blockchain account
params?.context_account string the user performing the search

Result

Name Type Description
result object
result?.account string steem blockchain account
result?.vote_sp number SP minus delegated away plus delegated to
result?.joined_at string account creation date
result?.reputation number legacy rep score (centered at 25)
result?.context_account string steem blockchain account
result?.context_recent_sends integer last 30d number of xfers to this acct
result?.context_is_following boolean if context_account follows this user
result?.context_is_follower boolean if context_account follows this user
result?.context_is_muted boolean if context_account muted (ignored) this user
result?.tags array {abuse exchange verified none}
result?.tags[#] string
result?.value_sp string effective SP value of all held tokens
result?.follower_count integer follower count
result?.following_count integer following count

Examples

Request

{
  "jsonrpc": "2.0",
  "id": "1234567890",
  "method": "conveyor.get_account",
  "params": {
    "account": "steemit",
    "context_account": "steemit"
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": "1234567890",
  "result": {
    "account": "steemit",
    "vote_sp": 100.1,
    "joined_at": "2016-03-24T17:00",
    "reputation": 100,
    "context_account": "steemit",
    "context_recent_sends": 100,
    "context_is_following": false,
    "context_is_follower": false,
    "context_is_muted": false,
    "tags": ["none"],
    "value_sp": "1000.1",
    "follower_count": 100,
    "following_count": 100
  }
}

conveyor.autocomplete_account

Lookup users by account name prefix

Parameters

Name Type Description
params object
params.account_substring string
params?.context_account string the user performing the search

Result

Name Type Description
result object
result?.recent array recently referenced accounts
result?.recent[#] object
result?.recent[#]?.account string steem blockchain account
result?.recent[#]?.vote_sp number SP minus delegated away plus delegated to
result?.recent[#]?.joined_at string account creation date
result?.recent[#]?.reputation number legacy rep score (centered at 25)
result?.recent[#]?.context_account string steem blockchain account
result?.recent[#]?.context_recent_sends integer last 30d number of xfers to this acct
result?.recent[#]?.context_is_following boolean if context_account follows this user
result?.recent[#]?.context_is_follower boolean if context_account follows this user
result?.recent[#]?.context_is_muted boolean if context_account muted (ignored) this user
result?.recent[#]?.tags array {abuse exchange verified none}
result?.recent[#]?.tags[#] string
result?.recent[#]?.value_sp string effective SP value of all held tokens
result?.recent[#]?.follower_count integer follower count
result?.recent[#]?.following_count integer following count
result?.friend array friend accounts
result?.friend[#] object
result?.friend[#]?.account string steem blockchain account
result?.friend[#]?.vote_sp number SP minus delegated away plus delegated to
result?.friend[#]?.joined_at string account creation date
result?.friend[#]?.reputation number legacy rep score (centered at 25)
result?.friend[#]?.context_account string steem blockchain account
result?.friend[#]?.context_recent_sends integer last 30d number of xfers to this acct
result?.friend[#]?.context_is_following boolean if context_account follows this user
result?.friend[#]?.context_is_follower boolean if context_account follows this user
result?.friend[#]?.context_is_muted boolean if context_account muted (ignored) this user
result?.friend[#]?.tags array {abuse exchange verified none}
result?.friend[#]?.tags[#] string
result?.friend[#]?.value_sp string effective SP value of all held tokens
result?.friend[#]?.follower_count integer follower count
result?.friend[#]?.following_count integer following count
result?.global array all accounts
result?.global[#] object
result?.global[#]?.account string steem blockchain account
result?.global[#]?.vote_sp number SP minus delegated away plus delegated to
result?.global[#]?.joined_at string account creation date
result?.global[#]?.reputation number legacy rep score (centered at 25)
result?.global[#]?.context_account string steem blockchain account
result?.global[#]?.context_recent_sends integer last 30d number of xfers to this acct
result?.global[#]?.context_is_following boolean if context_account follows this user
result?.global[#]?.context_is_follower boolean if context_account follows this user
result?.global[#]?.context_is_muted boolean if context_account muted (ignored) this user
result?.global[#]?.tags array {abuse exchange verified none}
result?.global[#]?.tags[#] string
result?.global[#]?.value_sp string effective SP value of all held tokens
result?.global[#]?.follower_count integer follower count
result?.global[#]?.following_count integer following count

Examples

Request

{
  "jsonrpc": "2.0",
  "id": "1234567890",
  "method": "conveyor.autocomplete_account",
  "params": {
    "account_substring": "ste",
    "context_account": "steemit"
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": "1234567890",
  "result": {
    "recent": [
      {
        "account": "steemit",
        "vote_sp": 100.1,
        "joined_at": "2016-03-24T17:00",
        "reputation": 100,
        "context_account": "steemit",
        "context_recent_sends": 100,
        "context_is_following": false,
        "context_is_follower": false,
        "context_is_muted": false,
        "tags": ["none"],
        "value_sp": "1000.1",
        "follower_count": 100,
        "following_count": 100
      }
    ],
    "friend": [
      {
        "account": "steemit",
        "vote_sp": 100.1,
        "joined_at": "2016-03-24T17:00",
        "reputation": 100,
        "context_account": "steemit",
        "context_recent_sends": 100,
        "context_is_following": false,
        "context_is_follower": false,
        "context_is_muted": false,
        "tags": ["none"],
        "value_sp": "1000.1",
        "follower_count": 100,
        "following_count": 100
      }
    ],
    "global": [
      {
        "account": "steemit",
        "vote_sp": 100.1,
        "joined_at": "2016-03-24T17:00",
        "reputation": 100,
        "context_account": "steemit",
        "context_recent_sends": 100,
        "context_is_following": false,
        "context_is_follower": false,
        "context_is_muted": false,
        "tags": ["none"],
        "value_sp": "1000.1",
        "follower_count": 100,
        "following_count": 100
      }
    ]
  }
}

conveyor.get_prices

Description

Find the exchange rates of various tokens based on internal markets.

Result

Name Type Description
result object
result?.steem_sbd number
result?.steem_usd number
result?.steem_vest number

Examples

Request

{
  "jsonrpc": "2.0",
  "id": "1234567890",
  "method": "conveyor.get_prices"
}

Response

{
  "jsonrpc": "2.0",
  "id": "1234567890",
  "result": {
    "steem_sbd": 0.8221426365,
    "steem_usd": 0.827,
    "steem_vest": 2019.1003284361
  }
}