cita-sdk-ruby 0.20.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 191e6e673e063a855ab3d9bff925ed99d88cb211d3a6600fbead317c5059ca87
+  data.tar.gz: 320fb2ce7b5b1fdec68fa20f1b68d171599bf682caaaa539e4f1d3b18750a57b
+SHA512:
+  metadata.gz: cda5eb17355ba2889eeb10faed7cd1755f62a7c19fd0981b03447c2dacbb04ed009488dcacaeff314bf59dce6cee241d8493b76551f2345e6afc793bb3fb33a5
+  data.tar.gz: eb19a729cb48b60b23890925955b5839c7f2ac31983e9de6e4779eac22fadd8621d8cd264ef2974c6b833663d1c789b4f1f987ea6a3804f44551fdce6c40e6a3

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+*.gem

data/.gitmodules

@@ -0,0 +1,6 @@
+[submodule "cita-proto"]
+	path = cita-proto
+	url = https://github.com/cryptape/cita-proto.git
+[submodule "secp256k1"]
+	path = secp256k1
+	url = https://github.com/bitcoin-core/secp256k1.git

data/.pryrc

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "awesome_print"
+AwesomePrint.pry!

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,103 @@
+AllCops:
+  TargetRubyVersion: 2.4
+  Exclude:
+  - 'spec/**/*'
+  - 'bin/*'
+  - 'Rakefile'
+  - 'Gemfile'
+  - 'Gemfile.lock'
+  - 'cita.gemspec'
+  - 'cita-proto/**/*'
+  - 'secp256k1/**/*'
+  - 'lib/cita/protos/**/*'
+
+Bundler/OrderedGems:
+  Enabled: false
+
+Layout/AccessModifierIndentation:
+  EnforcedStyle: indent
+
+Layout/EmptyLineAfterMagicComment:
+  Enabled: false
+
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: space
+
+Metrics/AbcSize:
+  Max: 100
+
+Metrics/ClassLength:
+  CountComments: false
+  Max: 300
+
+Metrics/CyclomaticComplexity:
+  Max: 25
+
+Metrics/LineLength:
+  AllowURI: true
+  Enabled: false
+
+Metrics/MethodLength:
+  CountComments: false
+  Max: 55
+
+Metrics/ModuleLength:
+  CountComments: false
+  Max: 200
+
+Metrics/ParameterLists:
+  Max: 5
+  CountKeywordArgs: true
+
+Metrics/PerceivedComplexity:
+  Max: 20
+
+Naming/MemoizedInstanceVariableName:
+  Enabled: false
+
+Style/CollectionMethods:
+  Enabled: true
+  PreferredMethods:
+    find_all: 'select'
+
+Style/DoubleNegation:
+  Enabled: true
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+
+Style/GuardClause:
+  Enabled: false
+
+Style/Lambda:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%i': '()'
+    '%w': '()'
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Naming/AccessorMethodName:
+  Enabled: false
+
+Metrics/BlockLength:
+  CountComments: false
+  Max: 25
+  ExcludedMethods:
+  - refine
+  - included
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+  SupportedStyles:
+  - single_quotes
+  - double_quotes
+  # If `true`, strings which span multiple lines using `\` for continuation must
+  # use the same type of quotes on each line.
+  ConsistentQuotesInMultiline: false

data/.travis.yml

@@ -0,0 +1,16 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.5
+  - 2.5.3
+before_install: gem install bundler -v 1.16.6
+install:
+  - cd secp256k1 && ./autogen.sh && ./configure --enable-module-recovery --enable-experimental --enable-module-ecdh && make && sudo make install && cd ..
+  - bundle install
+script:
+  - bundle exec rake
+
+after_success:
+  - bash <(curl -s https://codecov.io/bash)

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 classicalliu@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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in cita.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,95 @@
+PATH
+  remote: .
+  specs:
+    cita-sdk-ruby (0.20.0)
+      activesupport (~> 5.2.1)
+      ciri-crypto (= 0.1.1)
+      faraday (~> 0.15.3)
+      google-protobuf (~> 3.6)
+      web3-eth (~> 0.2.16)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    ast (2.4.0)
+    awesome_print (1.8.0)
+    bitcoin-secp256k1 (0.4.0)
+      ffi (>= 1.9.10)
+    ciri-crypto (0.1.1)
+      bitcoin-secp256k1 (~> 0.4.0)
+      ciri-utils (~> 0.2.0)
+    ciri-utils (0.2.2)
+      digest-sha3 (~> 1.1.0)
+    coderay (1.1.2)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    digest-sha3 (1.1.0)
+    faraday (0.15.3)
+      multipart-post (>= 1.2, < 3)
+    ffi (1.9.25)
+    google-protobuf (3.6.1-universal-darwin)
+    i18n (1.1.1)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.1)
+    method_source (0.9.0)
+    minitest (5.11.3)
+    multipart-post (2.0.0)
+    parallel (1.12.1)
+    parser (2.5.1.2)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rlp (0.7.3)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.59.2)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.10.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.4.0)
+    web3-eth (0.2.16)
+      digest-sha3 (~> 1.1.0)
+      rlp (~> 0.7.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print (~> 1.8)
+  bundler (~> 1.16)
+  cita-sdk-ruby!
+  pry (~> 0.11)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.59)
+
+BUNDLED WITH
+   1.16.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Cryptape
+
+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,106 @@
+# cita-sdk-ruby
+
+[![Build Status](https://travis-ci.org/cryptape/cita-sdk-ruby.svg?branch=master)](https://travis-ci.org/cryptape/cita-sdk-ruby)
+[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](https://www.rubydoc.info/github/cryptape/cita-sdk-ruby/master)
+
+CITA Ruby SDK
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cita-sdk-ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cita-sdk-ruby
+
+## Usage
+
+See `keccak256`, `to_hex` and other utils methods in `CITA::Utils` module
+
+RPC calls [RPC list](https://docs.nervos.org/cita/#/rpc_guide/rpc)
+```ruby
+cita = CITA::Client.new("your url")
+
+cita.rpc.block_number
+cita.rpc.get_block_by_number("0x0", true)
+# or
+cita.rpc.getBlockByNumber("0x0", true) 
+```
+
+sign and unsign
+```ruby
+# make a Transaction object first
+transaction = CITA::Transaction.new(
+  to: "8ff0f5b85fba9a6429e2e256880291774f8e224f",
+  nonce: "e4f195c409fe47c58a624de37c730679",
+  quota: 30000,
+  valid_until_block: 1882078,
+  data: "",
+  value: "0x3e8",
+  chain_id: "1",
+  version: 1
+)
+
+# sign transaction with your private key
+content = CITA::TransactionSigner.encode(transaction, "you private key")
+
+# you can unsign content by `decode` method
+CITA::TransactionSigner.decode(content) 
+```
+
+send transaction
+```ruby
+cita.rpc.send_transaction(transaction, private_key)
+```
+
+transfer tokens
+```ruby
+cita.rpc.transfer(to: "to address", value: 1000, private_key)
+```
+
+contract
+```ruby
+contract = cita.contract_at(abi, contract_address)
+# for RPC call (constant functions)
+response = contract.call_func(method: :symbol)
+# for RPC sendTransaction
+response = contract.send_func(tx: tx, private_key: private_key, method: :transfer, params: [address, tokens])
+```
+
+## CHANGELOG
+
+### v0.1
+
+* supports CITA 0.19
+
+### v0.2
+ 
+* supports CITA 0.20 and 0.19
+* set default transaction version to 1
+* update TransactionSinger.decode output type to hash with symbol keys
+* parse TransactionSinger.decode hash value to hex string if it's bytes.
+
+### v0.20.0
+
+* rename to `cita-sdk-ruby`
+* rename top module name to `CITA`
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/cryptape/cita-sdk-ruby. 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 cita-sdk-ruby project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/cryptape/cita-sdk-ruby/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cita"
+
+# 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/cita.gemspec

@@ -0,0 +1,47 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "cita/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "cita-sdk-ruby"
+  spec.version       = CITA::VERSION
+  spec.authors       = ["classicalliu"]
+  spec.email         = ["classicalliu@gmail.com"]
+
+  spec.summary       = %q{Ruby CITA SDK}
+  spec.description   = %q{Ruby CITA SDK for signature and rpc call}
+  spec.homepage      = "https://github.com/cryptape/cita-sdk-ruby"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.11"
+  spec.add_development_dependency "awesome_print", "~> 1.8"
+  spec.add_development_dependency "rubocop", "~> 0.59"
+
+  spec.add_dependency "google-protobuf", "~> 3.6"
+  spec.add_dependency "ciri-crypto", "0.1.1"
+  spec.add_dependency "faraday", "~> 0.15.3"
+  spec.add_dependency "activesupport", "~> 5.2.1"
+  spec.add_dependency "web3-eth", "~> 0.2.16"
+end

data/lib/cita/address.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module CITA
+  class Address
+    # @param str [String]
+    def initialize(str)
+      @addr = Utils.remove_hex_prefix(str)
+    end
+
+    # get address with `0x` prefix
+    #
+    # @return [String] address hex string with `0x` prefix
+    def addr
+      Utils.add_hex_prefix(@addr)
+    end
+
+    # compare address is equal
+    #
+    # @param other [CITA::Address]
+    def ==(other)
+      addr.casecmp(other.addr)
+    end
+
+    # TODO: valid? method that check address is valid?
+  end
+end

data/lib/cita/client.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module CITA
+  class Client
+    attr_reader :url, :rpc, :http, :contract
+
+    def initialize(url)
+      @url = url
+      @rpc = RPC.new(url)
+      @http = rpc.http
+    end
+
+    def contract_at(abi, address)
+      @contract = Contract.new(abi, url, address, rpc)
+    end
+  end
+end

data/lib/cita/contract.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require "web3/eth"
+
+module CITA
+  class Contract
+    include Web3::Eth::Abi::AbiCoder
+
+    attr_reader :url, :abi, :address, :rpc
+
+    # @param abi [String | Hash] json string or hash
+    # @param url [String] chain url
+    # @param address [String] contract address
+    # @param rpc [CITA::RPC]
+    #
+    # @return [void]
+    def initialize(abi, url, address = nil, rpc = nil)
+      @url = url
+      @abi = abi
+      @address = address
+      @rpc = rpc
+      parse_url
+    end
+
+    # wrapper Web3::Eth abi encoder for encoded data
+    #
+    # @param method_name [Symbol | String] method name you call
+    # @param *params [Array] method params you call
+    #
+    # @return [String] hex data
+    def function_data(method_name, *params)
+      data, _output_types = function_data_with_ot(method_name, *params)
+      data
+    end
+
+    # call contract functions by rpc `call` method
+    #
+    # @param method [Symbol | String] the method name you call
+    # @param params [Array] the method params you call
+    # @param tx [Hash] see rpc `call` doc for more info
+    #
+    # @return [any]
+    def call_func(method:, params: [], tx: {}) # rubocop:disable Naming/UncommunicativeMethodParamName
+      data, output_types = function_data_with_ot(method, *params)
+      resp = @rpc.call_rpc(:call, params: [tx.merge(data: data, to: address), "latest"])
+      result = resp["result"]
+
+      data = [Utils.remove_hex_prefix(result)].pack("H*")
+      return if data.nil?
+
+      re = decode_abi output_types, data
+      re.length == 1 ? re.first : re
+    end
+
+    # call contract functions by sendRawTransaction
+    #
+    # @param tx [Hash | CITA::Transaction]
+    # @param private_key [String] hex string
+    # @param method [Symbol | String] method name you call
+    # @param *params [Array] your params
+    #
+    # @return [nil | Hash] {hash: "", status: ""}, sendRawTransactionResult
+    def send_func(tx:, private_key:, method:, params: []) # rubocop:disable Naming/UncommunicativeMethodParamName
+      data, _output_types = function_data_with_ot(method, *params)
+      transaction = if tx.is_a?(Hash)
+                      Transaction.from_hash(tx)
+                    else
+                      tx
+                    end
+      transaction.data = data
+      resp = @rpc.send_transaction(transaction, private_key)
+
+      resp&.dig("result")
+    end
+
+    private
+
+    # parse url to host, port and scheme
+    def parse_url
+      uri = URI.parse(@url)
+      @host = uri.host
+      @port = uri.port
+      @scheme = uri.scheme
+    end
+
+    # is this url in https?
+    def https?
+      @scheme == "https"
+    end
+
+    # wrapper Web3::Eth abi encoder for encoded data
+    def function_data_with_ot(method_name, *params)
+      web3 = Web3::Eth::Rpc.new host: @host, port: @port, connect_options: { use_ssl: https? }
+      contract = web3.eth.contract(abi).at(address)
+      contract.function_data(method_name, *params)
+    end
+  end
+end