iost_sdk 0.1.0

data/lib/iost_sdk/models/tx_receipt.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'iost_sdk/models'
+require 'iost_sdk/models/receipt'
+
+module IOSTSdk
+  module Models
+    class TxReceipt
+      include Models
+
+      def self.attr_names
+        [
+          'tx_hash',
+          'gas_usage',
+          'ram_usage',
+          'status_code',
+          'message',
+          'returns',
+          'receipts'
+        ]
+      end
+    end
+  end
+end

data/lib/iost_sdk/models/util/serializer.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module IOSTSdk
+  module Models
+    module Util
+      module Serializer
+        def self.int32_to_bytes(int32)
+          [int32].pack('L>').unpack('C*')
+        end
+
+        def self.int64_to_bytes(int64)
+          [int64].pack('Q>').unpack('C*')
+        end
+
+        def self.string_to_bytes(str)
+          int32_to_bytes(str.size) + str.unpack('C*')
+        end
+
+        def self.array_to_bytes(arr, size_prefix=true)
+          return int32_to_bytes(0) if !arr || arr.empty?
+
+          data_bytes = arr.map do |elem|
+            if elem.class.name == 'Integer'
+              int64_to_bytes(elem)
+            elsif elem.class.name == 'String'
+              string_to_bytes(elem)
+            elsif elem.class.name == 'Array'
+              array_to_bytes(elem)
+            elsif elem.class.name == 'Hash'
+              hash_to_bytes(elem)
+            elsif elem.respond_to?(:raw_data_bytes)
+              raw_data_bytes = array_to_bytes(elem.raw_data_bytes, false)
+              (int32_to_bytes(raw_data_bytes.size) + raw_data_bytes).flatten
+            end
+          end
+
+          data_bytes.flatten!
+
+          size_prefix ? int32_to_bytes(arr.size) + data_bytes : data_bytes
+        end
+
+        def self.hash_to_bytes(h)
+          return int32_to_bytes(0) if !h || h.empty?
+
+          # hash to array of key-value pairs, sorted by key
+          key_value_pairs = h.sort.map { |k, v| [k.to_s, v] }.flatten
+          int32_to_bytes(h.size) + array_to_bytes(key_value_pairs, false)
+        end
+      end
+    end
+  end
+end

data/lib/iost_sdk/models/vote_info.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'iost_sdk/models'
+
+module IOSTSdk
+  module Models
+    class VoteInfo
+      include Models
+
+      def self.attr_names
+        [
+          'option',
+          'votes',
+          'cleared_votes'
+        ]
+      end
+    end
+  end
+end

data/lib/iost_sdk/models.rb

@@ -0,0 +1,276 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'iost_sdk/string'
+
+module IOSTSdk
+  module Models
+    MODEL_REGISTRY = {
+      # query
+      'IOSTSdk::Models::Query::ContractStorage' => {},
+      'IOSTSdk::Models::Query::ContractStorageFields' => {},
+      'IOSTSdk::Models::Query::Transaction' => {
+        'actions' => {
+          mode: :list,
+          class: 'IOSTSdk::Models::Action'
+        },
+        'amount_limit' => {
+          mode: :list,
+          class: 'IOSTSdk::Models::AmountLimit'
+        },
+        'signatures' => {
+          mode: :list,
+          class: 'IOSTSdk::Models::Signature'
+        }
+      },
+      'IOSTSdk::Models::Query::SignedTransaction' => {
+        'actions' => {
+          mode: :list,
+          class: 'IOSTSdk::Models::Action'
+        },
+        'amount_limit' => {
+          mode: :list,
+          class: 'IOSTSdk::Models::AmountLimit'
+        },
+        'signatures' => {
+          mode: :list,
+          class: 'IOSTSdk::Models::Signature'
+        },
+        'publisher_sigs' => {
+          mode: :list,
+          class: 'IOSTSdk::Models::Signature'
+        }
+      },
+      # result
+      'IOSTSdk::Models::NodeInfo' => {
+        'network' => {
+          mode: :object,
+          class: 'IOSTSdk::Models::NetworkInfo'
+        }
+      },
+      'IOSTSdk::Models::NetworkInfo' => {
+        'peer_info' => {
+          mode: :list,
+          class: 'IOSTSdk::Models::PeerInfo'
+        }
+      },
+      'IOSTSdk::Models::Info' => {},
+      'IOSTSdk::Models::VoteInfo' => {},
+      'IOSTSdk::Models::PeerInfo' => {},
+      'IOSTSdk::Models::ChainInfo' => {},
+      'IOSTSdk::Models::GasRatio' => {},
+      'IOSTSdk::Models::RAMInfo' => {},
+      'IOSTSdk::Models::Action' => {},
+      'IOSTSdk::Models::AmountLimit' => {},
+      'IOSTSdk::Models::Receipt' => {},
+      'IOSTSdk::Models::TxReceipt' => {
+        'receipts' => {
+          mode: :list,
+          class: 'IOSTSdk::Models::Receipt'
+        }
+      },
+      'IOSTSdk::Models::Transaction' => {
+        'actions' => {
+          mode: :list,
+          class: 'IOSTSdk::Models::Action'
+        },
+        'amount_limit' => {
+          mode: :list,
+          class: 'IOSTSdk::Models::AmountLimit'
+        },
+        'tx_receipt' => {
+          mode: :object,
+          class: 'IOSTSdk::Models::TxReceipt'
+        }
+      },
+      'IOSTSdk::Models::TransactionInfo' => {
+        'transaction' => {
+          mode: :object,
+          class: 'IOSTSdk::Models::Transaction'
+        }
+      },
+      'IOSTSdk::Models::Block' => {
+        'transactions' => {
+          mode: :list,
+          class: 'IOSTSdk::Models::Transaction'
+        },
+        'info' => {
+          mode: :object,
+          class: 'IOSTSdk::Models::Info'
+        }
+      },
+      'IOSTSdk::Models::BlockInfo' => {
+        'block' => {
+          mode: :object,
+          class: 'IOSTSdk::Models::Block'
+        }
+      },
+      'IOSTSdk::Models::AccountRAMInfo' => {},
+      'IOSTSdk::Models::FrozenBalance' => {},
+      'IOSTSdk::Models::PledgeInfo' => {},
+      'IOSTSdk::Models::GasInfo' => {
+        'pledged_info' => {
+          mode: :list,
+          class: 'IOSTSdk::Models::PledgeInfo'
+        }
+      },
+      'IOSTSdk::Models::PermissionItem' => {},
+      'IOSTSdk::Models::PermissionGroup' => {
+        'items' => {
+          mode: :list,
+          class: 'IOSTSdk::Models::PermissionItem'
+        }
+      },
+      'IOSTSdk::Models::Permission' => {
+        'items' => {
+          mode: :list,
+          class: 'IOSTSdk::Models::PermissionItem'
+        }
+      },
+      'IOSTSdk::Models::Account' => {
+        'gas_info' => {
+          mode: :object,
+          class: 'IOSTSdk::Models::GasInfo'
+        },
+        'ram_info' => {
+          mode: :object,
+          class: 'IOSTSdk::Models::AccountRAMInfo'
+        },
+        'permissions' => {
+          mode: :hash,
+          class: 'IOSTSdk::Models::Permission'
+        },
+        'groups' => {
+          mode: :hash,
+          class: 'IOSTSdk::Models::PermissionGroup'
+        },
+        'frozen_balances' => {
+          mode: :list,
+          class: 'IOSTSdk::Models::FrozenBalance'
+        },
+        'vote_infos' => {
+          mode: :list,
+          class: 'IOSTSdk::Models::VoteInfo'
+        }
+      },
+      'IOSTSdk::Models::TokenBalance' => {
+        'frozen_balances' => {
+          mode: :list,
+          class: 'IOSTSdk::Models::FrozenBalance'
+        }
+      },
+      'IOSTSdk::Models::ABI' => {
+        'amount_limit' => {
+          mode: :list,
+          class: 'IOSTSdk::Models::AmountLimit'
+        }
+      },
+      'IOSTSdk::Models::Contract' => {
+        'abis' => {
+          mode: :list,
+          class: 'IOSTSdk::Models::ABI'
+        }
+      },
+      'IOSTSdk::Models::Signature' => {}
+    }.freeze
+
+    def self.included base
+      base.send :include, InstanceMethods
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+    end
+
+    module InstanceMethods
+      require 'iost_sdk/errors'
+
+      # Creates an instance of a model from the JSON string.
+      #
+      # @param model_data [Hash] the JSON string of the model data
+      # @return an instance of +model_class+ if +model_data+ is valid.
+      def populate(model_data:)
+        # if nil, short-curcuit
+        return nil unless model_data
+
+        # the model class is expected implement "attr_names" method
+        model_attr_names = self.class.attr_names || []
+        # proceed ONLY if actual data has a subset of keys of what's defined by the class
+        unless Set.new(model_data.keys).subset?(Set.new(model_attr_names))
+          raise IOSTSdk::Errors::InvalidModelDataError.new(
+            self.class.name,
+            model_attr_names,
+            model_data.keys
+          )
+        end
+        # create the model
+        model_attr_names.each do |k|
+          v = model_data[k]
+          # set the instance var
+          instance_variable_set("@#{k}", parse(data_key: k, data_value: v))
+          # define the attr_reader
+          self.class.send(:define_method, k.to_sym) do
+            instance_variable_get("@#{k}")
+          end
+        end
+
+        self
+      end
+    end
+
+    def parse(data_key:, data_value:)
+      # if nil, short-curcuit
+      return nil unless data_value
+
+      if IOSTSdk::Models::MODEL_REGISTRY[self.class.name].has_key?(data_key)
+        instruction = IOSTSdk::Models::MODEL_REGISTRY[self.class.name][data_key]
+        mode = instruction[:mode]
+        class_name = instruction[:class]
+        clazz = IOSTSdk::String.classify(class_name)
+
+        case mode
+        when :object
+          clazz.new.populate(model_data: data_value)
+        when :list
+          data_value.empty? ? [] : data_value.map { |item| clazz.new.populate(model_data: item) }
+        when :hash
+          if data_value.empty?
+            {}
+          else
+            data_value.each_with_object({}) do |(v_key, v_value), memo|
+              memo[v_key] = clazz.new.populate(model_data: v_value)
+            end
+          end
+        end
+      else
+        data_value
+      end
+    end
+
+    def raw_data
+      raw_data = instance_variables.each_with_object({}) do |var_name, memo|
+        n = var_name.to_s[1..-1].to_sym
+        v = send(n)
+
+        final_v = if IOSTSdk::Models::MODEL_REGISTRY[self.class.name].has_key?(n.to_s)
+                    mode = IOSTSdk::Models::MODEL_REGISTRY[self.class.name][n.to_s][:mode]
+                    case mode
+                    when :object
+                      v.raw_data
+                    when :list
+                      v.map(&:raw_data)
+                    when :hash
+                      v.each_with_object({}) do |(v_key, v_value), memo|
+                        memo[v_key] = v_value.raw_data
+                      end
+                    end
+                  else
+                    v
+                  end
+        memo[n] = final_v
+      end
+
+      raw_data
+    end
+  end
+end

data/lib/iost_sdk/string.rb

@@ -0,0 +1,11 @@
+module IOSTSdk
+  module String
+    def self.camelize(str)
+      str.to_s.split('_').map(&:capitalize).join
+    end
+
+    def self.classify(fq_class_name)
+      fq_class_name.split('::').inject(Object) { |o, c| o.const_get c }
+    end
+  end
+end

data/lib/iost_sdk/version.rb

@@ -0,0 +1,3 @@
+module IOSTSdk
+  VERSION = ENV['IOST_SDK_VERSION'] || '0.1.0'
+end

data/lib/iost_sdk.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+require 'iost_sdk/version'
+require 'iost_sdk/crypto'
+require 'iost_sdk/errors'
+require 'iost_sdk/http/client'
+require 'iost_sdk/models/query/transaction'
+require 'iost_sdk/models/query/signed_transaction'
+
+module IOSTSdk
+  class Main
+    attr_accessor :gas_limit, :gas_ratio, :delay,
+                  :expiration, :approval_limit_amount,
+                  :transaction
+
+    DEFAULTS = {
+      gas_limit: 2_000_000,
+      gas_ratio: 1,
+      delay: 0,
+      expiration: 90,
+      approval_limit_amount: :unlimited
+    }.freeze
+
+    #
+    # @param endpoint [String] a URL of the JSON RPC endpoint of IOST
+    def initialize(endpoint:)
+      @endpoint = endpoint
+
+      DEFAULTS.each do |k, v|
+        instance_variable_set("@#{k}".to_sym, v)
+      end
+    end
+
+    def send(account_name:, key_pair:)
+      if @transaction
+        client = IOSTSdk::Http::Client.new(base_url: @endpoint)
+        client.send_tx(
+          transaction: @transaction,
+          account_name: account_name,
+          key_pair: key_pair
+        )
+      end
+    end
+
+    # Create an instance of IOSTSdk::Models::Transaction with an action to call the ABI.
+    #
+    # @param contract_id [String] a Contract's ID
+    # @param abi_name [String] the name of an ABI to call
+    # @param abi_args [any] args to the ABI
+    # @return a new instance of Transaction
+    def call_abi(contract_id:, abi_name:, abi_args:)
+      transaction = init_transaction
+      transaction.add_action(contract_id: contract_id, action_name: abi_name, action_data: abi_args)
+      transaction.add_approve(token: '*', amount: :unlimited)
+      transaction.set_time_params(expiration: expiration, delay: delay)
+
+      @transaction = transaction
+      self
+    end
+
+    # Create an instance IOSTSdk::Models::Transaction with an action to transfer tokens
+    #
+    # @param token [String] name of the token in the transfer
+    # @param from [String] sender
+    # @param to [String] recipient
+    # @param amount [Integer] amount to transfer
+    # @param memo [String] memo/notes for the transfer
+    # @return a new instance of Transaction
+    def transfer(token:, from:, to:, amount:, memo:)
+      call_abi(
+        contract_id: 'token.iost',
+        abi_name: :transfer,
+        abi_args: [token, from, to, amount, memo]
+      )
+      @transaction.add_approve(token: :iost, amount: amount)
+      @transaction.set_time_params(expiration: expiration, delay: delay)
+
+      self
+    end
+
+    # Create an instance IOSTSdk::Models::Transaction to create a new account
+    #
+    # @param name [String] the name of the account to be created
+    # @param creator [String] the name of the account that's creating a new account
+    # @param owner_key [IOSTSdk::Crypto::KeyPair] the owner key of the new account
+    # @param active_key [IOSTSdk::Crypto::KeyPair] the active key of the new account
+    # @param initial_ram [Integer] the initial RAM of the new account
+    # @param initial_gas_pledge [Integer] the initial gas pledge of the new account
+    def new_account(name:, creator:, owner_key:, active_key:, initial_ram:, initial_gas_pledge:)
+      transaction = init_transaction
+      transaction.add_action(
+        contract_id: 'auth.iost',
+        action_name: :signUp,
+        action_data: [name, owner_key.id, active_key.id]
+      )
+
+      if initial_ram > 10
+        transaction.add_action(
+          contract_id: 'ram.iost',
+          action_name: :buy,
+          action_data: [creator, name, initial_ram]
+        )
+      end
+
+      if initial_gas_pledge > 0
+        transaction.add_action(
+          contract_id: 'ram.iost',
+          action_name: :buy,
+          action_data: [creator, name, initial_gas_pledge.to_s]
+        )
+      end
+
+      transaction.set_time_params(expiration: expiration, delay: delay)
+      transaction.add_approve(token: '*', amount: approval_limit_amount)
+
+      @transaction = transaction
+      self
+    end
+
+    private
+
+    def init_transaction
+      time_now = Time.now.utc.to_i * 1_000_000
+      transaction = IOSTSdk::Models::Query::Transaction.new.populate(
+        model_data: {
+          'time' => time_now,
+          'expiration' => time_now + delay * 1_000_000,
+          'gas_ratio' => gas_ratio,
+          'gas_limit' => gas_limit,
+          'delay' => delay,
+          'chain_id' => 0,
+          'signers' => [],
+          'actions' => [],
+          'amount_limit' => [],
+          'signatures' => []
+        }
+      )
+      transaction
+    end
+  end
+end