Class: CryptoApis::ZilliqaApi

Inherits:
Object
  • Object
show all
Defined in:
lib/crypto_apis/api/zilliqa_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ZilliqaApi

Returns a new instance of ZilliqaApi.



19
20
21
 
# File 'lib/crypto_apis/api/zilliqa_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/crypto_apis/api/zilliqa_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_latest_mined_zilliqa_block(network, opts = {}) ⇒ GetLatestMinedZilliqaBlockR

Get Latest Mined Zilliqa Block Through this endpoint users can obtain information on the latest block that has been mined on the Zilliqa blockchain. Data could include the current and previous block hashes, transaction count, and more.

Parameters:

  • network (String) —

    Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - "mainnet" is the live network with actual data while networks like "testnet", "ropsten" are test networks.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :context (String) —

    In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.

Returns:



28
29
30
31
 
# File 'lib/crypto_apis/api/zilliqa_api.rb', line 28

def get_latest_mined_zilliqa_block(network, opts = {})
  data, _status_code, _headers = get_latest_mined_zilliqa_block_with_http_info(network, opts)
  data
end

#get_latest_mined_zilliqa_block_with_http_info(network, opts = {}) ⇒ Array<(GetLatestMinedZilliqaBlockR, Integer, Hash)>

Get Latest Mined Zilliqa Block Through this endpoint users can obtain information on the latest block that has been mined on the Zilliqa blockchain. Data could include the current and previous block hashes, transaction count, and more.

Parameters:

  • network (String) —

    Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - &quot;mainnet&quot; is the live network with actual data while networks like &quot;testnet&quot;, &quot;ropsten&quot; are test networks.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :context (String) —

    In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. &#x60;context&#x60; is specified by the user.

Returns:

  • (Array<(GetLatestMinedZilliqaBlockR, Integer, Hash)>) —

    GetLatestMinedZilliqaBlockR data, response status code and response headers



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/crypto_apis/api/zilliqa_api.rb', line 39

def get_latest_mined_zilliqa_block_with_http_info(network, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ZilliqaApi.get_latest_mined_zilliqa_block ...'
  end
  # verify the required parameter 'network' is set
  if @api_client.config.client_side_validation && network.nil?
    fail ArgumentError, "Missing the required parameter 'network' when calling ZilliqaApi.get_latest_mined_zilliqa_block"
  end
  # verify enum value
  allowable_values = ["mainnet"]
  if @api_client.config.client_side_validation && !allowable_values.include?(network)
    fail ArgumentError, "invalid value for \"network\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/blockchain-data/zilliqa-specific/{network}/blocks/last'.sub('{' + 'network' + '}', CGI.escape(network.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'context'] = opts[:'context'] if !opts[:'context'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetLatestMinedZilliqaBlockR'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"ZilliqaApi.get_latest_mined_zilliqa_block",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ZilliqaApi#get_latest_mined_zilliqa_block\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_zilliqa_address_details(network, address, opts = {}) ⇒ GetZilliqaAddressDetailsR

Get Zilliqa Address Details Through this endpoint customers can obtain information address details from the Zilliqa blockchain.

Parameters:

  • network (String) —

    Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - &quot;mainnet&quot; is the live network with actual data while networks like &quot;testnet&quot;, &quot;ropsten&quot; are test networks.

  • address (String) —

    Defines the specific transaction&#39;s address.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :context (String) —

    In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. &#x60;context&#x60; is specified by the user.

Returns:



100
101
102
103
 
# File 'lib/crypto_apis/api/zilliqa_api.rb', line 100

def get_zilliqa_address_details(network, address, opts = {})
  data, _status_code, _headers = get_zilliqa_address_details_with_http_info(network, address, opts)
  data
end

#get_zilliqa_address_details_with_http_info(network, address, opts = {}) ⇒ Array<(GetZilliqaAddressDetailsR, Integer, Hash)>

Get Zilliqa Address Details Through this endpoint customers can obtain information address details from the Zilliqa blockchain.

Parameters:

  • network (String) —

    Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - &quot;mainnet&quot; is the live network with actual data while networks like &quot;testnet&quot;, &quot;ropsten&quot; are test networks.

  • address (String) —

    Defines the specific transaction&#39;s address.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :context (String) —

    In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. &#x60;context&#x60; is specified by the user.

Returns:

  • (Array<(GetZilliqaAddressDetailsR, Integer, Hash)>) —

    GetZilliqaAddressDetailsR data, response status code and response headers



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/crypto_apis/api/zilliqa_api.rb', line 112

def get_zilliqa_address_details_with_http_info(network, address, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ZilliqaApi.get_zilliqa_address_details ...'
  end
  # verify the required parameter 'network' is set
  if @api_client.config.client_side_validation && network.nil?
    fail ArgumentError, "Missing the required parameter 'network' when calling ZilliqaApi.get_zilliqa_address_details"
  end
  # verify enum value
  allowable_values = ["mainnet"]
  if @api_client.config.client_side_validation && !allowable_values.include?(network)
    fail ArgumentError, "invalid value for \"network\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'address' is set
  if @api_client.config.client_side_validation && address.nil?
    fail ArgumentError, "Missing the required parameter 'address' when calling ZilliqaApi.get_zilliqa_address_details"
  end
  # resource path
  local_var_path = '/blockchain-data/zilliqa-specific/{network}/addresses/{address}'.sub('{' + 'network' + '}', CGI.escape(network.to_s)).sub('{' + 'address' + '}', CGI.escape(address.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'context'] = opts[:'context'] if !opts[:'context'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetZilliqaAddressDetailsR'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"ZilliqaApi.get_zilliqa_address_details",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ZilliqaApi#get_zilliqa_address_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_zilliqa_block_details_by_block_hash(network, block_hash, opts = {}) ⇒ GetZilliqaBlockDetailsByBlockHashR

Get Zilliqa Block Details By Block Hash Through this endpoint customers can obtain block details from the Zilliqa blockchain by providing the block Hash parameter.

Parameters:

  • network (String) —

    Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - &quot;mainnet&quot; is the live network with actual data while networks like &quot;testnet&quot;, &quot;ropsten&quot; are test networks.

  • block_hash (String) —

    Represents the hash of the block, which is its unique identifier. It represents a cryptographic digital fingerprint made by hashing the block header twice through the SHA256 algorithm.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :context (String) —

    In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. &#x60;context&#x60; is specified by the user.

Returns:



177
178
179
180
 
# File 'lib/crypto_apis/api/zilliqa_api.rb', line 177

def get_zilliqa_block_details_by_block_hash(network, block_hash, opts = {})
  data, _status_code, _headers = get_zilliqa_block_details_by_block_hash_with_http_info(network, block_hash, opts)
  data
end

#get_zilliqa_block_details_by_block_hash_with_http_info(network, block_hash, opts = {}) ⇒ Array<(GetZilliqaBlockDetailsByBlockHashR, Integer, Hash)>

Get Zilliqa Block Details By Block Hash Through this endpoint customers can obtain block details from the Zilliqa blockchain by providing the block Hash parameter.

Parameters:

  • network (String) —

    Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - &quot;mainnet&quot; is the live network with actual data while networks like &quot;testnet&quot;, &quot;ropsten&quot; are test networks.

  • block_hash (String) —

    Represents the hash of the block, which is its unique identifier. It represents a cryptographic digital fingerprint made by hashing the block header twice through the SHA256 algorithm.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :context (String) —

    In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. &#x60;context&#x60; is specified by the user.

Returns:



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/crypto_apis/api/zilliqa_api.rb', line 189

def get_zilliqa_block_details_by_block_hash_with_http_info(network, block_hash, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ZilliqaApi.get_zilliqa_block_details_by_block_hash ...'
  end
  # verify the required parameter 'network' is set
  if @api_client.config.client_side_validation && network.nil?
    fail ArgumentError, "Missing the required parameter 'network' when calling ZilliqaApi.get_zilliqa_block_details_by_block_hash"
  end
  # verify enum value
  allowable_values = ["mainnet"]
  if @api_client.config.client_side_validation && !allowable_values.include?(network)
    fail ArgumentError, "invalid value for \"network\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'block_hash' is set
  if @api_client.config.client_side_validation && block_hash.nil?
    fail ArgumentError, "Missing the required parameter 'block_hash' when calling ZilliqaApi.get_zilliqa_block_details_by_block_hash"
  end
  # resource path
  local_var_path = '/blockchain-data/zilliqa-specific/{network}/blocks/hash/{blockHash}'.sub('{' + 'network' + '}', CGI.escape(network.to_s)).sub('{' + 'blockHash' + '}', CGI.escape(block_hash.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'context'] = opts[:'context'] if !opts[:'context'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetZilliqaBlockDetailsByBlockHashR'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"ZilliqaApi.get_zilliqa_block_details_by_block_hash",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ZilliqaApi#get_zilliqa_block_details_by_block_hash\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_zilliqa_block_details_by_block_height(network, block_height, opts = {}) ⇒ GetZilliqaBlockDetailsByBlockHeightR

Get Zilliqa Block Details By Block Height Through this endpoint customers can obtain block details from the Zilliqa blockchain by providing the block Height parameter.

Parameters:

  • network (String) —

    Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - &quot;mainnet&quot; is the live network with actual data while networks like &quot;testnet&quot;, &quot;ropsten&quot; are test networks.

  • block_height (Integer) —

    Represents the number of blocks in the blockchain preceding this specific block. Block numbers have no gaps. A blockchain usually starts with block 0 called the &quot;Genesis block&quot;.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :context (String) —

    In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. &#x60;context&#x60; is specified by the user.

Returns:



254
255
256
257
 
# File 'lib/crypto_apis/api/zilliqa_api.rb', line 254

def get_zilliqa_block_details_by_block_height(network, block_height, opts = {})
  data, _status_code, _headers = get_zilliqa_block_details_by_block_height_with_http_info(network, block_height, opts)
  data
end

#get_zilliqa_block_details_by_block_height_with_http_info(network, block_height, opts = {}) ⇒ Array<(GetZilliqaBlockDetailsByBlockHeightR, Integer, Hash)>

Get Zilliqa Block Details By Block Height Through this endpoint customers can obtain block details from the Zilliqa blockchain by providing the block Height parameter.

Parameters:

  • network (String) —

    Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - &quot;mainnet&quot; is the live network with actual data while networks like &quot;testnet&quot;, &quot;ropsten&quot; are test networks.

  • block_height (Integer) —

    Represents the number of blocks in the blockchain preceding this specific block. Block numbers have no gaps. A blockchain usually starts with block 0 called the &quot;Genesis block&quot;.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :context (String) —

    In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. &#x60;context&#x60; is specified by the user.

Returns:



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/crypto_apis/api/zilliqa_api.rb', line 266

def get_zilliqa_block_details_by_block_height_with_http_info(network, block_height, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ZilliqaApi.get_zilliqa_block_details_by_block_height ...'
  end
  # verify the required parameter 'network' is set
  if @api_client.config.client_side_validation && network.nil?
    fail ArgumentError, "Missing the required parameter 'network' when calling ZilliqaApi.get_zilliqa_block_details_by_block_height"
  end
  # verify enum value
  allowable_values = ["mainnet"]
  if @api_client.config.client_side_validation && !allowable_values.include?(network)
    fail ArgumentError, "invalid value for \"network\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'block_height' is set
  if @api_client.config.client_side_validation && block_height.nil?
    fail ArgumentError, "Missing the required parameter 'block_height' when calling ZilliqaApi.get_zilliqa_block_details_by_block_height"
  end
  # resource path
  local_var_path = '/blockchain-data/zilliqa-specific/{network}/blocks/height/{blockHeight}'.sub('{' + 'network' + '}', CGI.escape(network.to_s)).sub('{' + 'blockHeight' + '}', CGI.escape(block_height.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'context'] = opts[:'context'] if !opts[:'context'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetZilliqaBlockDetailsByBlockHeightR'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"ZilliqaApi.get_zilliqa_block_details_by_block_height",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ZilliqaApi#get_zilliqa_block_details_by_block_height\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_zilliqa_transaction_details_by_transaction_id(network, transaction_hash, opts = {}) ⇒ GetZilliqaTransactionDetailsByTransactionIDR

Get Zilliqa Transaction Details by Transaction ID Through this endpoint customers can obtain transaction details on the Zilliqa blockchain by providing a Transaction ID parameter.

Parameters:

  • network (String) —

    Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - &quot;mainnet&quot; is the live network with actual data while networks like &quot;testnet&quot;, &quot;ropsten&quot; are test networks.

  • transaction_hash (String) —

    String identifier of the transaction

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :context (String) —

    In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. &#x60;context&#x60; is specified by the user.

Returns:



331
332
333
334
 
# File 'lib/crypto_apis/api/zilliqa_api.rb', line 331

def get_zilliqa_transaction_details_by_transaction_id(network, transaction_hash, opts = {})
  data, _status_code, _headers = get_zilliqa_transaction_details_by_transaction_id_with_http_info(network, transaction_hash, opts)
  data
end

#get_zilliqa_transaction_details_by_transaction_id_with_http_info(network, transaction_hash, opts = {}) ⇒ Array<(GetZilliqaTransactionDetailsByTransactionIDR, Integer, Hash)>

Get Zilliqa Transaction Details by Transaction ID Through this endpoint customers can obtain transaction details on the Zilliqa blockchain by providing a Transaction ID parameter.

Parameters:

  • network (String) —

    Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - &quot;mainnet&quot; is the live network with actual data while networks like &quot;testnet&quot;, &quot;ropsten&quot; are test networks.

  • transaction_hash (String) —

    String identifier of the transaction

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :context (String) —

    In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. &#x60;context&#x60; is specified by the user.

Returns:



343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/crypto_apis/api/zilliqa_api.rb', line 343

def get_zilliqa_transaction_details_by_transaction_id_with_http_info(network, transaction_hash, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ZilliqaApi.get_zilliqa_transaction_details_by_transaction_id ...'
  end
  # verify the required parameter 'network' is set
  if @api_client.config.client_side_validation && network.nil?
    fail ArgumentError, "Missing the required parameter 'network' when calling ZilliqaApi.get_zilliqa_transaction_details_by_transaction_id"
  end
  # verify enum value
  allowable_values = ["mainnet"]
  if @api_client.config.client_side_validation && !allowable_values.include?(network)
    fail ArgumentError, "invalid value for \"network\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'transaction_hash' is set
  if @api_client.config.client_side_validation && transaction_hash.nil?
    fail ArgumentError, "Missing the required parameter 'transaction_hash' when calling ZilliqaApi.get_zilliqa_transaction_details_by_transaction_id"
  end
  # resource path
  local_var_path = '/blockchain-data/zilliqa-specific/{network}/transactions/{transactionHash}'.sub('{' + 'network' + '}', CGI.escape(network.to_s)).sub('{' + 'transactionHash' + '}', CGI.escape(transaction_hash.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'context'] = opts[:'context'] if !opts[:'context'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetZilliqaTransactionDetailsByTransactionIDR'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"ZilliqaApi.get_zilliqa_transaction_details_by_transaction_id",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ZilliqaApi#get_zilliqa_transaction_details_by_transaction_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_zilliqa_transactions_by_address(network, address, opts = {}) ⇒ ListZilliqaTransactionsByAddressR

List Zilliqa Transactions by Address Through this endpoint customers can list transactions on the Zilliqa blockchain by the address parameter.

Parameters:

  • network (String) —

    Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - &quot;mainnet&quot; is the live network with actual data while networks like &quot;testnet&quot;, &quot;ropsten&quot; are test networks.

  • address (String) —

    Defines the specific address of the sender.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :context (String) —

    In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. &#x60;context&#x60; is specified by the user.

  • :limit (Integer) —

    Defines how many items should be returned in the response per page basis. (default to 50)

  • :offset (Integer) —

    The starting index of the response items, i.e. where the response should start listing the returned items. (default to 0)

Returns:



410
411
412
413
 
# File 'lib/crypto_apis/api/zilliqa_api.rb', line 410

def list_zilliqa_transactions_by_address(network, address, opts = {})
  data, _status_code, _headers = list_zilliqa_transactions_by_address_with_http_info(network, address, opts)
  data
end

#list_zilliqa_transactions_by_address_with_http_info(network, address, opts = {}) ⇒ Array<(ListZilliqaTransactionsByAddressR, Integer, Hash)>

List Zilliqa Transactions by Address Through this endpoint customers can list transactions on the Zilliqa blockchain by the address parameter.

Parameters:

  • network (String) —

    Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - &quot;mainnet&quot; is the live network with actual data while networks like &quot;testnet&quot;, &quot;ropsten&quot; are test networks.

  • address (String) —

    Defines the specific address of the sender.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :context (String) —

    In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. &#x60;context&#x60; is specified by the user.

  • :limit (Integer) —

    Defines how many items should be returned in the response per page basis. (default to 50)

  • :offset (Integer) —

    The starting index of the response items, i.e. where the response should start listing the returned items. (default to 0)

Returns:



424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
 
# File 'lib/crypto_apis/api/zilliqa_api.rb', line 424

def list_zilliqa_transactions_by_address_with_http_info(network, address, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ZilliqaApi.list_zilliqa_transactions_by_address ...'
  end
  # verify the required parameter 'network' is set
  if @api_client.config.client_side_validation && network.nil?
    fail ArgumentError, "Missing the required parameter 'network' when calling ZilliqaApi.list_zilliqa_transactions_by_address"
  end
  # verify enum value
  allowable_values = ["mainnet"]
  if @api_client.config.client_side_validation && !allowable_values.include?(network)
    fail ArgumentError, "invalid value for \"network\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'address' is set
  if @api_client.config.client_side_validation && address.nil?
    fail ArgumentError, "Missing the required parameter 'address' when calling ZilliqaApi.list_zilliqa_transactions_by_address"
  end
  # resource path
  local_var_path = '/blockchain-data/zilliqa-specific/{network}/addresses/{address}/transactions'.sub('{' + 'network' + '}', CGI.escape(network.to_s)).sub('{' + 'address' + '}', CGI.escape(address.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'context'] = opts[:'context'] if !opts[:'context'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ListZilliqaTransactionsByAddressR'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"ZilliqaApi.list_zilliqa_transactions_by_address",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ZilliqaApi#list_zilliqa_transactions_by_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_zilliqa_transactions_by_block_hash(network, block_hash, opts = {}) ⇒ ListZilliqaTransactionsByBlockHashR

List Zilliqa Transactions By Block Hash Through this endpoint customers can list transactions on the Zilliqa blockchain by the block hash parameter.

Parameters:

  • network (String) —

    Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - &quot;mainnet&quot; is the live network with actual data while networks like &quot;testnet&quot;, &quot;ropsten&quot; are test networks.

  • block_hash (String) —

    Represents the hash of the block, which is its unique identifier. It represents a cryptographic digital fingerprint made by hashing the block header twice through the SHA256 algorithm.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :context (String) —

    In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. &#x60;context&#x60; is specified by the user.

  • :limit (Integer) —

    Defines how many items should be returned in the response per page basis. (default to 50)

  • :offset (Integer) —

    The starting index of the response items, i.e. where the response should start listing the returned items. (default to 0)

Returns:



493
494
495
496
 
# File 'lib/crypto_apis/api/zilliqa_api.rb', line 493

def list_zilliqa_transactions_by_block_hash(network, block_hash, opts = {})
  data, _status_code, _headers = list_zilliqa_transactions_by_block_hash_with_http_info(network, block_hash, opts)
  data
end

#list_zilliqa_transactions_by_block_hash_with_http_info(network, block_hash, opts = {}) ⇒ Array<(ListZilliqaTransactionsByBlockHashR, Integer, Hash)>

List Zilliqa Transactions By Block Hash Through this endpoint customers can list transactions on the Zilliqa blockchain by the block hash parameter.

Parameters:

  • network (String) —

    Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - &quot;mainnet&quot; is the live network with actual data while networks like &quot;testnet&quot;, &quot;ropsten&quot; are test networks.

  • block_hash (String) —

    Represents the hash of the block, which is its unique identifier. It represents a cryptographic digital fingerprint made by hashing the block header twice through the SHA256 algorithm.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :context (String) —

    In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. &#x60;context&#x60; is specified by the user.

  • :limit (Integer) —

    Defines how many items should be returned in the response per page basis. (default to 50)

  • :offset (Integer) —

    The starting index of the response items, i.e. where the response should start listing the returned items. (default to 0)

Returns:



507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
 
# File 'lib/crypto_apis/api/zilliqa_api.rb', line 507

def list_zilliqa_transactions_by_block_hash_with_http_info(network, block_hash, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ZilliqaApi.list_zilliqa_transactions_by_block_hash ...'
  end
  # verify the required parameter 'network' is set
  if @api_client.config.client_side_validation && network.nil?
    fail ArgumentError, "Missing the required parameter 'network' when calling ZilliqaApi.list_zilliqa_transactions_by_block_hash"
  end
  # verify enum value
  allowable_values = ["mainnet"]
  if @api_client.config.client_side_validation && !allowable_values.include?(network)
    fail ArgumentError, "invalid value for \"network\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'block_hash' is set
  if @api_client.config.client_side_validation && block_hash.nil?
    fail ArgumentError, "Missing the required parameter 'block_hash' when calling ZilliqaApi.list_zilliqa_transactions_by_block_hash"
  end
  # resource path
  local_var_path = '/blockchain-data/zilliqa-specific/{network}/blocks/hash/{blockHash}/transactions'.sub('{' + 'network' + '}', CGI.escape(network.to_s)).sub('{' + 'blockHash' + '}', CGI.escape(block_hash.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'context'] = opts[:'context'] if !opts[:'context'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ListZilliqaTransactionsByBlockHashR'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"ZilliqaApi.list_zilliqa_transactions_by_block_hash",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ZilliqaApi#list_zilliqa_transactions_by_block_hash\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_zilliqa_transactions_by_block_height(network, block_height, opts = {}) ⇒ ListZilliqaTransactionsByBlockHeightR

List Zilliqa Transactions By Block Height Through this endpoint customers can list transactions on the Zilliqa blockchain by the block height parameter.

Parameters:

  • network (String) —

    Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - &quot;mainnet&quot; is the live network with actual data while networks like &quot;testnet&quot;, &quot;ropsten&quot; are test networks.

  • block_height (Integer) —

    Represents the number of blocks in the blockchain preceding this specific block. Block numbers have no gaps. A blockchain usually starts with block 0 called the &quot;Genesis block&quot;.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :context (String) —

    In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. &#x60;context&#x60; is specified by the user.

  • :limit (Integer) —

    Defines how many items should be returned in the response per page basis. (default to 50)

  • :offset (Integer) —

    The starting index of the response items, i.e. where the response should start listing the returned items. (default to 0)

Returns:



576
577
578
579
 
# File 'lib/crypto_apis/api/zilliqa_api.rb', line 576

def list_zilliqa_transactions_by_block_height(network, block_height, opts = {})
  data, _status_code, _headers = list_zilliqa_transactions_by_block_height_with_http_info(network, block_height, opts)
  data
end

#list_zilliqa_transactions_by_block_height_with_http_info(network, block_height, opts = {}) ⇒ Array<(ListZilliqaTransactionsByBlockHeightR, Integer, Hash)>

List Zilliqa Transactions By Block Height Through this endpoint customers can list transactions on the Zilliqa blockchain by the block height parameter.

Parameters:

  • network (String) —

    Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - &quot;mainnet&quot; is the live network with actual data while networks like &quot;testnet&quot;, &quot;ropsten&quot; are test networks.

  • block_height (Integer) —

    Represents the number of blocks in the blockchain preceding this specific block. Block numbers have no gaps. A blockchain usually starts with block 0 called the &quot;Genesis block&quot;.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :context (String) —

    In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. &#x60;context&#x60; is specified by the user.

  • :limit (Integer) —

    Defines how many items should be returned in the response per page basis. (default to 50)

  • :offset (Integer) —

    The starting index of the response items, i.e. where the response should start listing the returned items. (default to 0)

Returns:



590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
 
# File 'lib/crypto_apis/api/zilliqa_api.rb', line 590

def list_zilliqa_transactions_by_block_height_with_http_info(network, block_height, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ZilliqaApi.list_zilliqa_transactions_by_block_height ...'
  end
  # verify the required parameter 'network' is set
  if @api_client.config.client_side_validation && network.nil?
    fail ArgumentError, "Missing the required parameter 'network' when calling ZilliqaApi.list_zilliqa_transactions_by_block_height"
  end
  # verify enum value
  allowable_values = ["mainnet"]
  if @api_client.config.client_side_validation && !allowable_values.include?(network)
    fail ArgumentError, "invalid value for \"network\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'block_height' is set
  if @api_client.config.client_side_validation && block_height.nil?
    fail ArgumentError, "Missing the required parameter 'block_height' when calling ZilliqaApi.list_zilliqa_transactions_by_block_height"
  end
  # resource path
  local_var_path = '/blockchain-data/zilliqa-specific/{network}/blocks/height/{blockHeight}/transactions'.sub('{' + 'network' + '}', CGI.escape(network.to_s)).sub('{' + 'blockHeight' + '}', CGI.escape(block_height.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'context'] = opts[:'context'] if !opts[:'context'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ListZilliqaTransactionsByBlockHeightR'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"ZilliqaApi.list_zilliqa_transactions_by_block_height",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ZilliqaApi#list_zilliqa_transactions_by_block_height\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end