ton_sdk_client 1.26.0 → 1.34.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6089c778489c542c5be6b2f08aaa25b658b0de1bc82cea166a36fe6005e6430e
-  data.tar.gz: 05511b5132c85588c2f2d9c9c26fc1681fa08ebecbf4445f7d4171ae997e9fc7
+  metadata.gz: 5a7f0b6efe10b27110b81583c88d1001e261d4a65d5b244698c7fb1f6f948e1c
+  data.tar.gz: c589d48fba0d43db0eaeebb1f0997414d9b27a64b84d05f0815a2a5e590f9b9b
 SHA512:
-  metadata.gz: a5287864732773d988a8a668e6a19a99d8c199bfbf59ddd913924c334771bcaf43b64ed1ed423ceb67270c5dfe1ad2a534cfb5251d2562981b2ff15351e9cc92
-  data.tar.gz: d058acfb7188d6e5c96a2b01294d90494138254ebfbf991f9ba97990c1b191cb10a0746a9247302bb610a6b42ce050af5b8e48cc12992c374c9ee30ab1d8b79d
+  metadata.gz: b596337a82d897dc1d7f5e8805525d34f4121e052f22a1ebdc8253c87d1199347c658e89f0874cac8abdd5f1d9d7f2863a882be40ba92a2f9ccef80a39ea84d8
+  data.tar.gz: b156904a3e7d0087c1e110f9d77dbecd52e660811f82fabad23a6b0a6fbf59e2c436e0efb07bd05cdc7a2dd74c6b2e7de5b0051be89058d19a061286708d33a5

data/CHANGELOG.md

@@ -2,17 +2,30 @@
 
 all the changes are always according to the ones of the main TON SDK library; and on top on that, there may be additional ones
 
+1.34.0
+-----
+* Changes https://github.com/tonlabs/ever-sdk/blob/master/CHANGELOG.md
+
+1.28.0
+-----
+* Changes `1.28.0` https://github.com/tonlabs/ever-sdk/blob/master/CHANGELOG.md#1280--2021-12-24
+* Implement Debot module
+
+1.27.0
+-----
+* Changes `1.27.0` https://github.com/tonlabs/ever-sdk/blob/master/CHANGELOG.md#1270--2021-12-03
+
 1.26.0
 -----
-* Changes `1.26.0` https://github.com/tonlabs/TON-SDK/blob/master/CHANGELOG.md#1260--2021-11-25
+* Changes `1.26.0` https://github.com/tonlabs/ever-sdk/blob/master/CHANGELOG.md#1260--2021-11-25
 
 1.25.0
 -----
-* Changes `1.25.0` https://github.com/tonlabs/TON-SDK/blob/master/CHANGELOG.md#1250--2021-11-08
+* Changes `1.25.0` https://github.com/tonlabs/ever-sdk/blob/master/CHANGELOG.md#1250--2021-11-08
 
 1.24.0
 -----
-* Changes `1.24.0` https://github.com/tonlabs/TON-SDK/blob/master/CHANGELOG.md#1240--2021-10-18
+* Changes `1.24.0` https://github.com/tonlabs/ever-sdk/blob/master/CHANGELOG.md#1240--2021-10-18
 * **BREAKING CHANGE** All Params now require keyword arguments
 
 1.20.x

data/README.md

@@ -1,44 +1,39 @@
-# TON SDK client in Ruby and for Ruby
+# Ever SDK (formerly TON SDK) client in Ruby and for Ruby
 
 [![Gem Version](https://badge.fury.io/rb/ton_sdk_client.svg)](https://rubygems.org/gems/ton_sdk_client)
-[![TON SDK version](https://img.shields.io/badge/TON%20SDK%20version-1.26.0-green)](https://github.com/tonlabs/TON-SDK/tree/1.26.0)
+[![Ever SDK version](https://img.shields.io/badge/Ever%20SDK%20version-1.34.0-green)](https://github.com/tonlabs/ever-sdk/tree/1.34.0)
 
-Ruby gem-client bindings for [TON SDK](https://github.com/tonlabs/TON-SDK) which allows one to communicate with [FreeTON](https://freeton.org) blockchain in Ruby.
+Ruby gem-client bindings for [Ever SDK](https://github.com/tonlabs/ever-sdk) which allows one to communicate with [Everscale](https://everscale.network/) blockchain in Ruby.
 
-Note that there're 2 types of versions:
+Note that there are 2 types of versions:
   * `TonSdk::VERSION` - the version of the gem
   * `TonSdk::NATIVE_SDK_VERSION` - the version of the original SDK
 
 and they may not always match each other.
 
-
-
 ## Installation
 
 Add this to the `Gemfile` of a project:
 
 ```ruby
-gem 'ton_sdk_client'
+gem "ton_sdk_client"
 ```
 and run `bundle install`
 
 Alternatively install it directly
 
-```
+```shell
 gem install ton_sdk_client
 ```
 
-
 ## Requirements
 
 The gem requires `tonclient` native library, appropriate for one's OS; the download links are at:
 
-https://github.com/tonlabs/TON-SDK/#download-precompiled-binaries
+https://github.com/tonlabs/ever-sdk#download-precompiled-binaries
 
 Once downloaded, unpack it into a directory of your choice and then set an environmental variable `TON_CLIENT_NATIVE_LIB_NAME` pointing to the full path of a library.
 
-Also, check out the file `.ruby-version` to see which version has been used to develop the gem. Some older versions of ruby may work as well.
-
 ## Examples
 
 The examples are located in the `examples` directory, and they cover most the modules.
@@ -46,7 +41,7 @@ The examples are located in the `examples` directory, and they cover most the mo
 And here's a simple minimalistic one:
 
 ```ruby
-require 'ton_sdk_client'
+require "ton_sdk_client"
 
 cfg = TonSdk::ClientConfig.new(
   network: TonSdk::NetworkConfig.new(
@@ -60,7 +55,7 @@ c_ctx = TonSdk::ClientContext.new(cfg.to_h.to_json)
 # next, call a method of a module you want passing a context to it
 TonSdk::Client.version(c_ctx.context) do |res|
 
-  # 'res' is of type TonSdk::NativeLibResponsetResult
+  # 'res' is of type TonSdk::NativeLibResponseResult
   # holds either 'result' or 'error'
   # to check which one it is, use boolean methods:
   # res.success? or res.failure?
@@ -75,13 +70,12 @@ end
 ```
 
 In this case, the method `version()` requires only a `context` object. But most others require an additional 2nd argument appropriate for a certain method.
-Note that some methods, such some of the `Processing`, `Net`, `Tvm` modules, will continue to run for some time asyncronously delivering a result to a user, for instance, `Processing.process_message(...)` will do it via a callback
+Note that some methods, such some of the `Processing`, `Net`, `Tvm` modules, will continue to run for some time asynchronously delivering a result to a user, for instance, `Processing.process_message(...)` will do it via a callback
 
 ```ruby
-
   my_callback = Proc.new do |a|
 
-    # will be triggered multiple times, asyncronously
+    # will be triggered multiple times, asynchronously
     puts "callback fired: #{a}"
   end
 
@@ -93,32 +87,17 @@ Note that some methods, such some of the `Processing`, `Net`, `Tvm` modules, wil
   TonSdk::Processing.process_message(@c_ctx.context, pr1, my_callback) do |a|
     # [.......]
   end
-
 ```
 
 while other methods will deliver a result relatively fast, without a callback, and terminate.
 
-
-## Implementation coverage, by modules
-- ✅ abi
-- ✅ boc
-- ✅ client
-- ✅ crypto
-- ✅ net
-- ✅ processing
-- ✅ tvm
-- ✅ utils
-- ✅ debot (unstable)
-
-
 ## Documentation
 
   * https://docs.ton.dev/86757ecb2/p/7941cd-what-is-ton-os
-  * https://github.com/tonlabs/TON-SDK/tree/master/docs
-  * https://github.com/tonlabs/TON-SDK/blob/master/tools/api.json
-
-Mind the current version of SDK when reading documentation and examples at https://github.com/tonlabs/TON-SDK
+  * https://github.com/tonlabs/ever-sdk/tree/master/docs
+  * https://github.com/tonlabs/ever-sdk/blob/master/tools/api.json
 
+Mind the current version of SDK when reading documentation and examples at https://github.com/tonlabs/ever-sdk
 
 ## Using it as a developer
 
@@ -131,8 +110,7 @@ cd ton-client-ruby
 
 ### Install the dependencies
 ```
-gem install ffi
-gem install concurrent-ruby
+gem install ffi concurrent-ruby rspec
 ```
 There may be other dependencies too, check the `gemspec` file for the full list of them.
 
@@ -153,16 +131,6 @@ or run a specific set of the tests:
 rspec spec/boc_spec.rb
 ```
 
-## Test coverage, by modules
-- ✅ abi
-- ✅ boc
-- ✅ client
-- ✅ crypto
-- ✅ net
-- ✅ processing
-- ✅ tvm
-- ✅ utils
-
 
 ### Run the examples
 
@@ -180,40 +148,31 @@ factorize
 ```
 
 
-## Tested at and with
+## Tested with
 
 * MacOS Catalina 10.15.5
 * Arch Linux x86_64
-* TON client native library: `TonSdk::NATIVE_SDK_VERSION`
-
 
 ## References
   * Wiki of the gem FFI: https://github.com/ffi/ffi/wiki ; callbacks: https://github.com/ffi/ffi/wiki/Callbacks
-
   * https://stackoverflow.com/questions/60689128/ruby-ffi-callback-return-values
 
-
 ## Notes
   * Rspec validators or matchers don't work in a block of a non main thread, therefore in the tests an intermediate variable is used to save a result, a block, and then validate it outside of a block.
-
-  * Testing asyncronous code in Ruby is difficult and can incur hacks. Not all asyncronous code should be tested automatically via Rspec or other libraries, some should be instead tested manually once and then left alone thereafter:
+  * Testing asynchronous code in Ruby is difficult and can incur hacks. Not all asynchronous code should be tested automatically via Rspec or other libraries, some should be instead tested manually once and then left alone thereafter:
   https://www.mikeperham.com/2015/12/14/how-to-test-multithreaded-code
-
-  * In some of the tests of the gem a "sleep" loop with a timeout are used to wait for an asyncronous operation to deliver a result, and this approach will do, although it can be replaced with a more idiomatic one. Oweing to the side effects, at times some tests may fail. When it happens, try to increase a timeout:
+  * In some of the tests of the gem a "sleep" loop with a timeout are used to wait for an asynchronous operation to deliver a result, and this approach will do, although it can be replaced with a more idiomatic one. Oweing to the side effects, at times some tests may fail. When it happens, try to increase a timeout:
 
   ```ruby
-  timeout_at = get_timeout_for_async_operation()
+  timeout_at = get_timeout_for_async_operation
 
   # before, 5 seconds by default
-  sleep(0.1) until @res || get_now() >= timeout_at
+  sleep(0.1) until @res || get_now >= timeout_at
 
   # after, longer timeout
-  sleep(0.1) until @res || get_now() >= (timeout_at * 2)
+  sleep(0.1) until @res || get_now >= (timeout_at * 2)
   ```
 
-  * No automatic generator has been used to generate Ruby classes or bindings to the SDK. Why not? Because no appropriate, simple and functional one has been found.
-
-
 ## Credits
 
 * [Tonlabs.io](https://tonlabs.io)
@@ -230,5 +189,6 @@ See the `CHANGELOG` file
 
 ## Community
 
-* news about FreeTON on Telegram https://t.me/ton_crystal_news
-* [FreeTON](https://freeton.org)
+* Everscale News on Telegram https://t.me/everscale_news
+* Everscale DEV Tools & SDK Telegram chat https://t.me/ever_sdk
+* [Everscale](https://everscale.network/)

data/lib/ton_sdk_client/abi.rb

@@ -315,15 +315,16 @@ module TonSdk
       end
     end
 
-    ParamsOfDecodeMessage = KwStruct.new(:abi, :message) do
-      def initialize(abi:, message:)
+    ParamsOfDecodeMessage = KwStruct.new(:abi, :message, :allow_partial) do
+      def initialize(abi:, message:, allow_partial: false)
         super
       end
 
       def to_h
         {
           abi: abi&.to_h,
-          message: message
+          message: message,
+          allow_partial: allow_partial
         }
       end
     end
@@ -391,8 +392,8 @@ module TonSdk
       end
     end
 
-    ParamsOfDecodeMessageBody = KwStruct.new(:abi, :body, :is_internal) do
-      def initialize(abi:, body:, is_internal:)
+    ParamsOfDecodeMessageBody = KwStruct.new(:abi, :body, :is_internal, :allow_partial) do
+      def initialize(abi:, body:, is_internal:, allow_partial: false)
         super
       end
 
@@ -400,7 +401,8 @@ module TonSdk
         {
           abi: abi&.to_h,
           body: body,
-          is_internal: is_internal
+          is_internal: is_internal,
+          allow_partial: allow_partial
         }
       end
     end
@@ -725,11 +727,16 @@ module TonSdk
       end
     end
 
-    ParamsOfDecodeAccountData = KwStruct.new(:abi, :data) do
+    ParamsOfDecodeAccountData = KwStruct.new(:abi, :data, :allow_partial) do
+      def initialize(abi:, data:, allow_partial: false)
+        super
+      end
+
       def to_h
         {
           abi: abi&.to_h,
-          data: data
+          data: data,
+          allow_partial: allow_partial
         }
       end
     end
@@ -756,11 +763,29 @@ module TonSdk
 
     ResultOfUpdateInitialData = KwStruct.new(:data)
 
-    ParamsOfDecodeInitialData = KwStruct.new(:data, :abi) do
+    ParamsOfEncodeInitialData = KwStruct.new(:abi, :initial_data, :initial_pubkey, :boc_cache) do
+      def to_h
+        {
+          abi: abi&.to_h,
+          initial_data: initial_data,
+          initial_pubkey: initial_pubkey,
+          boc_cache: boc_cache&.to_h
+        }
+      end
+    end
+
+    ResultOfEncodeInitialData = KwStruct.new(:data)
+
+    ParamsOfDecodeInitialData = KwStruct.new(:data, :abi, :allow_partial) do
+      def initialize(data:, abi:, allow_partial: false)
+        super
+      end
+
       def to_h
         {
           data: data,
-          abi: abi&.to_h
+          abi: abi&.to_h,
+          allow_partial: allow_partial
         }
       end
     end
@@ -779,6 +804,18 @@ module TonSdk
 
     ResultOfDecodeBoc = KwStruct.new(:data)
 
+    ParamsOfAbiEncodeBoc = KwStruct.new(:params, :data, :boc_cache) do
+      def to_h
+        {
+          params: params&.map(&:to_h),
+          data: data,
+          boc_cache: boc_cache&.to_h
+        }
+      end
+    end
+
+    ResultOfAbiEncodeBoc = KwStruct.new(:boc)
+
     #
     # functions
     #
@@ -923,6 +960,20 @@ module TonSdk
       end
     end
 
+    def self.encode_initial_data(ctx, params)
+      Interop::request_to_native_lib(ctx, "abi.encode_initial_data", params) do |resp|
+        if resp.success?
+          yield NativeLibResponseResult.new(
+            result: ResultOfEncodeInitialData.new(
+              data: resp.result["data"]
+            )
+          )
+        else
+          yield resp
+        end
+      end
+    end
+
     def self.decode_initial_data(ctx, params)
       Interop::request_to_native_lib(ctx, "abi.decode_initial_data", params) do |resp|
         if resp.success?
@@ -951,5 +1002,19 @@ module TonSdk
         end
       end
     end
+
+    def self.encode_boc(ctx, params)
+      Interop::request_to_native_lib(ctx, "abi.encode_boc", params) do |resp|
+        if resp.success?
+          yield NativeLibResponseResult.new(
+            result: ResultOfAbiEncodeBoc.new(
+              boc: resp.result["boc"]
+            )
+          )
+        else
+          yield resp
+        end
+      end
+    end
   end
 end

data/lib/ton_sdk_client/boc.rb

@@ -130,6 +130,20 @@ module TonSdk
 
     ResultOfEncodeTvc = KwStruct.new(:tvc)
 
+    ParamsOfEncodeExternalInMessage = KwStruct.new(:src, :dst, :init, :body, :boc_cache) do
+      def to_h
+        {
+          src: src,
+          dst: dst,
+          init: init,
+          body: body,
+          boc_cache: boc_cache&.to_h
+        }
+      end
+    end
+
+    ResultOfEncodeExternalInMessage = KwStruct.new(:message, :message_id)
+
     ParamsOfGetCompilerVersion = KwStruct.new(:code)
 
     ResultOfGetCompilerVersion = KwStruct.new(:version)
@@ -370,6 +384,21 @@ module TonSdk
       end
     end
 
+    def self.encode_external_in_message(ctx, params)
+      Interop::request_to_native_lib(ctx, "boc.encode_external_in_message", params) do |resp|
+        if resp.success?
+          yield NativeLibResponseResult.new(
+            result: ResultOfEncodeExternalInMessage.new(
+              message: resp.result["message"],
+              message_id: resp.result["message_id"]
+            )
+          )
+        else
+          yield resp
+        end
+      end
+    end
+
     def self.get_compiler_version(ctx, params)
       Interop::request_to_native_lib(ctx, "boc.get_compiler_version", params) do |resp|
         if resp.success?

data/lib/ton_sdk_client/client.rb

@@ -122,6 +122,23 @@ module TonSdk
       end
     end
 
+    def self.config(ctx)
+      Interop::request_to_native_lib(ctx, "client.config") do |resp|
+        if resp.success?
+          yield NativeLibResponseResult.new(
+            result: ClientConfig.new(
+              network: resp.result["network"],
+              crypto: resp.result["crypto"],
+              abi: resp.result["abi"],
+              boc: resp.result["boc"]
+            )
+          )
+        else
+          yield resp
+        end
+      end
+    end
+
     def self.get_api_reference(ctx)
       Interop::request_to_native_lib(ctx, "client.get_api_reference") do |resp|
         if resp.success?

data/lib/ton_sdk_client/config.rb

@@ -15,6 +15,9 @@ module TonSdk
     :latency_detection_interval,
     :max_latency,
     :query_timeout,
+    :queries_protocol,
+    :first_remp_status_timeout,
+    :next_remp_status_timeout,
     :access_key
   ) do
     def initialize(
@@ -31,12 +34,20 @@ module TonSdk
       latency_detection_interval: 60000,
       max_latency: 60000,
       query_timeout: 60000,
+      queries_protocol: nil,
+      first_remp_status_timeout: nil,
+      next_remp_status_timeout: nil,
       access_key: nil
     )
       super
     end
   end
 
+  module NetworkQueriesProtocol
+    HTTP = "HTTP".freeze
+    WS = "WS".freeze
+  end
+
   AbiConfig = KwStruct.new(
     :workchain,
     :message_expiration_timeout,
@@ -63,5 +74,4 @@ module TonSdk
       }
     end
   end
-
 end