Class: TonClient::Net
- Includes:
- CommonInstanceHelpers
- Defined in:
- lib/ton-client-ruby/Client/Net.rb
Constant Summary collapse
- MODULE =
self.to_s.downcase.gsub(/^(.+::|)(\w+)$/, '\2').freeze
Instance Attribute Summary collapse
-
#context ⇒ Object
readonly
Returns the value of attribute context.
-
#core ⇒ Object
readonly
Returns the value of attribute core.
Instance Method Summary collapse
-
#aggregate_collection(payload, &block) ⇒ Object
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.
-
#batch_query(payload, &block) ⇒ Object
INPUT: ParamsOfBatchQuery operations: Array - # # List of query operations that must be performed per single fetch.
-
#fetch_endpoints(&block) ⇒ Object
RESPONSE: EndpointsSet endpoints: Array - # # List of endpoints provided by server.
-
#find_last_shard_block(payload, &block) ⇒ Object
INPUT: ParamsOfFindLastShardBlock address: String - # # Account address RESPONSE: ResultOfFindLastShardBlock block_id: String - # # Account shard last block ID.
-
#get_endpoints(&block) ⇒ Object
RESPONSE: ResultOfGetEndpoints query: String - # # Current query endpoint endpoints: Array - # # List of all endpoints used by client.
-
#initialize(context: Context.new, core: TonClient::TonBinding) ⇒ Net
constructor
A new instance of Net.
-
#query(payload, &block) ⇒ Object
INPUT: ParamsOfQuery query: String - # # GraphQL query text.
-
#query_collection(payload, &block) ⇒ Object
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.
-
#query_counterparties(payload, &block) ⇒ Object
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.
-
#query_transaction_tree(payload, &block) ⇒ Object
INPUT: ParamsOfQueryTransactionTree in_msg: String - # # Input message id.
- #resume(&block) ⇒ Object
-
#set_endpoints(payload, &block) ⇒ Object
INPUT: EndpointsSet endpoints: Array - # # List of endpoints provided by server.
-
#subscribe_collection(payload, &block) ⇒ Object
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.
- #suspend(&block) ⇒ Object
-
#unsubscribe(payload, &block) ⇒ Object
INPUT: ResultOfSubscribeCollection handle: Number - # # Subscription handle.
-
#wait_for_collection(payload, &block) ⇒ Object
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.
Methods included from CommonInstanceHelpers
#base64?, #encode_to_base64, #full_method_name
Constructor Details
#initialize(context: Context.new, core: TonClient::TonBinding) ⇒ Net
Returns a new instance of Net.
9 10 11 12 |
# File 'lib/ton-client-ruby/Client/Net.rb', line 9 def initialize(context: Context.new, core: TonClient::TonBinding) @context = context @core = core end |
Instance Attribute Details
#context ⇒ Object (readonly)
Returns the value of attribute context.
6 7 8 |
# File 'lib/ton-client-ruby/Client/Net.rb', line 6 def context @context end |
#core ⇒ Object (readonly)
Returns the value of attribute core.
6 7 8 |
# File 'lib/ton-client-ruby/Client/Net.rb', line 6 def core @core end |
Instance Method Details
#aggregate_collection(payload, &block) ⇒ Object
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.
50 51 52 |
# File 'lib/ton-client-ruby/Client/Net.rb', line 50 def aggregate_collection(payload, &block) core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: payload, &block) end |
#batch_query(payload, &block) ⇒ Object
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.
27 28 29 |
# File 'lib/ton-client-ruby/Client/Net.rb', line 27 def batch_query(payload, &block) core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: payload, &block) end |
#fetch_endpoints(&block) ⇒ Object
RESPONSE: EndpointsSet endpoints: Array - # # List of endpoints provided by server
99 100 101 |
# File 'lib/ton-client-ruby/Client/Net.rb', line 99 def fetch_endpoints(&block) core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: {}, &block) end |
#find_last_shard_block(payload, &block) ⇒ Object
INPUT: ParamsOfFindLastShardBlock address: String - # # Account address RESPONSE: ResultOfFindLastShardBlock block_id: String - # # Account shard last block ID
93 94 95 |
# File 'lib/ton-client-ruby/Client/Net.rb', line 93 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 |
#get_endpoints(&block) ⇒ Object
RESPONSE: ResultOfGetEndpoints query: String - # # Current query endpoint endpoints: Array - # # List of all endpoints used by client
112 113 114 |
# File 'lib/ton-client-ruby/Client/Net.rb', line 112 def get_endpoints(&block) core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: {}, &block) end |
#query(payload, &block) ⇒ Object
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.
19 20 21 |
# File 'lib/ton-client-ruby/Client/Net.rb', line 19 def query(payload, &block) core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: payload, &block) end |
#query_collection(payload, &block) ⇒ Object
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
39 40 41 |
# File 'lib/ton-client-ruby/Client/Net.rb', line 39 def query_collection(payload, &block) core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: payload, &block) end |
#query_counterparties(payload, &block) ⇒ Object
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
123 124 125 |
# File 'lib/ton-client-ruby/Client/Net.rb', line 123 def query_counterparties(payload, &block) core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: payload, &block) end |
#query_transaction_tree(payload, &block) ⇒ Object
INPUT: ParamsOfQueryTransactionTree in_msg: String - # # Input message id. abi_registry: Array<Optional> - # # 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. RESPONSE: ResultOfQueryTransactionTree messages: Array - # # Messages. transactions: Array - # # Transactions.
133 134 135 |
# File 'lib/ton-client-ruby/Client/Net.rb', line 133 def query_transaction_tree(payload, &block) core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: payload, &block) end |
#resume(&block) ⇒ Object
85 86 87 |
# File 'lib/ton-client-ruby/Client/Net.rb', line 85 def resume(&block) core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: {}, &block) end |
#set_endpoints(payload, &block) ⇒ Object
INPUT: EndpointsSet endpoints: Array - # # List of endpoints provided by server
105 106 107 |
# File 'lib/ton-client-ruby/Client/Net.rb', line 105 def set_endpoints(payload, &block) core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: payload, &block) end |
#subscribe_collection(payload, &block) ⇒ Object
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`
77 78 79 |
# File 'lib/ton-client-ruby/Client/Net.rb', line 77 def subscribe_collection(payload, &block) core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: payload, &block) end |
#suspend(&block) ⇒ Object
81 82 83 |
# File 'lib/ton-client-ruby/Client/Net.rb', line 81 def suspend(&block) core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: {}, &block) end |
#unsubscribe(payload, &block) ⇒ Object
INPUT: ResultOfSubscribeCollection handle: Number - # # Subscription handle. # # Must be closed with ‘unsubscribe`
67 68 69 |
# File 'lib/ton-client-ruby/Client/Net.rb', line 67 def unsubscribe(payload, &block) core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: payload, &block) end |
#wait_for_collection(payload, &block) ⇒ Object
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
61 62 63 |
# File 'lib/ton-client-ruby/Client/Net.rb', line 61 def wait_for_collection(payload, &block) core.requestLibrary(context: context.id, method_name: full_method_name(MODULE, __method__.to_s), payload: payload, &block) end |