Module java4ever.binding
Package tech.deplant.java4ever.binding

Class Net

java.lang.Object
tech.deplant.java4ever.binding.Net
public final class Net extends Object
Net Contains methods of "net" module of EVER-SDK API Network access.

  • Constructor Details

    • Net

      public Net()

  • Method Details

    • query

      public static Net.ResultOfQuery query(EverSdkContext ctx, String query, com.fasterxml.jackson.databind.JsonNode variables) throws EverSdkException
      Performs DAppServer GraphQL query.
      Parameters:
      query - GraphQL query text.
      variables - Must be a map with named values that can be used in query. Variables used in query.
      Throws:
      EverSdkException

    • batchQuery

      public static Net.ResultOfBatchQuery batchQuery(EverSdkContext ctx, Net.ParamsOfQueryOperation[] operations) throws EverSdkException
      Performs multiple queries per single fetch.
      Parameters:
      operations - List of query operations that must be performed per single fetch.
      Throws:
      EverSdkException

    • queryCollection

      public static Net.ResultOfQueryCollection queryCollection(EverSdkContext ctx, String collection, com.fasterxml.jackson.databind.JsonNode filter, String result, Net.OrderBy[] order, Long limit) throws EverSdkException
      Queries data that satisfies the `filter` conditions, limits the number of returned records and orders them. The projection fields are limited to `result` fields Queries collection data
      Parameters:
      collection - Collection name (accounts, blocks, transactions, messages, block_signatures)
      filter - Collection filter
      result - Projection (result) string
      order - Sorting order
      limit - Number of documents to return
      Throws:
      EverSdkException

    • aggregateCollection

      public static Net.ResultOfAggregateCollection aggregateCollection(EverSdkContext ctx, String collection, com.fasterxml.jackson.databind.JsonNode filter, Net.FieldAggregation[] fields) throws EverSdkException
      Aggregates values from the specified `fields` for records that satisfies the `filter` conditions, Aggregates collection data.
      Parameters:
      collection - Collection name (accounts, blocks, transactions, messages, block_signatures)
      filter - Collection filter
      fields - Projection (result) string
      Throws:
      EverSdkException

    • waitForCollection

      public static Net.ResultOfWaitForCollection waitForCollection(EverSdkContext ctx, String collection, com.fasterxml.jackson.databind.JsonNode filter, String result, Long timeout) throws EverSdkException
      Triggers only once. If object that satisfies the `filter` conditions already exists - returns it immediately. If not - waits for insert/update of data within the specified `timeout`, and returns it. The projection fields are limited to `result` fields Returns an object that fulfills the conditions or waits for its appearance
      Parameters:
      collection - Collection name (accounts, blocks, transactions, messages, block_signatures)
      filter - Collection filter
      result - Projection (result) string
      timeout - Query timeout
      Throws:
      EverSdkException

    • unsubscribe

      public static void unsubscribe(EverSdkContext ctx, Net.ResultOfSubscribeCollection params) throws EverSdkException
      Cancels a subscription specified by its handle. Cancels a subscription
      Throws:
      EverSdkException

    • subscribeCollection

      public static Net.ResultOfSubscribeCollection subscribeCollection(EverSdkContext ctx, String collection, com.fasterxml.jackson.databind.JsonNode filter, String result, Consumer<CallbackHandler> callbackHandler) throws EverSdkException
      Triggers for each insert/update of data that satisfies the `filter` conditions. The projection fields are limited to `result` fields. The subscription is a persistent communication channel between client and Free TON Network. All changes in the blockchain will be reflected in realtime. Changes means inserts and updates of the blockchain entities. ### Important Notes on Subscriptions Unfortunately sometimes the connection with the network brakes down. In this situation the library attempts to reconnect to the network. This reconnection sequence can take significant time. All of this time the client is disconnected from the network. Bad news is that all blockchain changes that happened while the client was disconnected are lost. Good news is that the client report errors to the callback when it loses and resumes connection. So, if the lost changes are important to the application then the application must handle these error reports. Library reports errors with `responseType` == 101 and the error object passed via `params`. When the library has successfully reconnected the application receives callback with `responseType` == 101 and `params.code` == 614 (NetworkModuleResumed). Application can use several ways to handle this situation: - If application monitors changes for the single blockchain object (for example specific account): application can perform a query for this object and handle actual data as a regular data from the subscription. - If application monitors sequence of some blockchain objects (for example transactions of the specific account): application must refresh all cached (or visible to user) lists where this sequences presents. Creates a collection subscription
      Parameters:
      collection - Collection name (accounts, blocks, transactions, messages, block_signatures)
      filter - Collection filter
      result - Projection (result) string
      Throws:
      EverSdkException

    • subscribe

      public static Net.ResultOfSubscribeCollection subscribe(EverSdkContext ctx, String subscription, com.fasterxml.jackson.databind.JsonNode variables, Consumer<CallbackHandler> callbackHandler) throws EverSdkException
      The subscription is a persistent communication channel between client and Everscale Network. ### Important Notes on Subscriptions Unfortunately sometimes the connection with the network breaks down. In this situation the library attempts to reconnect to the network. This reconnection sequence can take significant time. All of this time the client is disconnected from the network. Bad news is that all changes that happened while the client was disconnected are lost. Good news is that the client report errors to the callback when it loses and resumes connection. So, if the lost changes are important to the application then the application must handle these error reports. Library reports errors with `responseType` == 101 and the error object passed via `params`. When the library has successfully reconnected the application receives callback with `responseType` == 101 and `params.code` == 614 (NetworkModuleResumed). Application can use several ways to handle this situation: - If application monitors changes for the single object (for example specific account): application can perform a query for this object and handle actual data as a regular data from the subscription. - If application monitors sequence of some objects (for example transactions of the specific account): application must refresh all cached (or visible to user) lists where this sequences presents. Creates a subscription
      Parameters:
      subscription - GraphQL subscription text.
      variables - Must be a map with named values that can be used in query. Variables used in subscription.
      Throws:
      EverSdkException

    • suspend

      public static void suspend(EverSdkContext ctx) throws EverSdkException
      Suspends network module to stop any network activity
      Throws:
      EverSdkException

    • resume

      public static void resume(EverSdkContext ctx) throws EverSdkException
      Resumes network module to enable network activity
      Throws:
      EverSdkException

    • findLastShardBlock

      public static Net.ResultOfFindLastShardBlock findLastShardBlock(EverSdkContext ctx, String address) throws EverSdkException
      Returns ID of the last block in a specified account shard
      Parameters:
      address - Account address
      Throws:
      EverSdkException

    • fetchEndpoints

      public static Net.EndpointsSet fetchEndpoints(EverSdkContext ctx) throws EverSdkException
      Requests the list of alternative endpoints from server
      Throws:
      EverSdkException

    • setEndpoints

      public static void setEndpoints(EverSdkContext ctx, Net.EndpointsSet params) throws EverSdkException
      Sets the list of endpoints to use on reinit
      Throws:
      EverSdkException

    • getEndpoints

      public static Net.ResultOfGetEndpoints getEndpoints(EverSdkContext ctx) throws EverSdkException
      Requests the list of alternative endpoints from server
      Throws:
      EverSdkException

    • queryCounterparties

      public static Net.ResultOfQueryCollection queryCounterparties(EverSdkContext ctx, String account, String result, Long first, String after) throws EverSdkException
      *Attention* this query retrieves data from 'Counterparties' service which is not supported in the opensource version of DApp Server (and will not be supported) as well as in Evernode SE (will be supported in SE in future), but is always accessible via [EVER OS Clouds](../ton-os-api/networks.md) 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
      Parameters:
      account - Account address
      result - Projection (result) string
      first - Number of counterparties to return
      after - `cursor` field of the last received result
      Throws:
      EverSdkException

    • queryTransactionTree

      public static Net.ResultOfQueryTransactionTree queryTransactionTree(EverSdkContext ctx, String inMsg, Abi.ABI[] abiRegistry, Long timeout, Long transactionMaxCount) throws EverSdkException
      Performs recursive retrieval of a transactions tree produced by a specific message: in_msg -> dst_transaction -> out_messages -> dst_transaction -> ... If the chain of transactions execution is in progress while the function is running, it will wait for the next transactions to appear until the full tree or more than 50 transactions are received. All the retrieved messages and transactions are included into `result.messages` and `result.transactions` respectively. Function reads transactions layer by layer, by pages of 20 transactions. The retrieval process goes like this: Let's assume we have an infinite chain of transactions and each transaction generates 5 messages. 1. Retrieve 1st message (input parameter) and corresponding transaction - put it into result. It is the first level of the tree of transactions - its root. Retrieve 5 out message ids from the transaction for next steps. 2. Retrieve 5 messages and corresponding transactions on the 2nd layer. Put them into result. Retrieve 5*5 out message ids from these transactions for next steps 3. Retrieve 20 (size of the page) messages and transactions (3rd layer) and 20*5=100 message ids (4th layer). 4. Retrieve the last 5 messages and 5 transactions on the 3rd layer + 15 messages and transactions (of 100) from the 4th layer + 25 message ids of the 4th layer + 75 message ids of the 5th layer. 5. Retrieve 20 more messages and 20 more transactions of the 4th layer + 100 more message ids of the 5th layer. 6. Now we have 1+5+20+20+20 = 66 transactions, which is more than 50. Function exits with the tree of 1m->1t->5m->5t->25m->25t->35m->35t. If we see any message ids in the last transactions out_msgs, which don't have corresponding messages in the function result, it means that the full tree was not received and we need to continue iteration. To summarize, it is guaranteed that each message in `result.messages` has the corresponding transaction in the `result.transactions`. But there is no guarantee that all messages from transactions `out_msgs` are presented in `result.messages`. So the application has to continue retrieval for missing messages if it requires. Returns a tree of transactions triggered by a specific message.
      Parameters:
      inMsg - Input message id.
      abiRegistry - List of contract ABIs that will be used to decode message bodies. Library will try to decode each returned message body using any ABI from the registry.
      timeout - If some of the following messages and transactions are missing yet The maximum waiting time is regulated by this option. Default value is 60000 (1 min). If `timeout` is set to 0 then function will wait infinitely until the whole transaction tree is executed Timeout used to limit waiting time for the missing messages and transaction.
      transactionMaxCount - If transaction tree contains more transaction then this parameter then only first `transaction_max_count` transaction are awaited and returned. Default value is 50. If `transaction_max_count` is set to 0 then no limitation on transaction count is used and all transaction are returned. Maximum transaction count to wait.
      Throws:
      EverSdkException

    • createBlockIterator

      public static Net.RegisteredIterator createBlockIterator(EverSdkContext ctx, Long startTime, Long endTime, String[] shardFilter, String result) throws EverSdkException
      Block iterator uses robust iteration methods that guaranties that every block in the specified range isn't missed or iterated twice. Iterated range can be reduced with some filters: - `start_time` – the bottom time range. Only blocks with `gen_utime` more or equal to this value is iterated. If this parameter is omitted then there is no bottom time edge, so all blocks since zero state is iterated. - `end_time` – the upper time range. Only blocks with `gen_utime` less then this value is iterated. If this parameter is omitted then there is no upper time edge, so iterator never finishes. - `shard_filter` – workchains and shard prefixes that reduce the set of interesting blocks. Block conforms to the shard filter if it belongs to the filter workchain and the first bits of block's `shard` fields matches to the shard prefix. Only blocks with suitable shard are iterated. Items iterated is a JSON objects with block data. The minimal set of returned fields is: ```text id gen_utime workchain_id shard after_split after_merge prev_ref { root_hash } prev_alt_ref { root_hash } ``` Application can request additional fields in the `result` parameter. Application should call the `remove_iterator` when iterator is no longer required. Creates block iterator.
      Parameters:
      startTime - If the application specifies this parameter then the iteration includes blocks with `gen_utime` >= `start_time`. Otherwise the iteration starts from zero state. Must be specified in seconds. Starting time to iterate from.
      endTime - If the application specifies this parameter then the iteration includes blocks with `gen_utime` invalid input: '<' `end_time`. Otherwise the iteration never stops. Must be specified in seconds. Optional end time to iterate for.
      shardFilter - If the application specifies this parameter and it is not the empty array then the iteration will include items related to accounts that belongs to the specified shard prefixes. Shard prefix must be represented as a string "workchain:prefix". Where `workchain` is a signed integer and the `prefix` if a hexadecimal representation if the 64-bit unsigned integer with tagged shard prefix. For example: "0:3800000000000000". Shard prefix filter.
      result - List of the fields that must be returned for iterated items. This field is the same as the `result` parameter of the `query_collection` function. Note that iterated items can contains additional fields that are not requested in the `result`. Projection (result) string.
      Throws:
      EverSdkException

    • resumeBlockIterator

      public static Net.RegisteredIterator resumeBlockIterator(EverSdkContext ctx, com.fasterxml.jackson.databind.JsonNode resumeState) throws EverSdkException
      The iterator stays exactly at the same position where the `resume_state` was caught. Application should call the `remove_iterator` when iterator is no longer required. Resumes block iterator.
      Parameters:
      resumeState - Same as value returned from `iterator_next`. Iterator state from which to resume.
      Throws:
      EverSdkException

    • createTransactionIterator

      public static Net.RegisteredIterator createTransactionIterator(EverSdkContext ctx, Long startTime, Long endTime, String[] shardFilter, String[] accountsFilter, String result, Boolean includeTransfers) throws EverSdkException
      Transaction iterator uses robust iteration methods that guaranty that every transaction in the specified range isn't missed or iterated twice. Iterated range can be reduced with some filters: - `start_time` – the bottom time range. Only transactions with `now` more or equal to this value are iterated. If this parameter is omitted then there is no bottom time edge, so all the transactions since zero state are iterated. - `end_time` – the upper time range. Only transactions with `now` less then this value are iterated. If this parameter is omitted then there is no upper time edge, so iterator never finishes. - `shard_filter` – workchains and shard prefixes that reduce the set of interesting accounts. Account address conforms to the shard filter if it belongs to the filter workchain and the first bits of address match to the shard prefix. Only transactions with suitable account addresses are iterated. - `accounts_filter` – set of account addresses whose transactions must be iterated. Note that accounts filter can conflict with shard filter so application must combine these filters carefully. Iterated item is a JSON objects with transaction data. The minimal set of returned fields is: ```text id account_addr now balance_delta(format:DEC) bounce { bounce_type } in_message { id value(format:DEC) msg_type src } out_messages { id value(format:DEC) msg_type dst } ``` Application can request an additional fields in the `result` parameter. Another parameter that affects on the returned fields is the `include_transfers`. When this parameter is `true` the iterator computes and adds `transfer` field containing list of the useful `TransactionTransfer` objects. Each transfer is calculated from the particular message related to the transaction and has the following structure: - message – source message identifier. - isBounced – indicates that the transaction is bounced, which means the value will be returned back to the sender. - isDeposit – indicates that this transfer is the deposit (true) or withdraw (false). - counterparty – account address of the transfer source or destination depending on `isDeposit`. - value – amount of nano tokens transferred. The value is represented as a decimal string because the actual value can be more precise than the JSON number can represent. Application must use this string carefully – conversion to number can follow to loose of precision. Application should call the `remove_iterator` when iterator is no longer required. Creates transaction iterator.
      Parameters:
      startTime - If the application specifies this parameter then the iteration includes blocks with `gen_utime` >= `start_time`. Otherwise the iteration starts from zero state. Must be specified in seconds. Starting time to iterate from.
      endTime - If the application specifies this parameter then the iteration includes blocks with `gen_utime` invalid input: '<' `end_time`. Otherwise the iteration never stops. Must be specified in seconds. Optional end time to iterate for.
      shardFilter - If the application specifies this parameter and it is not an empty array then the iteration will include items related to accounts that belongs to the specified shard prefixes. Shard prefix must be represented as a string "workchain:prefix". Where `workchain` is a signed integer and the `prefix` if a hexadecimal representation if the 64-bit unsigned integer with tagged shard prefix. For example: "0:3800000000000000". Account address conforms to the shard filter if it belongs to the filter workchain and the first bits of address match to the shard prefix. Only transactions with suitable account addresses are iterated. Shard prefix filters.
      accountsFilter - Application can specify the list of accounts for which it wants to iterate transactions. If this parameter is missing or an empty list then the library iterates transactions for all accounts that pass the shard filter. Note that the library doesn't detect conflicts between the account filter and the shard filter if both are specified. So it is an application responsibility to specify the correct filter combination. Account address filter.
      result - List of the fields that must be returned for iterated items. This field is the same as the `result` parameter of the `query_collection` function. Note that iterated items can contain additional fields that are not requested in the `result`. Projection (result) string.
      includeTransfers - If this parameter is `true` then each transaction contains field `transfers` with list of transfer. See more about this structure in function description. Include `transfers` field in iterated transactions.
      Throws:
      EverSdkException

    • resumeTransactionIterator

      public static Net.RegisteredIterator resumeTransactionIterator(EverSdkContext ctx, com.fasterxml.jackson.databind.JsonNode resumeState, String[] accountsFilter) throws EverSdkException
      The iterator stays exactly at the same position where the `resume_state` was caught. Note that `resume_state` doesn't store the account filter. If the application requires to use the same account filter as it was when the iterator was created then the application must pass the account filter again in `accounts_filter` parameter. Application should call the `remove_iterator` when iterator is no longer required. Resumes transaction iterator.
      Parameters:
      resumeState - Same as value returned from `iterator_next`. Iterator state from which to resume.
      accountsFilter - Application can specify the list of accounts for which it wants to iterate transactions. If this parameter is missing or an empty list then the library iterates transactions for all accounts that passes the shard filter. Note that the library doesn't detect conflicts between the account filter and the shard filter if both are specified. So it is the application's responsibility to specify the correct filter combination. Account address filter.
      Throws:
      EverSdkException

    • iteratorNext

      public static Net.ResultOfIteratorNext iteratorNext(EverSdkContext ctx, Long iterator, Long limit, Boolean returnResumeState) throws EverSdkException
      In addition to available items this function returns the `has_more` flag indicating that the iterator isn't reach the end of the iterated range yet. This function can return the empty list of available items but indicates that there are more items is available. This situation appears when the iterator doesn't reach iterated range but database doesn't contains available items yet. If application requests resume state in `return_resume_state` parameter then this function returns `resume_state` that can be used later to resume the iteration from the position after returned items. The structure of the items returned depends on the iterator used. See the description to the appropriated iterator creation function. Returns next available items.
      Parameters:
      iterator - Iterator handle
      limit - If value is missing or is less than 1 the library uses 1. Maximum count of the returned items.
      returnResumeState - Indicates that function must return the iterator state that can be used for resuming iteration.
      Throws:
      EverSdkException

    • removeIterator

      public static void removeIterator(EverSdkContext ctx, Net.RegisteredIterator params) throws EverSdkException
      Frees all resources allocated in library to serve iterator. Application always should call the `remove_iterator` when iterator is no longer required. Removes an iterator
      Throws:
      EverSdkException

    • getSignatureId

      public static Net.ResultOfGetSignatureId getSignatureId(EverSdkContext ctx) throws EverSdkException
      Returns signature ID for configured network if it should be used in messages signature
      Throws:
      EverSdkException