https://github.com/celer-network/celer-light-client

TypeScript implementation of a Celer client
https://github.com/celer-network/celer-light-client

blockchain ethereum layer-2

Last synced: 20 days ago
JSON representation

TypeScript implementation of a Celer client

• Host: GitHub
• URL: https://github.com/celer-network/celer-light-client
• Owner: celer-network
• License: mit
• Created: 2019-10-02T21:51:49.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-24T00:55:08.000Z (about 3 years ago)
• Last Synced: 2025-09-19T16:51:01.063Z (5 months ago)
• Topics: blockchain, ethereum, layer-2
• Language: JavaScript
• Size: 1.84 MB
• Stars: 31
• Watchers: 8
• Forks: 10
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Celer Light Client

[![Build Status](https://travis-ci.com/celer-network/celer-light-client.svg?token=DvaxasPgAzCzksHzA2ct&branch=master)](https://travis-ci.com/celer-network/celer-light-client) [![npm version](https://badge.fury.io/js/celer-light-client.svg)](https://badge.fury.io/js/celer-light-client)

This is a TypeScript implementation of a Celer client capable of sending and

receiving conditional payments via state channels. Compared to a full Celer

node, the light client does NOT have the capability of relaying payments.

## API docs

Auto-generated API docs are available [here](https://celer-network.github.io/celer-light-client/index.html).

The APIs on the client object are listed [here](https://celer-network.github.io/celer-light-client/classes/_api_celer_.celer.html).

## Try it out

1. Make sure you have MetaMask installed on your browser and you are on the

   **Ropsten** testnet.

2. Check out the repo.

3. Run `yarn install`.

4. Run `yarn demo`.

5. A demo page will be available at `localhost:1234`. It is a bare-bone static

   page that implements a simple off-chain wallet.

6. Click "Connect Celer wallet" and sign **one** pop-up message.

7. Click "Open channel", sign **one** pop-up message, sign **one** transaction,

   and sign **two** pop-up messages after the transaction is mined.

Now you are free to send payments to a recipient that has also opened a channel,

or you can send to the Celer Community OSP :)

The [code](https://github.com/celer-network/celer-light-client/blob/master/demo/demo.ts)

is pretty self-explanatory.