Coder Social home page Coder Social logo

Websocket API about samourai-dojo HOT 2 CLOSED

samourai-wallet avatar samourai-wallet commented on July 17, 2024
Websocket API

from samourai-dojo.

Comments (2)

LaurentMT avatar LaurentMT commented on July 17, 2024 1

Indeed, Dojo provides a websocket API allowing clients to subscribe to two types of notifications:

  • notifications of new blocks,
  • notifications of new transactions related to a given address or xpub.

AFAIK, this API isn't documented but here are a few elements:

  • access to this API is authenticated. It means that you first need to authenticate to your Dojo (see this doc) in order to receive an access token and a refresh token.
  • subscription to notifications is done by sending a request to the url <onion_address>/v2/inv with a websocket client.

Data sent for a subscription request are structured as a JSON encoded in UTF-8:

// JSON for a subscription to notifications of new blocks
{
  "op":"block_sub",
  "at":"<your_access_token>"
}

// JSON for a subscription to notifications of new transactions
{
  "op":"addr_sub",
  "addr": "<address_or_xpub>",
  "at":"<your_access_token>"
}

from samourai-dojo.

waterdrop01 avatar waterdrop01 commented on July 17, 2024

Thanks @LaurentMT, I will try and close the issue if it's working for me!

from samourai-dojo.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.