machankura/mempool
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

testnet4 docs

Browse Source
This commit is contained in:
Mononaut 2024-05-06 17:31:49 +00:00
parent 15bd58c746
commit de8462e81e
No known key found for this signature in database
GPG Key ID: A3F058E41374C04E
4 changed files with 41 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
frontend/src/app/docs/api-docs/api-docs-data.ts
View File

@ -1,5 +1,6 @@
const bitcoinNetworks = ["", "testnet", "signet"];
const bitcoinNetworks = ["", "testnet", "testnet4", "signet"];
const liquidNetworks = ["liquid", "liquidtestnet"];
const lightningNetworks = ["", "testnet", "signet"];
const miningTimeIntervals = "<code>24h</code>, <code>3d</code>, <code>1w</code>, <code>1m</code>, <code>3m</code>, <code>6m</code>, <code>1y</code>, <code>2y</code>, <code>3y</code>";
const emptyCodeSample = {
@ -6513,7 +6514,7 @@ export const restApiDocsData = [
category: "lightning",
fragment: "lightning",
title: "Lightning",
showConditions: bitcoinNetworks
showConditions: lightningNetworks
},
{
type: "endpoint",
@ -6525,7 +6526,7 @@ export const restApiDocsData = [
default: "<p>Returns network-wide stats such as total number of channels and nodes, total capacity, and average/median fee figures.</p><p>Pass one of the following for <code>:interval</code>: <code>latest</code>, <code>24h</code>, <code>3d</code>, <code>1w</code>, <code>1m</code>, <code>3m</code>, <code>6m</code>, <code>1y</code>, <code>2y</code>, <code>3y</code>.</p>"
},
urlString: "/v1/lightning/statistics/:interval",
showConditions: bitcoinNetworks,
showConditions: lightningNetworks,
showJsExamples: showJsExamplesDefaultFalse,
codeExample: {
default: {
@ -6621,7 +6622,7 @@ export const restApiDocsData = [
default: "<p>Returns Lightning nodes and channels that match a full-text, case-insensitive search <code>:query</code> across node aliases, node pubkeys, channel IDs, and short channel IDs.</p>"
},
urlString: "/v1/lightning/search?searchText=:query",
showConditions: bitcoinNetworks,
showConditions: lightningNetworks,
showJsExamples: showJsExamplesDefaultFalse,
codeExample: {
default: {
@ -6706,7 +6707,7 @@ export const restApiDocsData = [
default: "<p>Returns a list of Lightning nodes running on clearnet in the requested <code>:country</code>, where <code>:country</code> is an ISO Alpha-2 country code.</p>"
},
urlString: "/v1/lightning/nodes/country/:country",
showConditions: bitcoinNetworks,
showConditions: lightningNetworks,
showJsExamples: showJsExamplesDefaultFalse,
codeExample: {
default: {
@ -6928,7 +6929,7 @@ export const restApiDocsData = [
default: "<p>Returns aggregate capacity and number of clearnet nodes per country. Capacity figures are in satoshis.</p>"
},
urlString: "/v1/lightning/nodes/countries",
showConditions: bitcoinNetworks,
showConditions: lightningNetworks,
showJsExamples: showJsExamplesDefaultFalse,
codeExample: {
default: {
@ -7072,7 +7073,7 @@ export const restApiDocsData = [
default: "<p>Returns a list of nodes hosted by a specified <code>:isp</code>, where <code>:isp</code> is an ISP's ASN.</p>"
},
urlString: "/v1/lightning/nodes/isp/:isp",
showConditions: bitcoinNetworks,
showConditions: lightningNetworks,
showJsExamples: showJsExamplesDefaultFalse,
codeExample: {
default: {
@ -7191,7 +7192,7 @@ export const restApiDocsData = [
default: "<p>Returns aggregate capacity, number of nodes, and number of channels per ISP. Capacity figures are in satoshis.</p>"
},
urlString: "/v1/lightning/nodes/isp-ranking",
showConditions: bitcoinNetworks,
showConditions: lightningNetworks,
showJsExamples: showJsExamplesDefaultFalse,
codeExample: {
default: {
@ -7303,7 +7304,7 @@ export const restApiDocsData = [
default: "<p>Returns two lists of the top 100 nodes: one ordered by liquidity (aggregate channel capacity) and the other ordered by connectivity (number of open channels).</p>"
},
urlString: "/v1/lightning/nodes/rankings",
showConditions: bitcoinNetworks,
showConditions: lightningNetworks,
showJsExamples: showJsExamplesDefaultFalse,
codeExample: {
default: {
@ -7426,7 +7427,7 @@ export const restApiDocsData = [
default: "<p>Returns a list of the top 100 nodes by liquidity (aggregate channel capacity).</p>"
},
urlString: "/v1/lightning/nodes/rankings/liquidity",
showConditions: bitcoinNetworks,
showConditions: lightningNetworks,
showJsExamples: showJsExamplesDefaultFalse,
codeExample: {
default: {
@ -7623,7 +7624,7 @@ export const restApiDocsData = [
default: "<p>Returns a list of the top 100 nodes by connectivity (number of open channels).</p>"
},
urlString: "/v1/lightning/nodes/rankings/connectivity",
showConditions: bitcoinNetworks,
showConditions: lightningNetworks,
showJsExamples: showJsExamplesDefaultFalse,
codeExample: {
default: {
@ -7819,7 +7820,7 @@ export const restApiDocsData = [
default: "<p>Returns a list of the top 100 oldest nodes.</p>"
},
urlString: "/v1/lightning/nodes/rankings/age",
showConditions: bitcoinNetworks,
showConditions: lightningNetworks,
showJsExamples: showJsExamplesDefaultFalse,
codeExample: {
default: {
@ -8006,7 +8007,7 @@ export const restApiDocsData = [
default: "<p>Returns details about a node with the given <code>:pubKey</code>.</p>"
},
urlString: "/v1/lightning/nodes/:pubKey",
showConditions: bitcoinNetworks,
showConditions: lightningNetworks,
showJsExamples: showJsExamplesDefaultFalse,
codeExample: {
default: {
@ -8170,7 +8171,7 @@ export const restApiDocsData = [
default: "<p>Returns historical stats for a node with the given <code>:pubKey</code>.</p>"
},
urlString: "/v1/lightning/nodes/:pubKey/statistics",
showConditions: bitcoinNetworks,
showConditions: lightningNetworks,
showJsExamples: showJsExamplesDefaultFalse,
codeExample: {
default: {
@ -8268,7 +8269,7 @@ export const restApiDocsData = [
default: "<p>Returns info about a Lightning channel with the given <code>:channelId</code>.</p>"
},
urlString: "/v1/lightning/channels/:channelId",
showConditions: bitcoinNetworks,
showConditions: lightningNetworks,
showJsExamples: showJsExamplesDefaultFalse,
codeExample: {
default: {
@ -8433,7 +8434,7 @@ export const restApiDocsData = [
default: "<p>Returns channels that correspond to the given <code>:txid</code> (multiple transaction IDs can be specified).</p>"
},
urlString: "/v1/lightning/channels/txids?txId[]=:txid",
showConditions: bitcoinNetworks,
showConditions: lightningNetworks,
showJsExamples: showJsExamplesDefaultFalse,
codeExample: {
default: {
@ -8634,7 +8635,7 @@ export const restApiDocsData = [
default: "<p>Returns a list of a node's channels given its <code>:pubKey</code>. Ten channels are returned at a time. Use <code>:index</code> for paging. <code>:channelStatus</code> can be <code>open</code>, <code>active</code>, or <code>closed</code>.</p>"
},
urlString: "/v1/lightning/channels?public_key=:pubKey&status=:channelStatus",
showConditions: bitcoinNetworks,
showConditions: lightningNetworks,
showJsExamples: showJsExamplesDefaultFalse,
codeExample: {
default: {
@ -8770,7 +8771,7 @@ export const restApiDocsData = [
default: "<p>Returns a list of channels with corresponding node geodata.</p>"
},
urlString: "/v1/lightning/channels-geo",
showConditions: bitcoinNetworks,
showConditions: lightningNetworks,
showJsExamples: showJsExamplesDefaultFalse,
codeExample: {
default: {
@ -8878,7 +8879,7 @@ export const restApiDocsData = [
default: "<p>Returns a list of channels with corresponding geodata for a node with the given <code>:pubKey</code>.</p>"
},
urlString: "/v1/lightning/channels-geo/:pubKey",
showConditions: bitcoinNetworks,
showConditions: lightningNetworks,
showJsExamples: showJsExamplesDefaultFalse,
codeExample: {
default: {

2
frontend/src/app/docs/api-docs/api-docs.component.html
View File

@ -133,7 +133,7 @@
<p>{{electrsPort}}</p>
<p class="subtitle">SSL</p>
<p>Enabled</p>
<p class="note" *ngIf="network.val !== 'signet'">Electrum RPC interface for Bitcoin Signet is <a href="/signet/docs/api/electrs">publicly available</a>. Electrum RPC interface for all other networks is available to <a href='https://mempool.space/enterprise'>sponsors</a> only—whitelisting is required.</p>
<p class="note" *ngIf="network.val !== 'signet' && network.val !== 'testnet4'">Electrum RPC interface for <a href="/signet/docs/api/electrs">Bitcoin Signet</a> and <a href="/testnet4/docs/api/electrs">Bitcoin Testnet4</a> is publicly available. Electrum RPC interface for all other networks is available to <a href='https://mempool.space/enterprise'>sponsors</a> only—whitelisting is required.</p>
</div>
</div>
</div>

5
frontend/src/app/docs/api-docs/api-docs.component.ts
View File

@ -102,6 +102,8 @@ export class ApiDocsComponent implements OnInit, AfterViewInit {
this.electrsPort = 50002; break;
case "testnet":
this.electrsPort = 60002; break;
case "testnet4":
this.electrsPort = 40002; break;
case "signet":
this.electrsPort = 60602; break;
case "liquid":
@ -170,6 +172,9 @@ export class ApiDocsComponent implements OnInit, AfterViewInit {
if (network === 'testnet') {
curlResponse = code.codeSampleTestnet.curl;
}
if (network === 'testnet4') {
curlResponse = code.codeSampleTestnet.curl;
}
if (network === 'signet') {
curlResponse = code.codeSampleSignet.curl;
}

18
frontend/src/app/docs/code-template/code-template.component.ts
View File

@ -111,7 +111,10 @@ export class CodeTemplateComponent implements OnInit {
codeText = this.replaceJSPlaceholder(codeText, code.codeSampleMainnet.esModule);
}
if (this.network === 'testnet') {
codeText = this.replaceJSPlaceholder(codeText, code.codeSampleTestnet.esModule);
codeText = this.replaceJSPlaceholder(codeText, code.codeSampleTestnet.esModule);
}
if (this.network === 'testnet4') {
codeText = this.replaceJSPlaceholder(codeText, code.codeSampleTestnet.esModule);
}
if (this.network === 'signet') {
codeText = this.replaceJSPlaceholder(codeText, code.codeSampleSignet.esModule);
@ -144,7 +147,10 @@ init();`;
codeText = this.replaceJSPlaceholder(codeText, code.codeSampleMainnet.esModule);
}
if (this.network === 'testnet') {
codeText = this.replaceJSPlaceholder(codeText, code.codeSampleTestnet.esModule);
codeText = this.replaceJSPlaceholder(codeText, code.codeSampleTestnet.esModule);
}
if (this.network === 'testnet4') {
codeText = this.replaceJSPlaceholder(codeText, code.codeSampleTestnet.esModule);
}
if (this.network === 'signet') {
codeText = this.replaceJSPlaceholder(codeText, code.codeSampleSignet.esModule);
@ -212,6 +218,9 @@ yarn add @mempool/liquid.js`;
if (this.network === 'testnet') {
return this.replaceCurlPlaceholder(code.codeTemplate.curl, code.codeSampleTestnet);
}
if (this.network === 'testnet4') {
return this.replaceCurlPlaceholder(code.codeTemplate.curl, code.codeSampleTestnet);
}
if (this.network === 'signet') {
return this.replaceCurlPlaceholder(code.codeTemplate.curl, code.codeSampleSignet);
}
@ -234,6 +243,9 @@ yarn add @mempool/liquid.js`;
if (this.network === 'testnet') {
return code.codeSampleTestnet.response;
}
if (this.network === 'testnet4') {
return code.codeSampleTestnet.response;
}
if (this.network === 'signet') {
return code.codeSampleSignet.response;
}
@ -247,7 +259,7 @@ yarn add @mempool/liquid.js`;
}
wrapPythonTemplate(code: any) {
return ( ( this.network === 'testnet' || this.network === 'signet' ) ? ( code.codeTemplate.python.replace( "wss://mempool.space/api/v1/ws", "wss://mempool.space/" + this.network + "/api/v1/ws" ) ) : code.codeTemplate.python );
return ( ( this.network === 'testnet' || this.network === 'testnet4' || this.network === 'signet' ) ? ( code.codeTemplate.python.replace( "wss://mempool.space/api/v1/ws", "wss://mempool.space/" + this.network + "/api/v1/ws" ) ) : code.codeTemplate.python );
}
replaceJSPlaceholder(text: string, code: any) {