Class: Coinbase::Client::SmartContract

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

Overview

Represents a smart contract on the blockchain

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SmartContract

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/coinbase/client/models/smart_contract.rb', line 108

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#abi ⇒ Object

The JSON-encoded ABI of the contract



39
40
41
 
# File 'lib/coinbase/client/models/smart_contract.rb', line 39

def abi
  @abi
end

#contract_address ⇒ Object

The EVM address of the smart contract



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

def contract_address
  @contract_address
end

#deployer_address ⇒ Object

The EVM address of the account that deployed the smart contract



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

def deployer_address
  @deployer_address
end

#network_id ⇒ Object

The name of the blockchain network



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

def network_id
  @network_id
end

#options ⇒ Object

Returns the value of attribute options.



36
37
38
 
# File 'lib/coinbase/client/models/smart_contract.rb', line 36

def options
  @options
end

#smart_contract_id ⇒ Object

The unique identifier of the smart contract



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

def smart_contract_id
  @smart_contract_id
end

#transaction ⇒ Object

Returns the value of attribute transaction.



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

def transaction
  @transaction
end

#type ⇒ Object

Returns the value of attribute type.



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

def type
  @type
end

#wallet_id ⇒ Object

The ID of the wallet that deployed the smart contract



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

def wallet_id
  @wallet_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



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

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



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'smart_contract_id' => :'smart_contract_id',
    :'network_id' => :'network_id',
    :'wallet_id' => :'wallet_id',
    :'contract_address' => :'contract_address',
    :'deployer_address' => :'deployer_address',
    :'type' => :'type',
    :'options' => :'options',
    :'abi' => :'abi',
    :'transaction' => :'transaction'
  }
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



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

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



101
102
103
104
 
# File 'lib/coinbase/client/models/smart_contract.rb', line 101

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

.openapi_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/coinbase/client/models/smart_contract.rb', line 86

def self.openapi_types
  {
    :'smart_contract_id' => :'String',
    :'network_id' => :'String',
    :'wallet_id' => :'String',
    :'contract_address' => :'String',
    :'deployer_address' => :'String',
    :'type' => :'SmartContractType',
    :'options' => :'SmartContractOptions',
    :'abi' => :'String',
    :'transaction' => :'Transaction'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      smart_contract_id == o.smart_contract_id &&
      network_id == o.network_id &&
      wallet_id == o.wallet_id &&
      contract_address == o.contract_address &&
      deployer_address == o.deployer_address &&
      type == o.type &&
      options == o.options &&
      abi == o.abi &&
      transaction == o.transaction
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



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

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


254
255
256
 
# File 'lib/coinbase/client/models/smart_contract.rb', line 254

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



260
261
262
 
# File 'lib/coinbase/client/models/smart_contract.rb', line 260

def hash
  [smart_contract_id, network_id, wallet_id, contract_address, deployer_address, type, options, abi, transaction].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



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.rb', line 178

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

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

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

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

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

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

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

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

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



338
339
340
 
# File 'lib/coinbase/client/models/smart_contract.rb', line 338

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



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

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



332
333
334
 
# File 'lib/coinbase/client/models/smart_contract.rb', line 332

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



222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/coinbase/client/models/smart_contract.rb', line 222

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @smart_contract_id.nil?
  return false if @network_id.nil?
  return false if @wallet_id.nil?
  return false if @contract_address.nil?
  return false if @deployer_address.nil?
  return false if @type.nil?
  return false if @options.nil?
  return false if @abi.nil?
  return false if @transaction.nil?
  true
end