services

README

Sockety Services

Sockety offers various centralized services that allow subscribing to feeds of information over websocket. Below are the current list of services available:

Odysee API Service

With your auth_token as the id you can subscribe to different events specific to your user. Specifically, there are two messages that can currently come:

User Subscription

ID:<auth_token>

The auth token for a user. This will subscribe to events related to a specific user.

pending_notification

This does not send any data, but instead is a notice that there are new notifications and you should get an updated list of notifications via /notifications/list API.

swap-status

This message provides an update on a current swap status. When there is a delta in the status of the swap, the relevant data is sent over the subscription.

Commentron Service

The Commentron service provides valuable information from the commenting system of Odysee.

Claim Subscription

ID:<claim_id>

The ClaimID of a specific piece of content. This will subscribe to commentron events around a specific claim's comments via claim_id as the idof the subscription.

delta

This message will be sent every time a new comment is created on this claim. It will include the comment item as defined in the commentron APIs.

pinned

When a comment is pinnned by a creator the comment item as defined in the commentron APIs will be sent to the subscriber.

reaction

When a reaction is made to a comment on the content, this message with the comment_id, reaction_type, and commenter_channel_id are sent in a message.

Comment Subscription

ID:<comment_id>

pinned

When this comment is pinnned by a creator the comment item as defined in the commentron APIs will be sent to the subscriber.

reaction

When a reaction is made to this comment on the content, this message with the comment_id, reaction_type, and commenter_channel_id are sent to the subscriber.

BlockChain Service

The blockchain service allows people to subscribe to various block chain events via different subscriptions.

Blocks Subscription

ID:blocks

The block subscription provides block information continuously as blocks are confirmed on the blockchain

new_block

The result of this message is the json representation of a block from LBRYcrd. This message will come each time a new block is processed and confirmed.

Height Subscription

ID:<height>

The height subscription will subscribe to a future height not yet reached. Once its reached you will the message.

new_block

Same message as listed under Blocks Subscription.

Claims Subscription

ID:claims

support

The support message contains information about a support like, claimID, transaction hash, vout, and amount

claim_update

the claim update message will be sent whenever a claim is updated on the blockchain when subscribed. It contains information about the metadata of a claim. The claim messages contain information about the metadata of a claim.

new_claim

Claim Name Subscription

ID:<claim_name>

This subscription will allow to monitor a specific claim name and get information when any claims are created, updated and/or supported with this name.

support

The support message contains information about a support like, claimID, transaction hash, vout, and amount

claim_update

It will be sent whenever the claim name has an update for any claim ids claiming that name.

new_claim

It will be sent whenever someone tries to claim the same name subscribed to.

Claim ID Subscription

ID:<claim_id>

This subscription allows you to follow and subscribe to a specific claim id and updates when its supported of changed.

support

The support message contains information about a support like, claimID, transaction hash, vout, and amount. It will be sent whenever this claim is supported.

claim_update

It will be sent whenever this particular is updated on the blockchain.

Channel Claim ID Subscription

ID:<claim_id>

This subscription allows you to follow and subscribe to a specific channel.

new_claim

It will be sent whenever a new claim is published under this channel.

Claim Updates Subscription

ID:claimupdates

This subscription is for deltas to claims in the claim trie. So any time a claim is updated on the block the claim message will be sent out.

claim_update

This message will be sent any time claims are updated regardless of their names.

Transactions Subscription

ID: transactions

This subscription monitors all transactions from the blockchain. As they come in you will get a message for them.

new_tx

This message contains the default JSON representation of a raw transaction from lbrycrd.

Transaction ID Subscription

ID: <tx_id>

This subscription allows you to watch a future transaction id for confirmation. When its confirmed you will get the message.

new_tx

This message contains the default JSON representation of a raw transaction from lbrycrd.

Payments Subscription

ID:payments

This subscribes to every time LBC is sent to an address. All the payments

payments

This message provides information about a payment including the address, txid, vout and LBC amount of the payment.

Payment Address Subscription

ID:<address>

This subscriptions allows monitoring of payments to a specific address and when funds are sent on the block chain the message is sent.

payments

This message provides information about a payment including the address, txid, vout and LBC amount of the payment.

Documentation

Index

• func Blockchain() http.Handler
• func Commentron() http.Handler
• func InternalAPIs() http.Handler

Functions

func Blockchain

func Blockchain() http.Handler

Blockchain Handler for the blockchain websocket connections

func Commentron

func Commentron() http.Handler

Commentron Handler for the commentron apps websocket connections

func InternalAPIs

func InternalAPIs() http.Handler

InternalAPIs Handler for the internal-apis websocket connections