_ Git - ldk-java/blob - README.md

   1 LDK Java, C#, and TypeScript Bindings
   2 =====================================
   3
   4 This repo contains an autogeneration system to generate LDK bindings for garbage-collected languages, currently including Java, C#, and TypeScript. See below for the current status of the bindings.
   5
   6 The auto-generated code contains copies of the Rust documentation, which can also be viewed at
   7 [docs.rs/lightning](https://docs.rs/lightning). High-level documentation of the API can be found at
   8 [lightningdevkit.org](https://lightningdevkit.org).
   9
  10 Building
  11 ========
  12
  13 The releases for Java, C#, and TypeScript are all deterministic. You should be able to reproduce
  14 the release binaries identically by running the scripts run in CI, see
  15 [.github/workflows/build.yml](.github/workflows/build.yml).
  16
  17 Releases for all platforma re built on Linux as that is the easiest way to get things
  18 deterministic, however building on macOS should also work. Building on Windows is not currently
  19 supported.
  20
  21 Status
  22 ======
  23
  24 ## Java
  25
  26 The Java bindings are relatively mature, and should be considered safe for production use. Still,
  27 as they have relatively few users, unexpected issues remain possible, and bug reports are welcome.
  28
  29 ## TypeScript
  30
  31 The TypeScript bindings are functionally complete, but should be considered beta quality. As there
  32 are relatively few users, unexpected issues remain likely, and bug reports are welcome.
  33
  34 The TypeScript bindings require modern web standards, including support for `FinalizationRegistry`
  35 and `WeakRef` (Chrome 84, Firefox 79, Safari 14.1/iOS 14.5 and Node 14.6) and WASM BigInt support
  36 (Chrome 85, Firefox 78, Safari 14.1/iOS 14.5, and Node 15.0).
  37
  38 For users of Node.JS environments you may wish to use the `lightningdevkit-node-net` package as
  39 well to implement the required network handling to bridge the `lightningdevkit` package's
  40 `SocketDescriptor` interface to Node.JS TCP Sockets. For those wishing to run a lightning node in
  41 the browser you will need to provide your own bridge from `SocketDescriptor` to a WebSocket proxy.
  42
  43 # C#
  44
  45 The C# bindings are functionally complete, but should be considered alpha quality. They are brand
  46 new and likely contain bugs or memory leaks.
  47
  48 ## General
  49
  50 The only known issue resulting in a use-after-free bug requires custom a custom ChannelKeys instance
  51 created as a part of a new channel. After the channel is created, the ChannelKeys object will not
  52 be freed while the parent ChannelManager exists, however if the ChannelManager is garbage collected
  53 while a ChannelMonitor object which is associated with the same channel exists, a use-after-free bug
  54 may occur. This issue should be relatively rare as uses where a ChannelManager is removed while
  55 associated ChannelMonitors exist is not anticipated.