lisk 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9d527806f8f47279705cb1cfd3e6ce771387fa69
-  data.tar.gz: 0716014534de9e321302f44f8ddfb417279294bb
+  metadata.gz: 8eafe7fb9b6dbf55042554ee4a579a0e0f5d418f
+  data.tar.gz: e22f1dd7407b0d147c8fd9094a4b344894d43f28
 SHA512:
-  metadata.gz: e1060e59743ff5d8b476a558af469ba43e37d2ecc1da96b308f3605c3011f8cefd76e0b8e5482e9e55b371f9923fec0d36f84e3523c3dbb1e410ee44959a5985
-  data.tar.gz: ba79a7a558efb74293b4783e020bf4c186ed7aa92dd0f2a8698fdde0d3af5a3a81de4f210496fe3889acc84f0ee4a443e779342349999a09efb91d0f535d5325
+  metadata.gz: 0f361fd322d242a1c91dd3c7cf2befbd4ea04bc1f2a5240cce08a761c043ce79b86ab19c5bba7599e8710d969ae7d5b75ba0634d081daf961d4098424505ec3f
+  data.tar.gz: 4ceb3c01274c177097f4a187747a8d55f51747a4831217870f09606948c147b9b9ca05408fffa6fa36495c473c9104bb280246cf5f75c18233ebac9db3b9f2ec

data/README.md

@@ -2,6 +2,8 @@
 
 A simple Ruby wrapper for the Lisk API. 💎
 
+![Live-Preview.](examples/4fryn-lisk-rb.gif)
+
 ## Note before using
 
 This is very early work-in-progress. The idea is to publish this `gem` as soon as it is fully compatible with Lisk Core 1.0.0, which, however, is not released yet. The current implementation of the lisk.rb gem is pure minimal by design and barely allows checking the node status.
@@ -9,7 +11,7 @@ This is very early work-in-progress. The idea is to publish this `gem` as soon a
 API Implemententation Status:
 
 - `Lisk::Legacy` 48/62 APIs for Lisk Core 0.8.0+ ([#4](https://github.com/4fryn/lisk.rb/issues/4))
-- `Lisk::API` 0/34 APIs for Lisk Core 1.0.0+ ([#1](https://github.com/4fryn/lisk.rb/issues/1))
+- `Lisk::Raw` 0/34 APIs for Lisk Core 1.0.0+ ([#1](https://github.com/4fryn/lisk.rb/issues/1))
 
 ## Installation
 
@@ -42,49 +44,55 @@ require 'lisk'
 To get started, point the lisk.rb to any Lisk-API endpoint. By default, lisk.rb assumes a running Lisk testnet node on localhost port 7000.
 
 ```ruby
-client = Lisk::Client.new "127.0.0.1", 7000
+node = Lisk::Client.new "127.0.0.1", 7000
 ```
 
-Get access to the Lisk-0.8.0 legacy API (see [#4](https://github.com/4fryn/lisk.rb/issues/4)).
+For convenience, check if the Lisk node is connected, fully synchronized, and active by pinging it.
 
 ```ruby
-legacy_api = Lisk::Legacy.new client
+if node.is_alive?
+  # only do stuff if client is connected, fully synchronized, and active ...
+end
 ```
 
-For convenience, check if the Lisk node is connected, fully synchronized, and active by pinging it.
+Get access to the Lisk-0.8.0 legacy API (see [#4](https://github.com/4fryn/lisk.rb/issues/4)).
 
 ```ruby
-if legacy_api.loader_status_ping
-  # only do stuff if client is connected, fully synchronized, and active ...
-end
+lisk = Lisk::API.new node
 ```
 
 Get the version of the connected Lisk node.
 
 ```ruby
-version = legacy_api.peers_version
-p "Lisk node version #{version["version"]} build #{version["build"]}..."
+version = lisk.get_version
+build = lisk.get_version_build
+p "Lisk node version #{version} build #{build}..."
 ```
 
 Get the status of the connected Lisk node.
 
 ```ruby
-status = legacy_api.loader_status
-p "Lisk node is connected: #{status["success"]}... Blockchain loaded: #{status["loaded"]}..."
+connected = node.is_alive?
+loaded = lisk.is_chain_loaded?
+p "Lisk node is connected: #{connected}... Blockchain loaded: #{loaded}..."
 ```
 
 Figure out if the node is still synchronizing.
 
 ```ruby
-syncing = legacy_api.loader_status_sync
-p "Lisk node is syncing: #{syncing["syncing"]}... #{syncing["blocks"]} remaining blocks to latest block #{syncing["height"]}..."
+syncing = lisk.is_syncing?
+remaining = lisk.get_remaining_blocks
+best = lisk.get_chain_best_block
+p "Lisk node is syncing: #{syncing}... #{remaining} remaining blocks to latest block #{best}..."
 ```
 
 Get some global Lisk blockchain stats.
 
 ```ruby
-chain = legacy_api.blocks_get_status
-p "Lisk chain latest block: #{chain["height"]}... total supply: #{chain["supply"] / 1e8}... block reward: #{chain["reward"] / 1e8}"
+height = lisk.get_best_block
+reward = lisk.get_block_reward / 1e8
+supply = lisk.get_available_supply / 1e8
+p "Lisk chain latest block: #{height}... total supply: #{supply}... block reward: #{reward}"
 ```
 
 See `examples/*.rb` for more examples implementing the Lisk API.

data/bin/debug

@@ -7,5 +7,6 @@ rm pkg/*.gem
 git add -A
 bundle exec rake install
 ruby examples/status.rb
-ruby examples/payout.rb
-ruby examples/legacy_api.rb
+#ruby examples/payout.rb
+#ruby examples/legacy_api.rb
+ruby examples/delegates.rb

data/examples/delegates.rb

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require 'lisk'
+
+node     = Lisk::Client.new
+api      = Lisk::API.new node
+
+delegate = Lisk::Delegate.new api, "4fryn"
+p delegate.is_registered?
+
+delegate = Lisk::Delegate.new api, "not_4fryn"
+p delegate.is_registered?
+
+delegate.set_secrets "lorem ipsum foo bar", "foo bar lorem ipsum"
+p delegate.register

data/examples/payout.rb

@@ -14,51 +14,52 @@ if legacy_api.loader_status_ping
 
   # Get the desired delegate by name.
   delegate = legacy_api.delegates_get_by_name "4fryn"
-  p "Delegate #{delegate["username"]} is rank \##{delegate["rank"]} with #{delegate["approval"]}\% approval and #{delegate["productivity"]}\% productivity."
-
-  # Get a list of voters for a delegate.
-  deleagte_public_key = delegate["publicKey"]
-  deleagte_address = delegate["address"]
-  deleagte_voters = legacy_api.delegates_voters deleagte_public_key
-
-  # Get the total vote weight of our delegate
-  deleagte_total_weight = delegate["vote"].to_f
-
-  # Get the forging rewards from balance
-  payout_balance = legacy_api.accounts_get_balance deleagte_address
-  payout_balance = payout_balance["balance"].to_f
-
-  # Our pool is sharing 80%, and keeping 20%
-  pool_share = 0.80
-
-  # Filter out voters with out any Lisk
-  voter_threshold = 0
-
-  _debug_payout_sum = 0
-
-  # Iterate all voters
-  deleagte_voters.each do | voter |
-    voter_balance = voter["balance"].to_f
-
-    # Only handle voters with balance above threshold
-    if voter_balance > voter_threshold # and not voter["address"].eql? deleagte_address
-      voter_share = voter["balance"].to_f / deleagte_total_weight
-      payout = voter_share * payout_balance * pool_share
-      # @TODO: do some handling of dust amounts
-      # @TODO: do sanity checks and create transactions here ...
-      p "Sending #{payout / 1e8} LSK to voter #{voter["address"]}..."
-      _debug_payout_sum += payout
+  if not delegate.nil?
+    p "Delegate #{delegate["username"]} is rank \##{delegate["rank"]} with #{delegate["approval"]}\% approval and #{delegate["productivity"]}\% productivity."
+
+    # Get a list of voters for a delegate.
+    deleagte_public_key = delegate["publicKey"]
+    deleagte_address = delegate["address"]
+    deleagte_voters = legacy_api.delegates_voters deleagte_public_key
+
+    # Get the total vote weight of our delegate
+    deleagte_total_weight = delegate["vote"].to_f
+
+    # Get the forging rewards from balance
+    payout_balance = legacy_api.accounts_get_balance deleagte_address
+    payout_balance = payout_balance["balance"].to_f
+
+    # Our pool is sharing 80%, and keeping 20%
+    pool_share = 0.80
+
+    # Filter out voters with out any Lisk
+    voter_threshold = 0
+
+    _debug_payout_sum = 0
+
+    # Iterate all voters
+    deleagte_voters.each do | voter |
+      voter_balance = voter["balance"].to_f
+
+      # Only handle voters with balance above threshold
+      if voter_balance > voter_threshold # and not voter["address"].eql? deleagte_address
+        voter_share = voter["balance"].to_f / deleagte_total_weight
+        payout = voter_share * payout_balance * pool_share
+        # @TODO: do some handling of dust amounts
+        # @TODO: do sanity checks and create transactions here ...
+        p "Sending #{payout / 1e8} LSK to voter #{voter["address"]}..."
+        _debug_payout_sum += payout
+      end
     end
-  end
 
-  # @TODO: sending 20% delegate share to her private address
-  p "Sending #{payout_balance * 0.20 / 1e8} LSK to delegate private funds..."
-
-  # _debug_payout_diff should be 0
-  _debug_payout_sum += payout_balance * 0.20
-  _debug_payout_diff = payout_balance - _debug_payout_sum
-  p "#{_debug_payout_diff === 0}"
+    # @TODO: sending 20% delegate share to her private address
+    p "Sending #{payout_balance * 0.20 / 1e8} LSK to delegate private funds..."
 
+    # _debug_payout_diff should be 0
+    _debug_payout_sum += payout_balance * 0.20
+    _debug_payout_diff = payout_balance - _debug_payout_sum
+    p "#{_debug_payout_diff === 0}"
+  end
 else
   p 'Lisk node disconnected, inactive, or not fully synchronized ...'
 end

data/examples/status.rb

@@ -3,52 +3,49 @@
 require 'lisk'
 
 # Try to connect a local Lisk client.
-client = Lisk::Client.new
+node = Lisk::Client.new
 
 # Configure host and port of the Lisk client.
-client = client.configure "127.0.0.1", 8000
+node = node.configure "127.0.0.1", 7000
 
 # Same as above, just in one line, let's stick to test network for now.
-client = Lisk::Client.new "127.0.0.1", 7000
-
-# The pre-1.0.0 legacy API connected to the client.
-legacy_api = Lisk::Legacy.new client
+node = Lisk::Client.new "127.0.0.1", 7000
 
 # Only proceed if the client is connected, active, and fully synchronized.
-if legacy_api.loader_status_ping
+if node.is_alive?
+
+  # Lisk tools wraps the raw API in meaningful methods.
+  api = Lisk::API.new node
 
   # Lisk version API example.
-  version = legacy_api.peers_version
-  p "Lisk node version #{version["version"]} build #{version["build"]}..."
+  version = api.get_version
+  commit = api.get_version_commit
+  build = api.get_version_build
+  p "Lisk node version #{version} commit #{commit} build #{build}..."
 
   # Lisk node status API example.
-  status = legacy_api.loader_status
-  p "Lisk node is connected: #{status["success"]}... Blockchain loaded: #{status["loaded"]}..."
+  connected = node.is_alive?
+  loaded = api.is_chain_loaded?
+  p "Lisk node is connected: #{connected}... Blockchain loaded: #{loaded}..."
 
   # Lisk node syncing API example.
-  syncing = legacy_api.loader_status_sync
-  p "Lisk node is syncing: #{syncing["syncing"]}... #{syncing["blocks"]} remaining blocks to latest block #{syncing["height"]}..."
+  synced = api.is_syncing?
+  blocks = api.get_remaining_blocks
+  height = api.get_best_block
+  p "Lisk node is syncing: #{synced}... #{blocks} remaining blocks to latest block #{height}..."
 
   # Lisk node peers API example.
-  peers = legacy_api.peers
-  cond = 0
-  disd = 0
-  band = 0
-  peers.each do | peer |
-    case peer["state"]
-    when 0
-      band += 1
-    when 1
-      disd += 1
-    when 2
-      cond += 1
-    end
-  end
-  p "Lisk node saw #{peers.count} peers... #{cond} connected, #{disd} disconnected, #{band} banned..."
+  cond = api.get_connected_peers.count
+  disd = api.get_disconnected_peers.count
+  band = api.get_banned_peers.count
+  all = api.get_peer_count
+  p "Lisk node saw #{all} peers... #{cond} connected, #{disd} disconnected, #{band} banned..."
 
   # Lisk blockchain API example.
-  chain = legacy_api.blocks_get_status
-  p "Lisk chain latest block: #{chain["height"]}... total supply: #{chain["supply"] / 1e8}... block reward: #{chain["reward"] / 1e8}"
+  chain_height = api.get_chain_best_block
+  block_reward = api.get_block_reward
+  total_supply = api.get_available_supply
+  p "Lisk chain latest block: #{chain_height}... total supply: #{total_supply / 1e8}... block reward: #{block_reward / 1e8}"
 
 else
   p 'Lisk node disconnected, inactive, or not fully synchronized ...'

data/lib/lisk/api.rb

@@ -1,184 +1,187 @@
+require "time"
+
 # The Lisk API Ruby wrapper gem.
 module Lisk
 
-  # Implements APIs of the Lisk Core node.
-  class API
-
-    # A "lisk/client" connecting to a Lisk Core API node.
-    attr_accessor :client
+  # Helper functions to wrap raw legacy APIs into meaningul methods.
+  class API < Legacy
 
-    # Initializing the API with a Lisk Core API client.
-    def initialize client
-      if not client.nil?
-        @client = client
-        return self
+    # Returns true if chain is syncing.
+    def is_syncing?
+      synced = self.loader_status_sync
+      if synced["success"]
+        return synced["syncing"]
       else
         return nil
       end
     end
 
-    #############################################
-    # https://github.com/4fryn/lisk.rb/issues/1 #
-    #############################################
-
-    # The "accounts" API
-    def accounts
-      todo "#{self}::#{__method__} UNIMPLEMENTED"
-    end
-
-    # The "blocks" API
-    def blocks
-      todo "#{self}::#{__method__} UNIMPLEMENTED"
-    end
-
-    # The "dapps" API
-    def dapps
-      todo "#{self}::#{__method__} UNIMPLEMENTED"
-    end
-
-    # The "delegates" API
-    def delegates
-      todo "#{self}::#{__method__} UNIMPLEMENTED"
-    end
-
-    # The "delegates/forgers" API
-    def delegates_forgers
-      todo "#{self}::#{__method__} UNIMPLEMENTED"
-    end
-
-    # The "delegates/forging" API
-    def delegates_forging
-      todo "#{self}::#{__method__} UNIMPLEMENTED"
-    end
-
-    # The "node/constants" API
-    def node_constants
-      todo "#{self}::#{__method__} UNIMPLEMENTED"
-    end
-
-    # The "node/status" API
-    def node_status
-      todo "#{self}::#{__method__} UNIMPLEMENTED"
-    end
-
-    # The "peers" API
-    def peers
-      todo "#{self}::#{__method__} UNIMPLEMENTED"
-    end
-
-    # The "signatures" API
-    def signatures
-      todo "#{self}::#{__method__} UNIMPLEMENTED"
-    end
-
-    # The "transactions" API
-    def transactions
-      todo "#{self}::#{__method__} UNIMPLEMENTED"
-    end
-
-    # The "transactions/unsigned" API
-    def transactions_unsigned
-      todo "#{self}::#{__method__} UNIMPLEMENTED"
+    # Returns true if chain is loaded.
+    def is_chain_loaded?
+      loaded = self.loader_status
+      if loaded["success"]
+        return loaded["loaded"]
+      else
+        return nil
+      end
     end
 
-    # The "transactions/unconfirmed" API
-    def transactions_unconfirmed
-      todo "#{self}::#{__method__} UNIMPLEMENTED"
+    # Get the Lisk node version string.
+    def get_version
+      version = self.peers_version
+      if version["success"]
+        return version["version"]
+      else
+        return nil
+      end
     end
 
-    # The "transactions/unprocessed" API
-    def transactions_unprocessed
-      todo "#{self}::#{__method__} UNIMPLEMENTED"
+    # Get the Lisk node version build date.
+    def get_version_build
+      version = self.peers_version
+      if version["success"]
+        return version["build"]
+      else
+        return nil
+      end
     end
 
-    # The "votes" API
-    def votes
-      todo "#{self}::#{__method__} UNIMPLEMENTED"
+    # Get the Lisk node version commit.
+    def get_version_commit
+      version = self.peers_version
+      if version["success"]
+        return version["commit"]
+      else
+        return nil
+      end
     end
 
-    # The "voters" API
-    def voters
-      todo "#{self}::#{__method__} UNIMPLEMENTED"
+    # Get the height of the local best known block.
+    def get_best_block
+      synced = self.loader_status_sync
+      if synced["success"]
+        return synced["height"]
+      else
+        return nil
+      end
     end
 
-    # The "accounts" API
-    def accounts
-      todo "#{self}::#{__method__} UNIMPLEMENTED"
+    # Get the number of remaining local sync blocks.
+    def get_remaining_blocks
+      synced = self.loader_status_sync
+      if synced["success"]
+        return synced["blocks"]
+      else
+        return nil
+      end
     end
 
-    # The "blocks" API
-    def blocks
-      todo "#{self}::#{__method__} UNIMPLEMENTED"
+    # Get the global best block in the network.
+    def get_chain_best_block
+      blocks = self.blocks_get_height
+      if blocks["success"]
+        return blocks["height"]
+      else
+        return nil
+      end
     end
 
-    # The "dapps" API
-    def dapps
-      todo "#{self}::#{__method__} UNIMPLEMENTED"
+    # Get the broad hash.
+    def get_broadhash
+      blocks = self.blocks_get_status
+      if blocks["success"]
+        return blocks["broadhash"]
+      else
+        return nil
+      end
     end
 
-    # The "delegates" API
-    def delegates
-      todo "#{self}::#{__method__} UNIMPLEMENTED"
+    # Get the net hash.
+    def get_nethash
+      blocks = self.blocks_get_nethash
+      if blocks["success"]
+        return blocks["nethash"]
+      else
+        return nil
+      end
     end
 
-    # The "delegates/forgers" API
-    def delegates_forgers
-      todo "#{self}::#{__method__} UNIMPLEMENTED"
+    # Get the current epoch date.
+    def get_epoch
+      blocks = self.blocks_get_status
+      if blocks["success"]
+        epoch = Time.parse blocks["epoch"]
+        return epoch
+      else
+        return nil
+      end
     end
 
-    # The "delegates/forging" API
-    def delegates_forging
-      todo "#{self}::#{__method__} UNIMPLEMENTED"
+    # Get the current milestone.
+    def get_milestone
+      blocks = self.blocks_get_milestone
+      if blocks["success"]
+        return blocks["milestone"]
+      else
+        return nil
+      end
     end
 
-    # The "node/constants" API
-    def node_constants
-      todo "#{self}::#{__method__} UNIMPLEMENTED"
+    # Get the current block reward.
+    def get_block_reward
+      blocks = self.blocks_get_reward
+      if blocks["success"]
+        return blocks["reward"]
+      else
+        return nil
+      end
     end
 
-    # The "node/status" API
-    def node_status
-      todo "#{self}::#{__method__} UNIMPLEMENTED"
+    # Get the available supply.
+    def get_available_supply
+      blocks = self.blocks_get_supply
+      if blocks["success"]
+        return blocks["supply"]
+      else
+        return nil
+      end
     end
 
-    # The "peers" API
-    def peers
-      todo "#{self}::#{__method__} UNIMPLEMENTED"
-    end
 
-    # The "signatures" API
-    def signatures
-      todo "#{self}::#{__method__} UNIMPLEMENTED"
-    end
+#{}"fee"=>10000000
 
-    # The "transactions" API
-    def transactions
-      todo "#{self}::#{__method__} UNIMPLEMENTED"
-    end
 
-    # The "transactions/unsigned" API
-    def transactions_unsigned
-      todo "#{self}::#{__method__} UNIMPLEMENTED"
+    # Get an array of all known peers.
+    def get_peers
+      peers = self.peers
     end
 
-    # The "transactions/unconfirmed" API
-    def transactions_unconfirmed
-      todo "#{self}::#{__method__} UNIMPLEMENTED"
+    # Get the number of all known peers.
+    def get_peer_count
+      peers = self.get_peers
+      if not peers.nil?
+        count = peers.count
+      else
+        count = 0
+      end
     end
 
-    # The "transactions/unprocessed" API
-    def transactions_unprocessed
-      todo "#{self}::#{__method__} UNIMPLEMENTED"
+    # Get an array of all connected peers.
+    def get_connected_peers
+      filter_by_state = { :state => 2 }
+      connected = self.peers filter_by_state
     end
 
-    # The "votes" API
-    def votes
-      todo "#{self}::#{__method__} UNIMPLEMENTED"
+    # Get an array of all disconnected peers.
+    def get_disconnected_peers
+      filter_by_state = { :state => 1 }
+      disconnected = self.peers filter_by_state
     end
 
-    # The "voters" API
-    def voters
-      todo "#{self}::#{__method__} UNIMPLEMENTED"
+    # Get an array of all banned peers.
+    def get_banned_peers
+      filter_by_state = { :state => 0 }
+      banned = self.peers filter_by_state
     end
 
     # Handles unimplemented methods

data/lib/lisk/client.rb

@@ -9,7 +9,7 @@ module Lisk
   class Client
 
     # Host and port of the API endpoint.
-    attr_accessor :host, :port, :ssl
+    attr_accessor :host, :port, :ssl, :active
 
     # Initializes the Lisk HTTP client and defaults to localhost port 7000.
     def initialize host = "127.0.0.1", port = 7000
@@ -17,8 +17,10 @@ module Lisk
       @port = port
       @ssl = false
       if self.is_alive?
+        @active = true
         return self
       else
+        @active = false
         return nil
       end
     end
@@ -30,11 +32,14 @@ module Lisk
         @port = port
         @ssl = false
         if self.is_alive?
+          @active = true
           return self
         else
+          @active = false
           return nil
         end
       else
+        @active = false
         return nil
       end
     end
@@ -43,7 +48,7 @@ module Lisk
     # Returns true if block was received in the past 120 seconds.
     def is_alive?
       connected = self.query_get "loader/status/ping"
-      connected["success"]
+      @active = connected["success"]
     end
 
     # Handles GET requests to the given Lisk Core API endpoint
@@ -58,12 +63,16 @@ module Lisk
           end
           request = ::Net::HTTP::Get.new uri
           response = node.request request
+          @active = true
           result = JSON::parse response.body
         rescue Timeout::Error => e
+          @active = false
           p "Can't connect to the Lisk node: Timeout!"
         rescue Errno::EHOSTUNREACH => e
+          @active = false
           p "Can't connect to the Lisk node: Host Unreachable!"
         rescue Errno::ECONNREFUSED => e
+          @active = false
           p "Can't connect to the Lisk node: Connection Refused!"
         end
       end
@@ -80,12 +89,16 @@ module Lisk
           request = ::Net::HTTP::Post.new uri, header
           request.body = params.to_json
           response = node.request request
+          @active = true
           result = JSON::parse response.body
         rescue Timeout::Error => e
+          @active = false
           p "Can't connect to the Lisk node: Timeout!"
         rescue Errno::EHOSTUNREACH => e
+          @active = false
           p "Can't connect to the Lisk node: Host Unreachable!"
         rescue Errno::ECONNREFUSED => e
+          @active = false
           p "Can't connect to the Lisk node: Connection Refused!"
         end
       end
@@ -103,12 +116,16 @@ module Lisk
           request = ::Net::HTTP::Put.new uri, header
           request.body = params.to_json
           response = node.request request
+          @active = true
           result = JSON::parse response.body
         rescue Timeout::Error => e
+          @active = false
           p "Can't connect to the Lisk node: Timeout!"
         rescue Errno::EHOSTUNREACH => e
+          @active = false
           p "Can't connect to the Lisk node: Host Unreachable!"
         rescue Errno::ECONNREFUSED => e
+          @active = false
           p "Can't connect to the Lisk node: Connection Refused!"
         end
       end

data/lib/lisk/delegate.rb

@@ -0,0 +1,55 @@
+module Lisk
+
+  class Delegate
+
+    attr_accessor :api
+    attr_accessor :delegate_name
+    attr_accessor :address
+    attr_accessor :public_key
+    attr_accessor :secret
+    attr_accessor :secret_secondary
+    attr_accessor :registered
+
+    def initialize api, delegate_name
+      @api = api
+      @delegate_name = delegate_name
+      delegate = @api.delegates_get_by_name delegate_name
+      if delegate.nil?
+        @registered = false
+      else
+        @registered = true
+        @address = delegate["address"]
+        @public_key = delegate["publicKey"]
+      end
+    end
+
+    def is_registered?
+      return registered
+    end
+
+    def set_secrets secret, second_secret = nil
+      @secret = secret
+      @secret_secondary = second_secret
+    end
+
+    def register
+      if not self.is_registered?
+        delegate = {}
+        delegate[:username] = @delegate_name
+        if not @secret_secondary.nil?
+          delegate[:secondSecret] = @secret_secondary
+        end
+        if not @secret.nil?
+          delegate[:secret] = @secret
+          registration = api.delegates_put delegate
+          return registration
+        else
+          return false
+        end
+      else
+        return false
+      end
+    end
+
+  end
+end

data/lib/lisk/legacy.rb

@@ -1,7 +1,7 @@
 # The Lisk API Ruby wrapper gem.
 module Lisk
 
-  # Implements legacy APIs of the Lisk Core pre-1.0.0 node.
+  # Implements raw legacy APIs of the Lisk Core pre-1.0.0 node.
   class Legacy
 
     # A "lisk/client" connecting to a Lisk Core API node.

data/lib/lisk/raw.rb

@@ -0,0 +1,190 @@
+# The Lisk API Ruby wrapper gem.
+module Lisk
+
+  # Implements raw APIs of the Lisk Core node.
+  class Raw
+
+    # A "lisk/client" connecting to a Lisk Core API node.
+    attr_accessor :client
+
+    # Initializing the API with a Lisk Core API client.
+    def initialize client
+      if not client.nil?
+        @client = client
+        return self
+      else
+        return nil
+      end
+    end
+
+    #############################################
+    # https://github.com/4fryn/lisk.rb/issues/1 #
+    #############################################
+
+    # The "accounts" API
+    def accounts
+      todo "#{self}::#{__method__} UNIMPLEMENTED"
+    end
+
+    # The "blocks" API
+    def blocks
+      todo "#{self}::#{__method__} UNIMPLEMENTED"
+    end
+
+    # The "dapps" API
+    def dapps
+      todo "#{self}::#{__method__} UNIMPLEMENTED"
+    end
+
+    # The "delegates" API
+    def delegates
+      todo "#{self}::#{__method__} UNIMPLEMENTED"
+    end
+
+    # The "delegates/forgers" API
+    def delegates_forgers
+      todo "#{self}::#{__method__} UNIMPLEMENTED"
+    end
+
+    # The "delegates/forging" API
+    def delegates_forging
+      todo "#{self}::#{__method__} UNIMPLEMENTED"
+    end
+
+    # The "node/constants" API
+    def node_constants
+      todo "#{self}::#{__method__} UNIMPLEMENTED"
+    end
+
+    # The "node/status" API
+    def node_status
+      todo "#{self}::#{__method__} UNIMPLEMENTED"
+    end
+
+    # The "peers" API
+    def peers
+      todo "#{self}::#{__method__} UNIMPLEMENTED"
+    end
+
+    # The "signatures" API
+    def signatures
+      todo "#{self}::#{__method__} UNIMPLEMENTED"
+    end
+
+    # The "transactions" API
+    def transactions
+      todo "#{self}::#{__method__} UNIMPLEMENTED"
+    end
+
+    # The "transactions/unsigned" API
+    def transactions_unsigned
+      todo "#{self}::#{__method__} UNIMPLEMENTED"
+    end
+
+    # The "transactions/unconfirmed" API
+    def transactions_unconfirmed
+      todo "#{self}::#{__method__} UNIMPLEMENTED"
+    end
+
+    # The "transactions/unprocessed" API
+    def transactions_unprocessed
+      todo "#{self}::#{__method__} UNIMPLEMENTED"
+    end
+
+    # The "votes" API
+    def votes
+      todo "#{self}::#{__method__} UNIMPLEMENTED"
+    end
+
+    # The "voters" API
+    def voters
+      todo "#{self}::#{__method__} UNIMPLEMENTED"
+    end
+
+    # The "accounts" API
+    def accounts
+      todo "#{self}::#{__method__} UNIMPLEMENTED"
+    end
+
+    # The "blocks" API
+    def blocks
+      todo "#{self}::#{__method__} UNIMPLEMENTED"
+    end
+
+    # The "dapps" API
+    def dapps
+      todo "#{self}::#{__method__} UNIMPLEMENTED"
+    end
+
+    # The "delegates" API
+    def delegates
+      todo "#{self}::#{__method__} UNIMPLEMENTED"
+    end
+
+    # The "delegates/forgers" API
+    def delegates_forgers
+      todo "#{self}::#{__method__} UNIMPLEMENTED"
+    end
+
+    # The "delegates/forging" API
+    def delegates_forging
+      todo "#{self}::#{__method__} UNIMPLEMENTED"
+    end
+
+    # The "node/constants" API
+    def node_constants
+      todo "#{self}::#{__method__} UNIMPLEMENTED"
+    end
+
+    # The "node/status" API
+    def node_status
+      todo "#{self}::#{__method__} UNIMPLEMENTED"
+    end
+
+    # The "peers" API
+    def peers
+      todo "#{self}::#{__method__} UNIMPLEMENTED"
+    end
+
+    # The "signatures" API
+    def signatures
+      todo "#{self}::#{__method__} UNIMPLEMENTED"
+    end
+
+    # The "transactions" API
+    def transactions
+      todo "#{self}::#{__method__} UNIMPLEMENTED"
+    end
+
+    # The "transactions/unsigned" API
+    def transactions_unsigned
+      todo "#{self}::#{__method__} UNIMPLEMENTED"
+    end
+
+    # The "transactions/unconfirmed" API
+    def transactions_unconfirmed
+      todo "#{self}::#{__method__} UNIMPLEMENTED"
+    end
+
+    # The "transactions/unprocessed" API
+    def transactions_unprocessed
+      todo "#{self}::#{__method__} UNIMPLEMENTED"
+    end
+
+    # The "votes" API
+    def votes
+      todo "#{self}::#{__method__} UNIMPLEMENTED"
+    end
+
+    # The "voters" API
+    def voters
+      todo "#{self}::#{__method__} UNIMPLEMENTED"
+    end
+
+    # Handles unimplemented methods
+    def method_missing name, *args, &block
+      todo "#{self}::#{name} METHOD MISSING"
+    end
+
+  end
+end

data/lib/lisk/version.rb

@@ -1,3 +1,3 @@
 module Lisk
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/lisk.rb

@@ -3,9 +3,11 @@ require "todonotes"
 
 # The Lisk API Ruby wrapper gem.
 module Lisk
-  require "lisk/api"
   require "lisk/client"
   require "lisk/legacy"
+  require "lisk/raw"
+  require "lisk/api"
+  require "lisk/delegate"
 
   # Handles unimplemented methods
   def method_missing name, *args, &block

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lisk
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - 4fryn Dings
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-27 00:00:00.000000000 Z
+date: 2017-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -84,13 +84,17 @@ files:
 - bin/console
 - bin/debug
 - bin/setup
+- examples/4fryn-lisk-rb.gif
+- examples/delegates.rb
 - examples/legacy_api.rb
 - examples/payout.rb
 - examples/status.rb
 - lib/lisk.rb
 - lib/lisk/api.rb
 - lib/lisk/client.rb
+- lib/lisk/delegate.rb
 - lib/lisk/legacy.rb
+- lib/lisk/raw.rb
 - lib/lisk/version.rb
 - lisk.gemspec
 homepage: https://github.com/4fryn/lisk.rb