Class: Coinbase::Client::SmartContractActivityEvent

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

Overview

Represents an event triggered by a smart contract activity on the blockchain. Contains information about the function, transaction, block, and involved addresses.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SmartContractActivityEvent

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/coinbase/client/models/smart_contract_activity_event.rb', line 134

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#block_hash ⇒ Object

Hash of the block containing the transaction.



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

def block_hash
  @block_hash
end

#block_number ⇒ Object

Number of the block containing the transaction.



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

def block_number
  @block_number
end

#block_time ⇒ Object

Timestamp when the block was mined.



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

def block_time
  @block_time
end

#contract_address ⇒ Object

Address of the smart contract.



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

def contract_address
  @contract_address
end

#contract_name ⇒ Object

Name of the contract.



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

def contract_name
  @contract_name
end

#event_type ⇒ Object

Type of event, in this case, an ERC-721 token transfer.



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

def event_type
  @event_type
end

#four_bytes ⇒ Object

First 4 bytes of the Transaction, a unique ID.



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

def four_bytes
  @four_bytes
end

#from ⇒ Object

Address of the initiator in the transfer.



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

def from
  @from
end

#func ⇒ Object

Name of the function.



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

def func
  @func
end

#log_index ⇒ Object

Position of the event log within the transaction.



62
63
64
 
# File 'lib/coinbase/client/models/smart_contract_activity_event.rb', line 62

def log_index
  @log_index
end

#network ⇒ Object

Blockchain network where the event occurred.



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

def network
  @network
end

#project_name ⇒ Object

Name of the project this smart contract belongs to.



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

def project_name
  @project_name
end

#sig ⇒ Object

Signature of the function.



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

def sig
  @sig
end

#to ⇒ Object

Address of the recipient in the transfer.



68
69
70
 
# File 'lib/coinbase/client/models/smart_contract_activity_event.rb', line 68

def to
  @to
end

#transaction_hash ⇒ Object

Hash of the transaction that triggered the event.



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

def transaction_hash
  @transaction_hash
end

#transaction_index ⇒ Object

Position of the transaction within the block.



59
60
61
 
# File 'lib/coinbase/client/models/smart_contract_activity_event.rb', line 59

def transaction_index
  @transaction_index
end

#value ⇒ Object

Amount of tokens transferred, typically in the smallest unit (e.g., wei for Ethereum).



71
72
73
 
# File 'lib/coinbase/client/models/smart_contract_activity_event.rb', line 71

def value
  @value
end

#webhook_id ⇒ Object

Unique identifier for the webhook that triggered this event.



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

def webhook_id
  @webhook_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



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

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



98
99
100
 
# File 'lib/coinbase/client/models/smart_contract_activity_event.rb', line 98

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/coinbase/client/models/smart_contract_activity_event.rb', line 74

def self.attribute_map
  {
    :'webhook_id' => :'webhookId',
    :'event_type' => :'eventType',
    :'network' => :'network',
    :'project_name' => :'projectName',
    :'contract_name' => :'contractName',
    :'func' => :'func',
    :'sig' => :'sig',
    :'four_bytes' => :'fourBytes',
    :'contract_address' => :'contractAddress',
    :'block_hash' => :'blockHash',
    :'block_number' => :'blockNumber',
    :'block_time' => :'blockTime',
    :'transaction_hash' => :'transactionHash',
    :'transaction_index' => :'transactionIndex',
    :'log_index' => :'logIndex',
    :'from' => :'from',
    :'to' => :'to',
    :'value' => :'value'
  }
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



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/coinbase/client/models/smart_contract_activity_event.rb', line 275

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



127
128
129
130
 
# File 'lib/coinbase/client/models/smart_contract_activity_event.rb', line 127

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

.openapi_types ⇒ Object

Attribute type mapping.



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/coinbase/client/models/smart_contract_activity_event.rb', line 103

def self.openapi_types
  {
    :'webhook_id' => :'String',
    :'event_type' => :'String',
    :'network' => :'String',
    :'project_name' => :'String',
    :'contract_name' => :'String',
    :'func' => :'String',
    :'sig' => :'String',
    :'four_bytes' => :'String',
    :'contract_address' => :'String',
    :'block_hash' => :'String',
    :'block_number' => :'Integer',
    :'block_time' => :'Time',
    :'transaction_hash' => :'String',
    :'transaction_index' => :'Integer',
    :'log_index' => :'Integer',
    :'from' => :'String',
    :'to' => :'String',
    :'value' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/coinbase/client/models/smart_contract_activity_event.rb', line 237

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      webhook_id == o.webhook_id &&
      event_type == o.event_type &&
      network == o.network &&
      project_name == o.project_name &&
      contract_name == o.contract_name &&
      func == o.func &&
      sig == o.sig &&
      four_bytes == o.four_bytes &&
      contract_address == o.contract_address &&
      block_hash == o.block_hash &&
      block_number == o.block_number &&
      block_time == o.block_time &&
      transaction_hash == o.transaction_hash &&
      transaction_index == o.transaction_index &&
      log_index == o.log_index &&
      from == o.from &&
      to == o.to &&
      value == o.value
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



370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/coinbase/client/models/smart_contract_activity_event.rb', line 370

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


262
263
264
 
# File 'lib/coinbase/client/models/smart_contract_activity_event.rb', line 262

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



268
269
270
 
# File 'lib/coinbase/client/models/smart_contract_activity_event.rb', line 268

def hash
  [webhook_id, event_type, network, project_name, contract_name, func, sig, four_bytes, contract_address, block_hash, block_number, block_time, transaction_hash, transaction_index, log_index, from, to, value].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



222
223
224
225
226
 
# File 'lib/coinbase/client/models/smart_contract_activity_event.rb', line 222

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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



346
347
348
 
# File 'lib/coinbase/client/models/smart_contract_activity_event.rb', line 346

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



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

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



340
341
342
 
# File 'lib/coinbase/client/models/smart_contract_activity_event.rb', line 340

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



230
231
232
233
 
# File 'lib/coinbase/client/models/smart_contract_activity_event.rb', line 230

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end