Skip to content

Commit 331d46a

Browse files
naftalimurgornaftalimurgor
committed
[ci skip] Updates
0 parents  commit 331d46a

23 files changed

+3914
-0
lines changed

‎Icon.png

4.34 KB
Loading

‎assets/css/main.css

+1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎assets/images/icons.png

9.39 KB
Loading

‎assets/images/[email protected]

27.5 KB
Loading

‎assets/images/widgets.png

480 Bytes
Loading

‎assets/images/[email protected]

855 Bytes
Loading

‎assets/js/main.js

+51
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎assets/js/search.json

+1
Large diffs are not rendered by default.

‎classes/bgl.html

+315
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,315 @@
1+
<!doctype html>
2+
<html class="default no-js">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6+
<title>BGL | wbgl-bridge-sdk</title>
7+
<meta name="description" content="Documentation for wbgl-bridge-sdk">
8+
<meta name="viewport" content="width=device-width, initial-scale=1">
9+
<link rel="stylesheet" href="../assets/css/main.css">
10+
</head>
11+
<body>
12+
<header>
13+
<div class="tsd-page-toolbar">
14+
<div class="container">
15+
<div class="table-wrap">
16+
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
17+
<div class="field">
18+
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
19+
<input id="tsd-search-field" type="text" />
20+
</div>
21+
<ul class="results">
22+
<li class="state loading">Preparing search index...</li>
23+
<li class="state failure">The search index is not available</li>
24+
</ul>
25+
<a href="../index.html" class="title">wbgl-bridge-sdk</a>
26+
</div>
27+
<div class="table-cell" id="tsd-widgets">
28+
<div id="tsd-filter">
29+
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
30+
<div class="tsd-filter-group">
31+
<div class="tsd-select" id="tsd-filter-visibility">
32+
<span class="tsd-select-label">All</span>
33+
<ul class="tsd-select-list">
34+
<li data-value="public">Public</li>
35+
<li data-value="protected">Public/Protected</li>
36+
<li data-value="private" class="selected">All</li>
37+
</ul>
38+
</div>
39+
<input type="checkbox" id="tsd-filter-inherited" checked />
40+
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
41+
<input type="checkbox" id="tsd-filter-externals" checked />
42+
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
43+
<input type="checkbox" id="tsd-filter-only-exported" />
44+
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
45+
</div>
46+
</div>
47+
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
48+
</div>
49+
</div>
50+
</div>
51+
</div>
52+
<div class="tsd-page-title">
53+
<div class="container">
54+
<ul class="tsd-breadcrumb">
55+
<li>
56+
<a href="../globals.html">Globals</a>
57+
</li>
58+
<li>
59+
<a href="bgl.html">BGL</a>
60+
</li>
61+
</ul>
62+
<h1>Class BGL</h1>
63+
</div>
64+
</div>
65+
</header>
66+
<div class="container container-main">
67+
<div class="row">
68+
<div class="col-8 col-content">
69+
<section class="tsd-panel tsd-comment">
70+
<div class="tsd-comment tsd-typography">
71+
<div class="lead">
72+
<p>BGL &lt;- WBGL, send BGL and recive BGL,</p>
73+
</div>
74+
</div>
75+
</section>
76+
<section class="tsd-panel tsd-hierarchy">
77+
<h3>Hierarchy</h3>
78+
<ul class="tsd-hierarchy">
79+
<li>
80+
<span class="target">BGL</span>
81+
</li>
82+
</ul>
83+
</section>
84+
<section class="tsd-panel-group tsd-index-group">
85+
<h2>Index</h2>
86+
<section class="tsd-panel tsd-index-panel">
87+
<div class="tsd-index-content">
88+
<section class="tsd-index-section ">
89+
<h3>Constructors</h3>
90+
<ul class="tsd-index-list">
91+
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="bgl.html#constructor" class="tsd-kind-icon">constructor</a></li>
92+
</ul>
93+
</section>
94+
<section class="tsd-index-section tsd-is-private tsd-is-private-protected">
95+
<h3>Properties</h3>
96+
<ul class="tsd-index-list">
97+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="bgl.html#bridgeendpoint" class="tsd-kind-icon">bridge<wbr>Endpoint</a></li>
98+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="bgl.html#chainid" class="tsd-kind-icon">chain<wbr>Id</a></li>
99+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="bgl.html#chainname" class="tsd-kind-icon">chain<wbr>Name</a></li>
100+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="bgl.html#web3" class="tsd-kind-icon">web3</a></li>
101+
</ul>
102+
</section>
103+
<section class="tsd-index-section ">
104+
<h3>Methods</h3>
105+
<ul class="tsd-index-list">
106+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="bgl.html#swapbglforwbgl" class="tsd-kind-icon">swapBGLforWBGL</a></li>
107+
</ul>
108+
</section>
109+
</div>
110+
</section>
111+
</section>
112+
<section class="tsd-panel-group tsd-member-group ">
113+
<h2>Constructors</h2>
114+
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
115+
<a name="constructor" class="tsd-anchor"></a>
116+
<h3>constructor</h3>
117+
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
118+
<li class="tsd-signature tsd-kind-icon">new BGL<span class="tsd-signature-symbol">(</span>config<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BridgeConfig</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="bgl.html" class="tsd-signature-type">BGL</a></li>
119+
</ul>
120+
<ul class="tsd-descriptions">
121+
<li class="tsd-description">
122+
<aside class="tsd-sources">
123+
<ul>
124+
<li>Defined in <a href="https://github.com/naftalimurgor/wbgl-brigde-sdk/blob/56bfa80/src/bridge/BGL.ts#L13">src/bridge/BGL.ts:13</a></li>
125+
</ul>
126+
</aside>
127+
<h4 class="tsd-parameters-title">Parameters</h4>
128+
<ul class="tsd-parameters">
129+
<li>
130+
<h5>config: <span class="tsd-signature-type">BridgeConfig</span></h5>
131+
</li>
132+
</ul>
133+
<h4 class="tsd-returns-title">Returns <a href="bgl.html" class="tsd-signature-type">BGL</a></h4>
134+
</li>
135+
</ul>
136+
</section>
137+
</section>
138+
<section class="tsd-panel-group tsd-member-group tsd-is-private tsd-is-private-protected">
139+
<h2>Properties</h2>
140+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
141+
<a name="bridgeendpoint" class="tsd-anchor"></a>
142+
<h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> bridge<wbr>Endpoint</h3>
143+
<div class="tsd-signature tsd-kind-icon">bridge<wbr>Endpoint<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"https://bglswap.com/app/"</span><span class="tsd-signature-symbol"> = &quot;https://bglswap.com/app/&quot;</span></div>
144+
<aside class="tsd-sources">
145+
<ul>
146+
<li>Defined in <a href="https://github.com/naftalimurgor/wbgl-brigde-sdk/blob/56bfa80/src/bridge/BGL.ts#L13">src/bridge/BGL.ts:13</a></li>
147+
</ul>
148+
</aside>
149+
</section>
150+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
151+
<a name="chainid" class="tsd-anchor"></a>
152+
<h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> chain<wbr>Id</h3>
153+
<div class="tsd-signature tsd-kind-icon">chain<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
154+
<aside class="tsd-sources">
155+
<ul>
156+
<li>Defined in <a href="https://github.com/naftalimurgor/wbgl-brigde-sdk/blob/56bfa80/src/bridge/BGL.ts#L11">src/bridge/BGL.ts:11</a></li>
157+
</ul>
158+
</aside>
159+
</section>
160+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
161+
<a name="chainname" class="tsd-anchor"></a>
162+
<h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> chain<wbr>Name</h3>
163+
<div class="tsd-signature tsd-kind-icon">chain<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
164+
<aside class="tsd-sources">
165+
<ul>
166+
<li>Defined in <a href="https://github.com/naftalimurgor/wbgl-brigde-sdk/blob/56bfa80/src/bridge/BGL.ts#L12">src/bridge/BGL.ts:12</a></li>
167+
</ul>
168+
</aside>
169+
</section>
170+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
171+
<a name="web3" class="tsd-anchor"></a>
172+
<h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> web3</h3>
173+
<div class="tsd-signature tsd-kind-icon">web3<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Web3</span></div>
174+
<aside class="tsd-sources">
175+
<ul>
176+
<li>Defined in <a href="https://github.com/naftalimurgor/wbgl-brigde-sdk/blob/56bfa80/src/bridge/BGL.ts#L10">src/bridge/BGL.ts:10</a></li>
177+
</ul>
178+
</aside>
179+
</section>
180+
</section>
181+
<section class="tsd-panel-group tsd-member-group ">
182+
<h2>Methods</h2>
183+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
184+
<a name="swapbglforwbgl" class="tsd-anchor"></a>
185+
<h3>swapBGLforWBGL</h3>
186+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
187+
<li class="tsd-signature tsd-kind-icon">swapBGLforWBGL<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
188+
</ul>
189+
<ul class="tsd-descriptions">
190+
<li class="tsd-description">
191+
<aside class="tsd-sources">
192+
<ul>
193+
<li>Defined in <a href="https://github.com/naftalimurgor/wbgl-brigde-sdk/blob/56bfa80/src/bridge/BGL.ts#L27">src/bridge/BGL.ts:27</a></li>
194+
</ul>
195+
</aside>
196+
<div class="tsd-comment tsd-typography">
197+
<div class="lead">
198+
<p>swapBGLforWBGL submit eth/bsc address to receive WBGL to
199+
Send BGL to recieve WBGL tokens to complete the swap</p>
200+
</div>
201+
<dl class="tsd-comment-tags">
202+
<dt>link</dt>
203+
<dd><p>more <a href="https://bglswap.com/">https://bglswap.com/</a></p>
204+
</dd>
205+
</dl>
206+
</div>
207+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
208+
</li>
209+
</ul>
210+
</section>
211+
</section>
212+
</div>
213+
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
214+
<nav class="tsd-navigation primary">
215+
<ul>
216+
<li class="globals ">
217+
<a href="../globals.html"><em>Globals</em></a>
218+
</li>
219+
</ul>
220+
</nav>
221+
<nav class="tsd-navigation secondary menu-sticky">
222+
<ul class="before-current">
223+
</ul>
224+
<ul class="current">
225+
<li class="current tsd-kind-class">
226+
<a href="bgl.html" class="tsd-kind-icon">BGL</a>
227+
<ul>
228+
<li class=" tsd-kind-constructor tsd-parent-kind-class">
229+
<a href="bgl.html#constructor" class="tsd-kind-icon">constructor</a>
230+
</li>
231+
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
232+
<a href="bgl.html#bridgeendpoint" class="tsd-kind-icon">bridge<wbr>Endpoint</a>
233+
</li>
234+
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
235+
<a href="bgl.html#chainid" class="tsd-kind-icon">chain<wbr>Id</a>
236+
</li>
237+
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
238+
<a href="bgl.html#chainname" class="tsd-kind-icon">chain<wbr>Name</a>
239+
</li>
240+
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
241+
<a href="bgl.html#web3" class="tsd-kind-icon">web3</a>
242+
</li>
243+
<li class=" tsd-kind-method tsd-parent-kind-class">
244+
<a href="bgl.html#swapbglforwbgl" class="tsd-kind-icon">swapBGLforWBGL</a>
245+
</li>
246+
</ul>
247+
</li>
248+
</ul>
249+
<ul class="after-current">
250+
<li class=" tsd-kind-class">
251+
<a href="wbgl.html" class="tsd-kind-icon">WBGL</a>
252+
</li>
253+
<li class=" tsd-kind-class">
254+
<a href="wbglbridgesdk.html" class="tsd-kind-icon">WBGLBridgeSDK</a>
255+
</li>
256+
<li class=" tsd-kind-interface">
257+
<a href="../interfaces/bglstatus.html" class="tsd-kind-icon">BGLStatus</a>
258+
</li>
259+
<li class=" tsd-kind-interface">
260+
<a href="../interfaces/bip34.html" class="tsd-kind-icon">Bip34</a>
261+
</li>
262+
<li class=" tsd-kind-interface">
263+
<a href="../interfaces/bip9.html" class="tsd-kind-icon">Bip9</a>
264+
</li>
265+
<li class=" tsd-kind-interface">
266+
<a href="../interfaces/blockchaininfo.html" class="tsd-kind-icon">Blockchain<wbr>Info</a>
267+
</li>
268+
<li class=" tsd-kind-interface">
269+
<a href="../interfaces/bridgehealth.html" class="tsd-kind-icon">Bridge<wbr>Health</a>
270+
</li>
271+
<li class=" tsd-kind-interface">
272+
<a href="../interfaces/bridgestatus.html" class="tsd-kind-icon">Bridge<wbr>Status</a>
273+
</li>
274+
<li class=" tsd-kind-interface">
275+
<a href="../interfaces/ethstatus.html" class="tsd-kind-icon">ETHStatus</a>
276+
</li>
277+
<li class=" tsd-kind-interface">
278+
<a href="../interfaces/softforks.html" class="tsd-kind-icon">Softforks</a>
279+
</li>
280+
<li class=" tsd-kind-interface">
281+
<a href="../interfaces/taproot.html" class="tsd-kind-icon">Taproot</a>
282+
</li>
283+
<li class=" tsd-kind-interface">
284+
<a href="../interfaces/testdummy.html" class="tsd-kind-icon">Testdummy</a>
285+
</li>
286+
</ul>
287+
</nav>
288+
</div>
289+
</div>
290+
</div>
291+
<footer class="with-border-bottom">
292+
<div class="container">
293+
<h2>Legend</h2>
294+
<div class="tsd-legend-group">
295+
<ul class="tsd-legend">
296+
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
297+
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
298+
</ul>
299+
<ul class="tsd-legend">
300+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
301+
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
302+
</ul>
303+
<ul class="tsd-legend">
304+
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
305+
</ul>
306+
</div>
307+
</div>
308+
</footer>
309+
<div class="container tsd-generator">
310+
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
311+
</div>
312+
<div class="overlay"></div>
313+
<script src="../assets/js/main.js"></script>
314+
</body>
315+
</html>

0 commit comments

Comments
 (0)