feat: add regtest to list of available networks

fixes #1041
hirosystems · Jun 28, 2021 · f572477 · f572477 · vercel · Jun 28, 2021
1 parent 8cc69df
commit f572477
Show file tree

Hide file tree

Showing 163 changed files with 9,309 additions and 6,131 deletions.
diff --git a/docs/assets/js/search.js b/docs/assets/js/search.js
diff --git a/docs/classes/auth.appconfig.html b/docs/classes/auth.appconfig.html
@@ -486,6 +486,7 @@ <h2>Legend</h2>
 				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
 				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
 				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
+				<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
 			</ul>
 			<ul class="tsd-legend">
 				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
@@ -494,10 +495,11 @@ <h2>Legend</h2>
 				<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-enum"><span class="tsd-kind-icon">Enumeration</span></li>
+				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
+				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
 			</ul>
 			<ul class="tsd-legend">
-				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
+				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
 			</ul>
 		</div>
 	</div>

diff --git a/docs/classes/auth.usersession.html b/docs/classes/auth.usersession.html
@@ -698,6 +698,7 @@ <h2>Legend</h2>
 				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
 				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
 				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
+				<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
 			</ul>
 			<ul class="tsd-legend">
 				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
@@ -706,10 +707,11 @@ <h2>Legend</h2>
 				<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-enum"><span class="tsd-kind-icon">Enumeration</span></li>
+				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
+				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
 			</ul>
 			<ul class="tsd-legend">
-				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
+				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
 			</ul>
 		</div>
 	</div>

diff --git a/docs/classes/encryption.nodecryptosha2hash.html b/docs/classes/encryption.nodecryptosha2hash.html
@@ -361,6 +361,7 @@ <h2>Legend</h2>
 				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
 				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
 				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
+				<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
 			</ul>
 			<ul class="tsd-legend">
 				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
@@ -369,10 +370,11 @@ <h2>Legend</h2>
 				<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-enum"><span class="tsd-kind-icon">Enumeration</span></li>
+				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
+				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
 			</ul>
 			<ul class="tsd-legend">
-				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
+				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
 			</ul>
 		</div>
 	</div>

diff --git a/docs/classes/encryption.webcryptosha2hash.html b/docs/classes/encryption.webcryptosha2hash.html
@@ -323,6 +323,7 @@ <h2>Legend</h2>
 				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
 				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
 				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
+				<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
 			</ul>
 			<ul class="tsd-legend">
 				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
@@ -331,10 +332,11 @@ <h2>Legend</h2>
 				<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-enum"><span class="tsd-kind-icon">Enumeration</span></li>
+				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
+				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
 			</ul>
 			<ul class="tsd-legend">
-				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
+				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
 			</ul>
 		</div>
 	</div>

diff --git a/docs/classes/keychain.identity.html b/docs/classes/keychain.identity.html
@@ -457,6 +457,7 @@ <h2>Legend</h2>
 				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
 				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
 				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
+				<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
 			</ul>
 			<ul class="tsd-legend">
 				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
@@ -465,10 +466,11 @@ <h2>Legend</h2>
 				<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-enum"><span class="tsd-kind-icon">Enumeration</span></li>
+				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
+				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
 			</ul>
 			<ul class="tsd-legend">
-				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
+				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
 			</ul>
 		</div>
 	</div>

diff --git a/docs/classes/keychain.wallet.html b/docs/classes/keychain.wallet.html
@@ -851,6 +851,7 @@ <h2>Legend</h2>
 				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
 				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
 				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
+				<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
 			</ul>
 			<ul class="tsd-legend">
 				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
@@ -859,10 +860,11 @@ <h2>Legend</h2>
 				<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-enum"><span class="tsd-kind-icon">Enumeration</span></li>
+				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
+				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
 			</ul>
 			<ul class="tsd-legend">
-				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
+				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
 			</ul>
 			<ul class="tsd-legend">
 				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>

diff --git a/docs/classes/keychain.walletsigner.html b/docs/classes/keychain.walletsigner.html
@@ -119,7 +119,7 @@ <h3>constructor</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/wallet/signer.ts#L51">packages/keychain/src/wallet/signer.ts:51</a></li>
+									<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/wallet/signer.ts#L55">packages/keychain/src/wallet/signer.ts:55</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -146,7 +146,7 @@ <h3>private<wbr>Key</h3>
 					<div class="tsd-signature tsd-kind-icon">private<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Buffer</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/wallet/signer.ts#L51">packages/keychain/src/wallet/signer.ts:51</a></li>
+							<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/wallet/signer.ts#L55">packages/keychain/src/wallet/signer.ts:55</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -163,7 +163,7 @@ <h3>fetch<wbr>Account</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/wallet/signer.ts#L71">packages/keychain/src/wallet/signer.ts:71</a></li>
+									<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/wallet/signer.ts#L75">packages/keychain/src/wallet/signer.ts:75</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -194,7 +194,7 @@ <h3>get<wbr>Network</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/wallet/signer.ts#L65">packages/keychain/src/wallet/signer.ts:65</a></li>
+									<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/wallet/signer.ts#L69">packages/keychain/src/wallet/signer.ts:69</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-returns-title">Returns <a href="network.stackstestnet.html" class="tsd-signature-type" data-tsd-kind="Class">StacksTestnet</a></h4>
@@ -211,7 +211,7 @@ <h3>getSTXAddress</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/wallet/signer.ts#L57">packages/keychain/src/wallet/signer.ts:57</a></li>
+									<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/wallet/signer.ts#L61">packages/keychain/src/wallet/signer.ts:61</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -234,7 +234,7 @@ <h3>getSTXPrivate<wbr>Key</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/wallet/signer.ts#L61">packages/keychain/src/wallet/signer.ts:61</a></li>
+									<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/wallet/signer.ts#L65">packages/keychain/src/wallet/signer.ts:65</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Buffer</span></h4>
@@ -251,7 +251,7 @@ <h3>sign<wbr>Contract<wbr>Call</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/wallet/signer.ts#L83">packages/keychain/src/wallet/signer.ts:83</a></li>
+									<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/wallet/signer.ts#L87">packages/keychain/src/wallet/signer.ts:87</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -274,7 +274,7 @@ <h3>sign<wbr>Contract<wbr>Deploy</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/wallet/signer.ts#L106">packages/keychain/src/wallet/signer.ts:106</a></li>
+									<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/wallet/signer.ts#L112">packages/keychain/src/wallet/signer.ts:112</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -297,7 +297,7 @@ <h3>signSTXTransfer</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/wallet/signer.ts#L125">packages/keychain/src/wallet/signer.ts:125</a></li>
+									<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/wallet/signer.ts#L133">packages/keychain/src/wallet/signer.ts:133</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -440,6 +440,7 @@ <h2>Legend</h2>
 				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
 				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
 				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
+				<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
 			</ul>
 			<ul class="tsd-legend">
 				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
@@ -448,10 +449,11 @@ <h2>Legend</h2>
 				<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-enum"><span class="tsd-kind-icon">Enumeration</span></li>
+				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
+				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
 			</ul>
 			<ul class="tsd-legend">
-				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
+				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
 			</ul>
 		</div>
 	</div>

diff --git a/docs/classes/network.stacksmainnet.html b/docs/classes/network.stacksmainnet.html
@@ -80,6 +80,9 @@ <h3>Hierarchy</h3>
 							<li>
 								<a href="network.stacksmocknet.html" class="tsd-signature-type" data-tsd-kind="Class">StacksMocknet</a>
 							</li>
+							<li>
+								<a href="network.stacksregtest.html" class="tsd-signature-type" data-tsd-kind="Class">StacksRegtest</a>
+							</li>
 						</ul>
 					</li>
 				</ul>
@@ -640,6 +643,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</
 							<li class=" tsd-kind-class tsd-parent-kind-module">
 								<a href="network.stacksmocknet.html" class="tsd-kind-icon">Stacks<wbr>Mocknet</a>
 							</li>
+							<li class=" tsd-kind-class tsd-parent-kind-module">
+								<a href="network.stacksregtest.html" class="tsd-kind-icon">Stacks<wbr>Regtest</a>
+							</li>
 							<li class=" tsd-kind-class tsd-parent-kind-module">
 								<a href="network.stackstestnet.html" class="tsd-kind-icon">Stacks<wbr>Testnet</a>
 							</li>
@@ -676,6 +682,7 @@ <h2>Legend</h2>
 				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
 				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
 				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
+				<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
 			</ul>
 			<ul class="tsd-legend">
 				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
@@ -684,10 +691,11 @@ <h2>Legend</h2>
 				<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-enum"><span class="tsd-kind-icon">Enumeration</span></li>
+				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
+				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
 			</ul>
 			<ul class="tsd-legend">
-				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
+				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
 			</ul>
 		</div>
 	</div>

diff --git a/docs/classes/network.stacksmocknet.html b/docs/classes/network.stacksmocknet.html
@@ -658,6 +658,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</
 									</li>
 								</ul>
 							</li>
+							<li class=" tsd-kind-class tsd-parent-kind-module">
+								<a href="network.stacksregtest.html" class="tsd-kind-icon">Stacks<wbr>Regtest</a>
+							</li>
 							<li class=" tsd-kind-class tsd-parent-kind-module">
 								<a href="network.stackstestnet.html" class="tsd-kind-icon">Stacks<wbr>Testnet</a>
 							</li>
@@ -694,22 +697,24 @@ <h2>Legend</h2>
 				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
 				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
 				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
+				<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
 			</ul>
 			<ul class="tsd-legend">
 				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
 				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
 				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
 			</ul>
+			<ul class="tsd-legend">
+				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
+				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
+			</ul>
 			<ul class="tsd-legend">
 				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
 				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
 			</ul>
 			<ul class="tsd-legend">
 				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
 			</ul>
-			<ul class="tsd-legend">
-				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
-			</ul>
 		</div>
 	</div>
 </footer>