Class: Coinbase::Client::SmartContractsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SmartContractsApi

Returns a new instance of SmartContractsApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_smart_contract(wallet_id, address_id, create_smart_contract_request, opts = {}) ⇒ SmartContract

Create a new smart contract Create a new smart contract

Parameters:

  • wallet_id (String) —

    The ID of the wallet the address belongs to.

  • address_id (String) —

    The ID of the address to deploy the smart contract from.

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

    the optional parameters

Returns:



29
30
31
32
 
# File 'lib/coinbase/client/api/smart_contracts_api.rb', line 29

def create_smart_contract(wallet_id, address_id, create_smart_contract_request, opts = {})
  data, _status_code, _headers = create_smart_contract_with_http_info(wallet_id, address_id, create_smart_contract_request, opts)
  data
end

#create_smart_contract_with_http_info(wallet_id, address_id, create_smart_contract_request, opts = {}) ⇒ Array<(SmartContract, Integer, Hash)>

Create a new smart contract Create a new smart contract

Parameters:

  • wallet_id (String) —

    The ID of the wallet the address belongs to.

  • address_id (String) —

    The ID of the address to deploy the smart contract from.

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

    the optional parameters

Returns:

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

    SmartContract data, response status code and response headers



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
92
93
94
95
96
97
98
99
100
 
# File 'lib/coinbase/client/api/smart_contracts_api.rb', line 41

def create_smart_contract_with_http_info(wallet_id, address_id, create_smart_contract_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SmartContractsApi.create_smart_contract ...'
  end
  # verify the required parameter 'wallet_id' is set
  if @api_client.config.client_side_validation && wallet_id.nil?
    fail ArgumentError, "Missing the required parameter 'wallet_id' when calling SmartContractsApi.create_smart_contract"
  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 SmartContractsApi.create_smart_contract"
  end
  # verify the required parameter 'create_smart_contract_request' is set
  if @api_client.config.client_side_validation && create_smart_contract_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_smart_contract_request' when calling SmartContractsApi.create_smart_contract"
  end
  # resource path
  local_var_path = '/v1/wallets/{wallet_id}/addresses/{address_id}/smart_contracts'.sub('{' + 'wallet_id' + '}', CGI.escape(wallet_id.to_s)).sub('{' + 'address_id' + '}', CGI.escape(address_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']
  # 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(create_smart_contract_request)

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

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

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

#deploy_smart_contract(wallet_id, address_id, smart_contract_id, deploy_smart_contract_request, opts = {}) ⇒ SmartContract

Deploy a smart contract Deploys a smart contract, by broadcasting the transaction to the network.

Parameters:

  • wallet_id (String) —

    The ID of the wallet the address belongs to.

  • address_id (String) —

    The ID of the address to broadcast the transaction from.

  • smart_contract_id (String) —

    The UUID of the smart contract to broadcast the transaction to.

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

    the optional parameters

Returns:



110
111
112
113
 
# File 'lib/coinbase/client/api/smart_contracts_api.rb', line 110

def deploy_smart_contract(wallet_id, address_id, smart_contract_id, deploy_smart_contract_request, opts = {})
  data, _status_code, _headers = deploy_smart_contract_with_http_info(wallet_id, address_id, smart_contract_id, deploy_smart_contract_request, opts)
  data
end

#deploy_smart_contract_with_http_info(wallet_id, address_id, smart_contract_id, deploy_smart_contract_request, opts = {}) ⇒ Array<(SmartContract, Integer, Hash)>

Deploy a smart contract Deploys a smart contract, by broadcasting the transaction to the network.

Parameters:

  • wallet_id (String) —

    The ID of the wallet the address belongs to.

  • address_id (String) —

    The ID of the address to broadcast the transaction from.

  • smart_contract_id (String) —

    The UUID of the smart contract to broadcast the transaction to.

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

    the optional parameters

Returns:

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

    SmartContract data, response status code and response headers



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

def deploy_smart_contract_with_http_info(wallet_id, address_id, smart_contract_id, deploy_smart_contract_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SmartContractsApi.deploy_smart_contract ...'
  end
  # verify the required parameter 'wallet_id' is set
  if @api_client.config.client_side_validation && wallet_id.nil?
    fail ArgumentError, "Missing the required parameter 'wallet_id' when calling SmartContractsApi.deploy_smart_contract"
  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 SmartContractsApi.deploy_smart_contract"
  end
  # verify the required parameter 'smart_contract_id' is set
  if @api_client.config.client_side_validation && smart_contract_id.nil?
    fail ArgumentError, "Missing the required parameter 'smart_contract_id' when calling SmartContractsApi.deploy_smart_contract"
  end
  # verify the required parameter 'deploy_smart_contract_request' is set
  if @api_client.config.client_side_validation && deploy_smart_contract_request.nil?
    fail ArgumentError, "Missing the required parameter 'deploy_smart_contract_request' when calling SmartContractsApi.deploy_smart_contract"
  end
  # resource path
  local_var_path = '/v1/wallets/{wallet_id}/addresses/{address_id}/smart_contracts/{smart_contract_id}/deploy'.sub('{' + 'wallet_id' + '}', CGI.escape(wallet_id.to_s)).sub('{' + 'address_id' + '}', CGI.escape(address_id.to_s)).sub('{' + 'smart_contract_id' + '}', CGI.escape(smart_contract_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']
  # 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(deploy_smart_contract_request)

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

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

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

#get_smart_contract(wallet_id, address_id, smart_contract_id, opts = {}) ⇒ SmartContract

Get a specific smart contract deployed by address Get a specific smart contract deployed by address.

Parameters:

  • wallet_id (String) —

    The ID of the wallet the address belongs to.

  • address_id (String) —

    The ID of the address to fetch the smart contract for.

  • smart_contract_id (String) —

    The UUID of the smart contract to fetch.

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

    the optional parameters

Returns:



195
196
197
198
 
# File 'lib/coinbase/client/api/smart_contracts_api.rb', line 195

def get_smart_contract(wallet_id, address_id, smart_contract_id, opts = {})
  data, _status_code, _headers = get_smart_contract_with_http_info(wallet_id, address_id, smart_contract_id, opts)
  data
end

#get_smart_contract_with_http_info(wallet_id, address_id, smart_contract_id, opts = {}) ⇒ Array<(SmartContract, Integer, Hash)>

Get a specific smart contract deployed by address Get a specific smart contract deployed by address.

Parameters:

  • wallet_id (String) —

    The ID of the wallet the address belongs to.

  • address_id (String) —

    The ID of the address to fetch the smart contract for.

  • smart_contract_id (String) —

    The UUID of the smart contract to fetch.

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

    the optional parameters

Returns:

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

    SmartContract data, response status code and response headers



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
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/coinbase/client/api/smart_contracts_api.rb', line 207

def get_smart_contract_with_http_info(wallet_id, address_id, smart_contract_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SmartContractsApi.get_smart_contract ...'
  end
  # verify the required parameter 'wallet_id' is set
  if @api_client.config.client_side_validation && wallet_id.nil?
    fail ArgumentError, "Missing the required parameter 'wallet_id' when calling SmartContractsApi.get_smart_contract"
  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 SmartContractsApi.get_smart_contract"
  end
  # verify the required parameter 'smart_contract_id' is set
  if @api_client.config.client_side_validation && smart_contract_id.nil?
    fail ArgumentError, "Missing the required parameter 'smart_contract_id' when calling SmartContractsApi.get_smart_contract"
  end
  # resource path
  local_var_path = '/v1/wallets/{wallet_id}/addresses/{address_id}/smart_contracts/{smart_contract_id}'.sub('{' + 'wallet_id' + '}', CGI.escape(wallet_id.to_s)).sub('{' + 'address_id' + '}', CGI.escape(address_id.to_s)).sub('{' + 'smart_contract_id' + '}', CGI.escape(smart_contract_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] || 'SmartContract'

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

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

#list_smart_contracts(wallet_id, address_id, opts = {}) ⇒ SmartContractList

List smart contracts deployed by address List all smart contracts deployed by address.

Parameters:

  • wallet_id (String) —

    The ID of the wallet the address belongs to.

  • address_id (String) —

    The ID of the address to fetch the smart contracts for.

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

    the optional parameters

Returns:



269
270
271
272
 
# File 'lib/coinbase/client/api/smart_contracts_api.rb', line 269

def list_smart_contracts(wallet_id, address_id, opts = {})
  data, _status_code, _headers = list_smart_contracts_with_http_info(wallet_id, address_id, opts)
  data
end

#list_smart_contracts_with_http_info(wallet_id, address_id, opts = {}) ⇒ Array<(SmartContractList, Integer, Hash)>

List smart contracts deployed by address List all smart contracts deployed by address.

Parameters:

  • wallet_id (String) —

    The ID of the wallet the address belongs to.

  • address_id (String) —

    The ID of the address to fetch the smart contracts for.

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

    the optional parameters

Returns:

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

    SmartContractList data, response status code and response headers



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
323
324
325
326
327
328
329
330
 
# File 'lib/coinbase/client/api/smart_contracts_api.rb', line 280

def list_smart_contracts_with_http_info(wallet_id, address_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SmartContractsApi.list_smart_contracts ...'
  end
  # verify the required parameter 'wallet_id' is set
  if @api_client.config.client_side_validation && wallet_id.nil?
    fail ArgumentError, "Missing the required parameter 'wallet_id' when calling SmartContractsApi.list_smart_contracts"
  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 SmartContractsApi.list_smart_contracts"
  end
  # resource path
  local_var_path = '/v1/wallets/{wallet_id}/addresses/{address_id}/smart_contracts'.sub('{' + 'wallet_id' + '}', CGI.escape(wallet_id.to_s)).sub('{' + 'address_id' + '}', CGI.escape(address_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] || 'SmartContractList'

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

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

#read_contract(network_id, contract_address, read_contract_request, opts = {}) ⇒ SolidityValue

Read data from a smart contract Perform a read operation on a smart contract without creating a transaction

Parameters:

  • network_id (String)
  • contract_address (String)
  • read_contract_request (ReadContractRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



339
340
341
342
 
# File 'lib/coinbase/client/api/smart_contracts_api.rb', line 339

def read_contract(network_id, contract_address, read_contract_request, opts = {})
  data, _status_code, _headers = read_contract_with_http_info(network_id, contract_address, read_contract_request, opts)
  data
end

#read_contract_with_http_info(network_id, contract_address, read_contract_request, opts = {}) ⇒ Array<(SolidityValue, Integer, Hash)>

Read data from a smart contract Perform a read operation on a smart contract without creating a transaction

Parameters:

  • network_id (String)
  • contract_address (String)
  • read_contract_request (ReadContractRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    SolidityValue data, response status code and response headers



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
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/coinbase/client/api/smart_contracts_api.rb', line 351

def read_contract_with_http_info(network_id, contract_address, read_contract_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SmartContractsApi.read_contract ...'
  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 SmartContractsApi.read_contract"
  end
  # verify the required parameter 'contract_address' is set
  if @api_client.config.client_side_validation && contract_address.nil?
    fail ArgumentError, "Missing the required parameter 'contract_address' when calling SmartContractsApi.read_contract"
  end
  # verify the required parameter 'read_contract_request' is set
  if @api_client.config.client_side_validation && read_contract_request.nil?
    fail ArgumentError, "Missing the required parameter 'read_contract_request' when calling SmartContractsApi.read_contract"
  end
  # resource path
  local_var_path = '/v1/networks/{network_id}/smart_contracts/{contract_address}/read'.sub('{' + 'network_id' + '}', CGI.escape(network_id.to_s)).sub('{' + 'contract_address' + '}', CGI.escape(contract_address.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']
  # 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(read_contract_request)

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

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

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