Class: Coinbase::Client::StakeApi

Inherits:
Object
  • Object
show all
Defined in:
lib/coinbase/client/api/stake_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ StakeApi

Returns a new instance of StakeApi.



19
20
21
 
# File 'lib/coinbase/client/api/stake_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/coinbase/client/api/stake_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#build_staking_operation(build_staking_operation_request, opts = {}) ⇒ StakingOperation

Build a new staking operation Build a new staking operation

Parameters:

Returns:



27
28
29
30
 
# File 'lib/coinbase/client/api/stake_api.rb', line 27

def build_staking_operation(build_staking_operation_request, opts = {})
  data, _status_code, _headers = build_staking_operation_with_http_info(build_staking_operation_request, opts)
  data
end

#build_staking_operation_with_http_info(build_staking_operation_request, opts = {}) ⇒ Array<(StakingOperation, Integer, Hash)>

Build a new staking operation Build a new staking operation

Parameters:

Returns:

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

    StakingOperation data, response status code and response headers



37
38
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
 
# File 'lib/coinbase/client/api/stake_api.rb', line 37

def build_staking_operation_with_http_info(build_staking_operation_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StakeApi.build_staking_operation ...'
  end
  # verify the required parameter 'build_staking_operation_request' is set
  if @api_client.config.client_side_validation && build_staking_operation_request.nil?
    fail ArgumentError, "Missing the required parameter 'build_staking_operation_request' when calling StakeApi.build_staking_operation"
  end
  # resource path
  local_var_path = '/v1/stake/build'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(build_staking_operation_request)

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

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

  new_options = opts.merge(
    :operation => :"StakeApi.build_staking_operation",
    :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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StakeApi#build_staking_operation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#fetch_historical_staking_balances(network_id, asset_id, address_id, start_time, end_time, opts = {}) ⇒ FetchHistoricalStakingBalances200Response

Fetch historical staking balances Fetch historical staking balances for given address.

Parameters:

  • network_id (String) —

    The ID of the blockchain network.

  • asset_id (String) —

    The ID of the asset for which the historical staking balances are being fetched.

  • address_id (String) —

    The onchain address for which the historical staking balances are being fetched.

  • start_time (Time) —

    The start time of this historical staking balance period.

  • end_time (Time) —

    The end time of this historical staking balance period.

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 50.

  • :page (String) —

    A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

Returns:



101
102
103
104
 
# File 'lib/coinbase/client/api/stake_api.rb', line 101

def fetch_historical_staking_balances(network_id, asset_id, address_id, start_time, end_time, opts = {})
  data, _status_code, _headers = fetch_historical_staking_balances_with_http_info(network_id, asset_id, address_id, start_time, end_time, opts)
  data
end

#fetch_historical_staking_balances_with_http_info(network_id, asset_id, address_id, start_time, end_time, opts = {}) ⇒ Array<(FetchHistoricalStakingBalances200Response, Integer, Hash)>

Fetch historical staking balances Fetch historical staking balances for given address.

Parameters:

  • network_id (String) —

    The ID of the blockchain network.

  • asset_id (String) —

    The ID of the asset for which the historical staking balances are being fetched.

  • address_id (String) —

    The onchain address for which the historical staking balances are being fetched.

  • start_time (Time) —

    The start time of this historical staking balance period.

  • end_time (Time) —

    The end time of this historical staking balance period.

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 50.

  • :page (String) —

    A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

Returns:



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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/coinbase/client/api/stake_api.rb', line 117

def fetch_historical_staking_balances_with_http_info(network_id, asset_id, address_id, start_time, end_time, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StakeApi.fetch_historical_staking_balances ...'
  end
  # verify the required parameter 'network_id' is set
  if @api_client.config.client_side_validation && network_id.nil?
    fail ArgumentError, "Missing the required parameter 'network_id' when calling StakeApi.fetch_historical_staking_balances"
  end
  if @api_client.config.client_side_validation && network_id.to_s.length > 5000
    fail ArgumentError, 'invalid value for "network_id" when calling StakeApi.fetch_historical_staking_balances, the character length must be smaller than or equal to 5000.'
  end

  # verify the required parameter 'asset_id' is set
  if @api_client.config.client_side_validation && asset_id.nil?
    fail ArgumentError, "Missing the required parameter 'asset_id' when calling StakeApi.fetch_historical_staking_balances"
  end
  if @api_client.config.client_side_validation && asset_id.to_s.length > 5000
    fail ArgumentError, 'invalid value for "asset_id" when calling StakeApi.fetch_historical_staking_balances, the character length must be smaller than or equal to 5000.'
  end

  # verify the required parameter 'address_id' is set
  if @api_client.config.client_side_validation && address_id.nil?
    fail ArgumentError, "Missing the required parameter 'address_id' when calling StakeApi.fetch_historical_staking_balances"
  end
  if @api_client.config.client_side_validation && address_id.to_s.length > 5000
    fail ArgumentError, 'invalid value for "address_id" when calling StakeApi.fetch_historical_staking_balances, the character length must be smaller than or equal to 5000.'
  end

  # verify the required parameter 'start_time' is set
  if @api_client.config.client_side_validation && start_time.nil?
    fail ArgumentError, "Missing the required parameter 'start_time' when calling StakeApi.fetch_historical_staking_balances"
  end
  # verify the required parameter 'end_time' is set
  if @api_client.config.client_side_validation && end_time.nil?
    fail ArgumentError, "Missing the required parameter 'end_time' when calling StakeApi.fetch_historical_staking_balances"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'].to_s.length > 5000
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling StakeApi.fetch_historical_staking_balances, the character length must be smaller than or equal to 5000.'
  end

  # resource path
  local_var_path = '/v1/networks/{network_id}/addresses/{address_id}/stake/balances'.sub('{' + 'network_id' + '}', CGI.escape(network_id.to_s)).sub('{' + 'address_id' + '}', CGI.escape(address_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'asset_id'] = asset_id
  query_params[:'start_time'] = start_time
  query_params[:'end_time'] = end_time
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"StakeApi.fetch_historical_staking_balances",
    :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: StakeApi#fetch_historical_staking_balances\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#fetch_staking_rewards(fetch_staking_rewards_request, opts = {}) ⇒ FetchStakingRewards200Response

Fetch staking rewards Fetch staking rewards for a list of addresses

Parameters:

Options Hash (opts):

  • :limit (Integer) —

    A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 50.

  • :page (String) —

    A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

Returns:



209
210
211
212
 
# File 'lib/coinbase/client/api/stake_api.rb', line 209

def fetch_staking_rewards(fetch_staking_rewards_request, opts = {})
  data, _status_code, _headers = fetch_staking_rewards_with_http_info(fetch_staking_rewards_request, opts)
  data
end

#fetch_staking_rewards_with_http_info(fetch_staking_rewards_request, opts = {}) ⇒ Array<(FetchStakingRewards200Response, Integer, Hash)>

Fetch staking rewards Fetch staking rewards for a list of addresses

Parameters:

Options Hash (opts):

  • :limit (Integer) —

    A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 50.

  • :page (String) —

    A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

Returns:



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
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/coinbase/client/api/stake_api.rb', line 221

def fetch_staking_rewards_with_http_info(fetch_staking_rewards_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StakeApi.fetch_staking_rewards ...'
  end
  # verify the required parameter 'fetch_staking_rewards_request' is set
  if @api_client.config.client_side_validation && fetch_staking_rewards_request.nil?
    fail ArgumentError, "Missing the required parameter 'fetch_staking_rewards_request' when calling StakeApi.fetch_staking_rewards"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'].to_s.length > 5000
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling StakeApi.fetch_staking_rewards, the character length must be smaller than or equal to 5000.'
  end

  # resource path
  local_var_path = '/v1/stake/rewards/search'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(fetch_staking_rewards_request)

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

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

  new_options = opts.merge(
    :operation => :"StakeApi.fetch_staking_rewards",
    :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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StakeApi#fetch_staking_rewards\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_external_staking_operation(network_id, address_id, staking_operation_id, opts = {}) ⇒ StakingOperation

Get the latest state of a staking operation Get the latest state of a staking operation

Parameters:

  • network_id (String) —

    The ID of the blockchain network

  • address_id (String) —

    The ID of the address to fetch the staking operation for

  • staking_operation_id (String) —

    The ID of the staking operation

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

    the optional parameters

Returns:



287
288
289
290
 
# File 'lib/coinbase/client/api/stake_api.rb', line 287

def get_external_staking_operation(network_id, address_id, staking_operation_id, opts = {})
  data, _status_code, _headers = get_external_staking_operation_with_http_info(network_id, address_id, staking_operation_id, opts)
  data
end

#get_external_staking_operation_with_http_info(network_id, address_id, staking_operation_id, opts = {}) ⇒ Array<(StakingOperation, Integer, Hash)>

Get the latest state of a staking operation Get the latest state of a staking operation

Parameters:

  • network_id (String) —

    The ID of the blockchain network

  • address_id (String) —

    The ID of the address to fetch the staking operation for

  • staking_operation_id (String) —

    The ID of the staking operation

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

    the optional parameters

Returns:

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

    StakingOperation data, response status code and response headers



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/coinbase/client/api/stake_api.rb', line 299

def get_external_staking_operation_with_http_info(network_id, address_id, staking_operation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StakeApi.get_external_staking_operation ...'
  end
  # verify the required parameter 'network_id' is set
  if @api_client.config.client_side_validation && network_id.nil?
    fail ArgumentError, "Missing the required parameter 'network_id' when calling StakeApi.get_external_staking_operation"
  end
  # verify the required parameter 'address_id' is set
  if @api_client.config.client_side_validation && address_id.nil?
    fail ArgumentError, "Missing the required parameter 'address_id' when calling StakeApi.get_external_staking_operation"
  end
  # verify the required parameter 'staking_operation_id' is set
  if @api_client.config.client_side_validation && staking_operation_id.nil?
    fail ArgumentError, "Missing the required parameter 'staking_operation_id' when calling StakeApi.get_external_staking_operation"
  end
  # resource path
  local_var_path = '/v1/networks/{network_id}/addresses/{address_id}/staking_operations/{staking_operation_id}'.sub('{' + 'network_id' + '}', CGI.escape(network_id.to_s)).sub('{' + 'address_id' + '}', CGI.escape(address_id.to_s)).sub('{' + 'staking_operation_id' + '}', CGI.escape(staking_operation_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"StakeApi.get_external_staking_operation",
    :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: StakeApi#get_external_staking_operation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_staking_context(get_staking_context_request, opts = {}) ⇒ StakingContext

Get staking context Get staking context for an address

Parameters:

Returns:



360
361
362
363
 
# File 'lib/coinbase/client/api/stake_api.rb', line 360

def get_staking_context(get_staking_context_request, opts = {})
  data, _status_code, _headers = get_staking_context_with_http_info(get_staking_context_request, opts)
  data
end

#get_staking_context_with_http_info(get_staking_context_request, opts = {}) ⇒ Array<(StakingContext, Integer, Hash)>

Get staking context Get staking context for an address

Parameters:

Returns:

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

    StakingContext data, response status code and response headers



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
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'lib/coinbase/client/api/stake_api.rb', line 370

def get_staking_context_with_http_info(get_staking_context_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StakeApi.get_staking_context ...'
  end
  # verify the required parameter 'get_staking_context_request' is set
  if @api_client.config.client_side_validation && get_staking_context_request.nil?
    fail ArgumentError, "Missing the required parameter 'get_staking_context_request' when calling StakeApi.get_staking_context"
  end
  # resource path
  local_var_path = '/v1/stake/context'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(get_staking_context_request)

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

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

  new_options = opts.merge(
    :operation => :"StakeApi.get_staking_context",
    :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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StakeApi#get_staking_context\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end