c-lightningrb 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 217391984ad129f43d5a9c94faf0768d26bf1b58ea3693bb4c63699c74e08c1c
-  data.tar.gz: 3d535c1c49a4952e7f202ba4d6e67c2a90c873e2c2b0c5aa2bd8d1ab8c731a38
+  metadata.gz: 2c2fd714b383235136db352d6b4a907a2b418d595de24f900102497887629d4e
+  data.tar.gz: 6046070fc4a9ba437cd4688a423b4acc8ade9f07953d77a36827e92d8ea7d38b
 SHA512:
-  metadata.gz: 0bfcbdefe33df305f684fefd8f6c636a9ba709742b409b3aa57a2eabb9f9f1493b70ffabba6fc60e3983eedca3cb44e2ec112a35bf5991e7cc4663648745db6f
-  data.tar.gz: 92440120dc13251e3beba89a0c10dd9c96593d26481f23626711c6de0d9059a8584e0d7db1934468ee3ac160c97f4f779a2e0c1ab8e5f63253330df5d55527b3
+  metadata.gz: 96e06e96542e9851634321af9be64d09a774a94f8835eb7d7b49b61058397ecbb7b189bcc91a9eb36597b459b23d7e28931875301a118720ae7555ce4fb61a22
+  data.tar.gz: d7d2b4015a2abbb689fbba7832459bc1c8cc045cf1e4f12a3596d3c4a0ec21580206dad730cde2e855797dab95576c640062c5ace3e6e16a6f44ab21d70ee7a9

data/README.md

@@ -21,6 +21,56 @@ Or install it yourself as:
 
 ## Examples
 
+### Using the JSON-RPC client
+
+```ruby
+require 'lightning'
+
+# initialize RPC interface using unix socket file.
+rpc = Lightning::RPC.new('/home/azuchi/.lightning/lightning-rpc')
+
+puts rpc.getinfo
+
+=> {
+  "id": "02a7581f5aafd3ed01a6664ad5108ce1601435d9e9e47c57f1c40cff152cd59307",
+  "alias": "GREENPHOTO",
+  "color": "02a758",
+  "num_peers": 0,
+  "num_pending_channels": 0,
+  "num_active_channels": 0,
+  "num_inactive_channels": 0,
+  "address": [
+
+  ],
+  "binding": [
+    {
+      "type": "ipv6",
+      "address": "::",
+      "port": 9735
+    },
+    {
+      "type": "ipv4",
+      "address": "0.0.0.0",
+      "port": 9735
+    }
+  ],
+  "version": "v0.7.0",
+  "blockheight": 1518441,
+  "network": "testnet",
+  "msatoshi_fees_collected": 0,
+  "fees_collected_msat": "0msat"
+}
+
+puts rpc.invoice(1000, 'example', 'test payment')
+
+=> {
+     "payment_hash": "76b2f5d6791a2e0be44071543c71d27238e2153fd832ac23d8c027b33e024fb8",
+     "expires_at": 1558856940,
+     "bolt11": "lntb10n1pww5dkupp5w6e0t4nerghqhezqw92rcuwjwguwy9flmqe2cg7ccqnmx0szf7uqdq5w3jhxapqwpshjmt9de6qcqp2phn9mgplxj2mxg59zjrlhwh2p66h2r3p4f7kyk8w4s3zcma5htn807r8lgfmg75hwcvhse8sqtgcyakgezdzjc0zyd87uahe3wsz3qcp4nv6f0",
+     "warning_capacity": "No channels have sufficient incoming capacity"
+   }
+```
+
 ### Writing a plugin
 
 You can write your own Plugin by inheriting `Lightning::Plugin`.
@@ -30,6 +80,9 @@ You can write your own Plugin by inheriting `Lightning::Plugin`.
 require 'lightning'
 
 class HelloPlugin < Lightning::Plugin
+  
+  # Command line option pass-through
+  option 'greeting', 'World', "What name should I call you?"
 
   # define new rpc. Usage and description are required only for the definition of RPC.
   desc '[name]', 'Returns a personalized greeting for {greeting} (set via options).'
@@ -61,6 +114,7 @@ p.run
 
 Write all RPC, notification, and hook handlers in Lambda. 
 These Lambdas are implemented as methods, so you can access any of the fields and methods of the Plugin.
+For example, `Lightning::Plugin` instance has `rpc` field which can access `lightningd` via `Lightning::RPC`.
 
 And it works if you specify Plugin as the parameter when c-lightning launches.
 

data/examples/README.md

@@ -0,0 +1,9 @@
+# Examples
+
+### [hello Plugin](hello.rb)
+
+ Add hello rpc to lightning-cli.
+ 
+    $ lightning-cli hello c-lightning
+    hello c-lightning
+ 

data/examples/hello.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+require 'lightning'
+
+class HelloPlugin < Lightning::Plugin
+
+  desc '[name]', 'Returns a personalized greeting for {greeting} (set via options).'
+  define_rpc :hello, -> (name) do
+    log.info "log = #{log}"
+    "hello #{name}"
+  end
+
+  option 'greeting', 'World', "What name should I call you?"
+
+end
+
+p = HelloPlugin.new
+p.run

data/lib/lightning/plugin.rb

@@ -53,6 +53,20 @@ module Lightning
         @subscriptions ||= []
       end
 
+      # get options
+      def options
+        @options ||= []
+      end
+
+      # Define option for lightningd command line.
+      # @param [String] name option name.
+      # @param [String] default default value.
+      # @param [String] description description.
+      def option(name, default, description)
+        # currently only string options are supported.
+        options << {name: name, default: default, description: description, type: 'string'}
+      end
+
       # Define the definition of RPC method
       # @param [String] usage the usage of RPC method.
       # @param [String] desc the description of RPC method.
@@ -100,7 +114,6 @@ module Lightning
 
     end
 
-    attr_reader :options
     attr_reader :stdout
     attr_reader :stdin
     attr_reader :log
@@ -110,20 +123,21 @@ module Lightning
 
     def initialize
       methods[:init] = Method.new(:init)
-      @options = {}
       @stdout = STDOUT
       @stdin = STDIN
       methods[:getmanifest] = Method.new(:getmanifest)
       @log = Lightning::Logger.create(:plugin)
     end
 
-    def init(options, configuration)
+    def init(opts, configuration)
       log.info("init")
       @lightning_dir = configuration['lightning-dir']
       @rpc_filename = configuration['rpc-file']
       socket_path = (Pathname.new(lightning_dir) + rpc_filename).to_path
-      @rpc = Lightning::RPC.new(socket_path, log)
-      @options.merge!(options)
+      @rpc = Lightning::RPC.new(socket_path)
+      opts.each do |key, value|
+        options.find{|o|o[:name] == key}[:value] = value
+      end
       nil
     end
 
@@ -132,7 +146,7 @@ module Lightning
     def getmanifest
       log.info("getmanifest")
       {
-          options: options.values,
+          options: options,
           rpcmethods: rpc_methods.map(&:to_h),
           subscriptions: subscriptions,
           hooks: hook_methods.map(&:name),
@@ -148,20 +162,16 @@ module Lightning
     def run
       log.info("Plugin run.")
       begin
-      partial = ''
-      stdin.each_line do |l|
-        partial << l
-        msgs = partial.split("\n\n", -1)
-        next if msgs.size < 2
-        partial = multi_dispatch(msgs)
-      end
-      rescue Exception => e
-        if e.is_a?(Interrupt)
-          shutdown
-        else
-          log.error e
-          throw e
+        partial = ''
+        stdin.each_line do |l|
+          partial << l
+          msgs = partial.split("\n\n", -1)
+          next if msgs.size < 2
+          partial = multi_dispatch(msgs)
         end
+      rescue Interrupt
+        log.info "Interrupt occur."
+        shutdown
       end
       log.info("Plugin end.")
     end
@@ -179,6 +189,11 @@ module Lightning
       self.class.subscriptions # delegate to class instance
     end
 
+    # get options
+    def options
+      self.class.options # delegate to class instance
+    end
+
     def multi_dispatch(msgs)
       msgs[0...-1].each do |payload|
         json = JSON.parse(payload)
@@ -194,16 +209,25 @@ module Lightning
     end
 
     def dispatch_request(request)
-      method = methods[request.method]
-      raise ArgumentError, "No method #{request.method} found." unless method
-      result = request.method_args.empty? ? send(method.name) : send(method.name, *request.method_args)
-      request.apply_result(result) if result
+      begin
+        method = methods[request.method]
+        raise ArgumentError, "No method #{request.method} found." unless method
+        result = request.method_args.empty? ? send(method.name) : send(method.name, *request.method_args)
+        request.apply_result(result) if result
+      rescue Exception => e
+        log.error e
+        request.write_error(e)
+      end
     end
 
     def dispatch_notification(request)
-      name = request.method
-      raise ArgumentError, "No handler #{request.method} found." unless subscriptions.include?(request.method)
-      request.method_args.empty? ? send(name) : send(name, *request.method_args)
+      begin
+        name = request.method
+        raise ArgumentError, "No handler #{request.method} found." unless subscriptions.include?(request.method)
+        request.method_args.empty? ? send(name) : send(name, *request.method_args)
+      rescue Exception => e
+        log.error e
+      end
     end
 
     def rpc_methods

data/lib/lightning/request.rb

@@ -32,6 +32,8 @@ module Lightning
       end
     end
 
+    # write response
+    # @param [Hash] result the content of response
     def apply_result(result)
       @result = result
       json = {
@@ -39,8 +41,27 @@ module Lightning
           id: id,
           result: result
       }.to_json
-      log.info "write response: #{json.to_s}"
-      plugin.stdout.write(json.to_s + "\n\n")
+      write(json.to_s)
+    end
+
+    # write error
+    # @param [Exception] e an error.
+    def write_error(e)
+      error = {message: e.message}
+      error[:code] = e.code if e.is_a?(Lightning::RPCError)
+      json = {
+          jsonrpc: '2.0',
+          id: id,
+          error: error
+      }.to_json
+      write(json.to_s)
+    end
+
+    private
+
+    def write(content)
+      log.info "write response: #{content}"
+      plugin.stdout.write(content + "\n\n")
       plugin.stdout.flush
     end
 

data/lib/lightning/rpc.rb

@@ -1,14 +1,59 @@
+require 'socket'
+require 'json'
+
 module Lightning
 
+  class RPCError < StandardError
+
+    INVALID_REQUEST = -32600
+    METHOD_NOT_FOUND = -32601
+    INVALID_PARAMS = -32602
+
+    attr_reader :code
+    attr_reader :message
+
+    def initialize(code, message)
+      @code = code
+      @message = message
+    end
+
+  end
+
   # RPC client for the `lightningd` daemon.
   class RPC
 
     attr_reader :socket_path
-    attr_reader :log
+    attr_accessor :next_id
 
-    def initialize(socket_path, log)
+    def initialize(socket_path)
       @socket_path = socket_path
-      @log = log
+      @next_id = 0
+    end
+
+    private
+
+    def call(method, *kargs)
+      UNIXSocket.open(socket_path) do |socket|
+        msg = {
+            method: method.to_s,
+            params: kargs,
+            id: next_id
+        }
+        socket.write(msg.to_json)
+        self.next_id += 1
+        response = ''
+        loop do
+          response << socket.gets
+          break if response.include?("\n\n")
+        end
+        json = JSON.parse(response)
+        raise RPCError.new(json['error']['code'], json['error']['message']) if json['error']
+        json['result']
+      end
+    end
+
+    def method_missing(method, *args)
+      call(method, *args)
     end
 
   end

data/lib/lightning/version.rb

@@ -1,3 +1,3 @@
 module Lightning
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: c-lightningrb
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - azuchi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-25 00:00:00.000000000 Z
+date: 2019-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -71,6 +71,8 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- examples/README.md
+- examples/hello.rb
 - lib/lightning.rb
 - lib/lightning/logger.rb
 - lib/lightning/plugin.rb