https://github.com/lightninglabs/lndclient

Golang client library for lnd
https://github.com/lightninglabs/lndclient

Last synced: over 1 year ago
JSON representation

Golang client library for lnd

• Host: GitHub
• URL: https://github.com/lightninglabs/lndclient
• Owner: lightninglabs
• License: mit
• Created: 2020-06-16T18:48:05.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-10-29T12:03:28.000Z (over 1 year ago)
• Last Synced: 2024-10-29T13:32:02.510Z (over 1 year ago)
• Language: Go
• Homepage:
• Size: 1.46 MB
• Stars: 49
• Watchers: 14
• Forks: 43
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Golang client library for lnd

`lndclient` is a golang native wrapper for `lnd`'s gRPC interface.

## Compatibility matrix

This library depends heavily on `lnd` for obvious reasons. To support backward

compatibility with older versions of `lnd`, we use different branches for

different versions. There are two "levels" of depending on a version of

`lnd`:

 - Code level dependency: This is the version of `lnd` that is pulled in when

   compiling `lndclient`. It is defined in `go.mod`. This usually is the latest

   released version of `lnd`, because its RPC definitions are kept backward

   compatible. This means that a new field added in the latest version of `lnd`

   might already be available in `lndclient`'s code, but whether or not that

   field will actually be set at run time is dependent on the actual version of

   `lnd` that's being connected to.

 - RPC level dependency: This is defined in `minimalCompatibleVersion` in

   [`lnd_services.go`](lnd_services.go). When connecting to `lnd`, the version

   returned by its version service is checked and if it doesn't meet the minimal

   required version defined in `lnd_services.go`, an error will be returned.

   Users of `lndclient` can also overwrite this minimum required version when

   creating a new client.

The current compatibility matrix reads as follows:

| `lndclient` git tag                                                                   | `lnd` version in `go.mod` | minimum required `lnd` version | 

|---------------------------------------------------------------------------------------|---------------------------|--------------------------------|

| `master` / [`v0.18.5-13`](https://github.com/lightninglabs/lndclient/blob/v0.18.5-13) | `v0.18.5-beta`            | `v0.18.5-beta`                 |

By default, `lndclient` requires (and enforces) the following RPC subservers to

be active in `lnd`:

 - `signrpc`

 - `walletrpc`

 - `chainrpc`

 - `invoicesrpc`

## Branch strategy

We follow the following strategy to maintain different versions of this library

that have different `lnd` compatibilities:

1. The `master` is always backward compatible with the last major version.

2. We create branches for all minor versions and future major versions and merge PRs to those branches, if the features require that version to work.

3. We rebase the branches if needed and use tags to track versions that we depend on in other projects.

4. Once a new major version of `lnd` is final, all branches of minor versions lower than that are merged into master.