Code Monkey home page Code Monkey logo

conduit's Introduction

Conduit Conduit - 0x Relayer API

CircleCI code style: prettier

Overview

[Work in progress, PR/Contributions welcome! Testing on Kovan test network]

ZeroEx Open Source Relayer using the Open Orderbook strategy.

Follows ZeroEx Standard Relayer API V0 Draft specification.

Getting started

Local dev setup

To start the local dev server:

yarn install
yarn start

The server is hosted at http://localhost:3000

To make sure it is working, make a GET request to http://localhost:3000/api/v0/token_pairs

Architecture

                              ┌──────────────┐                       
                              │              │                       
                              │    Client    │                       
                              │              │                       
                              └──────────────┘                       
                                    ▲  ▲                             
                            ┌───────┘  └───────┐                     
                            │                  ▼                     
                     ┌─────────────┐    ┌─────────────┐              
                     │             │    │             │              
                     │  WebSocket  │    │  HTTP API   │              
                     │             │    │             │              
                     └─────────────┘    └─────────────┘              
                            ▲                  ▲                     
                            │ emits            │                     
                            └─events┐   ┌──────┘                     
                                    │   │                            
                                    │   ▼                            
    ┌──────────────────┐      ┌──────────────┐       ┌──────────────┐
    │  Relevant event  │      │              │       │◦◦◦◦◦◦◦◦◦◦◦◦◦◦│
    │     streams      │─────▶│  App Engine  │◀─────▶│◦◦◦◦0x.js◦◦◦◦◦│
    │ (includes 0x.js) │      │              │       │◦◦◦◦◦◦◦◦◦◦◦◦◦◦│
    └──────────────────┘      └──────────────┘       └──────────────┘
                                      ▲                              
                                      │                              
                                      ▼                              
                              ┌──────────────┐                       
                              │              │                       
                              │  Orderbook   │                       
                              │              │                       
                              └──────────────┘                       
                                      ▲                              
                                      │                              
                                      ▼                              
                              ┌──────────────┐                       
                              │              │                       
                              │  Data store  │                       
                              │              │                       
                              └──────────────┘                       

Roadmap

I'll be adding support for Matching as soon as this proposal is implemented. I personally think the matching strategy will lead to a better UX (atomic, no race conditions, faster relay feedback), but currently requires large upfront capital. Matching engine will use sorted sets on top of red-black trees and will be configured as a separate strategy.

conduit's People

Contributors

johnrjj avatar

Watchers

 avatar  avatar

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.