Class: Coinbase::Client::Transaction

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

Overview

An onchain transaction.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Transaction

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#block_hash ⇒ Object

The hash of the block at which the transaction was recorded.



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

def block_hash
  @block_hash
end

#block_height ⇒ Object

The block height at which the transaction was recorded.



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

def block_height
  @block_height
end

#content ⇒ Object

Returns the value of attribute content.



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

def content
  @content
end

#from_address_id ⇒ Object

The onchain address of the sender.



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

def from_address_id
  @from_address_id
end

#network_id ⇒ Object

The ID of the blockchain network.



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

def network_id
  @network_id
end

#signed_payload ⇒ Object

The signed payload of the transaction. This is the payload that has been signed by the sender.



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

def signed_payload
  @signed_payload
end

#status ⇒ Object

The status of the transaction.



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

def status
  @status
end

#to_address_id ⇒ Object

The onchain address of the recipient.



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

def to_address_id
  @to_address_id
end

#transaction_hash ⇒ Object

The hash of the transaction.



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

def transaction_hash
  @transaction_hash
end

#transaction_link ⇒ Object

The link to view the transaction on a block explorer. This is optional and may not be present for all transactions.



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

def transaction_link
  @transaction_link
end

#unsigned_payload ⇒ Object

The unsigned payload of the transaction. This is the payload that needs to be signed by the sender.



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

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



290
291
292
293
294
295
296
297
298
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
 
# File 'lib/coinbase/client/models/transaction.rb', line 290

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



91
92
93
 
# File 'lib/coinbase/client/models/transaction.rb', line 91

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

def self.attribute_map
  {
    :'network_id' => :'network_id',
    :'block_hash' => :'block_hash',
    :'block_height' => :'block_height',
    :'from_address_id' => :'from_address_id',
    :'to_address_id' => :'to_address_id',
    :'unsigned_payload' => :'unsigned_payload',
    :'signed_payload' => :'signed_payload',
    :'transaction_hash' => :'transaction_hash',
    :'transaction_link' => :'transaction_link',
    :'status' => :'status',
    :'content' => :'content'
  }
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



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/coinbase/client/models/transaction.rb', line 266

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



113
114
115
116
 
# File 'lib/coinbase/client/models/transaction.rb', line 113

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

.openapi_types ⇒ Object

Attribute type mapping.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/coinbase/client/models/transaction.rb', line 96

def self.openapi_types
  {
    :'network_id' => :'String',
    :'block_hash' => :'String',
    :'block_height' => :'String',
    :'from_address_id' => :'String',
    :'to_address_id' => :'String',
    :'unsigned_payload' => :'String',
    :'signed_payload' => :'String',
    :'transaction_hash' => :'String',
    :'transaction_link' => :'String',
    :'status' => :'String',
    :'content' => :'TransactionContent'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      network_id == o.network_id &&
      block_hash == o.block_hash &&
      block_height == o.block_height &&
      from_address_id == o.from_address_id &&
      to_address_id == o.to_address_id &&
      unsigned_payload == o.unsigned_payload &&
      signed_payload == o.signed_payload &&
      transaction_hash == o.transaction_hash &&
      transaction_link == o.transaction_link &&
      status == o.status &&
      content == o.content
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



361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/coinbase/client/models/transaction.rb', line 361

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


253
254
255
 
# File 'lib/coinbase/client/models/transaction.rb', line 253

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



259
260
261
 
# File 'lib/coinbase/client/models/transaction.rb', line 259

def hash
  [network_id, block_hash, block_height, from_address_id, to_address_id, unsigned_payload, signed_payload, transaction_hash, transaction_link, status, content].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



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

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

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

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



337
338
339
 
# File 'lib/coinbase/client/models/transaction.rb', line 337

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



343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/coinbase/client/models/transaction.rb', line 343

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



331
332
333
 
# File 'lib/coinbase/client/models/transaction.rb', line 331

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



212
213
214
215
216
217
218
219
220
221
 
# File 'lib/coinbase/client/models/transaction.rb', line 212

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @network_id.nil?
  return false if @from_address_id.nil?
  return false if @unsigned_payload.nil?
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('String', ["pending", "signed", "broadcast", "complete", "failed", "unspecified", "unknown_default_open_api"])
  return false unless status_validator.valid?(@status)
  true
end