Git Product home page Git Product logo

gitcoin's People

Watchers

James Cloos avatar

gitcoin's Issues

Create JavaScript library/SDK that wraps the Kchannels API

We are looking for help (from an experienced JavaScript dev) with a standalone JS library/SDK that wraps the Kchannels API. We have working JS code that already contains a lot of the requested functionality to help you with this effort.

The API is located at https://docs.kchannels.io/docs/api (all of the subsections of the API docs should be part of the library).

The API is mostly JSON-RPC-based, although some parts of it are REST-style. There are also 2 WebSocket endpoints.

IMPORTANT: The library must perform all the client-side validation (checking hashes, detecting channel inconsistencies) to protect the client whenever required (e.g. when data is returned in a response).

The library should

  • use modern, idiomatic JavaScript
  • be of high quality and use good coding practices (in the spirit of Code Complete -- good variable names, documentation, etc.)
  • contain unit tests (using mocking where appropriate) with good coverage
  • be structured in a way that lets it be uploaded to NPM
  • use a permissive, open-source license
  • come with a README that explains how to get started quickly
  • be publicly available on GitHub

Additional pointers:

  • The library should support all the ways that keypairs are commonly represented in the Ethereum ecosystem (as files, strings, etc).
  • The library should cleanly, idiomatically present the WebSocket information to the client.

We are open to discussing whether you continue to maintain the library or hand it off to us.

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.