iost_sdk 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d0ba04a338a8f5867fc9f2e67972aef668c6cfd82f21ff03f3ebc3cc2366b1f1
+  data.tar.gz: '069a286d08b085e971a37b608875be1e11fb09e123759bc6bf0e122ed21ac3fb'
+SHA512:
+  metadata.gz: 9c2b65bc592070cb2b943b2aaf6452b42e3b0d91176330fd108604d823af0f61d051f52d03ca2e92cb0b5b1044515dab0ea0c9513289667aca9e43055b3320d5
+  data.tar.gz: 0cdaa59f203f23b3694b9a8cfebce19da9740f6a52ed3543da58fa886a7c26d47db4513157e880628c79f245a3451a961e7789498b8bbcf2d8e1bca1ff7f5c99

data/lib/iost_sdk/crypto.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+module IOSTSdk
+  module Crypto
+    require 'btcruby'
+    require 'ed25519'
+    require 'base58'
+    require 'sha3'
+
+    KEY_ALGOS = {
+      Secp256k1: 'secp256k1',
+      Ed25519: 'ED25519'
+    }.freeze
+
+    def self.key_algos
+      KEY_ALGOS
+    end
+
+    # Create an instance of KeyPair by generating a brand new pair of public-private keys
+    #
+    # @param algo [String] the algorithm should be used to generate the new key pair
+    # @return an instance of +KeyPair+
+    def self.new_keypair(algo:)
+      raise ArgumentError.new("Invalid keypair algo: #{algo}") unless Set.new(KEY_ALGOS.values).include?(algo)
+
+      public_key, private_key = if algo == KEY_ALGOS[:Secp256k1]
+                                  p_key = BTC::Key.random
+                                  [p_key.public_key, p_key.private_key]
+                                elsif algo == KEY_ALGOS[:Ed25519]
+                                  private_key = Ed25519::SigningKey.generate
+                                  public_key = private_key.verify_key
+
+                                  [public_key, private_key]
+                                end
+      KeyPair.new(algo: algo, public_key: public_key, private_key: private_key)
+    end
+
+    # Create an instance of KeyPair from a +private_key_hex+ in a given +algo+
+    #
+    # @param algo [String] the algorithm used to generate the key pair
+    # @param encoded_private_key [String] the Base58 encoded string of an existing private key
+    # @return an instance of +KeyPair+
+    def self.keypair_from_private_key(algo:, encoded_private_key:)
+      raise ArgumentError.new("Invalid algo: #{algo}") unless Set.new(KEY_ALGOS.values).include?(algo)
+
+      public_key, private_key = if algo == KEY_ALGOS[:Secp256k1]
+                                  p_key = BTC::Key.new(
+                                    private_key: Base58.base58_to_binary(encoded_private_key, :bitcoin)
+                                  )
+                                  [p_key.public_key, p_key.private_key]
+                                elsif algo == KEY_ALGOS[:Ed25519]
+                                  private_key = Ed25519::SigningKey.new(
+                                    Base58.base58_to_binary(encoded_private_key, :bitcoin)
+                                  )
+                                  public_key = private_key.verify_key
+
+                                  [public_key, private_key]
+                                end
+
+      KeyPair.new(algo: algo, public_key: public_key, private_key: private_key)
+    end
+
+    # Create an instance of KeyPair from an +Ed25519+ keypair string
+    #
+    # @param encoded_kaypair [String] a Base58 encoded Ed25519 keypair string
+    # @return an instance of KeyPair
+    def self.from_keypair(encoded_keypair:)
+      private_key = Ed25519::SigningKey.from_keypair(
+        Base58.base58_to_binary(encoded_keypair, :bitcoin)
+      )
+
+      KeyPair.new(
+        algo: IOSTSdk::Crypto::KEY_ALGOS[:Ed25519],
+        public_key: private_key.verify_key,
+        private_key: private_key
+      )
+    end
+
+    class KeyPair
+      attr_reader :algo
+
+      # Create an instance of KeyPair
+      #
+      # @param algo [String] the algorithm used to generate the key pair
+      # @param public_key [Ed25519::VerifyKey|OpenSSL::PKey::EC::Point] an instance of the public key
+      # @param private_key [Ed25519::SigningKey|OpenSSL::BN] an instance of the private key
+      # @return an instance of KeyPair
+      def initialize(algo:, public_key:, private_key:)
+        @algo = algo
+        @public_key = public_key
+        @private_key = private_key
+      end
+
+      def value
+        Base58.binary_to_base58(@private_key.keypair, :bitcoin) if
+          @algo == IOSTSdk::Crypto.key_algos[:Ed25519]
+      end
+
+      def public_key
+        Base58.binary_to_base58(public_key_raw, :bitcoin)
+      end
+
+      def public_key_raw
+        if @algo == IOSTSdk::Crypto.key_algos[:Secp256k1]
+          # @public_key is in bytes already
+          @public_key
+        elsif @algo == IOSTSdk::Crypto.key_algos[:Ed25519]
+          @public_key.to_bytes
+        end
+      end
+
+      def private_key
+        Base58.binary_to_base58(private_key_raw, :bitcoin)
+      end
+
+      def private_key_raw
+        if @algo == IOSTSdk::Crypto.key_algos[:Secp256k1]
+          # @private_key is in bytes already
+          @private_key
+        elsif @algo == IOSTSdk::Crypto.key_algos[:Ed25519]
+          @private_key.to_bytes
+        end
+      end
+
+      def id
+        public_key
+      end
+
+      def sign(message:)
+        if @algo == IOSTSdk::Crypto.key_algos[:Secp256k1]
+          p_key = BTC::Key.new(private_key: @private_key)
+          der_signature = p_key.ecdsa_signature(message)
+          decoded_der = OpenSSL::ASN1.decode(der_signature)
+          decoded_der.value
+                     .map { |v| v.value.to_s(2) }
+                     .flatten
+                     .join
+        elsif @algo == IOSTSdk::Crypto.key_algos[:Ed25519]
+          @private_key.sign(message)
+        end
+      end
+    end
+  end
+end

data/lib/iost_sdk/errors.rb

@@ -0,0 +1,10 @@
+module IOSTSdk
+  module Errors
+    class InvalidModelDataError < StandardError
+      def initialize(class_name, expected, actual)
+        @message = "Model data for #{class_name} is invalid. Expecting attribute names: #{expected}, actual: #{actual}"
+        super(@message)
+      end
+    end
+  end
+end

data/lib/iost_sdk/http/client.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'httparty'
+require 'iost_sdk/models/query/signed_transaction'
+require 'iost_sdk/http/http_request_error'
+require 'iost_sdk/string'
+
+module IOSTSdk
+  module Http
+    class Client
+      # key: method name
+      # value: an array of args
+      METHODS = {
+        get_node_info: [],
+        get_chain_info: [],
+        get_gas_ratio: [],
+        get_ram_info: [],
+        get_tx_by_hash: [:hash_value],
+        get_tx_receipt_by_tx_hash: [:hash_value],
+        get_block_by_hash: [:hash_value, :complete],
+        get_block_by_number: [:number, :complete],
+        get_account: [:name, :by_longest_chain],
+        get_token_balance: [:account_name, :token_name, :by_longest_chain],
+        get_contract: [:id, :by_longest_chain],
+        get_contract_storage: [:query],
+        get_contract_storage_fields: [:query],
+        send_tx: [:transaction, :account_name, :key_pair]
+        # TODO: exec_tx
+        # TODO: subscribe
+      }
+
+      def initialize(base_url:)
+        @base_url = base_url
+
+        METHODS.each do |method_name, method_args|
+          # require the file
+          require "iost_sdk/http/#{method_name}"
+          # define the method
+          self.class.send(:define_method, method_name) do |**args|
+            # extract match args for the call
+            raise ArgumentError.new('Invalid method arguments.') unless
+              Set.new(method_args).subset?(Set.new(args.keys))
+
+            valid_args = method_args.reduce({}) do |memo, k|
+              memo[k] = args[k]
+              memo
+            end
+            # init and invoke
+            class_name = IOSTSdk::String.camelize(method_name)
+            clazz = IOSTSdk::String.classify("IOSTSdk::Http::#{class_name}")
+            clazz.new.invoke(valid_args.merge(base_url: @base_url))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/iost_sdk/http/get_account.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module IOSTSdk
+  module Http
+    class GetAccount
+      require 'iost_sdk/models/account'
+
+      def invoke(base_url:, name:, by_longest_chain:)
+        resp = HTTParty.get("#{base_url}/getAccount/#{name}/#{by_longest_chain}")
+        raise HttpRequestError.new(status_code: resp.code, body: resp.body) unless
+          resp.code == 200
+
+        IOSTSdk::Models::Account.new.populate(model_data: JSON.parse(resp.body))
+      end
+    end
+  end
+end

data/lib/iost_sdk/http/get_block_by_hash.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module IOSTSdk
+  module Http
+    class GetBlockByHash
+      require 'iost_sdk/models/block_info'
+
+      def invoke(base_url:, hash_value:, complete:)
+        resp = HTTParty.get("#{base_url}/getBlockByHash/#{hash_value}/#{complete}")
+        raise HttpRequestError.new(status_code: resp.code, body: resp.body) unless
+          resp.code == 200
+
+        IOSTSdk::Models::BlockInfo.new.populate(model_data: JSON.parse(resp.body))
+      end
+    end
+  end
+end

data/lib/iost_sdk/http/get_block_by_number.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module IOSTSdk
+  module Http
+    class GetBlockByNumber
+      require 'iost_sdk/models/block_info'
+
+      def invoke(base_url:, number:, complete:)
+        resp = HTTParty.get("#{base_url}/getBlockByNumber/#{number}/#{complete}")
+        raise HttpRequestError.new(status_code: resp.code, body: resp.body) unless
+          resp.code == 200
+
+        IOSTSdk::Models::BlockInfo.new.populate(model_data: JSON.parse(resp.body))
+      end
+    end
+  end
+end

data/lib/iost_sdk/http/get_chain_info.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module IOSTSdk
+  module Http
+    class GetChainInfo
+      require 'iost_sdk/models/chain_info'
+
+      def invoke(base_url:)
+        resp = HTTParty.get("#{base_url}/getChainInfo")
+        raise HttpRequestError.new(status_code: resp.code, body: resp.body) unless
+          resp.code == 200
+
+        IOSTSdk::Models::ChainInfo.new.populate(model_data: JSON.parse(resp.body))
+      end
+    end
+  end
+end

data/lib/iost_sdk/http/get_contract.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module IOSTSdk
+  module Http
+    class GetContract
+      require 'iost_sdk/models/contract'
+
+      def invoke(base_url:, id:, by_longest_chain:)
+        resp = HTTParty.get("#{base_url}/getContract/#{id}/#{by_longest_chain}")
+        raise HttpRequestError.new(status_code: resp.code, body: resp.body) unless
+          resp.code == 200
+
+        IOSTSdk::Models::Contract.new.populate(model_data: JSON.parse(resp.body))
+      end
+    end
+  end
+end

data/lib/iost_sdk/http/get_contract_storage.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'iost_sdk/models/query/contract_storage'
+
+module IOSTSdk
+  module Http
+    class GetContractStorage
+      def invoke(base_url:, query:)
+        raise ArgumentError.new('query must be an instance of IOSTSdk::Models::Query::ContractStorage') unless
+          query.is_a?(IOSTSdk::Models::Query::ContractStorage)
+
+        resp = HTTParty.post(
+          "#{base_url}/getContractStorage",
+          body: JSON.generate(query.raw_data),
+          headers: { 'Content-Type' => 'application/json' }
+        )
+        raise HttpRequestError.new(status_code: resp.code, body: resp.body) unless
+          resp.code == 200
+
+        { data: JSON.parse(resp.body)['data'] }
+      end
+    end
+  end
+end

data/lib/iost_sdk/http/get_contract_storage_fields.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'iost_sdk/models/query/contract_storage_fields'
+
+module IOSTSdk
+  module Http
+    class GetContractStorageFields
+      def invoke(base_url:, query:)
+        raise ArgumentError.new('query must be an instance of IOSTSdk::Models::Query::ContractStorageFields') unless
+          query.is_a?(IOSTSdk::Models::Query::ContractStorageFields)
+
+        resp = HTTParty.post(
+          "#{base_url}/getContractStorageFields",
+          body: JSON.generate(query.raw_data),
+          headers: { 'Content-Type' => 'application/json' }
+        )
+        raise HttpRequestError.new(status_code: resp.code, body: resp.body) unless
+          resp.code == 200
+
+        { fields: JSON.parse(resp.body)['fields'] }
+      end
+    end
+  end
+end

data/lib/iost_sdk/http/get_gas_ratio.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module IOSTSdk
+  module Http
+    class GetGasRatio
+      require 'iost_sdk/models/gas_ratio'
+
+      def invoke(base_url:)
+        resp = HTTParty.get("#{base_url}/getGasRatio")
+        raise HttpRequestError.new(status_code: resp.code, body: resp.body) unless
+          resp.code == 200
+
+        IOSTSdk::Models::GasRatio.new.populate(model_data: JSON.parse(resp.body))
+      end
+    end
+  end
+end

data/lib/iost_sdk/http/get_node_info.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module IOSTSdk
+  module Http
+    class GetNodeInfo
+      require 'iost_sdk/models/node_info'
+
+      def invoke(base_url:)
+        resp = HTTParty.get("#{base_url}/getNodeInfo")
+        raise HttpRequestError.new(status_code: resp.code, body: resp.body) unless
+          resp.code == 200
+
+        IOSTSdk::Models::NodeInfo.new.populate(model_data: JSON.parse(resp.body))
+      end
+    end
+  end
+end

data/lib/iost_sdk/http/get_ram_info.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module IOSTSdk
+  module Http
+    class GetRamInfo
+      require 'iost_sdk/models/ram_info'
+
+      def invoke(base_url:)
+        resp = HTTParty.get("#{base_url}/getRAMInfo")
+        raise HttpRequestError.new(status_code: resp.code, body: resp.body) unless
+          resp.code == 200
+
+        IOSTSdk::Models::RAMInfo.new.populate(model_data: JSON.parse(resp.body))
+      end
+    end
+  end
+end

data/lib/iost_sdk/http/get_token_balance.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module IOSTSdk
+  module Http
+    class GetTokenBalance
+      require 'iost_sdk/models/token_balance'
+
+      def invoke(base_url:, account_name:, token_name:, by_longest_chain:)
+        resp = HTTParty.get("#{base_url}/getTokenBalance/#{account_name}/#{token_name}/#{by_longest_chain}")
+        raise HttpRequestError.new(status_code: resp.code, body: resp.body) unless
+          resp.code == 200
+
+        IOSTSdk::Models::TokenBalance.new.populate(model_data: JSON.parse(resp.body))
+      end
+    end
+  end
+end

data/lib/iost_sdk/http/get_tx_by_hash.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module IOSTSdk
+  module Http
+    class GetTxByHash
+      require 'iost_sdk/models/transaction_info'
+
+      def invoke(base_url:, hash_value:)
+        resp = HTTParty.get("#{base_url}/getTxByHash/#{hash_value}")
+        raise HttpRequestError.new(status_code: resp.code, body: resp.body) unless
+          resp.code == 200
+
+        IOSTSdk::Models::TransactionInfo.new.populate(model_data: JSON.parse(resp.body))
+      end
+    end
+  end
+end

data/lib/iost_sdk/http/get_tx_receipt_by_tx_hash.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module IOSTSdk
+  module Http
+    class GetTxReceiptByTxHash
+      require 'iost_sdk/models/tx_receipt'
+
+      def invoke(base_url:, hash_value:)
+        resp = HTTParty.get("#{base_url}/getTxReceiptByTxHash/#{hash_value}")
+        raise HttpRequestError.new(status_code: resp.code, body: resp.body) unless
+          resp.code == 200
+
+        IOSTSdk::Models::TxReceipt.new.populate(model_data: JSON.parse(resp.body))
+      end
+    end
+  end
+end

data/lib/iost_sdk/http/http_request_error.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module IOSTSdk
+  module Http
+    class HttpRequestError < StandardError
+      def initialize(status_code:, body:)
+        super("HTTP request error. Status code #{status_code}. Response body: #{body}")
+      end
+    end
+  end
+end

data/lib/iost_sdk/http/send_tx.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'iost_sdk/models/query/signed_transaction'
+
+module IOSTSdk
+  module Http
+    class SendTx
+      def invoke(base_url:, transaction:, account_name:, key_pair:)
+        # sign the transaction first
+        signed_txn = IOSTSdk::Models::Query::SignedTransaction.from_transaction(transaction: transaction)
+        final_txn = signed_txn.sign(account_name: account_name, key_pair: key_pair)
+
+        resp = HTTParty.post(
+          "#{base_url}/sendTx",
+          body: JSON.generate(final_txn.raw_data),
+          headers: { 'Content-Type' => 'application/json' }
+        )
+        raise HttpRequestError.new(status_code: resp.code, body: resp.body) unless
+          resp.code == 200
+
+        JSON.parse(resp.body)
+      end
+    end
+  end
+end

data/lib/iost_sdk/models/abi.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'iost_sdk/models'
+require 'iost_sdk/models/amount_limit'
+
+module IOSTSdk
+  module Models
+    class ABI
+      include Models
+
+      def self.attr_names
+        [
+          'name',
+          'args',
+          'amount_limit'
+        ]
+      end
+    end
+  end
+end

data/lib/iost_sdk/models/account.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'iost_sdk/models'
+
+module IOSTSdk
+  module Models
+    class Account
+      include Models
+
+      require 'iost_sdk/models/permission'
+      require 'iost_sdk/models/permission_group'
+      require 'iost_sdk/models/permission_item'
+      require 'iost_sdk/models/gas_info'
+      require 'iost_sdk/models/account_ram_info'
+      require 'iost_sdk/models/frozen_balance'
+      require 'iost_sdk/models/vote_info'
+
+      def self.attr_names
+        [
+          'name',
+          'balance',
+          'gas_info',
+          'ram_info',
+          'permissions',
+          'groups',
+          'frozen_balances',
+          'vote_infos'
+        ]
+      end
+    end
+  end
+end

data/lib/iost_sdk/models/account_ram_info.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'iost_sdk/models'
+
+module IOSTSdk
+  module Models
+    class AccountRAMInfo
+      include Models
+
+      def self.attr_names
+        [
+          'available',
+          'used',
+          'total'
+        ]
+      end
+    end
+  end
+end

data/lib/iost_sdk/models/action.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'iost_sdk/models'
+
+module IOSTSdk
+  module Models
+    class Action
+      include Models
+
+      def self.attr_names
+        [
+          'contract',
+          'action_name',
+          'data'
+        ]
+      end
+
+      def raw_data_bytes
+        [contract, action_name, data.to_s]
+      end
+    end
+  end
+end

data/lib/iost_sdk/models/amount_limit.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'iost_sdk/models'
+
+module IOSTSdk
+  module Models
+    class AmountLimit
+      include Models
+
+      def self.attr_names
+        [
+          'token',
+          'value'
+        ]
+      end
+
+      def raw_data_bytes
+        [token, value.to_s]
+      end
+    end
+  end
+end

data/lib/iost_sdk/models/block.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'iost_sdk/models'
+require 'iost_sdk/models/transaction'
+require 'iost_sdk/models/info'
+
+module IOSTSdk
+  module Models
+    class Block
+      include Models
+
+      def self.attr_names
+        [
+          'hash',
+          'version',
+          'parent_hash',
+          'tx_merkle_hash',
+          'tx_receipt_merkle_hash',
+          'number',
+          'witness',
+          'time',
+          'gas_usage',
+          'tx_count',
+          'info',
+          'transactions'
+        ]
+      end
+    end
+  end
+end