Class: Universa::Contract

Inherits:
RemoteAdapter show all
Defined in:
lib/universa/contract.rb

Overview

Universa contract adapter.

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from RemoteAdapter

#__getobj__, #__setobj__, #initialize, #inspect, invoke_static, remote_class, remote_class_name, remote_field, static_method, #to_s

Constructor Details

This class inherits a constructor from Universa::RemoteAdapter

Class Method Details

.create(issuer_key, expires_at: (Time.now + 90 * 24 * 60 * 60), use_short_address: false) ⇒ Contract

Create simple contract with preset critical parts:

  • expiration set to 90 days unless specified else

  • issuer role is set to the address of the issuer key_address, short ot long

  • creator role is set as link to issuer

  • owner role is set as link to issuer

  • change owner permission is set to link to owner

The while contract is then signed by the issuer key_address. Not that it will not seal it: caller almost always will add more data before it, then must call #seal().

Parameters:

  • issuer_key (PrivateKey) —

    also will be used to sign it

  • expires_at (Time) (defaults to: (Time.now + 90 * 24 * 60 * 60)) —

    defaults to 90 days

  • use_short_address (Boolean) (defaults to: false) —

    set to true to use short address of the issuer key_address in the role

Returns:

  • (Contract) —

    simple contact, not sealed



234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/universa/contract.rb', line 234

def self.create issuer_key, expires_at: (Time.now + 90 * 24 * 60 * 60), use_short_address: false
  contract = Contract.new
  contract.set_expires_at expires_at
  contract.set_issuer_keys(use_short_address ? issuer_key.short_address : issuer_key.long_address)
  contract.register_role(contract.issuer.link_as("owner"))
  contract.register_role(contract.issuer.link_as("creator"))
  contract.add_permission ChangeOwnerPermission.new(contract.owner.link_as "@owner")
  contract.add_permission RevokePermission.new(contract.owner.link_as "@owner")
  contract.add_signer_key issuer_key
  contract
end

.from_packed(packed) ⇒ Object

Load from transaction pack



247
248
249
250
251
 
# File 'lib/universa/contract.rb', line 247

def self.from_packed packed
  packed.nil? and raise ArgumentError, "packed contract required"
  packed.force_encoding 'binary'
  self.invoke_static "fromPackedTransaction", packed
end

Instance Method Details

#==(other) ⇒ Object

Ruby-style contracts equality.



398
399
400
401
 
# File 'lib/universa/contract.rb', line 398

def == other
  return false if !other || !other.is_a?(Contract)
  hash_id == other.hash_id
end

#amount ⇒ BigDecimal

Helper for many token-like contracts containing state.data.amount

Returns:

  • (BigDecimal) —

    amount or nil



341
342
343
 
# File 'lib/universa/contract.rb', line 341

def amount
  v = state[:amount] and BigDecimal(v.to_s)
end

#amount=(value) ⇒ Object

Write helper for many token-like contracts containing state.data.amount. Saves value in state.data.anomount and properly encodes it so it will be preserved on packing.

Parameters:

  • value (Object) —

    should be some representation of a number (also string)



349
350
351
 
# File 'lib/universa/contract.rb', line 349

def amount= (value)
  state[:amount] = value.to_s.force_encoding('utf-8')
end

#can_perform_role(name, *keys) ⇒ Object

Test that some set of keys could be used to perform some role.

Parameters:

  • name (String) —

    of the role to check

  • keys (PublicKey) —

    instances to check against



380
381
382
383
384
 
# File 'lib/universa/contract.rb', line 380

def can_perform_role(name, *keys)
  getRole(name.to_s).isAllowedForKeys(Set.new keys.map { |x|
    x.is_a?(PrivateKey) ? x.public_key : x
  })
end

#create_revocation(*keys) ⇒ Contract

Create a contract that revokes this one if register with the Universa network. BE CAREFUL! REVOCATION IS IRREVERSIBLE! period.

Parameters:

  • keys (PrivateKey) —

    enough to allow this contract revocation

Returns:

  • (Contract) —

    revocation contract. Register it with the Universa network to perform revocation.



391
392
393
394
395
 
# File 'lib/universa/contract.rb', line 391

def create_revocation(*keys)
  revoke = Service.umi.invoke_static 'ContractsService', 'createRevocation', *keys
  revoke.seal
  revoke
end

#creator ⇒ Role

Shortcut ofr get_creator

Returns:

  • (Role) —

    universa role of the creator



267
268
269
 
# File 'lib/universa/contract.rb', line 267

def creator
  get_creator
end

#definition ⇒ Object

Returns definition data.

Returns:

  • definition data



320
321
322
 
# File 'lib/universa/contract.rb', line 320

def definition
  @definition ||= get_definition.get_data
end

#errors_string ⇒ String

Call it after check to get summaru of errors found.

Returns:

  • (String) —

    possibly empty ”



372
373
374
 
# File 'lib/universa/contract.rb', line 372

def errors_string
  getErrors.map { |e| "(#{e.object || ''}): #{e.error}" }.join(', ').strip
end

#expires_at ⇒ Object

shortcut for get_expires_at. Get the contract expiration time.



309
310
311
 
# File 'lib/universa/contract.rb', line 309

def expires_at
  get_expires_at
end

#expires_at=(time) ⇒ Object

set expires_at field

Parameters:

  • time (Time) —

    when this contract will be expired, if yet APPROVED.



315
316
317
 
# File 'lib/universa/contract.rb', line 315

def expires_at=(time)
  set_expires_at time
end

#hash_id ⇒ HashId

shortcut for getHashId

Returns:

  • (HashId) —

    of the contracr



294
295
296
 
# File 'lib/universa/contract.rb', line 294

def hash_id
  getId()
end

#issuer ⇒ Role

Returns issuer role.

Returns:

  • (Role) —

    issuer role



272
273
274
 
# File 'lib/universa/contract.rb', line 272

def issuer
  get_issuer
end

#keys_to_sign_with ⇒ Set<PrivateKey>

returns keys that will be used to sign this contract on next #seal.

Returns:



261
262
263
 
# File 'lib/universa/contract.rb', line 261

def keys_to_sign_with
  get_keys_to_sign_with
end

#ok? ⇒ Boolean

Shortcut for is_ok

Returns:

  • (Boolean) 


288
289
290
 
# File 'lib/universa/contract.rb', line 288

def ok?
  is_ok
end

#origin ⇒ HashId

Returns of the origin contract.

Returns:

  • (HashId) —

    of the origin contract



299
300
301
 
# File 'lib/universa/contract.rb', line 299

def origin
  getOrigin()
end

#owner ⇒ Role

Returns owner role.

Returns:

  • (Role) —

    owner role



277
278
279
 
# File 'lib/universa/contract.rb', line 277

def owner
  get_owner
end

#owner=(key_address) ⇒ Object

Set owner to the key_address, usable only in the simplest case where owner is the single address.

Parameters:



283
284
285
 
# File 'lib/universa/contract.rb', line 283

def owner=(key_address)
  set_owner_key key_address
end

#packed ⇒ Object

Get packed transaction containing the serialized signed contract and all its counterparts. Be sure to cal #seal somewhere before.

Returns:

  • binary string with packed transaction.



357
358
359
 
# File 'lib/universa/contract.rb', line 357

def packed
  get_packed_transaction
end

#parent ⇒ HashId

Returns pf the parent contracr.

Returns:

  • (HashId) —

    pf the parent contracr



304
305
306
 
# File 'lib/universa/contract.rb', line 304

def parent
  getParent()
end

#seal ⇒ String

seal the contract

Returns:

  • (String) —

    contract packed to the binary string



255
256
257
 
# File 'lib/universa/contract.rb', line 255

def seal
  super
end

#state ⇒ Object

Return state binder. Shortcut for Java API getStateData()



325
326
327
 
# File 'lib/universa/contract.rb', line 325

def state
  @state ||= getStateData()
end

#trace_errors ⇒ Object

trace found errors (call it afer check()): the Java version will not be able to trace to the process stdout, so we reqrite it here



363
364
365
366
367
 
# File 'lib/universa/contract.rb', line 363

def trace_errors
  getErrors.each { |e|
    puts "(#{e.object || ''}): #{e.error}"
  }
end

#transactional ⇒ Binder

Get transactional.data section creating it if need

Returns:



331
332
333
 
# File 'lib/universa/contract.rb', line 331

def transactional
  @transactional ||= getTransactionalData()
end