ton-client-ruby 1.0.0 → 1.0.1

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

@@ -1,5 +1,5 @@
 module TonClient
-  
+
   class Net
     include CommonInstanceHelpers
 
@@ -11,62 +11,112 @@ module TonClient
       @core = core
     end
 
+    # INPUT: ParamsOfQuery
+    # query: String -     #     # GraphQL query text.
+    # variables: Value -     #     # Variables used in query.    #     # Must be a map with named values that can be used in query.
+    # RESPONSE: ResultOfQuery
+    # result: Value -     #     # Result provided by DAppServer.
     def query(payload, &block)
       core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: payload, &block)
     end
 
+    # INPUT: ParamsOfBatchQuery
+    # operations: Array -     #     # List of query operations that must be performed per single fetch.
+    # RESPONSE: ResultOfBatchQuery
+    # results: Array -     #     # Result values for batched queries.    #     # Returns an array of values. Each value corresponds to `queries` item.
     def batch_query(payload, &block)
       core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: payload, &block)
     end
 
+    # INPUT: ParamsOfQueryCollection
+    # collection: String -     #     # Collection name (accounts, blocks, transactions, messages, block_signatures)
+    # filter: Value -     #     # Collection filter
+    # result: String -     #     # Projection (result) string
+    # order: Array<Optional> -     #     # Sorting order
+    # limit: Number<Optional> -     #     # Number of documents to return
+    # RESPONSE: ResultOfQueryCollection
+    # result: Array -     #     # Objects that match the provided criteria
     def query_collection(payload, &block)
       core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: payload, &block)
     end
 
+    # INPUT: ParamsOfAggregateCollection
+    # collection: String -     #     # Collection name (accounts, blocks, transactions, messages, block_signatures)
+    # filter: Value -     #     # Collection filter
+    # fields: Array<Optional> -     #     # Projection (result) string
+    # RESPONSE: ResultOfAggregateCollection
+    # values: Value -     #     # Values for requested fields.    #     # Returns an array of strings. Each string refers to the corresponding `fields` item.
+    # Numeric value is returned as a decimal string representations.
     def aggregate_collection(payload, &block)
       core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: payload, &block)
     end
 
+    # INPUT: ParamsOfWaitForCollection
+    # collection: String -     #     # Collection name (accounts, blocks, transactions, messages, block_signatures)
+    # filter: Value -     #     # Collection filter
+    # result: String -     #     # Projection (result) string
+    # timeout: Number<Optional> -     #     # Query timeout
+    # RESPONSE: ResultOfWaitForCollection
+    # result: Value -     #     # First found object that matches the provided criteria
     def wait_for_collection(payload, &block)
       core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: payload, &block)
     end
 
+    # INPUT: ResultOfSubscribeCollection
+    # handle: Number -     #     # Subscription handle.    #     # Must be closed with `unsubscribe`
     def unsubscribe(payload, &block)
       core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: payload, &block)
     end
 
+    # INPUT: ParamsOfSubscribeCollection
+    # collection: String -     #     # Collection name (accounts, blocks, transactions, messages, block_signatures)
+    # filter: Value -     #     # Collection filter
+    # result: String -     #     # Projection (result) string
+    # RESPONSE: ResultOfSubscribeCollection
+    # handle: Number -     #     # Subscription handle.    #     # Must be closed with `unsubscribe`
     def subscribe_collection(payload, &block)
       core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: payload, &block)
     end
 
-    def suspend(payload, &block)
-      core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: payload, &block)
+    def suspend(&block)
+      core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: {}, &block)
     end
 
-    def resume(payload, &block)
-      core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: payload, &block)
+    def resume(&block)
+      core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: {}, &block)
     end
 
+    # INPUT: ParamsOfFindLastShardBlock
+    # address: String -     #     # Account address
+    # RESPONSE: ResultOfFindLastShardBlock
+    # block_id: String -     #     # Account shard last block ID
     def find_last_shard_block(payload, &block)
       core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: payload, &block)
     end
 
-    def fetch_endpoints(payload, &block)
-      core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: payload, &block)
+    # RESPONSE: EndpointsSet
+    # endpoints: Array -     #     # List of endpoints provided by server
+    def fetch_endpoints(&block)
+      core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: {}, &block)
     end
 
+    # INPUT: EndpointsSet
+    # endpoints: Array -     #     # List of endpoints provided by server
     def set_endpoints(payload, &block)
       core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: payload, &block)
     end
 
+    # INPUT: ParamsOfQueryCounterparties
+    # account: String -     #     # Account address
+    # result: String -     #     # Projection (result) string
+    # first: Number<Optional> -     #     # Number of counterparties to return
+    # after: String<Optional> -     #     # `cursor` field of the last received result
+    # RESPONSE: ResultOfQueryCollection
+    # result: Array -     #     # Objects that match the provided criteria
     def query_counterparties(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/Processing.rb

@@ -1,5 +1,5 @@
 module TonClient
-  
+
   class Processing
     include CommonInstanceHelpers
 
@@ -11,22 +11,47 @@ module TonClient
       @core = core
     end
 
+    # INPUT: ParamsOfSendMessage
+    # message: String -     #     # Message BOC.
+    # abi: Value<Optional> -     #     # Optional message ABI.    #     # If this parameter is specified and the message has the`expire` header then expiration time will be checked againstthe current time to prevent unnecessary sending of already expired message.
+    # The `message already expired` error will be returned in thiscase.
+    # Note, that specifying `abi` for ABI compliant contracts isstrongly recommended, so that proper processing strategy can bechosen.
+    # send_events: Boolean -     #     # Flag for requesting events sending
+    # RESPONSE: ResultOfSendMessage
+    # shard_block_id: String -     #     # The last generated shard block of the message destination account before the message was sent.    #     # This block id must be used as a parameter of the`wait_for_transaction`.
+    # sending_endpoints: Array -     #     # The list of endpoints to which the message was sent.    #     # This list id must be used as a parameter of the`wait_for_transaction`.
     def send_message(payload, &block)
       core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: payload, &block)
     end
 
+    # INPUT: ParamsOfWaitForTransaction
+    # abi: Value<Optional> -     #     # Optional ABI for decoding the transaction result.    #     # If it is specified, then the output messages' bodies will bedecoded according to this ABI.
+    # The `abi_decoded` result field will be filled out.
+    # message: String -     #     # Message BOC.    #     # Encoded with `base64`.
+    # shard_block_id: String -     #     # The last generated block id of the destination account shard before the message was sent.    #     # You must provide the same value as the `send_message` has returned.
+    # send_events: Boolean -     #     # Flag that enables/disables intermediate events
+    # sending_endpoints: Array<Optional> -     #     # The list of endpoints to which the message was sent.    #     # You must provide the same value as the `send_message` has returned.
+    # RESPONSE: ResultOfProcessMessage
+    # transaction: Value -     #     # Parsed transaction.    #     # In addition to the regular transaction fields there is a`boc` field encoded with `base64` which contains sourcetransaction BOC.
+    # out_messages: Array -     #     # List of output messages' BOCs.    #     # Encoded as `base64`
+    # decoded: DecodedOutput<Optional> -     #     # Optional decoded message bodies according to the optional `abi` parameter.
+    # fees: TransactionFees -     #     # Transaction fees
     def wait_for_transaction(payload, &block)
       core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: payload, &block)
     end
 
+    # INPUT: ParamsOfProcessMessage
+    # message_encode_params: ParamsOfEncodeMessage -     #     # Message encode parameters.
+    # send_events: Boolean -     #     # Flag for requesting events sending
+    # RESPONSE: ResultOfProcessMessage
+    # transaction: Value -     #     # Parsed transaction.    #     # In addition to the regular transaction fields there is a`boc` field encoded with `base64` which contains sourcetransaction BOC.
+    # out_messages: Array -     #     # List of output messages' BOCs.    #     # Encoded as `base64`
+    # decoded: DecodedOutput<Optional> -     #     # Optional decoded message bodies according to the optional `abi` parameter.
+    # fees: TransactionFees -     #     # Transaction fees
     def process_message(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/Tvm.rb

@@ -1,5 +1,5 @@
 module TonClient
-  
+
   class Tvm
     include CommonInstanceHelpers
 
@@ -11,22 +11,52 @@ module TonClient
       @core = core
     end
 
+    # INPUT: ParamsOfRunExecutor
+    # message: String -     #     # Input message BOC.    #     # Must be encoded as base64.
+    # account: AccountForExecutor -     #     # Account to run on executor
+    # execution_options: ExecutionOptions<Optional> -     #     # Execution options.
+    # abi: Value<Optional> -     #     # Contract ABI for decoding output messages
+    # skip_transaction_check: Boolean<Optional> -     #     # Skip transaction check flag
+    # boc_cache: BocCacheType<Optional> -     #     # Cache type to put the result.    #     # The BOC itself returned if no cache type provided
+    # return_updated_account: Boolean<Optional> -     #     # Return updated account flag.    #     # Empty string is returned if the flag is `false`
+    # RESPONSE: ResultOfRunExecutor
+    # transaction: Value -     #     # Parsed transaction.    #     # In addition to the regular transaction fields there is a`boc` field encoded with `base64` which contains sourcetransaction BOC.
+    # out_messages: Array -     #     # List of output messages' BOCs.    #     # Encoded as `base64`
+    # decoded: DecodedOutput<Optional> -     #     # Optional decoded message bodies according to the optional `abi` parameter.
+    # account: String -     #     # Updated account state BOC.    #     # Encoded as `base64`
+    # fees: TransactionFees -     #     # Transaction fees
     def run_executor(payload, &block)
       core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: payload, &block)
     end
 
+    # INPUT: ParamsOfRunTvm
+    # message: String -     #     # Input message BOC.    #     # Must be encoded as base64.
+    # account: String -     #     # Account BOC.    #     # Must be encoded as base64.
+    # execution_options: ExecutionOptions<Optional> -     #     # Execution options.
+    # abi: Value<Optional> -     #     # Contract ABI for decoding output messages
+    # boc_cache: BocCacheType<Optional> -     #     # Cache type to put the result.    #     # The BOC itself returned if no cache type provided
+    # return_updated_account: Boolean<Optional> -     #     # Return updated account flag.    #     # Empty string is returned if the flag is `false`
+    # RESPONSE: ResultOfRunTvm
+    # out_messages: Array -     #     # List of output messages' BOCs.    #     # Encoded as `base64`
+    # decoded: DecodedOutput<Optional> -     #     # Optional decoded message bodies according to the optional `abi` parameter.
+    # account: String -     #     # Updated account state BOC.    #     # Encoded as `base64`. Attention! Only `account_state.storage.state.data` part of the BOC is updated.
     def run_tvm(payload, &block)
       core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: payload, &block)
     end
 
+    # INPUT: ParamsOfRunGet
+    # account: String -     #     # Account BOC in `base64`
+    # function_name: String -     #     # Function name
+    # input: Value -     #     # Input parameters
+    # execution_options: ExecutionOptions<Optional> -     #     # Execution options
+    # tuple_list_as_array: Boolean<Optional> -     #     # Convert lists based on nested tuples in the **result** into plain arrays.    #     # Default is `false`. Input parameters may use any of lists representationsIf you receive this error on Web: "Runtime error. Unreachable code should not be executed...",set this flag to true.
+    # This may happen, for example, when elector contract contains too many participants
+    # RESPONSE: ResultOfRunGet
+    # output: Value -     #     # Values returned by get-method on stack
     def run_get(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/Utils.rb

@@ -1,5 +1,5 @@
 module TonClient
-  
+
   class Utils
     include CommonInstanceHelpers
 
@@ -11,26 +11,41 @@ module TonClient
       @core = core
     end
 
+    # INPUT: ParamsOfConvertAddress
+    # address: String -     #     # Account address in any TON format.
+    # output_format: AddressStringFormat -     #     # Specify the format to convert to.
+    # RESPONSE: ResultOfConvertAddress
+    # address: String -     #     # Address in the specified format
     def convert_address(payload, &block)
       core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: payload, &block)
     end
 
+    # INPUT: ParamsOfCalcStorageFee
+    # account: String - 
+    # period: Number - 
+    # RESPONSE: ResultOfCalcStorageFee
+    # fee: String - 
     def calc_storage_fee(payload, &block)
       core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: payload, &block)
     end
 
+    # INPUT: ParamsOfCompressZstd
+    # uncompressed: String -     #     # Uncompressed data.    #     # Must be encoded as base64.
+    # level: Number<Optional> -     #     # Compression level, from 1 to 21. Where: 1 - lowest compression level (fastest compression); 21 - highest compression level (slowest compression). If level is omitted, the default compression level is used (currently `3`).
+    # RESPONSE: ResultOfCompressZstd
+    # compressed: String -     #     # Compressed data.    #     # Must be encoded as base64.
     def compress_zstd(payload, &block)
       core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: payload, &block)
     end
 
+    # INPUT: ParamsOfDecompressZstd
+    # compressed: String -     #     # Compressed data.    #     # Must be encoded as base64.
+    # RESPONSE: ResultOfDecompressZstd
+    # decompressed: String -     #     # Decompressed data.    #     # Must be encoded as base64.
     def decompress_zstd(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/Helpers/CommonHelpers.rb

@@ -23,6 +23,14 @@ module CommonInstanceHelpers
   def full_method_name(module_name, method_name)
     "#{module_name}.#{method_name}"
   end
+
+  def base64?(value)
+    value.is_a?(String) && (Base64.encode64(Base64.decode64(value)).strip == value)
+  end
+
+  def encode_to_base64(message)
+    Base64.encode64(message.force_encoding('UTF-8')).strip
+  end
 end
 
 class << Object

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

@@ -1,3 +1,3 @@
 module TonClient
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ton-client-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - nerzh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-10 00:00:00.000000000 Z
+date: 2021-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.13.1
+        version: 1.15.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.13.1
+        version: 1.15.0
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -97,10 +97,12 @@ dependencies:
 description: Gem Ton Client Ruby for all ruby projects
 email:
 - emptystamp@gmail.com
-executables: []
+executables:
+- ton-client-ruby
 extensions: []
 extra_rdoc_files: []
 files:
+- bin/ton-client-ruby
 - lib/ton-client-ruby.rb
 - lib/ton-client-ruby/Binding/binding.rb
 - lib/ton-client-ruby/Binding/struct.rb