Giter Club home page Giter Club logo

cln-grpc-client's Introduction

Build GitHub Release Maven Central License

Logo Logo

cln-grpc-client

A gRPC client for Core Lightning (CLN).

cln-grpc-client-starter

A module containing a Spring Boot Starter is also available.

Table of Contents

Install

Download from Maven Central.

Gradle

repositories {
    mavenCentral()
}
implementation "io.github.theborakompanioni:cln-grpc-client-core:${clnGrpcClientVersion}"

Maven

<dependency>
    <groupId>io.github.theborakompanioni</groupId>
    <artifactId>cln-grpc-client-core</artifactId>
    <version>${clnGrpcClient.version}</version>
</dependency>

Development

Requirements

  • java >=17
  • docker

Build

./gradlew build -x test

Test

./gradlew test integrationTest --rerun-tasks

Dependency Verification

Gradle is used for checksum and signature verification of dependencies.

# write metadata for dependency verification
./gradlew --write-verification-metadata pgp,sha256 --export-keys

See Gradle Userguide: Verifying dependencies for more information.

Checkstyle

Checkstyle with adapted google_checks is used for checking Java source code for adherence to a Code Standard.

# check for code standard violations with checkstyle
./gradlew checkstyleMain --rerun-tasks

SpotBugs

SpotBugs is used for static code analysis.

# invoke static code analysis with spotbugs
./gradlew spotbugsMain --rerun-tasks

Troubleshooting

ManagedChannelProvider$ProviderNotFoundException

Caused by: io.grpc.ManagedChannelProvider$ProviderNotFoundException: No functional channel service provider found. Try adding a dependency on the grpc-okhttp, grpc-netty, or grpc-netty-shaded artifact

add a channel service provider implementation, e.g.

implementation "io.grpc:grpc-netty-shaded:${grpcVersion}"

Hint: The above section should currently not apply, as grpc-netty-shaded is included as dependency. However, this dependency might be removed in future releases.

Error loading shared library libio_grpc_netty_shaded_netty_tcnative-*.so

See: https://github.com/grpc/grpc-java/blob/master/SECURITY.md#netty

Contributing

All contributions and ideas are always welcome. For any question, bug or feature request, please create an issue. Before you start, please read the contributing guidelines.

Resources


License

The project is licensed under the Apache License. See LICENSE for details.

cln-grpc-client's People

Contributors

theborakompanioni avatar

Stargazers

 avatar

Watchers

 avatar  avatar

cln-grpc-client's Issues

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.