forked from naftalimurgor/bitgesell-blockchain-sdk-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
244 lines (239 loc) · 11 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
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
175
176
177
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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>bitgesell-blockchain-sdk</title>
<meta name="description" content="Documentation for bitgesell-blockchain-sdk">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="assets/js/search.json" data-base=".">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="index.html" class="title">bitgesell-blockchain-sdk</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="globals.html">Globals</a>
</li>
</ul>
<h1>bitgesell-blockchain-sdk</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<div class="tsd-panel tsd-typography">
<a href="#bitgesell-blockchain-sdk" id="bitgesell-blockchain-sdk" style="color: inherit; text-decoration: none;">
<h1>Bitgesell Blockchain SDK Documentation</h1>
</a>
<img src="./Icon.png" style="height: 60px;"/>
<p>A comprehensive library for interacting Bitgesell API on Web, Nodejs and other JavaScript runtimes through the Bitgesell API</p>
<a href="#getting-started" id="getting-started" style="color: inherit; text-decoration: none;">
<h2>Getting started</h2>
</a>
<p>Install via yarn/npm:</p>
<pre><code class="language-sh">yarn add bgl-blockchain-sdk <span class="hljs-comment"># npm i </span>
</code></pre>
<a href="#initialization" id="initialization" style="color: inherit; text-decoration: none;">
<h3>Initialization</h3>
</a>
<p>To initialize the sdk library</p>
<pre><code class="language-javascript"><span class="hljs-keyword">import</span> {BitgesellBlockchainSDK} <span class="hljs-keyword">from</span> <span class="hljs-string">'bitgesell-blockchain-sdk'</span>
<span class="hljs-keyword">const</span> sdkConfig = {
<span class="hljs-attr">baseAPIURL</span>: <span class="hljs-string">'https://api.bitaps.com/bgl/v1/blockchain'</span>,
<span class="hljs-attr">logger</span>: <span class="hljs-built_in">console</span>.log <span class="hljs-comment">// optional</span>
}
<span class="hljs-keyword">const</span> bitgesellBlockchainSDK = <span class="hljs-keyword">new</span> BitgesellBlockchainSDK(sdkConfig)
</code></pre>
<p>To initialize the sdk library in Commonjs pattern:</p>
<pre><code class="language-javascript"><span class="hljs-keyword">const</span> {BitgesellBlockchainSDK} = <span class="hljs-built_in">require</span>(<span class="hljs-string">'bitgesell-blockchain-sdk'</span>)
<span class="hljs-keyword">const</span> sdkConfig = {
<span class="hljs-attr">baseAPIURL</span>: <span class="hljs-string">'https://api.bitaps.com/bgl/v1/blockchain'</span>,
<span class="hljs-attr">logger</span>: <span class="hljs-built_in">console</span>.log <span class="hljs-comment">// optional</span>
}
<span class="hljs-keyword">const</span> bitgesellBlockchainSDK = <span class="hljs-keyword">new</span> BitgesellBlockchainSDK(sdkConfig)
</code></pre>
<a href="#query-transactions" id="query-transactions" style="color: inherit; text-decoration: none;">
<h3>Query Transactions</h3>
</a>
<p>To query transacton by the transaction <code>hash</code>:</p>
<pre><code class="language-javascript">(<span class="hljs-keyword">async</span>() => {
<span class="hljs-keyword">const</span> txHash = <span class="hljs-string">'a transaction hash'</span>
<span class="hljs-keyword">const</span> transaction = <span class="hljs-keyword">await</span> bitgesellBlockchainSDK.tx.getTransactionByHash(txHash)
<span class="hljs-built_in">console</span>.log(txHash)
})()
</code></pre>
<a href="#query-the-mempool" id="query-the-mempool" style="color: inherit; text-decoration: none;">
<h3>Query the Mempool</h3>
</a>
<p>To query mempool state:</p>
<pre><code class="language-javascript">(<span class="hljs-keyword">async</span>() => {
<span class="hljs-keyword">const</span> mempoolState = <span class="hljs-keyword">await</span> bitgesellBlockchainSDK.mempool.getMempoolState()
<span class="hljs-built_in">console</span>.log(mempoolState)
})()
</code></pre>
<a href="#query-blocks" id="query-blocks" style="color: inherit; text-decoration: none;">
<h3>Query Blocks</h3>
</a>
<p>To query block by the blockHeight:</p>
<pre><code class="language-javascript">(<span class="hljs-keyword">async</span>() => {
<span class="hljs-keyword">const</span> block = <span class="hljs-keyword">await</span> bitgesellBlockchainSDK.blockchain.getBlockByHeight(<span class="hljs-number">206</span>)
<span class="hljs-built_in">console</span>.log(block)
})()
</code></pre>
<a href="#documentation" id="documentation" style="color: inherit; text-decoration: none;">
<h2>Documentation</h2>
</a>
<p>For complete documenation on how to use this library see the complete docs:</p>
<a href="#support" id="support" style="color: inherit; text-decoration: none;">
<h2>Support</h2>
</a>
<p>Any form of support is highly welcome through contributions, pull requests and feature requests.</p>
<p><code>License</code>: MIT</p>
</div>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="globals.html"><em>Globals</em></a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-class">
<a href="classes/address.html" class="tsd-kind-icon">Address</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/bitgesellblockchainsdk.html" class="tsd-kind-icon">Bitgesell<wbr>BlockchainSDK</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/blockchain.html" class="tsd-kind-icon">Blockchain</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/mempool.html" class="tsd-kind-icon">Mempool</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/transaction.html" class="tsd-kind-icon">Transaction</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="globals.html#addressblance" class="tsd-kind-icon">Address<wbr>Blance</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="globals.html#addresstransaction" class="tsd-kind-icon">Address<wbr>Transaction</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="globals.html#addresstransactions" class="tsd-kind-icon">Address<wbr>Transactions</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="globals.html#addressutxo" class="tsd-kind-icon">AddressUTXO</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="globals.html#addressutxos" class="tsd-kind-icon">AddressUTXOs</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="globals.html#block" class="tsd-kind-icon">Block</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="globals.html#blockheader" class="tsd-kind-icon">Block<wbr>Header</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="globals.html#blockstats" class="tsd-kind-icon">Block<wbr>Stats</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="globals.html#mempoolrecommendedfee" class="tsd-kind-icon">Mempool<wbr>Recommended<wbr>Fee</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="globals.html#mempoolstate" class="tsd-kind-icon">Mempool<wbr>State</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="globals.html#mempooltxes" class="tsd-kind-icon">Mempool<wbr>Txes</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="globals.html#sdkconfig" class="tsd-kind-icon">SDKConfig</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="globals.html#transactionmerkelproof" class="tsd-kind-icon">Transaction<wbr>Merkel<wbr>Proof</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="globals.html#transactions" class="tsd-kind-icon">Transactions</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="globals.html#utxo" class="tsd-kind-icon">UTXO</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="globals.html#utxos" class="tsd-kind-icon">UTXOs</a>
</li>
<li class=" tsd-kind-object-literal">
<a href="globals.html#sdkconfig" class="tsd-kind-icon">sdk<wbr>Config</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="assets/js/main.js"></script>
</body>
</html>