ton-client-ruby 1.0.0 → 1.1.0

data/lib/code_generator/code_generator.rb

@@ -0,0 +1,325 @@
+require 'byebug'
+require 'json'
+require File.dirname(__FILE__) + '/helpers.rb'
+
+class CodeGenerator
+  include InstanceHelpers
+
+  attr_accessor :types
+  attr_accessor :root_dir
+
+  TAB = "  "
+
+  def initialize(types, root_dir)
+    @types = types
+    @root_dir = root_dir
+  end
+
+  def generate_self_code
+    generateModules(types)
+    generateReadme(types)
+  end
+
+  private
+
+  def generateModules(types)
+    types.modules.each do |mod|
+      modulesFolder = root_dir + "/lib/ton-client-ruby/Client"
+      moduleFilePath = "#{modulesFolder}/#{mod.name.capitalize}.rb"
+      newModuleContent = ""
+      if mod.name == "client"
+          newModuleContent = generateClientModule(mod, types.modules)
+      else
+          newModuleContent = generateModule(mod)
+      end
+      if File.exists?(moduleFilePath)
+          File.delete(moduleFilePath)
+      end
+      File.open(moduleFilePath, 'w+') { |f| f.write(newModuleContent) }
+    end
+    
+    p 'generate_self_code ok'
+  end
+
+  def generateReadme(types)
+    readmePath = root_dir + "/README.md"
+    content = %{
+# Ruby Client for Free TON SDK
+
+[![GEM](https://img.shields.io/badge/ruby-gem-green)]()
+
+## Install
+
+Install gem
+```bash
+gem install ton-client-ruby
+```
+
+Install TON-SDK
+```bash
+ton-client-ruby setup
+# result - path to dylib file for ton-client-ruby configuration
+```
+
+### Manual build FreeTON SDK
+0. Install Rust to your OS
+1. git clone https://github.com/tonlabs/TON-SDK
+2. cd ./TON-SDK
+3. cargo update
+4. cargo build --release
+
+## Usage
+
+```ruby
+# For MAcOS
+TonClient.configure { |config| config.ffi_lib(./TON-SDK/target/release/libton_client.dylib) }
+# For Linux
+# TonClient.configure { |config| config.ffi_lib(./TON-SDK/target/release/libton_client.so) }
+
+client = TonClient.create(config: {network: {server_address: "net.ton.dev"}})
+
+# All methods are asynchronous
+
+# example: call method for Crypto module
+payload = {composite: '17ED48941A08F981'}
+client.crypto.factorize(payload) do |response|
+  p response.result['factors']
+end
+
+# e.g. ...
+```\n\n
+}
+    content << "## All Modules, methods and types\n\n"
+
+    # types
+    content << "<details>\n#{TAB}<summary>Types</summary>\n\n"
+    
+    content << "#{customTypes()}\n"
+
+    types.modules.each do |mod|
+      (mod.enums || []).each do |type|
+        content << checkComment(type.summary, 0) if type.summary
+        content << checkComment(type.description, 0) if type.description
+        content << "\n- #### #{type.name}\n"
+        (type.cases || []).each do |enum_case|
+          content << "#{checkComment(enum_case.summary, 1).gsub(/#/, '')}" if enum_case.summary
+          content << "#{checkComment(enum_case.description, 1).gsub(/#/, '')}" if enum_case.description
+          content << "#{TAB}- case #{enum_case.name} = #{enum_case.value}\n\n"
+        end
+      end
+
+      (mod.types || []).each do |type|
+        content << checkComment(type.summary, 0) if type.summary
+        content << checkComment(type.description, 0) if type.description
+        content << "\n- #### #{type.name}\n"
+        (type.fields || []).each do |field|
+          content << "#{checkComment(field.summary, 1).gsub(/#/, '')}\n" if field.summary
+          content << "#{checkComment(field.description, 1).gsub(/#/, '')}\n" if field.description
+          content << "#{TAB}- #{field.name}: #{field.type}\n\n"
+        end
+      end
+    end
+    content << "</details>\n\n"
+
+    # methods
+    types.modules.each do |mod|
+      content << "<details>\n#{TAB}<summary>#{mod.name&.upcase}</summary>\n\n"
+      (mod.functions || []).each do |function|
+        content << "```ruby\n"
+        content << checkComment(function.summary, 2) if function.summary
+        content << checkComment(function.description, 2) if function.description
+        content << "\n#{TAB}#{TAB}def #{function.name}"
+        if function.arguments.empty?
+          content << "(&block)\n"
+        else
+          content << "(payload, &block)\n"
+        end
+        content << getFunctionComment(function, types)
+        content << "```\n"
+      end
+      content << "</details>\n\n"
+    end
+
+    content << %{
+\n## Tests
+
+1. create __.env.test__ file inside root directory of this library with variables   
+
+example for NodeSE   
+```
+spec_ffi=./TON-SDK/target/release/libton_client.dylib
+server_address=http://localhost:80
+giver_abi_name=GiverNodeSE
+giver_amount=10000000000
+```
+2. Run tests: inside folder of this library execute this commands      
+**rspec spec/binding.rb**   
+**rspec spec/client.rb**  
+**rspec spec/context.rb**  
+**rspec spec/abi.rb**   
+**rspec spec/boc.rb**   
+**rspec spec/crypto.rb**   
+**rspec spec/net.rb**   
+**rspec spec/processing.rb**   
+**rspec spec/tvm.rb**   
+**rspec spec/utils.rb**
+
+\n## Update\n\n
+```\n
+curl https://raw.githubusercontent.com/tonlabs/TON-SDK/master/tools/api.json > api.json\n\n
+ton-client-ruby update api.json\n 
+```\n 
+}
+    content = checkContent(content)    
+    if File.exists?(readmePath)
+        File.delete(readmePath)
+    end
+    File.open(readmePath, 'w+') { |f| f.write(content) }
+  end
+
+  private def checkContent(content)
+    content.gsub!(/^([\s]+)# RESPONSE/, "\n\\1# RESPONSE")
+    content.gsub(/<Optional>/i, '&lt;Optional&gt;')
+  end
+
+  def customTypes
+    content = %{
+- #### #{lib_prefix}MnemonicDictionary
+#{TAB}- case TON = 0
+#{TAB}- case ENGLISH = 1
+#{TAB}- case CHINESE_SIMPLIFIED = 2
+#{TAB}- case CHINESE_TRADITIONAL = 3
+#{TAB}- case FRENCH = 4
+#{TAB}- case ITALIAN = 5
+#{TAB}- case JAPANESE = 6
+#{TAB}- case KOREAN = 7
+#{TAB}- case SPANISH = 8
+}
+  content
+  end
+
+  private def checkComment(string, tabs = 1)
+      replacedString = "\n"
+      tab = ""
+      tabs.times do |i|
+          tab << TAB
+      end
+      comment = "#"
+      replacedString << "#{tab}#{comment} "
+      symbolsWithSpace = "\\.|\\:|\\!|\\?|\\;"
+      regxp = /([^#{symbolsWithSpace}])\n/
+      result = string
+      result.gsub!(/\n+/, "\n")
+      result.gsub!(/ \n/, "\n#{comment} ")
+      result.gsub!(/(#{symbolsWithSpace})\s*\n/, "\\1#{replacedString}")
+      result.gsub!(regxp, "\\1")
+      "#{tab}# #{result}"
+  end
+
+  private def generateClientModule(mod, modules)
+    content = "module TonClient\n\n#{TAB}class #{mod.name.capitalize}\n#{TAB}#{TAB}include CommonInstanceHelpers\n\n"
+    content << "#{TAB}#{TAB}attr_reader :core, :context\n"
+    content << "#{TAB}#{TAB}private_accessor "
+    modules.each_with_index do |m, i|
+      next if m.name.downcase == 'client'
+      content << ((modules.size - 1) == i ? ":_#{m.name}\n" : ":_#{m.name}, ")
+    end
+    content << "#{TAB}#{TAB}MODULE = self.to_s.downcase.gsub(/^(.+::|)(\\w+)$/, '\\2').freeze\n\n"
+    content << "#{TAB}#{TAB}def initialize(context: Context.new, core: TonClient::TonBinding)\n"
+    content << "#{TAB}#{TAB}#{TAB}@context = context\n"
+    content << "#{TAB}#{TAB}#{TAB}@core = core\n#{TAB}#{TAB}end\n\n"
+    content << "#{TAB}#{TAB}def destroy_context\n"
+    content << "#{TAB}#{TAB}#{TAB}core.tc_destroy_context(context.id)\n#{TAB}#{TAB}end\n\n"
+    modules.each_with_index do |m, i|
+      next if m.name.downcase == 'client'
+      content << "#{TAB}#{TAB}def #{m.name}\n"
+      content << "#{TAB}#{TAB}#{TAB}_#{m.name} ||= #{m.name.capitalize}.new(context: context)\n"
+      content << "#{TAB}#{TAB}end\n\n"
+    end
+
+    mod.functions.each do |func|
+      content << gen_function(func, types)
+    end
+
+    content << "#{TAB}end\n"
+    content << "end\n\n"
+
+    content
+  end
+
+  private def generateModule(mod)
+    content = "module TonClient\n\n#{TAB}class #{mod.name.capitalize}\n#{TAB}#{TAB}include CommonInstanceHelpers\n\n"
+    content << "#{TAB}#{TAB}attr_reader :core, :context\n"
+    content << "#{TAB}#{TAB}MODULE = self.to_s.downcase.gsub(/^(.+::|)(\\w+)$/, '\\2').freeze\n\n"
+    content << "#{TAB}#{TAB}def initialize(context: Context.new, core: TonClient::TonBinding)\n"
+    content << "#{TAB}#{TAB}#{TAB}@context = context\n"
+    content << "#{TAB}#{TAB}#{TAB}@core = core\n"
+    content << "#{TAB}#{TAB}end\n\n"
+
+    mod.functions.each do |func|
+      content << gen_function(func, types)
+    end
+
+    content << "#{TAB}end\n"
+    content << "end\n\n"
+
+    content
+  end
+
+  private def gen_function(function, types)
+    content = getFunctionComment(function, types)
+    content << "#{TAB}#{TAB}def #{function.name}"
+    if function.arguments.empty?
+      content << "(&block)\n"
+      content << "#{TAB}#{TAB}#{TAB}core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: {}, &block)\n"
+    else
+      content << "(payload, &block)\n"
+      content << "#{TAB}#{TAB}#{TAB}core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: payload, &block)\n"
+    end
+    content << "#{TAB}#{TAB}end\n\n"
+
+    content
+  end
+
+  def getFunctionComment(function, types)
+    content = ''
+    if argument = function.arguments.first
+      content << "#{TAB}#{TAB}# INPUT: #{argument.type}\n"
+      if types.all_types[argument.type].respond_to?(:fields)
+        types.all_types[argument.type].fields.each do |arg|
+          content << "#{TAB}#{TAB}# #{arg.name}: #{arg.type} - "
+          content << "#{TAB}#{TAB}# #{checkComment(arg.summary, 2)}" if arg.summary
+          content << "#{TAB}#{TAB}# #{checkComment(arg.description, 2)}" if arg.description
+          content << "\n"
+        end
+      elsif types.all_types[argument.type].respond_to?(:cases)
+      end
+    end
+    
+    if types.all_types[function.result]
+      content << "#{TAB}#{TAB}# RESPONSE: #{function.result}\n"
+      if types.all_types[function.result].respond_to?(:fields)
+        types.all_types[function.result].fields.each do |arg|
+          content << "#{TAB}#{TAB}# #{arg.name}: #{arg.type} - "
+          content << "#{TAB}#{TAB}# #{checkComment(arg.summary, 2)}" if arg.summary
+          content << "#{TAB}#{TAB}# #{checkComment(arg.description, 2)}" if arg.description
+          content << "\n"
+        end
+      elsif types.all_types[function.result].respond_to?(:cases)
+      end
+    end
+
+    content
+  end
+end
+
+
+
+
+
+
+
+
+
+
+

data/lib/code_generator/helpers.rb

@@ -0,0 +1,13 @@
+require 'json'
+require 'byebug'
+
+module InstanceHelpers
+  
+  def lib_prefix 
+    '' 
+  end
+
+  def lib_enum_postfix
+    ''
+  end
+end

data/lib/ton-client-ruby.rb

@@ -3,6 +3,7 @@ require "base64"
 require 'json'
 require 'byebug'
 require 'dotenv'
+require 'fileutils'
 require 'ton-client-ruby/Helpers/CommonHelpers.rb'
 require 'ton-client-ruby/Binding/struct.rb'
 require 'ton-client-ruby/Binding/binding.rb'

data/lib/ton-client-ruby/Binding/binding.rb

@@ -147,14 +147,11 @@ module TonClient
       end
 
       if string[:content].address > 1
-        # string = string[:content].read_string(string[:len]).force_encoding('UTF-8') + ''
-        # tc_destroy_string(tc_string_handle) if is_ref
-        # return string
-        return string[:content].read_string(string[:len]).force_encoding('UTF-8') + ''
+        string = string[:content].read_string(string[:len]).force_encoding('UTF-8') + ''
+        tc_destroy_string(tc_string_handle) if is_ref
+        return string
       end
       nil
-    ensure
-      tc_destroy_string(tc_string_handle) if is_ref
     end
 
     def self.read_string_to_hash(tc_string_handle_t_ref)

data/lib/ton-client-ruby/Client/Abi.rb

@@ -1,5 +1,5 @@
 module TonClient
-  
+
   class Abi
     include CommonInstanceHelpers
 
@@ -11,42 +11,124 @@ module TonClient
       @core = core
     end
 
+    # INPUT: ParamsOfEncodeMessageBody
+    # abi: Value -     #     # Contract ABI.
+    # call_set: CallSet -     #     # Function call parameters.    #     # Must be specified in non deploy message.
+    # In case of deploy message contains parameters of constructor.
+    # is_internal: Boolean -     #     # True if internal message body must be encoded.
+    # signer: Signer -     #     # Signing parameters.
+    # processing_try_index: Number<Optional> -     #     # Processing try index.    #     # Used in message processing with retries.
+    # Encoder uses the provided try index to calculate messageexpiration time.
+    # Expiration timeouts will grow with every retry.
+    # Default value is 0.
+    # RESPONSE: ResultOfEncodeMessageBody
+    # body: String -     #     # Message body BOC encoded with `base64`.
+    # data_to_sign: String<Optional> -     #     # Optional data to sign.    #     # Encoded with `base64`.
+    # # Presents when `message` is unsigned. Can be used for externalmessage signing. Is this case you need to sing this data andproduce signed message using `abi.attach_signature`.
     def encode_message_body(payload, &block)
       core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: payload, &block)
     end
 
+    # INPUT: ParamsOfAttachSignatureToMessageBody
+    # abi: Value -     #     # Contract ABI
+    # public_key: String -     #     # Public key.    #     # Must be encoded with `hex`.
+    # message: String -     #     # Unsigned message body BOC.    #     # Must be encoded with `base64`.
+    # signature: String -     #     # Signature.    #     # Must be encoded with `hex`.
+    # RESPONSE: ResultOfAttachSignatureToMessageBody
+    # body: String - 
     def attach_signature_to_message_body(payload, &block)
       core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: payload, &block)
     end
 
+    # INPUT: ParamsOfEncodeMessage
+    # abi: Value -     #     # Contract ABI.
+    # address: String<Optional> -     #     # Target address the message will be sent to.    #     # Must be specified in case of non-deploy message.
+    # deploy_set: DeploySet<Optional> -     #     # Deploy parameters.    #     # Must be specified in case of deploy message.
+    # call_set: CallSet<Optional> -     #     # Function call parameters.    #     # Must be specified in case of non-deploy message.
+    # In case of deploy message it is optional and contains parametersof the functions that will to be called upon deploy transaction.
+    # signer: Signer -     #     # Signing parameters.
+    # processing_try_index: Number<Optional> -     #     # Processing try index.    #     # Used in message processing with retries (if contract's ABI includes "expire" header).
+    # Encoder uses the provided try index to calculate messageexpiration time. The 1st message expiration time is specified inClient config.
+    # Expiration timeouts will grow with every retry.
+    # Retry grow factor is set in Client config:
+    # <.....add config parameter with default value here>Default value is 0.
+    # RESPONSE: ResultOfEncodeMessage
+    # message: String -     #     # Message BOC encoded with `base64`.
+    # data_to_sign: String<Optional> -     #     # Optional data to be signed encoded in `base64`.    #     # Returned in case of `Signer::External`. Can be used for externalmessage signing. Is this case you need to use this data to create signature andthen produce signed message using `abi.attach_signature`.
+    # address: String -     #     # Destination address.
+    # message_id: String -     #     # Message id.
     def encode_message(payload, &block)
       core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: payload, &block)
     end
 
+    # INPUT: ParamsOfEncodeInternalMessage
+    # abi: Value<Optional> -     #     # Contract ABI.    #     # Can be None if both deploy_set and call_set are None.
+    # address: String<Optional> -     #     # Target address the message will be sent to.    #     # Must be specified in case of non-deploy message.
+    # src_address: String<Optional> -     #     # Source address of the message.
+    # deploy_set: DeploySet<Optional> -     #     # Deploy parameters.    #     # Must be specified in case of deploy message.
+    # call_set: CallSet<Optional> -     #     # Function call parameters.    #     # Must be specified in case of non-deploy message.
+    # In case of deploy message it is optional and contains parametersof the functions that will to be called upon deploy transaction.
+    # value: String -     #     # Value in nanotokens to be sent with message.
+    # bounce: Boolean<Optional> -     #     # Flag of bounceable message.    #     # Default is true.
+    # enable_ihr: Boolean<Optional> -     #     # Enable Instant Hypercube Routing for the message.    #     # Default is false.
+    # RESPONSE: ResultOfEncodeInternalMessage
+    # message: String -     #     # Message BOC encoded with `base64`.
+    # address: String -     #     # Destination address.
+    # message_id: String -     #     # Message id.
     def encode_internal_message(payload, &block)
       core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: payload, &block)
     end
 
+    # INPUT: ParamsOfAttachSignature
+    # abi: Value -     #     # Contract ABI
+    # public_key: String -     #     # Public key encoded in `hex`.
+    # message: String -     #     # Unsigned message BOC encoded in `base64`.
+    # signature: String -     #     # Signature encoded in `hex`.
+    # RESPONSE: ResultOfAttachSignature
+    # message: String -     #     # Signed message BOC
+    # message_id: String -     #     # Message ID
     def attach_signature(payload, &block)
       core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: payload, &block)
     end
 
+    # INPUT: ParamsOfDecodeMessage
+    # abi: Value -     #     # contract ABI
+    # message: String -     #     # Message BOC
+    # RESPONSE: DecodedMessageBody
+    # body_type: MessageBodyType -     #     # Type of the message body content.
+    # name: String -     #     # Function or event name.
+    # value: Value<Optional> -     #     # Parameters or result value.
+    # header: FunctionHeader<Optional> -     #     # Function header.
     def decode_message(payload, &block)
       core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: payload, &block)
     end
 
+    # INPUT: ParamsOfDecodeMessageBody
+    # abi: Value -     #     # Contract ABI used to decode.
+    # body: String -     #     # Message body BOC encoded in `base64`.
+    # is_internal: Boolean -     #     # True if the body belongs to the internal message.
+    # RESPONSE: DecodedMessageBody
+    # body_type: MessageBodyType -     #     # Type of the message body content.
+    # name: String -     #     # Function or event name.
+    # value: Value<Optional> -     #     # Parameters or result value.
+    # header: FunctionHeader<Optional> -     #     # Function header.
     def decode_message_body(payload, &block)
       core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: payload, &block)
     end
 
+    # INPUT: ParamsOfEncodeAccount
+    # state_init: StateInitSource -     #     # Source of the account state init.
+    # balance: BigInt<Optional> -     #     # Initial balance.
+    # last_trans_lt: BigInt<Optional> -     #     # Initial value for the `last_trans_lt`.
+    # last_paid: Number<Optional> -     #     # Initial value for the `last_paid`.
+    # boc_cache: BocCacheType<Optional> -     #     # Cache type to put the result.    #     # The BOC itself returned if no cache type provided
+    # RESPONSE: ResultOfEncodeAccount
+    # account: String -     #     # Account BOC encoded in `base64`.
+    # id: String -     #     # Account ID  encoded in `hex`.
     def encode_account(payload, &block)
       core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: payload, &block)
     end
+
   end
 end
 
-
-
-
-
-