Giter Club home page Giter Club logo

ouroboros-network-js's Introduction

@stricahq/ouroboros-network-js

Ouroboros network library written in typescript with nodejs streaming module. This library has been developed with extensive testing and research done by communicating with Haskell Cardano Node with edge cases and scenarios. Supports multiplexing and streaming for seamless communication between clients. Simple yet sophisticated project structure and modular design of multiplexer and de-multiplexer to support all ouroboros mini protocols without hassle.

✅ Supports communication over unix socket and TCP ✅ Built using nodejs Stream for efficient communication ✅ Stable multiplexer and de-multiplexer ✅ Modular and scalable design

Currently Implemented Mini Protocols

  • Local Chain Sync
  • Local Transaction Submission
  • Local Tx Monitor

Please note that this is only a networking library and is polymorphic in nature. Use cbors and Cardano Codec for decoding and parsing the Cardano data objects returned by the mini protocols.

Please create an issue if you want to add support for another mini protocol

Used By

Installation

yarn/npm

yarn add @stricahq/ouroboros-network-js

Tests

TODO

Examples

TODO

API Doc

Find the API documentation here

License

Copyright 2023 Strica

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

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.