neb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ab59927760b6f667af8bb29812e60751cd73eafbaac68c715126f097c4d6def8
+  data.tar.gz: 021746fb0d659d33f032c97ab0296c3c280b011569e59b408a46cefd3d8a4d08
+SHA512:
+  metadata.gz: 35cb95f930fb38bf471a359da1ce6adb4cf8c1505a7a3347df7752ef288a19bea3cedbafc6dbf6dcc4145d05cad92d0205c5127a152152f678a00b3982a4ab52
+  data.tar.gz: 56e40fd005edc6fd156f1444b13d7724e1e6a831d4e0ec657da9910a2954e69a02155afdbae9a856f1931eb1750401455df6aa532e46b0ce5cf027aee5fa7657

data/.gitignore

@@ -0,0 +1,62 @@
+
+# Created by https://www.gitignore.io/api/ruby
+
+### Ruby ###
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+# /tmp/
+/log
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+.tags*
+
+tmp/*.json
+# End of https://www.gitignore.io/api/ruby
+
+.ruby-version
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.7
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at neverlandxy.naix@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+if ENV['USE_OFFICIAL_GEM_SOURCE']
+  source 'https://rubygems.org'
+else
+  source 'https://gems.ruby-china.org'
+end
+
+git_source(:github) do |repo_name|
+  repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include?("/")
+  "https://github.com/#{repo_name}.git"
+end
+
+# Specify your gem's dependencies in neb.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,9 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+guard :minitest do
+  # with Minitest::Unit
+  watch(%r{^test/(.*)\/?test_(.*)\.rb$})
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+  watch(%r{^test/test_helper\.rb$})      { 'test' }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Spirit
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,123 @@
+# Nebulas Ruby API
+
+This is the Nebulas compatible Ruby API. Users can use it in Ruby and Rails. This ruby library also support API for our Repl console. Users can sign/send transactions and deploy/call smart contract with it. [neb.rb](https://github.com/NaixSpirit/neb.rb)
+
+## Install Secp256k1
+
+https://github.com/cryptape/ruby-bitcoin-secp256k1
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'neb'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install neb
+
+## Usage
+
+
+### API Example
+```ruby
+Neb.configure(host: 'https://testnet.nebulas.io')
+client = Neb::Client.new
+
+resp = client.api.get_neb_state
+resp.code     # => 200
+resp.success? # => true
+resp.result   # =>  {:chain_id=>100, :tail=>"xxxx", :lib=>"xxxx", :height=>"1085", :protocol_version=>"/neb/1.0.0", :synchronized=>false, :version=>"1.0.1"}
+
+resp = client.admin.accounts
+resp.code     # => 200
+resp.success? # => true
+resp.result   # => {:addresses=>["n1FF1nz6tarkDVwWQkMnnwFPuPKUaQTdptE", "n1FNj5aZhKFeFJ8cQ26Lvsr84NDvNSVRu67"]}
+```
+
+### Account Example
+
+```ruby
+# Create a new account with random private_key
+account = Neb::Account.create
+account = Neb::Account.create(password: YOUR_PASSOWRD)
+
+account.private_key         # => "b5e53a1582a48d243ebd478a7722d1bfea4805ff7c1da4cc7084043e8263c5a8"
+account.public_key          # => "35a80ac8a27e2bf072ae84b2cb019e3af0c06547ad939fab1c6d12f713d26ae178d1fd6677aef3e6e94bc7cc1a39f4ca80fc2409a5ef59f97ee55dbd6efc7714"
+account.address             # => "n1NfnKqgXBixjiDkJZDSVwqf7ps5roGwFyJ"
+account.password = "123456" # or account.set_password("123456")
+account.to_key              # => {:version=>4, :id=>"becde267-902e-4f23-ac01-53a4ba6edac7", :address=>"n1VYLxkZoehWEWPHxi351HgZ2R8Hfn2DGpa" ....}
+account.to_key_file(file_path: "/tmp/mykey.json")
+
+# Create a new account from exist private_key
+account = Neb::Account.new(private_key: YOUR_PRIVATE_KEY)
+account = Neb::Account.new(private_key: YOUR_PRIVATE_KEY, password: YOUR_PASSOWRD)
+
+# Restore account from key
+account = Neb::Account.from_key(key: YOUR_KEY, password: YOUR_PASSOWRD)
+
+# Restore account from a key file
+account = Neb::Account.from_key_file(key_file: YOUR_KEY_FILE, password: YOUR_PASSOWRD)
+```
+
+### Transaction Example
+
+```ruby
+Neb.configure(host: 'https://testnet.nebulas.io')
+client = Neb::Client.new
+
+account = Neb::Account.new(private_key: YOUR_KEY)
+tx = Neb::Transaction.new(
+  chain_id: 1,
+  from_account: account,
+  to_address: 'n1SAeQRVn33bamxN4ehWUT7JGdxipwn8b17',
+  value: 10,
+  nonce: 1,
+  gas_price: 1000000,
+  gas_limit: 2000000
+)
+
+tx.sign_hash
+
+resp = client.api.send_raw_transaction(data: tx.to_proto_str)
+resp.code     # => 200
+resp.success? # => true
+resp.result   # => {:txhash=>"8524384dce7e122bfd007e0ba465e597d821e22db6d563b87dfc55d703fb008c", :contract_address=>""}
+
+resp = client.api.get_transaction_receipt(hash: "8524384dce7e122bfd007e0ba465e597d821e22db6d563b87dfc55d703fb008c")
+resp.result[:status] # => 1
+
+client.api.get_account_state(address: 'n1SAeQRVn33bamxN4ehWUT7JGdxipwn8b17').result # => {:balance=>"10", :nonce=>"0", :type=>87}
+```
+
+# Documentation
+
+## API list
+
+[Ruby Client API list](https://github.com/NaixSpirit/neb.rb/blob/master/lib/neb/client/api.rb)
+
+[Ruby Admin API list](https://github.com/NaixSpirit/neb.rb/blob/master/lib/neb/client/admin.rb)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/NaixSpirit/neb.rb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Neb project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/NaixSpirit/neb.rb/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "neb"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start
+
+# require "irb"
+# IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/neb/account.rb

@@ -0,0 +1,55 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+module Neb
+  class Account
+    attr_reader :private_key_obj, :public_key_obj, :address_obj
+    attr_accessor :password
+
+    alias_method :set_password, :password=
+
+    def initialize(private_key:, password: nil)
+      @private_key_obj = PrivateKey.new(private_key)
+      @public_key_obj  = @private_key_obj.to_pubkey_obj
+      @address_obj     = @public_key_obj.to_address_obj
+      @password        = password
+    end
+
+    class << self
+      def create(password: nil)
+        new(private_key: PrivateKey.random.to_s, password: password)
+      end
+
+      def from_key(key:, password:)
+        new(private_key: Key.decrypt(key, password), password: password)
+      end
+
+      def from_key_file(key_file:, password:)
+        from_key(key: File.read(key_file), password: password)
+      end
+    end
+
+    def private_key
+      @private_key_obj.to_s
+    end
+
+    def public_key
+      @public_key_obj.to_s
+    end
+
+    def address
+      @address_obj.to_s
+    end
+
+    def to_key
+      raise ArgumentError.new("must set_password first") if password.blank?
+      Key.encrypt(address, private_key, password)
+    end
+
+    def to_key_file(file_path: nil)
+      file_path = Neb.root.join('tmp', "#{address}.json") if file_path.blank?
+      File.open(file_path, 'w+') { |f| f << Utils.to_json(to_key) }
+      file_path.to_s
+    end
+  end
+end

data/lib/neb/address.rb

@@ -0,0 +1,90 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+module Neb
+  class Address
+    attr_reader :raw
+
+    def initialize(raw)
+      @raw = raw
+    end
+
+    def value
+      @value ||= decode
+    end
+
+    def to_s
+      encode(:hex_extended)
+    end
+
+    def checksum
+      Utils.keccak256(encode(:bin))[0, 4]
+    end
+
+    def encode(fmt)
+      case fmt
+      when :decimal
+        raw
+      when :bin
+        BaseConvert.encode(value, 256, 22)
+      when :bin_extended
+        "#{BaseConvert.encode(value, 256, 22)}#{checksum}"
+      when :hex
+        Utils.binary_to_base58(BaseConvert.encode(value, 256, 22))
+      when :hex_extended
+        Utils.binary_to_base58("#{BaseConvert.encode(value, 256, 22)}#{checksum}")
+      else
+        raise ArgumentError, "invalid format: #{fmt}"
+      end
+    end
+
+    def decode(fmt = nil)
+      fmt ||= format
+
+      case fmt
+      when :decimal
+        raw
+      when :bin
+        BaseConvert.decode(raw, 256)
+      when :bin_extended
+        BaseConvert.decode(raw[0, 22], 256)
+      when :hex
+        BaseConvert.decode(Utils.base58_to_binary(raw), 256)
+      when :hex_extended
+        BaseConvert.decode(Utils.base58_to_binary(raw)[0, 22], 256)
+      else
+        raise FormatError, "Invalid format!"
+      end
+    end
+
+    def format
+      return :decimal if raw.is_a?(Numeric)
+      return :bin if raw.size == 22
+      return :bin_extended if raw.size == 26
+      return :hex if raw.size == 30
+      return :hex_extended if raw.size == 35
+    end
+
+    class << self
+
+      def is_validate?(address)
+        addr = Utils.base58_to_binary(address)
+        return false if addr.length != Constant::ADDRESS_LENGTH
+
+        preifx = BaseConvert.decode(addr[0], 256)
+        type   = BaseConvert.decode(addr[1], 256)
+
+        return false if preifx != Constant::ADDRESS_PREFIX
+        return false if type != Constant::NORMAL_TYPE && type != Constant::CONTRACT_TYPE
+
+        content  = addr[0..21]
+        checksum = addr[-4..-1]
+
+        ActiveSupport::SecurityUtils.secure_compare(
+          Utils.keccak256(content)[0, 4], checksum
+        )
+      end
+    end
+
+  end
+end

data/lib/neb/base_convert.rb

@@ -0,0 +1,57 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+module Neb
+  #
+  # @see https://github.com/cryptape/ruby-ethereum/blob/master/lib/ethereum/base_convert.rb
+  #
+  module BaseConvert
+
+    BaseSymbols = {
+      2   => '01'.freeze,
+      10  => '0123456789'.freeze,
+      16  => '0123456789abcdef'.freeze,
+      32  => 'abcdefghijklmnopqrstuvwxyz234567'.freeze,
+      58  => '123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz'.freeze,
+      256 => 256.times.map {|i| i.chr }.join.freeze
+    }.freeze
+
+    extend self
+
+    def symbols(base)
+      BaseSymbols[base] or raise ArgumentError, "invalid base!"
+    end
+
+    def convert(s, from, to, minlen = 0)
+      return Utils.lpad(s, symbols(from)[0], minlen) if from == to
+      encode(decode(s, from), to, minlen)
+    end
+
+    def encode(v, base, minlen = 0)
+      syms = symbols(base)
+
+      result = ''
+      while v > 0
+        result = syms[v % base] + result
+        v /= base
+      end
+
+      Utils.lpad(result, syms[0], minlen)
+    end
+
+    def decode(s, base)
+      syms = symbols(base)
+      s = s.downcase if base == 16
+
+      result = 0
+      while s.size > 0
+        result *= base
+        result += syms.index(s[0])
+        s = s[1..-1]
+      end
+
+      result
+    end
+
+  end
+end

data/lib/neb/client/admin.rb

@@ -0,0 +1,95 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+require_relative "./request"
+require_relative "./response"
+
+module Neb
+  class Client
+    class Admin
+      attr_reader :host, :api_version, :endpoint
+
+      def initialize
+        @host        = CONFIG[:host]
+        @api_version = CONFIG[:api_version]
+        @endpoint    = CONFIG[:admin_endpoint]
+      end
+
+      def node_info
+        send_request(:get, "/nodeinfo")
+      end
+
+      def accounts
+        send_request(:get, "/accounts")
+      end
+
+      def new_account(passphrase:)
+        send_request(:post, "/account/new", passphrase: passphrase)
+      end
+
+      def unlock_account(address:, passphrase:, duration: '30000000000')
+        params = {
+          address:    address,
+          passphrase: passphrase,
+          duration:   duration
+        }
+        send_request(:post, "/account/unlock", params)
+      end
+
+      def lock_account(address:)
+        send_request(:post, "/account/lock", address: address)
+      end
+
+      def send_transaction(from:, to:, value:, nonce:, gas_price: 1_000_000, gas_limit: 20_000)
+        params = {
+          from:      from,
+          to:        to,
+          value:     value.to_i,
+          nonce:     nonce.to_i,
+          gas_price: gas_price.to_i,
+          gas_limit: gas_limit.to_i
+        }
+        send_request(:post, "/transaction", params)
+      end
+
+      def sign_hash(address:, hash:, alg: 1)
+        send_request(:post, "/sign/hash", address: address, hash: hash, alg: alg)
+      end
+
+      def sign_transaction_with_passphrase(from:, to:, value:, nonce:, gas_price: 1_000_000, gas_limit: 20_000,
+                                           type:, contract:, binary:, passphrase:)
+        params = {
+          transaction: {
+            from:      from,
+            to:        to,
+            value:     value.to_i,
+            nonce:     nonce.to_i,
+            gas_price: gas_price.to_i,
+            gas_limit: gas_limit.to_i,
+            type:      type,
+            contract:  contract,
+            binary:    binary
+          },
+          passphrase:  passphrase
+        }
+
+        send_request(:post, "/transactionWithPassphrase", params)
+      end
+
+      def start_pprof(listen:)
+        send_request(:post, "/pprof", listen: listen)
+      end
+
+      def get_config
+        send_request(:get, "/getConfig")
+      end
+
+      private
+
+      def send_request(action, url, payload = {})
+        request_url = host + api_version + endpoint + url
+        Request.new(action, request_url, payload).execute
+      end
+    end
+  end
+end