https://github.com/wslyvh/raiden-api-client

A lightweight Raiden Network API TypeScript client to interact with a Raiden Network node.
https://github.com/wslyvh/raiden-api-client

blockchain ethereum raiden raiden-network

Last synced: about 2 months ago
JSON representation

A lightweight Raiden Network API TypeScript client to interact with a Raiden Network node.

• Host: GitHub
• URL: https://github.com/wslyvh/raiden-api-client
• Owner: wslyvh
• License: mit
• Archived: true
• Created: 2019-08-08T09:29:38.000Z (over 5 years ago)
• Default Branch: develop
• Last Pushed: 2022-12-04T06:46:21.000Z (about 2 years ago)
• Last Synced: 2024-04-24T22:42:49.765Z (8 months ago)
• Topics: blockchain, ethereum, raiden, raiden-network
• Language: TypeScript
• Homepage: https://wslyvh.github.io/raiden-api-client/
• Size: 824 KB
• Stars: 8
• Watchers: 3
• Forks: 2
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-raiden - Raiden API TypeScript client - A lightweight Raiden Network API TypeScript client to interact with a Raiden Network node. (Developer Resources / 🛠️ Hacks and More Tools for Devs)

README

        
# Raiden-client

[![Build Status](https://travis-ci.org/wslyvh/raiden-api-client.svg?branch=develop)](https://travis-ci.org/wslyvh/raiden-api-client)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=raiden-api-client&metric=alert_status)](https://sonarcloud.io/dashboard?id=raiden-api-client)

[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=raiden-api-client&metric=coverage)](https://sonarcloud.io/dashboard?id=raiden-api-client)

[![NPM](https://img.shields.io/npm/v/raiden-api-client.svg)](https://www.npmjs.com/package/raiden-api-client)

[![NPM](https://img.shields.io/npm/l/raiden-api-client.svg)](https://www.npmjs.com/package/raiden-api-client)

[![NPM](https://img.shields.io/npm/dt/raiden-api-client.svg)](https://www.npmjs.com/package/raiden-api-client)

# Introduction

A lightweight Raiden Network API TypeScript client to interact with a Raiden Network node.

- [Official Website](https://raiden.network)

- [Official Developer Portal](https://developer.raiden.network/)

- [Official Raiden Network API documentation](https://raiden-network.readthedocs.io/en/latest/rest_api.html)

# Install

`npm i raiden-api-client --save`

# Usage

```typescript

import RaidenClient from "raiden-api-client";

async function printChannels() {

  const client = new RaidenClient("http://localhost:5001/api");

  const channels = await client.getChannels();

  console.log(channels);

}

```

# Documentation

- [Raiden Client API documentation](https://wslyvh.github.io/raiden-api-client/)

# Contributing

See [CONTRIBUTING](./.github/CONTRIBUTING.MD).

# License

This project is released under the MIT License. See [LICENSE](LICENSE).