Class: Coinbase::Client::ContractEvent

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

Overview

Represents a single decoded event emitted by a smart contract

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ContractEvent

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Coinbase::Client::ContractEvent` 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::ContractEvent`. 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?(:'protocol_name')
    self.protocol_name = attributes[:'protocol_name']
  else
    self.protocol_name = nil
  end

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#block_height ⇒ Object

The block number in which the event was emitted



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

def block_height
  @block_height
end

#block_time ⇒ Object

The timestamp of the block in which the event was emitted



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

def block_time
  @block_time
end

#contract_address ⇒ Object

The EVM address of the smart contract



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

def contract_address
  @contract_address
end

#contract_name ⇒ Object

The name of the specific contract within the project



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

def contract_name
  @contract_name
end

#data ⇒ Object

The event data in a stringified format



56
57
58
 
# File 'lib/coinbase/client/models/contract_event.rb', line 56

def data
  @data
end

#event_index ⇒ Object

The index of the event within the transaction



53
54
55
 
# File 'lib/coinbase/client/models/contract_event.rb', line 53

def event_index
  @event_index
end

#event_name ⇒ Object

The name of the event emitted by the contract



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

def event_name
  @event_name
end

#four_bytes ⇒ Object

The first four bytes of the Keccak hash of the event signature



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

def four_bytes
  @four_bytes
end

#network_id ⇒ Object

The name of the blockchain network



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

def network_id
  @network_id
end

#protocol_name ⇒ Object

The name of the blockchain project or protocol



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

def protocol_name
  @protocol_name
end

#sig ⇒ Object

The signature of the event, including parameter types



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

def sig
  @sig
end

#tx_hash ⇒ Object

The transaction hash in which the event was emitted



47
48
49
 
# File 'lib/coinbase/client/models/contract_event.rb', line 47

def tx_hash
  @tx_hash
end

#tx_index ⇒ Object

The index of the transaction within the block



50
51
52
 
# File 'lib/coinbase/client/models/contract_event.rb', line 50

def tx_index
  @tx_index
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



340
341
342
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
 
# File 'lib/coinbase/client/models/contract_event.rb', line 340

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



78
79
80
 
# File 'lib/coinbase/client/models/contract_event.rb', line 78

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/coinbase/client/models/contract_event.rb', line 59

def self.attribute_map
  {
    :'network_id' => :'network_id',
    :'protocol_name' => :'protocol_name',
    :'contract_name' => :'contract_name',
    :'event_name' => :'event_name',
    :'sig' => :'sig',
    :'four_bytes' => :'four_bytes',
    :'contract_address' => :'contract_address',
    :'block_time' => :'block_time',
    :'block_height' => :'block_height',
    :'tx_hash' => :'tx_hash',
    :'tx_index' => :'tx_index',
    :'event_index' => :'event_index',
    :'data' => :'data'
  }
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



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/coinbase/client/models/contract_event.rb', line 316

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



102
103
104
105
 
# File 'lib/coinbase/client/models/contract_event.rb', line 102

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

.openapi_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/coinbase/client/models/contract_event.rb', line 83

def self.openapi_types
  {
    :'network_id' => :'String',
    :'protocol_name' => :'String',
    :'contract_name' => :'String',
    :'event_name' => :'String',
    :'sig' => :'String',
    :'four_bytes' => :'String',
    :'contract_address' => :'String',
    :'block_time' => :'Time',
    :'block_height' => :'Integer',
    :'tx_hash' => :'String',
    :'tx_index' => :'Integer',
    :'event_index' => :'Integer',
    :'data' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/coinbase/client/models/contract_event.rb', line 283

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      network_id == o.network_id &&
      protocol_name == o.protocol_name &&
      contract_name == o.contract_name &&
      event_name == o.event_name &&
      sig == o.sig &&
      four_bytes == o.four_bytes &&
      contract_address == o.contract_address &&
      block_time == o.block_time &&
      block_height == o.block_height &&
      tx_hash == o.tx_hash &&
      tx_index == o.tx_index &&
      event_index == o.event_index &&
      data == o.data
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



411
412
413
414
415
416
417
418
419
420
421
422
423
 
# File 'lib/coinbase/client/models/contract_event.rb', line 411

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


303
304
305
 
# File 'lib/coinbase/client/models/contract_event.rb', line 303

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



309
310
311
 
# File 'lib/coinbase/client/models/contract_event.rb', line 309

def hash
  [network_id, protocol_name, contract_name, event_name, sig, four_bytes, contract_address, block_time, block_height, tx_hash, tx_index, event_index, data].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



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

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 @protocol_name.nil?
    invalid_properties.push('invalid value for "protocol_name", protocol_name cannot be nil.')
  end

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

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

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

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

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

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

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

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

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

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

  if @data.nil?
    invalid_properties.push('invalid value for "data", data 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



387
388
389
 
# File 'lib/coinbase/client/models/contract_event.rb', line 387

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



393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/coinbase/client/models/contract_event.rb', line 393

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



381
382
383
 
# File 'lib/coinbase/client/models/contract_event.rb', line 381

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



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/coinbase/client/models/contract_event.rb', line 263

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @network_id.nil?
  return false if @protocol_name.nil?
  return false if @contract_name.nil?
  return false if @event_name.nil?
  return false if @sig.nil?
  return false if @four_bytes.nil?
  return false if @contract_address.nil?
  return false if @block_time.nil?
  return false if @block_height.nil?
  return false if @tx_hash.nil?
  return false if @tx_index.nil?
  return false if @event_index.nil?
  return false if @data.nil?
  true
end