Class: Coinbase::Client::ContractInvocation

Inherits:
Object
  • Object
show all
Defined in:
lib/coinbase/client/models/contract_invocation.rb

Overview

A contract invocation onchain.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ContractInvocation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
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
 
# File 'lib/coinbase/client/models/contract_invocation.rb', line 93

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Coinbase::Client::ContractInvocation` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Coinbase::Client::ContractInvocation`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'network_id')
    self.network_id = attributes[:'network_id']
  else
    self.network_id = nil
  end

  if attributes.key?(:'wallet_id')
    self.wallet_id = attributes[:'wallet_id']
  else
    self.wallet_id = nil
  end

  if attributes.key?(:'address_id')
    self.address_id = attributes[:'address_id']
  else
    self.address_id = nil
  end

  if attributes.key?(:'contract_invocation_id')
    self.contract_invocation_id = attributes[:'contract_invocation_id']
  else
    self.contract_invocation_id = nil
  end

  if attributes.key?(:'contract_address')
    self.contract_address = attributes[:'contract_address']
  else
    self.contract_address = nil
  end

  if attributes.key?(:'method')
    self.method = attributes[:'method']
  else
    self.method = nil
  end

  if attributes.key?(:'args')
    self.args = attributes[:'args']
  else
    self.args = nil
  end

  if attributes.key?(:'abi')
    self.abi = attributes[:'abi']
  end

  if attributes.key?(:'amount')
    self.amount = attributes[:'amount']
  else
    self.amount = nil
  end

  if attributes.key?(:'transaction')
    self.transaction = attributes[:'transaction']
  else
    self.transaction = nil
  end
end

Instance Attribute Details

#abi ⇒ Object

The JSON-encoded ABI of the contract.



41
42
43
 
# File 'lib/coinbase/client/models/contract_invocation.rb', line 41

def abi
  @abi
end

#address_id ⇒ Object

The onchain address of the address invoking the contract.



26
27
28
 
# File 'lib/coinbase/client/models/contract_invocation.rb', line 26

def address_id
  @address_id
end

#amount ⇒ Object

The amount to send to the contract for a payable method



44
45
46
 
# File 'lib/coinbase/client/models/contract_invocation.rb', line 44

def amount
  @amount
end

#args ⇒ Object

The JSON-encoded arguments to pass to the contract method. The keys should be the argument names and the values should be the argument values.



38
39
40
 
# File 'lib/coinbase/client/models/contract_invocation.rb', line 38

def args
  @args
end

#contract_address ⇒ Object

The onchain address of the contract.



32
33
34
 
# File 'lib/coinbase/client/models/contract_invocation.rb', line 32

def contract_address
  @contract_address
end

#contract_invocation_id ⇒ Object

The ID of the contract invocation.



29
30
31
 
# File 'lib/coinbase/client/models/contract_invocation.rb', line 29

def contract_invocation_id
  @contract_invocation_id
end

#method ⇒ Object

The method to be invoked on the contract.



35
36
37
 
# File 'lib/coinbase/client/models/contract_invocation.rb', line 35

def method
  @method
end

#network_id ⇒ Object

The ID of the blockchain network.



20
21
22
 
# File 'lib/coinbase/client/models/contract_invocation.rb', line 20

def network_id
  @network_id
end

#transaction ⇒ Object

Returns the value of attribute transaction.



46
47
48
 
# File 'lib/coinbase/client/models/contract_invocation.rb', line 46

def transaction
  @transaction
end

#wallet_id ⇒ Object

The ID of the wallet that owns the address.



23
24
25
 
# File 'lib/coinbase/client/models/contract_invocation.rb', line 23

def wallet_id
  @wallet_id
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



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
 
# File 'lib/coinbase/client/models/contract_invocation.rb', line 281

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = Coinbase::Client.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



65
66
67
 
# File 'lib/coinbase/client/models/contract_invocation.rb', line 65

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/coinbase/client/models/contract_invocation.rb', line 49

def self.attribute_map
  {
    :'network_id' => :'network_id',
    :'wallet_id' => :'wallet_id',
    :'address_id' => :'address_id',
    :'contract_invocation_id' => :'contract_invocation_id',
    :'contract_address' => :'contract_address',
    :'method' => :'method',
    :'args' => :'args',
    :'abi' => :'abi',
    :'amount' => :'amount',
    :'transaction' => :'transaction'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/coinbase/client/models/contract_invocation.rb', line 257

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



86
87
88
89
 
# File 'lib/coinbase/client/models/contract_invocation.rb', line 86

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/coinbase/client/models/contract_invocation.rb', line 70

def self.openapi_types
  {
    :'network_id' => :'String',
    :'wallet_id' => :'String',
    :'address_id' => :'String',
    :'contract_invocation_id' => :'String',
    :'contract_address' => :'String',
    :'method' => :'String',
    :'args' => :'String',
    :'abi' => :'String',
    :'amount' => :'String',
    :'transaction' => :'Transaction'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/coinbase/client/models/contract_invocation.rb', line 227

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      network_id == o.network_id &&
      wallet_id == o.wallet_id &&
      address_id == o.address_id &&
      contract_invocation_id == o.contract_invocation_id &&
      contract_address == o.contract_address &&
      method == o.method &&
      args == o.args &&
      abi == o.abi &&
      amount == o.amount &&
      transaction == o.transaction
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/coinbase/client/models/contract_invocation.rb', line 352

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


244
245
246
 
# File 'lib/coinbase/client/models/contract_invocation.rb', line 244

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



250
251
252
 
# File 'lib/coinbase/client/models/contract_invocation.rb', line 250

def hash
  [network_id, wallet_id, address_id, contract_invocation_id, contract_address, method, args, abi, amount, transaction].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



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
201
202
203
204
205
206
207
 
# File 'lib/coinbase/client/models/contract_invocation.rb', line 167

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @network_id.nil?
    invalid_properties.push('invalid value for "network_id", network_id cannot be nil.')
  end

  if @wallet_id.nil?
    invalid_properties.push('invalid value for "wallet_id", wallet_id cannot be nil.')
  end

  if @address_id.nil?
    invalid_properties.push('invalid value for "address_id", address_id cannot be nil.')
  end

  if @contract_invocation_id.nil?
    invalid_properties.push('invalid value for "contract_invocation_id", contract_invocation_id cannot be nil.')
  end

  if @contract_address.nil?
    invalid_properties.push('invalid value for "contract_address", contract_address cannot be nil.')
  end

  if @method.nil?
    invalid_properties.push('invalid value for "method", method cannot be nil.')
  end

  if @args.nil?
    invalid_properties.push('invalid value for "args", args cannot be nil.')
  end

  if @amount.nil?
    invalid_properties.push('invalid value for "amount", amount cannot be nil.')
  end

  if @transaction.nil?
    invalid_properties.push('invalid value for "transaction", transaction cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



328
329
330
 
# File 'lib/coinbase/client/models/contract_invocation.rb', line 328

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/coinbase/client/models/contract_invocation.rb', line 334

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



322
323
324
 
# File 'lib/coinbase/client/models/contract_invocation.rb', line 322

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/coinbase/client/models/contract_invocation.rb', line 211

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @network_id.nil?
  return false if @wallet_id.nil?
  return false if @address_id.nil?
  return false if @contract_invocation_id.nil?
  return false if @contract_address.nil?
  return false if @method.nil?
  return false if @args.nil?
  return false if @amount.nil?
  return false if @transaction.nil?
  true
end