Class: Coinbase::Client::EthereumTransaction

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EthereumTransaction

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/coinbase/client/models/ethereum_transaction.rb', line 135

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#block_timestamp ⇒ Object

The timestamp of the block in which the event was emitted



64
65
66
 
# File 'lib/coinbase/client/models/ethereum_transaction.rb', line 64

def block_timestamp
  @block_timestamp
end

#flattened_traces ⇒ Object

Returns the value of attribute flattened_traces.



61
62
63
 
# File 'lib/coinbase/client/models/ethereum_transaction.rb', line 61

def flattened_traces
  @flattened_traces
end

#from ⇒ Object

The onchain address of the sender.



19
20
21
 
# File 'lib/coinbase/client/models/ethereum_transaction.rb', line 19

def from
  @from
end

#gas ⇒ Object

The amount of gas spent in the transaction.



22
23
24
 
# File 'lib/coinbase/client/models/ethereum_transaction.rb', line 22

def gas
  @gas
end

#gas_price ⇒ Object

The price per gas spent in the transaction in atomic units of the native asset.



25
26
27
 
# File 'lib/coinbase/client/models/ethereum_transaction.rb', line 25

def gas_price
  @gas_price
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



28
29
30
 
# File 'lib/coinbase/client/models/ethereum_transaction.rb', line 28

def hash
  @hash
end

#index ⇒ Object

The index of the transaction in the block.



40
41
42
 
# File 'lib/coinbase/client/models/ethereum_transaction.rb', line 40

def index
  @index
end

#input ⇒ Object

The input data of the transaction.



31
32
33
 
# File 'lib/coinbase/client/models/ethereum_transaction.rb', line 31

def input
  @input
end

#max_fee_per_gas ⇒ Object

The max fee per gas as defined in EIP-1559. eips.ethereum.org/EIPS/eip-1559 for more details.



49
50
51
 
# File 'lib/coinbase/client/models/ethereum_transaction.rb', line 49

def max_fee_per_gas
  @max_fee_per_gas
end

#max_priority_fee_per_gas ⇒ Object

The max priority fee per gas as defined in EIP-1559. eips.ethereum.org/EIPS/eip-1559 for more details.



52
53
54
 
# File 'lib/coinbase/client/models/ethereum_transaction.rb', line 52

def max_priority_fee_per_gas
  @max_priority_fee_per_gas
end

#mint ⇒ Object

This is for handling optimism rollup specific EIP-2718 transaction type field.



67
68
69
 
# File 'lib/coinbase/client/models/ethereum_transaction.rb', line 67

def mint
  @mint
end

#nonce ⇒ Object

The nonce of the transaction in the source address.



34
35
36
 
# File 'lib/coinbase/client/models/ethereum_transaction.rb', line 34

def nonce
  @nonce
end

#priority_fee_per_gas ⇒ Object

The confirmed priority fee per gas as defined in EIP-1559. eips.ethereum.org/EIPS/eip-1559 for more details.



55
56
57
 
# File 'lib/coinbase/client/models/ethereum_transaction.rb', line 55

def priority_fee_per_gas
  @priority_fee_per_gas
end

#rlp_encoded_tx ⇒ Object

RLP encoded transaction as a hex string (prefixed with 0x) for native compatibility with popular eth clients such as etherjs, viem etc.



70
71
72
 
# File 'lib/coinbase/client/models/ethereum_transaction.rb', line 70

def rlp_encoded_tx
  @rlp_encoded_tx
end

#to ⇒ Object

The onchain address of the receiver.



37
38
39
 
# File 'lib/coinbase/client/models/ethereum_transaction.rb', line 37

def to
  @to
end

#token_transfers ⇒ Object

Returns the value of attribute token_transfers.



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

def token_transfers
  @token_transfers
end

#transaction_access_list ⇒ Object

Returns the value of attribute transaction_access_list.



57
58
59
 
# File 'lib/coinbase/client/models/ethereum_transaction.rb', line 57

def transaction_access_list
  @transaction_access_list
end

#type ⇒ Object

The EIP-2718 transaction type. See eips.ethereum.org/EIPS/eip-2718 for more details.



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

def type
  @type
end

#value ⇒ Object

The value of the transaction in atomic units of the native asset.



43
44
45
 
# File 'lib/coinbase/client/models/ethereum_transaction.rb', line 43

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



323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/coinbase/client/models/ethereum_transaction.rb', line 323

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/ethereum_transaction.rb', line 98

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



73
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/ethereum_transaction.rb', line 73

def self.attribute_map
  {
    :'from' => :'from',
    :'gas' => :'gas',
    :'gas_price' => :'gas_price',
    :'hash' => :'hash',
    :'input' => :'input',
    :'nonce' => :'nonce',
    :'to' => :'to',
    :'index' => :'index',
    :'value' => :'value',
    :'type' => :'type',
    :'max_fee_per_gas' => :'max_fee_per_gas',
    :'max_priority_fee_per_gas' => :'max_priority_fee_per_gas',
    :'priority_fee_per_gas' => :'priority_fee_per_gas',
    :'transaction_access_list' => :'transaction_access_list',
    :'token_transfers' => :'token_transfers',
    :'flattened_traces' => :'flattened_traces',
    :'block_timestamp' => :'block_timestamp',
    :'mint' => :'mint',
    :'rlp_encoded_tx' => :'rlp_encoded_tx'
  }
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



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/coinbase/client/models/ethereum_transaction.rb', line 299

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



128
129
130
131
 
# File 'lib/coinbase/client/models/ethereum_transaction.rb', line 128

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

def self.openapi_types
  {
    :'from' => :'String',
    :'gas' => :'Integer',
    :'gas_price' => :'Integer',
    :'hash' => :'String',
    :'input' => :'String',
    :'nonce' => :'Integer',
    :'to' => :'String',
    :'index' => :'Integer',
    :'value' => :'String',
    :'type' => :'Integer',
    :'max_fee_per_gas' => :'Integer',
    :'max_priority_fee_per_gas' => :'Integer',
    :'priority_fee_per_gas' => :'Integer',
    :'transaction_access_list' => :'EthereumTransactionAccessList',
    :'token_transfers' => :'Array<EthereumTokenTransfer>',
    :'flattened_traces' => :'Array<EthereumTransactionFlattenedTrace>',
    :'block_timestamp' => :'Time',
    :'mint' => :'String',
    :'rlp_encoded_tx' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/coinbase/client/models/ethereum_transaction.rb', line 260

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      from == o.from &&
      gas == o.gas &&
      gas_price == o.gas_price &&
      hash == o.hash &&
      input == o.input &&
      nonce == o.nonce &&
      to == o.to &&
      index == o.index &&
      value == o.value &&
      type == o.type &&
      max_fee_per_gas == o.max_fee_per_gas &&
      max_priority_fee_per_gas == o.max_priority_fee_per_gas &&
      priority_fee_per_gas == o.priority_fee_per_gas &&
      transaction_access_list == o.transaction_access_list &&
      token_transfers == o.token_transfers &&
      flattened_traces == o.flattened_traces &&
      block_timestamp == o.block_timestamp &&
      mint == o.mint &&
      rlp_encoded_tx == o.rlp_encoded_tx
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



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

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


286
287
288
 
# File 'lib/coinbase/client/models/ethereum_transaction.rb', line 286

def eql?(o)
  self == o
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/coinbase/client/models/ethereum_transaction.rb', line 235

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

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



370
371
372
 
# File 'lib/coinbase/client/models/ethereum_transaction.rb', line 370

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



376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/coinbase/client/models/ethereum_transaction.rb', line 376

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



364
365
366
 
# File 'lib/coinbase/client/models/ethereum_transaction.rb', line 364

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



251
252
253
254
255
256
 
# File 'lib/coinbase/client/models/ethereum_transaction.rb', line 251

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @from.nil?
  return false if @to.nil?
  true
end