ton-client-ruby 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0321af077acd0b4c971b583f6448bbb0c9633abfd72be60a9a442bd595f74bc2
-  data.tar.gz: 3e2bca8f73c5dd23dc5c60be5655d2f777d58a5870d1176d3633ef69d0eb52b4
+  metadata.gz: d7dfd053a1c976028bc40dfe2cf9bb4750beee2688428ae7b8cfc9ff7e3c4d8d
+  data.tar.gz: 651588ea67891811a9a847dda130c5cc2c6d1aac770213254b16c47ce4384238
 SHA512:
-  metadata.gz: 242a9a7821f494ef4165d3c3b25d680c194b9be860a766fab753d44b05332a1c5a14e5674347a0af31f52af34e751a980352070000c1cadd67b4949e88faba11
-  data.tar.gz: fdca0400955e2d5010bde1ed0ca3b938f43a9198c315e8bed2cca7d9518bca57ee02f1447576a5dd52b6a1c03b26601fbd641d2c3d3b099ae68beec2ffacef1c
+  metadata.gz: 30e93f4c4d28c0b0d8af0766a5d9f632b1a3263ff63ac0edb312bb552b28404f5a2c5129fc418b9a18c440e7a6e6be8e18886c8377d83b28d58157d9052572e1
+  data.tar.gz: 88ea3e6773d2d005a48ffdc7cb1ca4992f4a0955606814ceaed33c9f391b4842fac02d8043c35496fd69feb9eea70c34080b6c0b4f6b73eddf10122818c4dc46

data/bin/ton-client-ruby

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+
+require File.dirname(__FILE__) + '/../code_generator/api_converter.rb'
+require File.dirname(__FILE__) + '/../code_generator/code_generator.rb'
+
+GEM_DIR = File.dirname(__FILE__) + '/..'
+
+if ARGV[0] == 'update'
+  if !ARGV[1]
+    puts ''
+    puts ''
+    p "PLEASE DOWNLOAD api.json from https://github.com/tonlabs/TON-SDK/blob/master/tools/api.json and pass as second parameter."
+    p "Example: ton-client-ruby update ./api.json" 
+    puts ''
+    return
+  end
+  api_json_path = ARGV[1]
+  json = ''
+  if File.exists?(api_json_path)
+    json = File.read(api_json_path)
+  else
+    p "Current directory: #{Dir.pwd}. File #{api_json_path} is not exist"
+    exit 0
+  end
+  converter = ApiConverter.new(json)
+  types = converter.convert
+  generator = CodeGenerator.new(types, GEM_DIR)
+  generator.generate_self_code
+elsif ARGV[0] == 'update' && ARGV[1] == nil
+  p 'soon from github'
+elsif ARGV[0] == 'setup'
+  raise "\nPLEASE INSTALL RUST TO YOUR SYSTEM. \nTry this command: \ncurl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh" if `which rustc`.strip.empty?
+  system("cd #{GEM_DIR} && git clone https://github.com/tonlabs/TON-SDK ./TON-SDK")
+  system("cd #{GEM_DIR}/TON-SDK && git pull --ff-only")
+  system("cd #{GEM_DIR}/TON-SDK && cargo update")
+  system("cd #{GEM_DIR}/TON-SDK && cargo build --release")
+  puts "PATH TO YOR DYNAMIC LIBRARY IS: #{GEM_DIR}/TON-SDK/target/release/libton_client.dylib"
+end

data/lib/ton-client-ruby.rb

@@ -1,8 +1,11 @@
+require 'bundler/setup'
+Bundler.setup
 require 'ffi'
 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
 
-
-
-
-
-

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

@@ -1,5 +1,5 @@
 module TonClient
-  
+
   class Boc
     include CommonInstanceHelpers
 
@@ -11,58 +11,105 @@ module TonClient
       @core = core
     end
 
+    # INPUT: ParamsOfParse
+    # boc: String -     #     # BOC encoded as base64
+    # RESPONSE: ResultOfParse
+    # parsed: Value -     #     # JSON containing parsed BOC
     def parse_message(payload, &block)
       core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: payload, &block)
     end
 
+    # INPUT: ParamsOfParse
+    # boc: String -     #     # BOC encoded as base64
+    # RESPONSE: ResultOfParse
+    # parsed: Value -     #     # JSON containing parsed BOC
     def parse_transaction(payload, &block)
       core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: payload, &block)
     end
 
+    # INPUT: ParamsOfParse
+    # boc: String -     #     # BOC encoded as base64
+    # RESPONSE: ResultOfParse
+    # parsed: Value -     #     # JSON containing parsed BOC
     def parse_account(payload, &block)
       core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: payload, &block)
     end
 
+    # INPUT: ParamsOfParse
+    # boc: String -     #     # BOC encoded as base64
+    # RESPONSE: ResultOfParse
+    # parsed: Value -     #     # JSON containing parsed BOC
     def parse_block(payload, &block)
       core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: payload, &block)
     end
 
+    # INPUT: ParamsOfParseShardstate
+    # boc: String -     #     # BOC encoded as base64
+    # id: String -     #     # Shardstate identificator
+    # workchain_id: Number -     #     # Workchain shardstate belongs to
+    # RESPONSE: ResultOfParse
+    # parsed: Value -     #     # JSON containing parsed BOC
     def parse_shardstate(payload, &block)
       core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: payload, &block)
     end
 
+    # INPUT: ParamsOfGetBlockchainConfig
+    # block_boc: String -     #     # Key block BOC or zerostate BOC encoded as base64
+    # RESPONSE: ResultOfGetBlockchainConfig
+    # config_boc: String -     #     # Blockchain config BOC encoded as base64
     def get_blockchain_config(payload, &block)
       core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: payload, &block)
     end
 
+    # INPUT: ParamsOfGetBocHash
+    # boc: String -     #     # BOC encoded as base64
+    # RESPONSE: ResultOfGetBocHash
+    # hash: String -     #     # BOC root hash encoded with hex
     def get_boc_hash(payload, &block)
       core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: payload, &block)
     end
 
+    # INPUT: ParamsOfGetCodeFromTvc
+    # tvc: String -     #     # Contract TVC image encoded as base64
+    # RESPONSE: ResultOfGetCodeFromTvc
+    # code: String -     #     # Contract code encoded as base64
     def get_code_from_tvc(payload, &block)
       core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: payload, &block)
     end
 
+    # INPUT: ParamsOfBocCacheGet
+    # boc_ref: String -     #     # Reference to the cached BOC
+    # RESPONSE: ResultOfBocCacheGet
+    # boc: String<Optional> -     #     # BOC encoded as base64.
     def cache_get(payload, &block)
       core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: payload, &block)
     end
 
+    # INPUT: ParamsOfBocCacheSet
+    # boc: String -     #     # BOC encoded as base64 or BOC reference
+    # cache_type: BocCacheType -     #     # Cache type
+    # RESPONSE: ResultOfBocCacheSet
+    # boc_ref: String -     #     # Reference to the cached BOC
     def cache_set(payload, &block)
       core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: payload, &block)
     end
 
+    # INPUT: ParamsOfBocCacheUnpin
+    # pin: String -     #     # Pinned name
+    # boc_ref: String<Optional> -     #     # Reference to the cached BOC.    #     # If it is provided then only referenced BOC is unpinned
     def cache_unpin(payload, &block)
       core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: payload, &block)
     end
 
+    # INPUT: ParamsOfEncodeBoc
+    # builder: Array -     #     # Cell builder operations.
+    # boc_cache: BocCacheType<Optional> -     #     # Cache type to put the result. The BOC itself returned if no cache type provided.
+    # RESPONSE: ResultOfEncodeBoc
+    # boc: String -     #     # Encoded cell BOC or BOC cache key.
     def encode_boc(payload, &block)
       core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: payload, &block)
     end
+
   end
 end
 
-
-
-
-
-

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

@@ -1,10 +1,10 @@
 module TonClient
-  
+
   class Client
     include CommonInstanceHelpers
 
     attr_reader :core, :context
-    private_accessor :_crypto, :_abi, :_boc, :_net, :_processing, :_tvm, :_utils
+    private_accessor :_crypto, :_abi, :_boc, :_processing, :_utils, :_tvm, :_net, :_debot
     MODULE = self.to_s.downcase.gsub(/^(.+::|)(\w+)$/, '\2').freeze
 
     def initialize(context: Context.new, core: TonClient::TonBinding)
@@ -12,22 +12,6 @@ module TonClient
       @core = core
     end
 
-    def version(&block)
-      core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: {}, &block)
-    end
-
-    def get_api_reference(&block)
-      core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: {}, &block)
-    end
-
-    def build_info(&block)
-      core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: {}, &block)
-    end
-
-    def resolve_app_request(&block)
-      core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: {}, &block)
-    end
-
     def destroy_context
       core.tc_destroy_context(context.id)
     end
@@ -44,20 +28,52 @@ module TonClient
       _boc ||= Boc.new(context: context)
     end
 
-    def net
-      _net ||= Net.new(context: context)
-    end
-
     def processing
       _processing ||= Processing.new(context: context)
     end
 
+    def utils
+      _utils ||= Utils.new(context: context)
+    end
+
     def tvm
       _tvm ||= Tvm.new(context: context)
     end
 
-    def utils
-      _utils ||= Utils.new(context: context)
+    def net
+      _net ||= Net.new(context: context)
+    end
+
+    def debot
+      _debot ||= Debot.new(context: context)
+    end
+
+    # RESPONSE: ResultOfGetApiReference
+    # api: Value - 
+    def get_api_reference(&block)
+      core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: {}, &block)
     end
+
+    # RESPONSE: ResultOfVersion
+    # version: String -     #     # Core Library version
+    def version(&block)
+      core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: {}, &block)
+    end
+
+    # RESPONSE: ResultOfBuildInfo
+    # build_number: Number -     #     # Build number assigned to this build by the CI.
+    # dependencies: Array -     #     # Fingerprint of the most important dependencies.
+    def build_info(&block)
+      core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: {}, &block)
+    end
+
+    # INPUT: ParamsOfResolveAppRequest
+    # app_request_id: Number -     #     # Request ID received from SDK
+    # result: AppRequestResult -     #     # Result of request processing
+    def resolve_app_request(payload, &block)
+      core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: payload, &block)
+    end
+
   end
-end
+end
+

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

@@ -8,6 +8,7 @@ module TonClient
       @config = TonBinding.make_string(config.to_json)
       context = TonBinding.tc_create_context(@config)
       @id = TonBinding.read_string_to_hash(context)['result']
+      ObjectSpace.define_finalizer(self, self.class.finalize(@id))
     end
 
     def config=(value = {})
@@ -22,8 +23,12 @@ module TonClient
       TonBinding.tc_destroy_context(id)
     end
 
-    def self.finalize
-      TonBinding.tc_destroy_context(id)
+    def self.finalize(id)
+      Proc.new do
+        if (id != nil) && (id > 0)
+          TonBinding.tc_destroy_context(id)
+        end
+      end
     end
   end
 end