Class: OnyxMesh::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/onyx_mesh/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(ledger_name:, credential:) ⇒ Query

Set up an Onyx Mesh client. This is the entry point for all other Onyx Mesh interaction.

Parameters:

  • ledger_name (String) —

    Ledger name.

  • credential (String) —

    API credential secret.



23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/onyx_mesh/client.rb', line 23

def initialize(ledger_name:, credential:)
  if ledger_name.nil? || ledger_name == ''
    raise ArgumentError, ':ledger_name cannot be blank'
  end
  if credential.nil? || credential == ''
    raise ArgumentError, ':credential cannot be blank'
  end

  @opts = {
    credential: credential,
    ledger_name: ledger_name,
  }
  @session = Session.new(@opts)
end

Instance Attribute Details

#session ⇒ Session (readonly)

Returns:



45
46
47
 
# File 'lib/onyx_mesh/client.rb', line 45

def session
  @session
end

Instance Method Details

#accounts ⇒ Account::ClientModule

Returns:



48
49
50
 
# File 'lib/onyx_mesh/client.rb', line 48

def accounts
  @accounts ||= Account::ClientModule.new(self)
end

#actions ⇒ Action::ClientModule

Returns:



53
54
55
 
# File 'lib/onyx_mesh/client.rb', line 53

def actions
  @actions ||= Action::ClientModule.new(self)
end

#assets ⇒ Asset::ClientModule

Returns:



63
64
65
 
# File 'lib/onyx_mesh/client.rb', line 63

def assets
  @assets ||= Asset::ClientModule.new(self)
end

#dev_utils ⇒ DevUtils::ClientModule

Returns:



99
100
101
 
# File 'lib/onyx_mesh/client.rb', line 99

def dev_utils
  @dev_utils ||= DevUtils::ClientModule.new(self)
end

#feeds ⇒ Feed::ClientModule

Returns:



58
59
60
 
# File 'lib/onyx_mesh/client.rb', line 58

def feeds
  @feeds ||= Feed::ClientModule.new(self)
end

#flavors ⇒ Asset::ClientModule

Deprecated.

Use #assets.

The v2 name for #assets, and the same object. Deprecated: it is here so that code written against the 2.x SDK keeps working, and it will not gain anything new.

Returns:



73
74
75
 
# File 'lib/onyx_mesh/client.rb', line 73

def flavors
  assets
end

#keys ⇒ Key::ClientModule

Returns:



78
79
80
 
# File 'lib/onyx_mesh/client.rb', line 78

def keys
  @keys ||= Key::ClientModule.new(self)
end

#opts ⇒ Object 



39
40
41
 
# File 'lib/onyx_mesh/client.rb', line 39

def opts
  @opts.dup
end

#stats ⇒ Stats::ClientModule

Returns:



84
85
86
 
# File 'lib/onyx_mesh/client.rb', line 84

def stats
  @stats ||= Stats::ClientModule.new(self)
end

#tokens ⇒ Token::ClientModule

Returns:



89
90
91
 
# File 'lib/onyx_mesh/client.rb', line 89

def tokens
  @tokens ||= Token::ClientModule.new(self)
end

#transactions ⇒ Transaction::ClientModule

Returns:



94
95
96
 
# File 'lib/onyx_mesh/client.rb', line 94

def transactions
  @transactions ||= Transaction::ClientModule.new(self)
end