ruby-client 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.gitignore +59 -0
- data/.travis.yml +6 -0
- data/Gemfile +6 -0
- data/Gemfile.lock +91 -0
- data/LICENSE +177 -0
- data/README.md +49 -0
- data/Rakefile +14 -0
- data/bin/console +6 -0
- data/bin/setup +6 -0
- data/doc/Api.html +1592 -0
- data/doc/ClientRPC.html +99 -0
- data/doc/ClientRPC/Connect.html +106 -0
- data/doc/ClientRPC/Connect/Error.html +106 -0
- data/doc/Gemfile.html +101 -0
- data/doc/Gemfile_lock.html +193 -0
- data/doc/LICENSE.html +177 -0
- data/doc/LICENSE_txt.html +105 -0
- data/doc/Nimiq.html +99 -0
- data/doc/Nimiq/Client.html +248 -0
- data/doc/Nimiq/Error.html +108 -0
- data/doc/Nimiq/Exceptions.html +163 -0
- data/doc/Object.html +125 -0
- data/doc/README_md.html +162 -0
- data/doc/Rakefile.html +108 -0
- data/doc/Ruby.html +99 -0
- data/doc/Ruby/ClientTest.html +106 -0
- data/doc/bin/setup.html +99 -0
- data/doc/classes/Api.html +1506 -0
- data/doc/classes/ClientRPC.html +120 -0
- data/doc/classes/ClientRPC/Connect.html +120 -0
- data/doc/classes/ClientRPC/Connect/Error.html +111 -0
- data/doc/classes/Nimiq.html +145 -0
- data/doc/classes/Nimiq/Client.html +237 -0
- data/doc/classes/Nimiq/Error.html +113 -0
- data/doc/classes/Nimiq/Exceptions.html +152 -0
- data/doc/classes/index.html +80 -0
- data/doc/created.rid +13 -0
- data/doc/css/application.css +64 -0
- data/doc/css/bootstrap.min.css +868 -0
- data/doc/css/coderay.css +141 -0
- data/doc/css/fonts.css +167 -0
- data/doc/css/rdoc.css +668 -0
- data/doc/files/index.html +82 -0
- data/doc/files/lib/api_rb.html +112 -0
- data/doc/files/lib/client_rb.html +118 -0
- data/doc/files/lib/nimiq/version_rb.html +105 -0
- data/doc/files/lib/rpcclient_rb.html +119 -0
- data/doc/fonts/Lato-Light.ttf +0 -0
- data/doc/fonts/Lato-LightItalic.ttf +0 -0
- data/doc/fonts/Lato-Regular.ttf +0 -0
- data/doc/fonts/Lato-RegularItalic.ttf +0 -0
- data/doc/fonts/SourceCodePro-Bold.ttf +0 -0
- data/doc/fonts/SourceCodePro-Regular.ttf +0 -0
- data/doc/images/add.png +0 -0
- data/doc/images/arrow_up.png +0 -0
- data/doc/images/brick.png +0 -0
- data/doc/images/brick_link.png +0 -0
- data/doc/images/bug.png +0 -0
- data/doc/images/bullet_black.png +0 -0
- data/doc/images/bullet_toggle_minus.png +0 -0
- data/doc/images/bullet_toggle_plus.png +0 -0
- data/doc/images/date.png +0 -0
- data/doc/images/delete.png +0 -0
- data/doc/images/find.png +0 -0
- data/doc/images/loadingAnimation.gif +0 -0
- data/doc/images/macFFBgHack.png +0 -0
- data/doc/images/package.png +0 -0
- data/doc/images/page_green.png +0 -0
- data/doc/images/page_white_text.png +0 -0
- data/doc/images/page_white_width.png +0 -0
- data/doc/images/plugin.png +0 -0
- data/doc/images/ruby.png +0 -0
- data/doc/images/tag_blue.png +0 -0
- data/doc/images/tag_green.png +0 -0
- data/doc/images/transparent.png +0 -0
- data/doc/images/wrench.png +0 -0
- data/doc/images/wrench_orange.png +0 -0
- data/doc/images/zoom.png +0 -0
- data/doc/img/glyphicons-halflings-white.png +0 -0
- data/doc/img/glyphicons-halflings.png +0 -0
- data/doc/index.html +110 -0
- data/doc/js/application.js +50 -0
- data/doc/js/bootstrap.min.js +7 -0
- data/doc/js/darkfish.js +84 -0
- data/doc/js/index.js +1 -0
- data/doc/js/jquery.js +4 -0
- data/doc/js/navigation.js +105 -0
- data/doc/js/navigation.js.gz +0 -0
- data/doc/js/search.js +110 -0
- data/doc/js/search_index.js +1 -0
- data/doc/js/search_index.js.gz +0 -0
- data/doc/js/searcher.js +229 -0
- data/doc/js/searcher.js.gz +0 -0
- data/doc/method/index.html +122 -0
- data/doc/table_of_contents.html +318 -0
- data/lib/api.rb +317 -0
- data/lib/client.rb +46 -0
- data/lib/nimiq/version.rb +3 -0
- data/lib/rpcclient.rb +108 -0
- data/ruby-client.gemspec +28 -0
- metadata +160 -0
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
|
|
3
|
+
<html>
|
|
4
|
+
<head>
|
|
5
|
+
<meta charset="UTF-8">
|
|
6
|
+
|
|
7
|
+
<title>class Nimiq::Error - RDoc Documentation</title>
|
|
8
|
+
|
|
9
|
+
<script type="text/javascript">
|
|
10
|
+
var rdoc_rel_prefix = "../";
|
|
11
|
+
var index_rel_prefix = "../";
|
|
12
|
+
</script>
|
|
13
|
+
|
|
14
|
+
<script src="../js/navigation.js" defer></script>
|
|
15
|
+
<script src="../js/search.js" defer></script>
|
|
16
|
+
<script src="../js/search_index.js" defer></script>
|
|
17
|
+
<script src="../js/searcher.js" defer></script>
|
|
18
|
+
<script src="../js/darkfish.js" defer></script>
|
|
19
|
+
|
|
20
|
+
<link href="../css/fonts.css" rel="stylesheet">
|
|
21
|
+
<link href="../css/rdoc.css" rel="stylesheet">
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
<body id="top" role="document" class="class">
|
|
27
|
+
<nav role="navigation">
|
|
28
|
+
<div id="project-navigation">
|
|
29
|
+
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
|
|
30
|
+
<h2>
|
|
31
|
+
<a href="../index.html" rel="home">Home</a>
|
|
32
|
+
</h2>
|
|
33
|
+
|
|
34
|
+
<div id="table-of-contents-navigation">
|
|
35
|
+
<a href="../table_of_contents.html#pages">Pages</a>
|
|
36
|
+
<a href="../table_of_contents.html#classes">Classes</a>
|
|
37
|
+
<a href="../table_of_contents.html#methods">Methods</a>
|
|
38
|
+
</div>
|
|
39
|
+
</div>
|
|
40
|
+
|
|
41
|
+
<div id="search-section" role="search" class="project-section initially-hidden">
|
|
42
|
+
<form action="#" method="get" accept-charset="utf-8">
|
|
43
|
+
<div id="search-field-wrapper">
|
|
44
|
+
<input id="search-field" role="combobox" aria-label="Search"
|
|
45
|
+
aria-autocomplete="list" aria-controls="search-results"
|
|
46
|
+
type="text" name="search" placeholder="Search" spellcheck="false"
|
|
47
|
+
title="Type to search, Up and Down to navigate, Enter to load">
|
|
48
|
+
</div>
|
|
49
|
+
|
|
50
|
+
<ul id="search-results" aria-label="Search Results"
|
|
51
|
+
aria-busy="false" aria-expanded="false"
|
|
52
|
+
aria-atomic="false" class="initially-hidden"></ul>
|
|
53
|
+
</form>
|
|
54
|
+
</div>
|
|
55
|
+
|
|
56
|
+
</div>
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
<div id="class-metadata">
|
|
61
|
+
|
|
62
|
+
<div id="parent-class-section" class="nav-section">
|
|
63
|
+
<h3>Parent</h3>
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
<p class="link">StandardError
|
|
67
|
+
|
|
68
|
+
</div>
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
</div>
|
|
74
|
+
</nav>
|
|
75
|
+
|
|
76
|
+
<main role="main" aria-labelledby="class-Nimiq::Error">
|
|
77
|
+
<h1 id="class-Nimiq::Error" class="class">
|
|
78
|
+
class Nimiq::Error
|
|
79
|
+
</h1>
|
|
80
|
+
|
|
81
|
+
<section class="description">
|
|
82
|
+
|
|
83
|
+
<p>hi</p>
|
|
84
|
+
|
|
85
|
+
</section>
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
</section>
|
|
99
|
+
|
|
100
|
+
</main>
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
<footer id="validator-badges" role="contentinfo">
|
|
104
|
+
<p><a href="https://validator.w3.org/check/referer">Validate</a>
|
|
105
|
+
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.
|
|
106
|
+
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
|
107
|
+
</footer>
|
|
108
|
+
|
|
@@ -0,0 +1,163 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
|
|
3
|
+
<html>
|
|
4
|
+
<head>
|
|
5
|
+
<meta charset="UTF-8">
|
|
6
|
+
|
|
7
|
+
<title>class Nimiq::Exceptions - RDoc Documentation</title>
|
|
8
|
+
|
|
9
|
+
<script type="text/javascript">
|
|
10
|
+
var rdoc_rel_prefix = "../";
|
|
11
|
+
var index_rel_prefix = "../";
|
|
12
|
+
</script>
|
|
13
|
+
|
|
14
|
+
<script src="../js/navigation.js" defer></script>
|
|
15
|
+
<script src="../js/search.js" defer></script>
|
|
16
|
+
<script src="../js/search_index.js" defer></script>
|
|
17
|
+
<script src="../js/searcher.js" defer></script>
|
|
18
|
+
<script src="../js/darkfish.js" defer></script>
|
|
19
|
+
|
|
20
|
+
<link href="../css/fonts.css" rel="stylesheet">
|
|
21
|
+
<link href="../css/rdoc.css" rel="stylesheet">
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
<body id="top" role="document" class="class">
|
|
27
|
+
<nav role="navigation">
|
|
28
|
+
<div id="project-navigation">
|
|
29
|
+
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
|
|
30
|
+
<h2>
|
|
31
|
+
<a href="../index.html" rel="home">Home</a>
|
|
32
|
+
</h2>
|
|
33
|
+
|
|
34
|
+
<div id="table-of-contents-navigation">
|
|
35
|
+
<a href="../table_of_contents.html#pages">Pages</a>
|
|
36
|
+
<a href="../table_of_contents.html#classes">Classes</a>
|
|
37
|
+
<a href="../table_of_contents.html#methods">Methods</a>
|
|
38
|
+
</div>
|
|
39
|
+
</div>
|
|
40
|
+
|
|
41
|
+
<div id="search-section" role="search" class="project-section initially-hidden">
|
|
42
|
+
<form action="#" method="get" accept-charset="utf-8">
|
|
43
|
+
<div id="search-field-wrapper">
|
|
44
|
+
<input id="search-field" role="combobox" aria-label="Search"
|
|
45
|
+
aria-autocomplete="list" aria-controls="search-results"
|
|
46
|
+
type="text" name="search" placeholder="Search" spellcheck="false"
|
|
47
|
+
title="Type to search, Up and Down to navigate, Enter to load">
|
|
48
|
+
</div>
|
|
49
|
+
|
|
50
|
+
<ul id="search-results" aria-label="Search Results"
|
|
51
|
+
aria-busy="false" aria-expanded="false"
|
|
52
|
+
aria-atomic="false" class="initially-hidden"></ul>
|
|
53
|
+
</form>
|
|
54
|
+
</div>
|
|
55
|
+
|
|
56
|
+
</div>
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
<div id="class-metadata">
|
|
61
|
+
|
|
62
|
+
<div id="parent-class-section" class="nav-section">
|
|
63
|
+
<h3>Parent</h3>
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
<p class="link">StandardError
|
|
67
|
+
|
|
68
|
+
</div>
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
<!-- Method Quickref -->
|
|
73
|
+
<div id="method-list-section" class="nav-section">
|
|
74
|
+
<h3>Methods</h3>
|
|
75
|
+
|
|
76
|
+
<ul class="link-list" role="directory">
|
|
77
|
+
|
|
78
|
+
<li class="calls-super" ><a href="#method-c-new">::new</a>
|
|
79
|
+
|
|
80
|
+
</ul>
|
|
81
|
+
</div>
|
|
82
|
+
|
|
83
|
+
</div>
|
|
84
|
+
</nav>
|
|
85
|
+
|
|
86
|
+
<main role="main" aria-labelledby="class-Nimiq::Exceptions">
|
|
87
|
+
<h1 id="class-Nimiq::Exceptions" class="class">
|
|
88
|
+
class Nimiq::Exceptions
|
|
89
|
+
</h1>
|
|
90
|
+
|
|
91
|
+
<section class="description">
|
|
92
|
+
|
|
93
|
+
</section>
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
|
|
107
|
+
<header>
|
|
108
|
+
<h3>Public Class Methods</h3>
|
|
109
|
+
</header>
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
<div id="method-c-new" class="method-detail ">
|
|
113
|
+
|
|
114
|
+
<div class="method-heading">
|
|
115
|
+
<span class="method-name">new</span><span
|
|
116
|
+
class="method-args">(msg = "This is a custom exception", exception_type = "custom")</span>
|
|
117
|
+
|
|
118
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
119
|
+
|
|
120
|
+
</div>
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
<div class="method-description">
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
<div class="method-calls-super">
|
|
129
|
+
Calls superclass method
|
|
130
|
+
|
|
131
|
+
</div>
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
<div class="method-source-code" id="new-source">
|
|
136
|
+
<pre><span class="ruby-comment"># File lib/client.rb, line 60</span>
|
|
137
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">msg</span> = <span class="ruby-string">"This is a custom exception"</span>, <span class="ruby-identifier">exception_type</span> = <span class="ruby-string">"custom"</span>)
|
|
138
|
+
<span class="ruby-ivar">@exception_type</span> = <span class="ruby-identifier">exception_type</span>
|
|
139
|
+
<span class="ruby-keyword">super</span>(<span class="ruby-identifier">msg</span>)
|
|
140
|
+
<span class="ruby-keyword">end</span></pre>
|
|
141
|
+
</div>
|
|
142
|
+
|
|
143
|
+
</div>
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
</div>
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
</section>
|
|
152
|
+
|
|
153
|
+
</section>
|
|
154
|
+
|
|
155
|
+
</main>
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
<footer id="validator-badges" role="contentinfo">
|
|
159
|
+
<p><a href="https://validator.w3.org/check/referer">Validate</a>
|
|
160
|
+
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.
|
|
161
|
+
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
|
162
|
+
</footer>
|
|
163
|
+
|
data/doc/Object.html
ADDED
|
@@ -0,0 +1,125 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
|
|
3
|
+
<html>
|
|
4
|
+
<head>
|
|
5
|
+
<meta charset="UTF-8">
|
|
6
|
+
|
|
7
|
+
<title>class Object - RDoc Documentation</title>
|
|
8
|
+
|
|
9
|
+
<script type="text/javascript">
|
|
10
|
+
var rdoc_rel_prefix = "./";
|
|
11
|
+
var index_rel_prefix = "./";
|
|
12
|
+
</script>
|
|
13
|
+
|
|
14
|
+
<script src="./js/navigation.js" defer></script>
|
|
15
|
+
<script src="./js/search.js" defer></script>
|
|
16
|
+
<script src="./js/search_index.js" defer></script>
|
|
17
|
+
<script src="./js/searcher.js" defer></script>
|
|
18
|
+
<script src="./js/darkfish.js" defer></script>
|
|
19
|
+
|
|
20
|
+
<link href="./css/fonts.css" rel="stylesheet">
|
|
21
|
+
<link href="./css/rdoc.css" rel="stylesheet">
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
<body id="top" role="document" class="class">
|
|
27
|
+
<nav role="navigation">
|
|
28
|
+
<div id="project-navigation">
|
|
29
|
+
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
|
|
30
|
+
<h2>
|
|
31
|
+
<a href="./index.html" rel="home">Home</a>
|
|
32
|
+
</h2>
|
|
33
|
+
|
|
34
|
+
<div id="table-of-contents-navigation">
|
|
35
|
+
<a href="./table_of_contents.html#pages">Pages</a>
|
|
36
|
+
<a href="./table_of_contents.html#classes">Classes</a>
|
|
37
|
+
<a href="./table_of_contents.html#methods">Methods</a>
|
|
38
|
+
</div>
|
|
39
|
+
</div>
|
|
40
|
+
|
|
41
|
+
<div id="search-section" role="search" class="project-section initially-hidden">
|
|
42
|
+
<form action="#" method="get" accept-charset="utf-8">
|
|
43
|
+
<div id="search-field-wrapper">
|
|
44
|
+
<input id="search-field" role="combobox" aria-label="Search"
|
|
45
|
+
aria-autocomplete="list" aria-controls="search-results"
|
|
46
|
+
type="text" name="search" placeholder="Search" spellcheck="false"
|
|
47
|
+
title="Type to search, Up and Down to navigate, Enter to load">
|
|
48
|
+
</div>
|
|
49
|
+
|
|
50
|
+
<ul id="search-results" aria-label="Search Results"
|
|
51
|
+
aria-busy="false" aria-expanded="false"
|
|
52
|
+
aria-atomic="false" class="initially-hidden"></ul>
|
|
53
|
+
</form>
|
|
54
|
+
</div>
|
|
55
|
+
|
|
56
|
+
</div>
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
<div id="class-metadata">
|
|
61
|
+
|
|
62
|
+
<div id="parent-class-section" class="nav-section">
|
|
63
|
+
<h3>Parent</h3>
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
<p class="link">BasicObject
|
|
67
|
+
|
|
68
|
+
</div>
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
</div>
|
|
74
|
+
</nav>
|
|
75
|
+
|
|
76
|
+
<main role="main" aria-labelledby="class-Object">
|
|
77
|
+
<h1 id="class-Object" class="class">
|
|
78
|
+
class Object
|
|
79
|
+
</h1>
|
|
80
|
+
|
|
81
|
+
<section class="description">
|
|
82
|
+
|
|
83
|
+
</section>
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
<section class="constants-list">
|
|
93
|
+
<header>
|
|
94
|
+
<h3>Constants</h3>
|
|
95
|
+
</header>
|
|
96
|
+
<dl>
|
|
97
|
+
|
|
98
|
+
<dt id="GetAccount">GetAccount
|
|
99
|
+
|
|
100
|
+
<dd>
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
<dt id="GetBalance">GetBalance
|
|
104
|
+
|
|
105
|
+
<dd>
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
</dl>
|
|
109
|
+
</section>
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
</section>
|
|
116
|
+
|
|
117
|
+
</main>
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
<footer id="validator-badges" role="contentinfo">
|
|
121
|
+
<p><a href="https://validator.w3.org/check/referer">Validate</a>
|
|
122
|
+
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.
|
|
123
|
+
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
|
124
|
+
</footer>
|
|
125
|
+
|
data/doc/README_md.html
ADDED
|
@@ -0,0 +1,162 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
|
|
3
|
+
<html>
|
|
4
|
+
<head>
|
|
5
|
+
<meta charset="UTF-8">
|
|
6
|
+
|
|
7
|
+
<title>readme - RDoc Documentation</title>
|
|
8
|
+
|
|
9
|
+
<script type="text/javascript">
|
|
10
|
+
var rdoc_rel_prefix = "./";
|
|
11
|
+
var index_rel_prefix = "./";
|
|
12
|
+
</script>
|
|
13
|
+
|
|
14
|
+
<script src="./js/navigation.js" defer></script>
|
|
15
|
+
<script src="./js/search.js" defer></script>
|
|
16
|
+
<script src="./js/search_index.js" defer></script>
|
|
17
|
+
<script src="./js/searcher.js" defer></script>
|
|
18
|
+
<script src="./js/darkfish.js" defer></script>
|
|
19
|
+
|
|
20
|
+
<link href="./css/fonts.css" rel="stylesheet">
|
|
21
|
+
<link href="./css/rdoc.css" rel="stylesheet">
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
<body id="top" role="document" class="file">
|
|
27
|
+
<nav role="navigation">
|
|
28
|
+
<div id="project-navigation">
|
|
29
|
+
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
|
|
30
|
+
<h2>
|
|
31
|
+
<a href="./index.html" rel="home">Home</a>
|
|
32
|
+
</h2>
|
|
33
|
+
|
|
34
|
+
<div id="table-of-contents-navigation">
|
|
35
|
+
<a href="./table_of_contents.html#pages">Pages</a>
|
|
36
|
+
<a href="./table_of_contents.html#classes">Classes</a>
|
|
37
|
+
<a href="./table_of_contents.html#methods">Methods</a>
|
|
38
|
+
</div>
|
|
39
|
+
</div>
|
|
40
|
+
|
|
41
|
+
<div id="search-section" role="search" class="project-section initially-hidden">
|
|
42
|
+
<form action="#" method="get" accept-charset="utf-8">
|
|
43
|
+
<div id="search-field-wrapper">
|
|
44
|
+
<input id="search-field" role="combobox" aria-label="Search"
|
|
45
|
+
aria-autocomplete="list" aria-controls="search-results"
|
|
46
|
+
type="text" name="search" placeholder="Search" spellcheck="false"
|
|
47
|
+
title="Type to search, Up and Down to navigate, Enter to load">
|
|
48
|
+
</div>
|
|
49
|
+
|
|
50
|
+
<ul id="search-results" aria-label="Search Results"
|
|
51
|
+
aria-busy="false" aria-expanded="false"
|
|
52
|
+
aria-atomic="false" class="initially-hidden"></ul>
|
|
53
|
+
</form>
|
|
54
|
+
</div>
|
|
55
|
+
|
|
56
|
+
</div>
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
<div class="nav-section">
|
|
60
|
+
<h3>Table of Contents</h3>
|
|
61
|
+
|
|
62
|
+
<ul class="link-list" role="directory">
|
|
63
|
+
<li><a href="#label-Nimiq+Ruby+RPC+Client">Nimiq Ruby RPC Client</a>
|
|
64
|
+
<li><a href="#label-Info">Info</a>
|
|
65
|
+
<li><a href="#label-What+is+Nimiq-3F">What is Nimiq?</a>
|
|
66
|
+
<li><a href="#label-Usage">Usage</a>
|
|
67
|
+
<li><a href="#label-Development">Development</a>
|
|
68
|
+
<li><a href="#label-Contributions">Contributions</a>
|
|
69
|
+
<li><a href="#label-License">License</a>
|
|
70
|
+
</ul>
|
|
71
|
+
</div>
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
<div id="project-metadata">
|
|
75
|
+
<div id="fileindex-section" class="nav-section">
|
|
76
|
+
<h3>Pages</h3>
|
|
77
|
+
|
|
78
|
+
<ul class="link-list">
|
|
79
|
+
|
|
80
|
+
<li><a href="./Gemfile.html">Gemfile</a>
|
|
81
|
+
|
|
82
|
+
<li><a href="./Gemfile_lock.html">Gemfile.lock</a>
|
|
83
|
+
|
|
84
|
+
<li><a href="./LICENSE.html">LICENSE</a>
|
|
85
|
+
|
|
86
|
+
<li><a href="./Rakefile.html">Rakefile</a>
|
|
87
|
+
|
|
88
|
+
<li><a href="./bin/setup.html">setup</a>
|
|
89
|
+
|
|
90
|
+
<li><a href="./readme_md.html">readme</a>
|
|
91
|
+
|
|
92
|
+
</ul>
|
|
93
|
+
</div>
|
|
94
|
+
|
|
95
|
+
</div>
|
|
96
|
+
</nav>
|
|
97
|
+
|
|
98
|
+
<main role="main" aria-label="Page readme.md">
|
|
99
|
+
|
|
100
|
+
<h1 id="label-Nimiq+Ruby+RPC+Client"><a href="Nimiq.html"><code>Nimiq</code></a> Ruby RPC Client<span><a href="#label-Nimiq+Ruby+RPC+Client">¶</a> <a href="#top">↑</a></span></h1>
|
|
101
|
+
|
|
102
|
+
<blockquote>
|
|
103
|
+
<p>Ruby implementation of the <a href="Nimiq.html"><code>Nimiq</code></a> RPC client specs.</p>
|
|
104
|
+
</blockquote>
|
|
105
|
+
|
|
106
|
+
<h2 id="label-Info">Info<span><a href="#label-Info">¶</a> <a href="#top">↑</a></span></h2>
|
|
107
|
+
|
|
108
|
+
<p><a href="Nimiq.html"><code>Nimiq</code></a> Ruby RPC client. It will allow you to interact with the <a href="Nimiq.html"><code>Nimiq</code></a> Blockchain, to collect data, sync with the network etc.. This library covers all the current <a href="https://github.com/nimiq/core-js/wiki/JSON-RPC-API#remotejs-client">Nimiq JSON-RPC specification</a>.</p>
|
|
109
|
+
|
|
110
|
+
<h1 id="label-What+is+Nimiq-3F">What is <a href="Nimiq.html"><code>Nimiq</code></a>?<span><a href="#label-What+is+Nimiq-3F">¶</a> <a href="#top">↑</a></span></h1>
|
|
111
|
+
|
|
112
|
+
<p>Inspired by the Bitcoin, <a href="Nimiq.html"><code>Nimiq</code></a> is a blockchain / cryptocurrency that runs in your browser seamlessly. Fast, easy and fun to use, for more information visit the <a href="https://www.nimiq.com/">Nimiq website</a>.</p>
|
|
113
|
+
|
|
114
|
+
<h3 id="label-Usage">Usage<span><a href="#label-Usage">¶</a> <a href="#top">↑</a></span></h3>
|
|
115
|
+
|
|
116
|
+
<p>Example to use this ruby client:</p>
|
|
117
|
+
|
|
118
|
+
<pre class="ruby"><span class="ruby-identifier">options</span> = {
|
|
119
|
+
<span class="ruby-value">host:</span> <span class="ruby-string">"http://127.0.0.1"</span>,
|
|
120
|
+
<span class="ruby-value">port:</span> <span class="ruby-string">"8000"</span>,
|
|
121
|
+
<span class="ruby-comment"># user: "user",</span>
|
|
122
|
+
<span class="ruby-comment"># pass: "pass",</span>
|
|
123
|
+
<span class="ruby-comment"># uri: "http://USER:PASS@IP:PORT",</span>
|
|
124
|
+
}
|
|
125
|
+
<span class="ruby-identifier">nimiq</span> = <span class="ruby-constant">Nimiq</span><span class="ruby-operator">::</span><span class="ruby-constant">Client</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">options</span>)
|
|
126
|
+
<span class="ruby-identifier">consensus</span> = <span class="ruby-identifier">nimiq</span>.<span class="ruby-identifier">consensus</span>()
|
|
127
|
+
<span class="ruby-identifier">get_balance</span> = <span class="ruby-identifier">nimiq</span>.<span class="ruby-identifier">get_balance</span>(<span class="ruby-string">"NQ27 B9ED 98G5 3VH7 FY8D BFP0 XNF4 BD8L TN4B"</span>)
|
|
128
|
+
|
|
129
|
+
<span class="ruby-identifier">puts</span> <span class="ruby-node">"Consensus #{consensus}"</span>
|
|
130
|
+
<span class="ruby-identifier">puts</span> <span class="ruby-node">"My account balance #{get_balance}"</span>
|
|
131
|
+
</pre>
|
|
132
|
+
|
|
133
|
+
<h2 id="label-Development">Development<span><a href="#label-Development">¶</a> <a href="#top">↑</a></span></h2>
|
|
134
|
+
|
|
135
|
+
<p>This section is for developments. If you only want to use this client go to the <a href="#Usage">Usage</a> section.</p>
|
|
136
|
+
|
|
137
|
+
<p>After cloning the repo, run <code>bundle</code> to install the required dependencies.</p>
|
|
138
|
+
|
|
139
|
+
<p>For testing it requires a running <a href="Nimiq.html"><code>Nimiq</code></a> RPC node, to connect to. You can then run tests by typing <code>rspec --format documentation</code>.</p>
|
|
140
|
+
|
|
141
|
+
<p>For private nodes that requires a username/password, don't forget to set these in the configuration spec file.</p>
|
|
142
|
+
|
|
143
|
+
<h2 id="label-Contributions">Contributions<span><a href="#label-Contributions">¶</a> <a href="#top">↑</a></span></h2>
|
|
144
|
+
|
|
145
|
+
<p>This implementation was originally contributed by <a href="https://github.com/jxdv/">jxdv</a>.</p>
|
|
146
|
+
|
|
147
|
+
<p>Bug reports and pull requests are welcome on GitHub at <a href="https://github.com/jxdv/ruby-client">github.com/jxdv/ruby-client</a>.</p>
|
|
148
|
+
|
|
149
|
+
<h2 id="label-License">License<span><a href="#label-License">¶</a> <a href="#top">↑</a></span></h2>
|
|
150
|
+
|
|
151
|
+
<p><a href="LICENSE">Apache 2.0</a></p>
|
|
152
|
+
|
|
153
|
+
</main>
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
<footer id="validator-badges" role="contentinfo">
|
|
158
|
+
<p><a href="https://validator.w3.org/check/referer">Validate</a>
|
|
159
|
+
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.
|
|
160
|
+
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
|
161
|
+
</footer>
|
|
162
|
+
|