everscale-client-ruby 1.1.23 → 1.1.28

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e4378aa3309111cae784451d25b433bbee3281a701c359b99b1d042c2d097b4
-  data.tar.gz: 45c712c85370b6e5357f9d424015595173562c5791c7ddabd484e6d5e28c9e7c
+  metadata.gz: 02004364bdc99b10b5d54b95e8f1215189ec9698c147e5cca10b89de20e801b7
+  data.tar.gz: cf365a553241442768bee5f17c1507c9c38a872e1ce2fbca474aafdd90f46f96
 SHA512:
-  metadata.gz: bcd94078f6507d2ca3865125da0779f29430df1bfb32b915a89a2ef490f89dda2883a589ea0cb8747373a43bd7e1c2344d74ed2b7565112be19f3f8e66d517ad
-  data.tar.gz: 978db55faec424a07e0f5bc64633c7fd5fea4a98a254cfeeeaa6c19b644c87082b42c928de69c58963ef961a8a34f4507c924fecddda11dafa7dfe269a17f5bc
+  metadata.gz: 07ee9f04575ddea0e95f083b05fdd23a7281eefc8188f5e0277e6b62596a5778f0f771d1a1b9bdc60b7993d15113627b0a02088370bf9528d141290b93eceb7c
+  data.tar.gz: 8f94ae8fb2888c296df8c491a2a06c6ee49c242ef40cfa2718abee0b689cf94c556aa4751f10514581efc9d7060a297f642c7fce2a12af42a854d0c07af9bc00

data/lib/code_generator/api.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.31.0",
+  "version": "1.33.0",
   "modules": [
     {
       "name": "client",
@@ -365,7 +365,7 @@
               "optional_inner": {
                 "type": "String"
               },
-              "summary": "DApp Server public address. For instance, for `net.ton.dev/graphql` GraphQL endpoint the server address will be net.ton.dev",
+              "summary": "**This field is deprecated, but left for backward-compatibility.** DApp Server public address.",
               "description": null
             },
             {
@@ -378,7 +378,7 @@
                 }
               },
               "summary": "List of DApp Server addresses.",
-              "description": "Any correct URL format can be specified, including IP addresses This parameter is prevailing over `server_address`."
+              "description": "Any correct URL format can be specified, including IP addresses. This parameter is prevailing over `server_address`.\nCheck the full list of [supported network endpoints](../ton-os-api/networks.md)."
             },
             {
               "name": "network_retries_count",
@@ -466,7 +466,7 @@
                 "number_size": 8
               },
               "summary": "Maximum number of randomly chosen endpoints the library uses to broadcast a message.",
-              "description": "Default is 2."
+              "description": "Default is 1."
             },
             {
               "name": "latency_detection_interval",
@@ -501,6 +501,38 @@
               "summary": "Default timeout for http requests.",
               "description": "Is is used when no timeout specified for the request to limit the answer waiting time. If no answer received during the timeout requests ends with\nerror.\n\nMust be specified in milliseconds. Default is 60000 (1 min)."
             },
+            {
+              "name": "queries_protocol",
+              "type": "Optional",
+              "optional_inner": {
+                "type": "Ref",
+                "ref_name": "client.NetworkQueriesProtocol"
+              },
+              "summary": "Queries protocol.",
+              "description": "`HTTP` or `WS`. \nDefault is `HTTP`."
+            },
+            {
+              "name": "first_remp_status_timeout",
+              "type": "Optional",
+              "optional_inner": {
+                "type": "Number",
+                "number_type": "UInt",
+                "number_size": 32
+              },
+              "summary": "UNSTABLE.",
+              "description": "First REMP status awaiting timeout. If no status recieved during the timeout than fallback transaction scenario is activated.\n\nMust be specified in milliseconds. Default is 1000 (1 sec)."
+            },
+            {
+              "name": "next_remp_status_timeout",
+              "type": "Optional",
+              "optional_inner": {
+                "type": "Number",
+                "number_type": "UInt",
+                "number_size": 32
+              },
+              "summary": "UNSTABLE.",
+              "description": "Subsequent REMP status awaiting timeout. If no status recieved during the timeout than fallback transaction scenario is activated.\n\nMust be specified in milliseconds. Default is 5000 (5 sec)."
+            },
             {
               "name": "access_key",
               "type": "Optional",
@@ -514,6 +546,26 @@
           "summary": null,
           "description": null
         },
+        {
+          "name": "NetworkQueriesProtocol",
+          "type": "EnumOfConsts",
+          "enum_consts": [
+            {
+              "name": "HTTP",
+              "type": "None",
+              "summary": "Each GraphQL query uses separate HTTP request.",
+              "description": null
+            },
+            {
+              "name": "WS",
+              "type": "None",
+              "summary": "All GraphQL queries will be served using single web socket connection.",
+              "description": null
+            }
+          ],
+          "summary": "Network protocol used to perform GraphQL queries.",
+          "description": null
+        },
         {
           "name": "CryptoConfig",
           "type": "Struct",
@@ -1147,6 +1199,13 @@
               "value": "133",
               "summary": null,
               "description": null
+            },
+            {
+              "name": "InvalidNonceSize",
+              "type": "Number",
+              "value": "134",
+              "summary": null,
+              "description": null
             }
           ],
           "summary": null,
@@ -6368,6 +6427,15 @@
               "type": "String",
               "summary": "Message BOC",
               "description": null
+            },
+            {
+              "name": "allow_partial",
+              "type": "Optional",
+              "optional_inner": {
+                "type": "Boolean"
+              },
+              "summary": "Flag allowing partial BOC decoding when ABI doesn't describe the full body BOC. Controls decoder behaviour when after decoding all described in ABI params there are some data left in BOC: `true` - return decoded values `false` - return error of incomplete BOC deserialization (default)",
+              "description": null
             }
           ],
           "summary": null,
@@ -6436,6 +6504,15 @@
               "type": "Boolean",
               "summary": "True if the body belongs to the internal message.",
               "description": null
+            },
+            {
+              "name": "allow_partial",
+              "type": "Optional",
+              "optional_inner": {
+                "type": "Boolean"
+              },
+              "summary": "Flag allowing partial BOC decoding when ABI doesn't describe the full body BOC. Controls decoder behaviour when after decoding all described in ABI params there are some data left in BOC: `true` - return decoded values `false` - return error of incomplete BOC deserialization (default)",
+              "description": null
             }
           ],
           "summary": null,
@@ -6535,6 +6612,15 @@
               "type": "String",
               "summary": "Data BOC or BOC handle",
               "description": null
+            },
+            {
+              "name": "allow_partial",
+              "type": "Optional",
+              "optional_inner": {
+                "type": "Boolean"
+              },
+              "summary": "Flag allowing partial BOC decoding when ABI doesn't describe the full body BOC. Controls decoder behaviour when after decoding all described in ABI params there are some data left in BOC: `true` - return decoded values `false` - return error of incomplete BOC deserialization (default)",
+              "description": null
             }
           ],
           "summary": null,
@@ -6702,6 +6788,15 @@
               "type": "String",
               "summary": "Data BOC or BOC handle",
               "description": null
+            },
+            {
+              "name": "allow_partial",
+              "type": "Optional",
+              "optional_inner": {
+                "type": "Boolean"
+              },
+              "summary": "Flag allowing partial BOC decoding when ABI doesn't describe the full body BOC. Controls decoder behaviour when after decoding all described in ABI params there are some data left in BOC: `true` - return decoded values `false` - return error of incomplete BOC deserialization (default)",
+              "description": null
             }
           ],
           "summary": null,
@@ -9081,6 +9176,27 @@
               "value": "513",
               "summary": null,
               "description": null
+            },
+            {
+              "name": "MessageRejected",
+              "type": "Number",
+              "value": "514",
+              "summary": null,
+              "description": null
+            },
+            {
+              "name": "InvalidRempStatus",
+              "type": "Number",
+              "value": "515",
+              "summary": null,
+              "description": null
+            },
+            {
+              "name": "NextRempStatusTimeout",
+              "type": "Number",
+              "value": "516",
+              "summary": null,
+              "description": null
             }
           ],
           "summary": null,
@@ -9282,6 +9398,137 @@
               ],
               "summary": "Notifies the app that the message was not executed within expire timeout on-chain and will never be because it is already expired. The expiration timeout can be configured with `AbiConfig` parameters.",
               "description": "This event occurs only for the contracts which ABI includes \"expire\" header.\n\nIf Application specifies `NetworkConfig.message_retries_count` > 0, then `process_message`\nwill perform retries: will create a new message and send it again and repeat it untill it reaches\nthe maximum retries count or receives a successful result.  All the processing\nevents will be repeated."
+            },
+            {
+              "name": "RempSentToValidators",
+              "type": "Struct",
+              "struct_fields": [
+                {
+                  "name": "message_id",
+                  "type": "String",
+                  "summary": null,
+                  "description": null
+                },
+                {
+                  "name": "timestamp",
+                  "type": "BigInt",
+                  "number_type": "UInt",
+                  "number_size": 64,
+                  "summary": null,
+                  "description": null
+                },
+                {
+                  "name": "json",
+                  "type": "Ref",
+                  "ref_name": "Value",
+                  "summary": null,
+                  "description": null
+                }
+              ],
+              "summary": "Notifies the app that the message has been delivered to the thread's validators",
+              "description": null
+            },
+            {
+              "name": "RempIncludedIntoBlock",
+              "type": "Struct",
+              "struct_fields": [
+                {
+                  "name": "message_id",
+                  "type": "String",
+                  "summary": null,
+                  "description": null
+                },
+                {
+                  "name": "timestamp",
+                  "type": "BigInt",
+                  "number_type": "UInt",
+                  "number_size": 64,
+                  "summary": null,
+                  "description": null
+                },
+                {
+                  "name": "json",
+                  "type": "Ref",
+                  "ref_name": "Value",
+                  "summary": null,
+                  "description": null
+                }
+              ],
+              "summary": "Notifies the app that the message has been successfully included into a block candidate by the thread's collator",
+              "description": null
+            },
+            {
+              "name": "RempIncludedIntoAcceptedBlock",
+              "type": "Struct",
+              "struct_fields": [
+                {
+                  "name": "message_id",
+                  "type": "String",
+                  "summary": null,
+                  "description": null
+                },
+                {
+                  "name": "timestamp",
+                  "type": "BigInt",
+                  "number_type": "UInt",
+                  "number_size": 64,
+                  "summary": null,
+                  "description": null
+                },
+                {
+                  "name": "json",
+                  "type": "Ref",
+                  "ref_name": "Value",
+                  "summary": null,
+                  "description": null
+                }
+              ],
+              "summary": "Notifies the app that the block candicate with the message has been accepted by the thread's validators",
+              "description": null
+            },
+            {
+              "name": "RempOther",
+              "type": "Struct",
+              "struct_fields": [
+                {
+                  "name": "message_id",
+                  "type": "String",
+                  "summary": null,
+                  "description": null
+                },
+                {
+                  "name": "timestamp",
+                  "type": "BigInt",
+                  "number_type": "UInt",
+                  "number_size": 64,
+                  "summary": null,
+                  "description": null
+                },
+                {
+                  "name": "json",
+                  "type": "Ref",
+                  "ref_name": "Value",
+                  "summary": null,
+                  "description": null
+                }
+              ],
+              "summary": "Notifies the app about some other minor REMP statuses occurring during message processing",
+              "description": null
+            },
+            {
+              "name": "RempError",
+              "type": "Struct",
+              "struct_fields": [
+                {
+                  "name": "error",
+                  "type": "Ref",
+                  "ref_name": "client.ClientError",
+                  "summary": null,
+                  "description": null
+                }
+              ],
+              "summary": "Notifies the app about any problem that has occured in REMP processing - in this case library switches to the fallback transaction awaiting scenario (sequential block reading).",
+              "description": null
             }
           ],
           "summary": null,
@@ -12391,7 +12638,7 @@
         {
           "name": "query_counterparties",
           "summary": "Allows to query and paginate through the list of accounts that the specified account has interacted with, sorted by the time of the last internal message between accounts",
-          "description": "*Attention* this query retrieves data from 'Counterparties' service which is not supported in\nthe opensource version of DApp Server (and will not be supported) as well as in TON OS SE (will be supported in SE in future),\nbut is always accessible via [TON OS Devnet/Mainnet Clouds](https://docs.ton.dev/86757ecb2/p/85c869-networks)",
+          "description": "*Attention* this query retrieves data from 'Counterparties' service which is not supported in\nthe opensource version of DApp Server (and will not be supported) as well as in Evernode SE (will be supported in SE in future),\nbut is always accessible via [EVER OS Clouds](../ton-os-api/networks.md)",
           "params": [
             {
               "name": "context",
@@ -13723,7 +13970,7 @@
         {
           "name": "proof_block_data",
           "summary": "Proves that a given block's data, which is queried from TONOS API, can be trusted.",
-          "description": "This function checks block proofs and compares given data with the proven.\nIf the given data differs from the proven, the exception will be thrown.\nThe input param is a single block's JSON object, which was queried from DApp server using\nfunctions such as `net.query`, `net.query_collection` or `net.wait_for_collection`.\nIf block's BOC is not provided in the JSON, it will be queried from DApp server\n(in this case it is required to provide at least `id` of block).\n\nPlease note, that joins (like `signatures` in `Block`) are separated entities and not supported,\nso function will throw an exception in a case if JSON being checked has such entities in it.\n\nIf `cache_in_local_storage` in config is set to `true` (default), downloaded proofs and\nmaster-chain BOCs are saved into the persistent local storage (e.g. file system for native\nenvironments or browser's IndexedDB for the web); otherwise all the data is cached only in\nmemory in current client's context and will be lost after destruction of the client.\n\n**Why Proofs are needed**\n\nProofs are needed to ensure that the data downloaded from a DApp server is real blockchain\ndata. Checking proofs can protect from the malicious DApp server which can potentially provide\nfake data, or also from \"Man in the Middle\" attacks class.\n\n**What Proofs are**\n\nSimply, proof is a list of signatures of validators', which have signed this particular master-\nblock.\n\nThe very first validator set's public keys are included in the zero-state. Whe know a root hash\nof the zero-state, because it is stored in the network configuration file, it is our authority\nroot. For proving zero-state it is enough to calculate and compare its root hash.\n\nIn each new validator cycle the validator set is changed. The new one is stored in a key-block,\nwhich is signed by the validator set, which we already trust, the next validator set will be\nstored to the new key-block and signed by the current validator set, and so on.\n\nIn order to prove any block in the master-chain we need to check, that it has been signed by\na trusted validator set. So we need to check all key-blocks' proofs, started from the zero-state\nand until the block, which we want to prove. But it can take a lot of time and traffic to\ndownload and prove all key-blocks on a client. For solving this, special trusted blocks are used\nin TON-SDK.\n\nThe trusted block is the authority root, as well, as the zero-state. Each trusted block is the\n`id` (e.g. `root_hash`) of the already proven key-block. There can be plenty of trusted\nblocks, so there can be a lot of authority roots. The hashes of trusted blocks for MainNet\nand DevNet are hardcoded in SDK in a separated binary file (trusted_key_blocks.bin) and is\nbeing updated for each release by using `update_trusted_blocks` utility.\n\nSee [update_trusted_blocks](../../../tools/update_trusted_blocks) directory for more info.\n\nIn future SDK releases, one will also be able to provide their hashes of trusted blocks for\nother networks, besides for MainNet and DevNet.\nBy using trusted key-blocks, in order to prove any block, we can prove chain of key-blocks to\nthe closest previous trusted key-block, not only to the zero-state.\n\nBut shard-blocks don't have proofs on DApp server. In this case, in order to prove any shard-\nblock data, we search for a corresponding master-block, which contains the root hash of this\nshard-block, or some shard block which is linked to that block in shard-chain. After proving\nthis master-block, we traverse through each link and calculate and compare hashes with links,\none-by-one. After that we can ensure that this shard-block has also been proven.",
+          "description": "This function checks block proofs and compares given data with the proven.\nIf the given data differs from the proven, the exception will be thrown.\nThe input param is a single block's JSON object, which was queried from DApp server using\nfunctions such as `net.query`, `net.query_collection` or `net.wait_for_collection`.\nIf block's BOC is not provided in the JSON, it will be queried from DApp server\n(in this case it is required to provide at least `id` of block).\n\nPlease note, that joins (like `signatures` in `Block`) are separated entities and not supported,\nso function will throw an exception in a case if JSON being checked has such entities in it.\n\nIf `cache_in_local_storage` in config is set to `true` (default), downloaded proofs and\nmaster-chain BOCs are saved into the persistent local storage (e.g. file system for native\nenvironments or browser's IndexedDB for the web); otherwise all the data is cached only in\nmemory in current client's context and will be lost after destruction of the client.\n\n**Why Proofs are needed**\n\nProofs are needed to ensure that the data downloaded from a DApp server is real blockchain\ndata. Checking proofs can protect from the malicious DApp server which can potentially provide\nfake data, or also from \"Man in the Middle\" attacks class.\n\n**What Proofs are**\n\nSimply, proof is a list of signatures of validators', which have signed this particular master-\nblock.\n\nThe very first validator set's public keys are included in the zero-state. Whe know a root hash\nof the zero-state, because it is stored in the network configuration file, it is our authority\nroot. For proving zero-state it is enough to calculate and compare its root hash.\n\nIn each new validator cycle the validator set is changed. The new one is stored in a key-block,\nwhich is signed by the validator set, which we already trust, the next validator set will be\nstored to the new key-block and signed by the current validator set, and so on.\n\nIn order to prove any block in the master-chain we need to check, that it has been signed by\na trusted validator set. So we need to check all key-blocks' proofs, started from the zero-state\nand until the block, which we want to prove. But it can take a lot of time and traffic to\ndownload and prove all key-blocks on a client. For solving this, special trusted blocks are used\nin Ever-SDK.\n\nThe trusted block is the authority root, as well, as the zero-state. Each trusted block is the\n`id` (e.g. `root_hash`) of the already proven key-block. There can be plenty of trusted\nblocks, so there can be a lot of authority roots. The hashes of trusted blocks for MainNet\nand DevNet are hardcoded in SDK in a separated binary file (trusted_key_blocks.bin) and is\nbeing updated for each release by using `update_trusted_blocks` utility.\n\nSee [update_trusted_blocks](../../../tools/update_trusted_blocks) directory for more info.\n\nIn future SDK releases, one will also be able to provide their hashes of trusted blocks for\nother networks, besides for MainNet and DevNet.\nBy using trusted key-blocks, in order to prove any block, we can prove chain of key-blocks to\nthe closest previous trusted key-block, not only to the zero-state.\n\nBut shard-blocks don't have proofs on DApp server. In this case, in order to prove any shard-\nblock data, we search for a corresponding master-block, which contains the root hash of this\nshard-block, or some shard block which is linked to that block in shard-chain. After proving\nthis master-block, we traverse through each link and calculate and compare hashes with links,\none-by-one. After that we can ensure that this shard-block has also been proven.",
           "params": [
             {
               "name": "context",

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

@@ -94,6 +94,7 @@ module TonClient
     # INPUT: ParamsOfDecodeMessage
     # abi: Value -     #     # contract ABI
     # message: String -     #     # Message BOC
+    # allow_partial: Boolean<Optional> -     #     # Flag allowing partial BOC decoding when ABI doesn't describe the full body BOC. Controls decoder behaviour when after decoding all described in ABI params there are some data left in BOC: `true` - return decoded values `false` - return error of incomplete BOC deserialization (default)
     # RESPONSE: DecodedMessageBody
     # body_type: MessageBodyType -     #     # Type of the message body content.
     # name: String -     #     # Function or event name.
@@ -107,6 +108,7 @@ module TonClient
     # 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.
+    # allow_partial: Boolean<Optional> -     #     # Flag allowing partial BOC decoding when ABI doesn't describe the full body BOC. Controls decoder behaviour when after decoding all described in ABI params there are some data left in BOC: `true` - return decoded values `false` - return error of incomplete BOC deserialization (default)
     # RESPONSE: DecodedMessageBody
     # body_type: MessageBodyType -     #     # Type of the message body content.
     # name: String -     #     # Function or event name.
@@ -132,6 +134,7 @@ module TonClient
     # INPUT: ParamsOfDecodeAccountData
     # abi: Value -     #     # Contract ABI
     # data: String -     #     # Data BOC or BOC handle
+    # allow_partial: Boolean<Optional> -     #     # Flag allowing partial BOC decoding when ABI doesn't describe the full body BOC. Controls decoder behaviour when after decoding all described in ABI params there are some data left in BOC: `true` - return decoded values `false` - return error of incomplete BOC deserialization (default)
     # RESPONSE: ResultOfDecodeAccountData
     # data: Value -     #     # Decoded data as a JSON structure.
     def decode_account_data(payload, &block)
@@ -164,6 +167,7 @@ module TonClient
     # INPUT: ParamsOfDecodeInitialData
     # abi: Value<Optional> -     #     # Contract ABI.    #     # Initial data is decoded if this parameter is provided
     # data: String -     #     # Data BOC or BOC handle
+    # allow_partial: Boolean<Optional> -     #     # Flag allowing partial BOC decoding when ABI doesn't describe the full body BOC. Controls decoder behaviour when after decoding all described in ABI params there are some data left in BOC: `true` - return decoded values `false` - return error of incomplete BOC deserialization (default)
     # RESPONSE: ResultOfDecodeInitialData
     # initial_data: Value<Optional> -     #     # List of initial values of contract's public variables.    #     # Initial data is decoded if `abi` input parameter is provided
     # initial_pubkey: String -     #     # Initial account owner's public key

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

@@ -1,4 +1,4 @@
 module TonClient
-  VERSION = "1.1.23"
+  VERSION = "1.1.28"
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: everscale-client-ruby
 version: !ruby/object:Gem::Version
-  version: 1.1.23
+  version: 1.1.28
 platform: ruby
 authors:
 - nerzh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-21 00:00:00.000000000 Z
+date: 2022-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -112,11 +112,11 @@ description: Gem Ton Client Ruby for all ruby projects
 email:
 - emptystamp@gmail.com
 executables:
-- ton-client-ruby
+- everscale-client-ruby
 extensions: []
 extra_rdoc_files: []
 files:
-- bin/ton-client-ruby
+- bin/everscale-client-ruby
 - lib/code_generator/api.json
 - lib/code_generator/api_converter.rb
 - lib/code_generator/code_generator.rb