Class: Coinbase::Client::EthereumValidatorMetadata

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

Overview

An Ethereum validator.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EthereumValidatorMetadata

Initializes the object

Parameters:

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

    Model attributes in the form of hash



87
88
89
90
91
92
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
 
# File 'lib/coinbase/client/models/ethereum_validator_metadata.rb', line 87

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#activation_epoch ⇒ Object

The epoch at which the validator was activated.



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

def activation_epoch
  @activation_epoch
end

#balance ⇒ Object

Returns the value of attribute balance.



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

def balance
  @balance
end

#effective_balance ⇒ Object

Returns the value of attribute effective_balance.



42
43
44
 
# File 'lib/coinbase/client/models/ethereum_validator_metadata.rb', line 42

def effective_balance
  @effective_balance
end

#exit_epoch ⇒ Object

The epoch at which the validator exited.



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

def exit_epoch
  @exit_epoch
end

#index ⇒ Object

The index of the validator in the validator set.



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

def index
  @index
end

#public_key ⇒ Object

The public key of the validator.



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

def public_key
  @public_key
end

#slashed ⇒ Object

Whether the validator has been slashed.



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

def slashed
  @slashed
end

#withdrawable_epoch ⇒ Object

The epoch at which the validator can withdraw.



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

def withdrawable_epoch
  @withdrawable_epoch
end

#withdrawal_address ⇒ Object

The address to which the validator’s rewards are sent.



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

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



270
271
272
273
274
275
276
277
278
279
280
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
 
# File 'lib/coinbase/client/models/ethereum_validator_metadata.rb', line 270

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



60
61
62
 
# File 'lib/coinbase/client/models/ethereum_validator_metadata.rb', line 60

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/coinbase/client/models/ethereum_validator_metadata.rb', line 45

def self.attribute_map
  {
    :'index' => :'index',
    :'public_key' => :'public_key',
    :'withdrawal_address' => :'withdrawal_address',
    :'slashed' => :'slashed',
    :'activation_epoch' => :'activationEpoch',
    :'exit_epoch' => :'exitEpoch',
    :'withdrawable_epoch' => :'withdrawableEpoch',
    :'balance' => :'balance',
    :'effective_balance' => :'effective_balance'
  }
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



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/coinbase/client/models/ethereum_validator_metadata.rb', line 246

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



80
81
82
83
 
# File 'lib/coinbase/client/models/ethereum_validator_metadata.rb', line 80

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

.openapi_types ⇒ Object

Attribute type mapping.



65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/coinbase/client/models/ethereum_validator_metadata.rb', line 65

def self.openapi_types
  {
    :'index' => :'String',
    :'public_key' => :'String',
    :'withdrawal_address' => :'String',
    :'slashed' => :'Boolean',
    :'activation_epoch' => :'String',
    :'exit_epoch' => :'String',
    :'withdrawable_epoch' => :'String',
    :'balance' => :'Balance',
    :'effective_balance' => :'Balance'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/coinbase/client/models/ethereum_validator_metadata.rb', line 217

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      index == o.index &&
      public_key == o.public_key &&
      withdrawal_address == o.withdrawal_address &&
      slashed == o.slashed &&
      activation_epoch == o.activation_epoch &&
      exit_epoch == o.exit_epoch &&
      withdrawable_epoch == o.withdrawable_epoch &&
      balance == o.balance &&
      effective_balance == o.effective_balance
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



341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/coinbase/client/models/ethereum_validator_metadata.rb', line 341

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


233
234
235
 
# File 'lib/coinbase/client/models/ethereum_validator_metadata.rb', line 233

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



239
240
241
 
# File 'lib/coinbase/client/models/ethereum_validator_metadata.rb', line 239

def hash
  [index, public_key, withdrawal_address, slashed, activation_epoch, exit_epoch, withdrawable_epoch, balance, effective_balance].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



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

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

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

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

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

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

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

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

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

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



317
318
319
 
# File 'lib/coinbase/client/models/ethereum_validator_metadata.rb', line 317

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



323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/coinbase/client/models/ethereum_validator_metadata.rb', line 323

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



311
312
313
 
# File 'lib/coinbase/client/models/ethereum_validator_metadata.rb', line 311

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



201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/coinbase/client/models/ethereum_validator_metadata.rb', line 201

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @index.nil?
  return false if @public_key.nil?
  return false if @withdrawal_address.nil?
  return false if @slashed.nil?
  return false if @activation_epoch.nil?
  return false if @exit_epoch.nil?
  return false if @withdrawable_epoch.nil?
  return false if @balance.nil?
  return false if @effective_balance.nil?
  true
end