Class: Coinbase::Client::ERC20TransferEvent

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

Overview

Represents an event triggered by an ERC-20 token transfer on the blockchain. Contains information about the transaction, block, and involved addresses.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ERC20TransferEvent

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
 
# File 'lib/coinbase/client/models/erc20_transfer_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::ERC20TransferEvent` 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::ERC20TransferEvent`. 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?(:'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?(:'contract_address')
    self.contract_address = attributes[:'contract_address']
  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.



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

def block_hash
  @block_hash
end

#block_number ⇒ Object

Number of the block containing the transaction.



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

def block_number
  @block_number
end

#block_time ⇒ Object

Timestamp when the block was mined.



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

def block_time
  @block_time
end

#contract_address ⇒ Object

Address of the ERC-20 token contract.



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

def contract_address
  @contract_address
end

#event_type ⇒ Object

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



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

def event_type
  @event_type
end

#from ⇒ Object

Address of the sender in the token transfer.



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

def from
  @from
end

#log_index ⇒ Object

Position of the event log within the transaction.



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

def log_index
  @log_index
end

#network ⇒ Object

Blockchain network where the event occurred.



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

def network
  @network
end

#to ⇒ Object

Address of the recipient in the token transfer.



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

def to
  @to
end

#transaction_hash ⇒ Object

Hash of the transaction that triggered the event.



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

def transaction_hash
  @transaction_hash
end

#transaction_index ⇒ Object

Position of the transaction within the block.



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

def transaction_index
  @transaction_index
end

#value ⇒ Object

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



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

def value
  @value
end

#webhook_id ⇒ Object

Unique identifier for the webhook that triggered this event.



20
21
22
 
# File 'lib/coinbase/client/models/erc20_transfer_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



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
279
280
281
282
283
284
285
286
 
# File 'lib/coinbase/client/models/erc20_transfer_event.rb', line 249

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/erc20_transfer_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/erc20_transfer_event.rb', line 59

def self.attribute_map
  {
    :'webhook_id' => :'webhookId',
    :'event_type' => :'eventType',
    :'network' => :'network',
    :'block_hash' => :'blockHash',
    :'block_number' => :'blockNumber',
    :'block_time' => :'blockTime',
    :'transaction_hash' => :'transactionHash',
    :'transaction_index' => :'transactionIndex',
    :'log_index' => :'logIndex',
    :'contract_address' => :'contractAddress',
    :'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



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/coinbase/client/models/erc20_transfer_event.rb', line 225

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/erc20_transfer_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/erc20_transfer_event.rb', line 83

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/coinbase/client/models/erc20_transfer_event.rb', line 192

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 &&
      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 &&
      contract_address == o.contract_address &&
      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



320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/coinbase/client/models/erc20_transfer_event.rb', line 320

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


212
213
214
 
# File 'lib/coinbase/client/models/erc20_transfer_event.rb', line 212

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



218
219
220
 
# File 'lib/coinbase/client/models/erc20_transfer_event.rb', line 218

def hash
  [webhook_id, event_type, network, block_hash, block_number, block_time, transaction_hash, transaction_index, log_index, contract_address, 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



177
178
179
180
181
 
# File 'lib/coinbase/client/models/erc20_transfer_event.rb', line 177

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



296
297
298
 
# File 'lib/coinbase/client/models/erc20_transfer_event.rb', line 296

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



302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/coinbase/client/models/erc20_transfer_event.rb', line 302

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



290
291
292
 
# File 'lib/coinbase/client/models/erc20_transfer_event.rb', line 290

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



185
186
187
188
 
# File 'lib/coinbase/client/models/erc20_transfer_event.rb', line 185

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