Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create JavaScript library/SDK that wraps the Kchannels API #1

Open
maurycyp opened this issue Oct 14, 2020 · 0 comments
Open

Create JavaScript library/SDK that wraps the Kchannels API #1

maurycyp opened this issue Oct 14, 2020 · 0 comments

Comments

@maurycyp
Copy link

maurycyp commented Oct 14, 2020

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant