From ea1b74dcefe56cc816d0fce79347eeeafd494768 Mon Sep 17 00:00:00 2001
From: nymkappa <1612910616@pm.me>
Date: Sat, 27 Jan 2024 19:35:16 +0100
Subject: [PATCH 1/7] [doc] add accelerator rest api documentation

---
 .../src/app/docs/api-docs/api-docs-data.ts    | 285 ++++++++++++++++++
 .../app/docs/api-docs/api-docs.component.html |  88 +++---
 .../code-template/code-template.component.ts  |  16 +-
 3 files changed, 339 insertions(+), 50 deletions(-)

diff --git a/frontend/src/app/docs/api-docs/api-docs-data.ts b/frontend/src/app/docs/api-docs/api-docs-data.ts
index 86a63e513..8998ec59a 100644
--- a/frontend/src/app/docs/api-docs/api-docs-data.ts
+++ b/frontend/src/app/docs/api-docs/api-docs-data.ts
@@ -9871,7 +9871,292 @@ export const restApiDocsData = [
         codeSampleBisq: emptyCodeSample,
       }
     }
+  },
+  {
+    type: "category",
+    category: "accelerator",
+    fragment: "accelerator",
+    title: "Accelerator",
+    showConditions: [""],
+    options: { officialOnly: true },
+  },
+  {
+    options: { officialOnly: true },
+    type: "endpoint",
+    category: "accelerator",
+    httpRequestMethod: "GET",
+    fragment: "get-deposit-history",
+    title: "GET Deposit History",
+    description: {
+      default: "<p>Returns a list of previous deposits made as prepayment for the accelerator service.</p>"
+    },
+    urlString: "/v1/services/accelerator/deposit-history",
+    showConditions: bitcoinNetworks,
+    showJsExamples: showJsExamplesDefaultFalse,
+    codeExample: {
+      default: {
+        codeTemplate: {
+          curl: `/api/v1/services/accelerator/deposit-history`,
+          commonJS: ``,
+          esModule: ``
+        },
+        codeSampleMainnet: {
+          esModule: [],
+          commonJS: [],
+          curl: [],
+          headers: "api_key: stacksats",
+          response: `[
+  {
+    "type": "Bitcoin",
+    "invoiceId": "CCunucVyNw7jUiUz64mmHz",
+    "amount": 10311031,
+    "status": "pending",
+    "date": 1706372653000,
+    "link": "/payment/bitcoin/CCunucVyNw7jUiUz64mmHz"
+  },
+  {
+    "type": "Bitcoin",
+    "invoiceId": "SG1U27R9PdWi3gH3jB9tm9",
+    "amount": 21000000,
+    "status": "paid",
+    "date": 1706372582000,
+    "link": null
+  },
+  ...
+]`,
+        },
+      }
+    }
+  },
+  {
+    options: { officialOnly: true },
+    type: "endpoint",
+    category: "accelerator",
+    httpRequestMethod: "GET",
+    fragment: "balance",
+    title: "GET Available Balance",
+    description: {
+      default: "<p>Return your current available balance, as well as how much funds are currently locked and much you've been charged so far.</p>"
+    },
+    urlString: "/v1/services/accelerator/balance",
+    showConditions: bitcoinNetworks,
+    showJsExamples: showJsExamplesDefaultFalse,
+    codeExample: {
+      default: {
+        codeTemplate: {
+          curl: `/api/v1/services/accelerator/balance`,
+          commonJS: ``,
+          esModule: ``
+        },
+        codeSampleMainnet: {
+          esModule: [],
+          commonJS: [],
+          curl: [],
+          headers: "api_key: stacksats",
+          response: `{
+  "balance": 99900000,
+  "hold": 0,
+  "feesPaid": 200000
+}`,
+        },
+      }
+    }
+  },
+  {
+    options: { officialOnly: true },
+    type: "endpoint",
+    category: "accelerator",
+    httpRequestMethod: "POST",
+    fragment: "estimate",
+    title: "POST Calculate Estimated Costs",
+    description: {
+      default: "<p>Return an estimation of the costs to accelerate a transaction.</p>"
+    },
+    urlString: "/v1/services/accelerator/estimate",
+    showConditions: bitcoinNetworks,
+    showJsExamples: showJsExamplesDefaultFalse,
+    codeExample: {
+      default: {
+        codeTemplate: {
+          curl: `%{1}" "[[hostname]][[baseNetworkUrl]]/api/v1/services/accelerator/estimate`, //custom interpolation technique handled in replaceCurlPlaceholder()
+          commonJS: ``,
+          esModule: ``
+        },
+        codeSampleMainnet: {
+          esModule: [],
+          commonJS: [],
+          curl: ["txInput=ee13ebb99632377c15c94980357f674d285ac413452050031ea6dcd3e9b2dc29"],
+          headers: "api_key: stacksats",
+          response: `{
+  "txSummary": {
+    "txid": "ee13ebb99632377c15c94980357f674d285ac413452050031ea6dcd3e9b2dc29",
+    "effectiveVsize": 154,
+    "effectiveFee": 154,
+    "ancestorCount": 1
+  },
+  "cost": 3850,
+  "targetFeeRate": 26,
+  "nextBlockFee": 4004,
+  "userBalance": 99900000,
+  "mempoolBaseFee": 40000,
+  "vsizeFee": 50000,
+  "hasAccess": true
+}`,
+        },
+      }
+    }
+  },
+  {
+    options: { officialOnly: true },
+    type: "endpoint",
+    category: "accelerator",
+    httpRequestMethod: "POST",
+    fragment: "accelerate",
+    title: "POST Accelerate A Transaction",
+    description: {
+      default: "<p>Send a request to accelerate a transaction.</p>"
+    },
+    urlString: "/v1/services/accelerator/accelerate",
+    showConditions: bitcoinNetworks,
+    showJsExamples: showJsExamplesDefaultFalse,
+    codeExample: {
+      default: {
+        codeTemplate: {
+          curl: `%{1}" "[[hostname]][[baseNetworkUrl]]/api/v1/services/accelerator/accelerate`, //custom interpolation technique handled in replaceCurlPlaceholder()
+          commonJS: ``,
+          esModule: ``
+        },
+        codeSampleMainnet: {
+          esModule: [],
+          commonJS: [],
+          curl: ["txInput=ee13ebb99632377c15c94980357f674d285ac413452050031ea6dcd3e9b2dc29&userBid=21000000"],
+          headers: "api_key: stacksats",
+          response: `HTTP/1.1 200 OK`,
+        },
+      }
+    }
+  },
+  {
+    options: { officialOnly: true },
+    type: "endpoint",
+    category: "history",
+    httpRequestMethod: "GET",
+    fragment: "history",
+    title: "GET Acceleration History",
+    description: {
+      default: "<p>Return the history of previous acceleration requests.</p>"
+    },
+    urlString: "/v1/services/accelerator/history[?status=all|requested|accelerating|mined|completed|failed]",
+    showConditions: bitcoinNetworks,
+    showJsExamples: showJsExamplesDefaultFalse,
+    codeExample: {
+      default: {
+        codeTemplate: {
+          curl: `/api/v1/services/accelerator/history?status=all`,
+          commonJS: ``,
+          esModule: ``
+        },
+        codeSampleMainnet: {
+          esModule: [],
+          commonJS: [],
+          curl: [],
+          headers: "api_key: stacksats",
+          response: `[
+  {
+    "id": 89,
+    "user_id": 1,
+    "txid": "ae2639469ec000ed1d14e2550cbb01794e1cd288a00cdc7cce18398ba3cc2ffe",
+    "status": "failed",
+    "estimated_fee": 247,
+    "fee_paid": 0,
+    "added": 1706378712,
+    "last_updated": 1706378712,
+    "confirmations": 4,
+    "base_fee": 0,
+    "vsize_fee": 0,
+    "max_bid": 7000,
+    "effective_vsize": 135,
+    "effective_fee": 3128,
+    "history": [
+      {
+        "event": "user-requested-acceleration",
+        "timestamp": 1706378712
+      },
+      {
+        "event": "accepted_test-api-key",
+        "timestamp": 1706378712
+      },
+      {
+        "event": "failed-at-block-827672",
+        "timestamp": 1706380261
+      }
+    ]
+  },
+  {
+    "id": 88,
+    "user_id": 1,
+    "txid": "c5840e89173331760e959a190b24e2a289121277ed7f8a095fe289b37cee9fde",
+    "status": "completed",
+    "estimated_fee": 223,
+    "fee_paid": 140019,
+    "added": 1706378704,
+    "last_updated": 1706380231,
+    "confirmations": 6,
+    "base_fee": 40000,
+    "vsize_fee": 100000,
+    "max_bid": 14000,
+    "effective_vsize": 135,
+    "effective_fee": 3152,
+    "history": [
+      {
+        "event": "user-requested-acceleration",
+        "timestamp": 1706378704
+      },
+      {
+        "event": "accepted_test-api-key",
+        "timestamp": 1706378704
+      },
+      {
+        "event": "complete-at-block-827670",
+        "timestamp": 1706380231
+      }
+    ]
+  },
+  {
+    "id": 87,
+    "user_id": 1,
+    "txid": "178b5b9b310f0d667d7ea563a2cdcc17bc8cd15261b58b1653860a724ca83458",
+    "status": "completed",
+    "estimated_fee": 115,
+    "fee_paid": 90062,
+    "added": 1706378684,
+    "last_updated": 1706380231,
+    "confirmations": 6,
+    "base_fee": 40000,
+    "vsize_fee": 50000,
+    "max_bid": 14000,
+    "effective_vsize": 135,
+    "effective_fee": 3260,
+    "history": [
+      {
+        "event": "user-requested-acceleration",
+        "timestamp": 1706378684
+      },
+      {
+        "event": "accepted_test-api-key",
+        "timestamp": 1706378684
+      },
+      {
+        "event": "complete-at-block-827670",
+        "timestamp": 1706380231
+      }
+    ]
   }
+]`,
+        },
+      }
+    }
+  },
 ];
 
 export const faqData = [
diff --git a/frontend/src/app/docs/api-docs/api-docs.component.html b/frontend/src/app/docs/api-docs/api-docs.component.html
index c3a260995..ef7782199 100644
--- a/frontend/src/app/docs/api-docs/api-docs.component.html
+++ b/frontend/src/app/docs/api-docs/api-docs.component.html
@@ -43,54 +43,56 @@
         <p class="doc-welcome-note api-note" *ngIf="officialMempoolInstance">Note that we enforce rate limits. If you exceed these limits, you will get an HTTP 429 error. If you repeatedly exceed the limits, you may be banned from accessing the service altogether. Consider an <a href="https://mempool.space/enterprise">enterprise sponsorship</a> if you need higher API limits.</p>
 
         <div class="doc-item-container" *ngFor="let item of restDocs">
-          <h3 *ngIf="( item.type === 'category' ) && ( item.showConditions.indexOf(network.val) > -1 )">{{ item.title }}</h3>
-          <div *ngIf="( item.type !== 'category' ) && ( item.showConditions.indexOf(network.val) > -1 )" class="endpoint-container" id="{{ item.fragment }}">
-            <a id="{{ item.fragment + '-tab-header' }}" class="section-header" (click)="anchorLinkClick( $event )" [routerLink]="['./']" fragment="{{ item.fragment }}">{{ item.title }} <span>{{ item.category }}</span></a>
-            <div class="endpoint-content">
-              <div class="endpoint">
-                <div class="subtitle" i18n="Api docs endpoint">Endpoint</div>
-                <ng-container *ngIf="item.httpRequestMethod === 'GET' && network.val === 'bisq' && item.codeExample.hasOwnProperty('bisq');else liquid_link_example" #bisq_link_example>
-                  <a [href]="wrapUrl(network.val, item.codeExample.bisq)" target="_blank" rel="nofollow">{{ item.httpRequestMethod }} {{ baseNetworkUrl }}/api{{ item.urlString }}</a>
+          <div *ngIf="!item.hasOwnProperty('options') || ( item.hasOwnProperty('options') && item.options.hasOwnProperty('officialOnly') && item.options.officialOnly && officialMempoolInstance )">
+            <h3 *ngIf="( item.type === 'category' ) && ( item.showConditions.indexOf(network.val) > -1 )">{{ item.title }}</h3>
+            <div *ngIf="( item.type !== 'category' ) && ( item.showConditions.indexOf(network.val) > -1 )" class="endpoint-container" id="{{ item.fragment }}">
+              <a id="{{ item.fragment + '-tab-header' }}" class="section-header" (click)="anchorLinkClick( $event )" [routerLink]="['./']" fragment="{{ item.fragment }}">{{ item.title }} <span>{{ item.category }}</span></a>
+              <div class="endpoint-content">
+                <div class="endpoint">
+                  <div class="subtitle" i18n="Api docs endpoint">Endpoint</div>
+                  <ng-container *ngIf="item.httpRequestMethod === 'GET' && network.val === 'bisq' && item.codeExample.hasOwnProperty('bisq');else liquid_link_example" #bisq_link_example>
+                    <a [href]="wrapUrl(network.val, item.codeExample.bisq)" target="_blank" rel="nofollow">{{ item.httpRequestMethod }} {{ baseNetworkUrl }}/api{{ item.urlString }}</a>
+                  </ng-container>
+                  <ng-template #liquid_link_example>
+                    <ng-container *ngIf="item.httpRequestMethod === 'GET' && network.val === 'liquid' && item.codeExample.hasOwnProperty('liquid');else default_link_example">
+                      <a [href]="wrapUrl(network.val, item.codeExample.liquid)" target="_blank" rel="nofollow" *ngIf="item.fragment !== 'get-cpfp'">{{ item.httpRequestMethod }} {{ baseNetworkUrl }}/api{{ item.urlString }}</a>
+                      <p *ngIf="item.fragment === 'get-cpfp'">{{ item.httpRequestMethod }} {{ baseNetworkUrl }}/api{{ item.urlString }}</p>
+                    </ng-container>
+                  </ng-template>
+                  <ng-template #default_link_example>
+                    <ng-container *ngIf="item.httpRequestMethod === 'GET'">
+                      <a [href]="wrapUrl(network.val, item.codeExample.default)" target="_blank" rel="nofollow" *ngIf="item.fragment !== 'get-cpfp'">{{ item.httpRequestMethod }} {{ baseNetworkUrl }}/api{{ item.urlString }}</a>
+                      <p *ngIf="item.fragment === 'get-cpfp'">{{ item.httpRequestMethod }} {{ baseNetworkUrl }}/api{{ item.urlString }}</p>
+                    </ng-container>
+                  </ng-template>
+                  <div *ngIf="item.httpRequestMethod === 'POST'">{{ item.httpRequestMethod }} {{ item.urlString }}</div>
+                </div>
+                <div class="description">
+                  <div class="subtitle" i18n>Description</div>
+                  <ng-container *ngIf="network.val === 'bisq' && item.description.hasOwnProperty('bisq');else liquid_description" #bisq_description>
+                    <div [innerHTML]="item.description.bisq" i18n></div>
+                  </ng-container>
+                  <ng-template #liquid_description>
+                    <ng-container *ngIf="network.val === 'liquid' && item.description.hasOwnProperty('liquid');else default_description">
+                      <div [innerHTML]="item.description.liquid" i18n></div>
+                    </ng-container>
+                  </ng-template>
+                  <ng-template #default_description>
+                    <div [innerHTML]="item.description.default" i18n></div>
+                  </ng-template>
+                </div>
+                <ng-container *ngIf="network.val === 'bisq' && item.codeExample.hasOwnProperty('bisq');else liquid_code_example" #bisq_code_example>
+                  <app-code-template [hostname]="hostname" [baseNetworkUrl]="baseNetworkUrl" [method]="item.httpRequestMethod" [code]="item.codeExample.bisq" [network]="network.val" [showCodeExample]="item.showJsExamples"></app-code-template>
                 </ng-container>
-                <ng-template #liquid_link_example>
-                  <ng-container *ngIf="item.httpRequestMethod === 'GET' && network.val === 'liquid' && item.codeExample.hasOwnProperty('liquid');else default_link_example">
-                    <a [href]="wrapUrl(network.val, item.codeExample.liquid)" target="_blank" rel="nofollow" *ngIf="item.fragment !== 'get-cpfp'">{{ item.httpRequestMethod }} {{ baseNetworkUrl }}/api{{ item.urlString }}</a>
-                    <p *ngIf="item.fragment === 'get-cpfp'">{{ item.httpRequestMethod }} {{ baseNetworkUrl }}/api{{ item.urlString }}</p>
+                <ng-template #liquid_code_example>
+                  <ng-container *ngIf="network.val === 'liquid' && item.codeExample.hasOwnProperty('liquid');else default_code_example">
+                    <app-code-template [hostname]="hostname" [baseNetworkUrl]="baseNetworkUrl" [method]="item.httpRequestMethod" [code]="item.codeExample.liquid" [network]="network.val" [showCodeExample]="item.showJsExamples"></app-code-template>
                   </ng-container>
                 </ng-template>
-                <ng-template #default_link_example>
-                  <ng-container *ngIf="item.httpRequestMethod === 'GET'">
-                    <a [href]="wrapUrl(network.val, item.codeExample.default)" target="_blank" rel="nofollow" *ngIf="item.fragment !== 'get-cpfp'">{{ item.httpRequestMethod }} {{ baseNetworkUrl }}/api{{ item.urlString }}</a>
-                    <p *ngIf="item.fragment === 'get-cpfp'">{{ item.httpRequestMethod }} {{ baseNetworkUrl }}/api{{ item.urlString }}</p>
-                  </ng-container>
-                </ng-template>
-                <div *ngIf="item.httpRequestMethod === 'POST'">{{ item.httpRequestMethod }} {{ item.urlString }}</div>
-              </div>
-              <div class="description">
-                <div class="subtitle" i18n>Description</div>
-                <ng-container *ngIf="network.val === 'bisq' && item.description.hasOwnProperty('bisq');else liquid_description" #bisq_description>
-                  <div [innerHTML]="item.description.bisq" i18n></div>
-                </ng-container>
-                <ng-template #liquid_description>
-                  <ng-container *ngIf="network.val === 'liquid' && item.description.hasOwnProperty('liquid');else default_description">
-                    <div [innerHTML]="item.description.liquid" i18n></div>
-                  </ng-container>
-                </ng-template>
-                <ng-template #default_description>
-                  <div [innerHTML]="item.description.default" i18n></div>
+                <ng-template #default_code_example>
+                  <app-code-template [hostname]="hostname" [baseNetworkUrl]="baseNetworkUrl" [method]="item.httpRequestMethod" [code]="item.codeExample.default" [network]="network.val" [showCodeExample]="item.showJsExamples"></app-code-template>
                 </ng-template>
               </div>
-              <ng-container *ngIf="network.val === 'bisq' && item.codeExample.hasOwnProperty('bisq');else liquid_code_example" #bisq_code_example>
-                <app-code-template [hostname]="hostname" [baseNetworkUrl]="baseNetworkUrl" [method]="item.httpRequestMethod" [code]="item.codeExample.bisq" [network]="network.val" [showCodeExample]="item.showJsExamples"></app-code-template>
-              </ng-container>
-              <ng-template #liquid_code_example>
-                <ng-container *ngIf="network.val === 'liquid' && item.codeExample.hasOwnProperty('liquid');else default_code_example">
-                  <app-code-template [hostname]="hostname" [baseNetworkUrl]="baseNetworkUrl" [method]="item.httpRequestMethod" [code]="item.codeExample.liquid" [network]="network.val" [showCodeExample]="item.showJsExamples"></app-code-template>
-                </ng-container>
-              </ng-template>
-              <ng-template #default_code_example>
-                <app-code-template [hostname]="hostname" [baseNetworkUrl]="baseNetworkUrl" [method]="item.httpRequestMethod" [code]="item.codeExample.default" [network]="network.val" [showCodeExample]="item.showJsExamples"></app-code-template>
-              </ng-template>
             </div>
           </div>
         </div>
diff --git a/frontend/src/app/docs/code-template/code-template.component.ts b/frontend/src/app/docs/code-template/code-template.component.ts
index 5ef8a64ba..6b91f5a9d 100644
--- a/frontend/src/app/docs/code-template/code-template.component.ts
+++ b/frontend/src/app/docs/code-template/code-template.component.ts
@@ -311,27 +311,29 @@ yarn add @mempool/liquid.js`;
       text = text.replace('%{' + indexNumber + '}', textReplace);
     }
 
+    const headersString = code.headers ? ` -H "${code.headers}"` : ``;
+    
     if (this.env.BASE_MODULE === 'mempool') {
       if (this.network === 'main' || this.network === '') {
         if (this.method === 'POST') {
-          return `curl -X POST -sSLd "${text}"`;
+          return `curl${headersString} -X POST -sSLd "${text}"`;
         }
-        return `curl -sSL "${this.hostname}${text}"`;
+        return `curl${headersString} -sSL "${this.hostname}${text}"`;
       }
       if (this.method === 'POST') {
-        return `curl -X POST -sSLd "${text}"`;
+        return `curl${headersString} -X POST -sSLd "${text}"`;
       }
-      return `curl -sSL "${this.hostname}/${this.network}${text}"`;
+      return `curl${headersString} -sSL "${this.hostname}/${this.network}${text}"`;
     } else if (this.env.BASE_MODULE === 'liquid') {
       if (this.method === 'POST') {
         if (this.network !== 'liquid') {
           text = text.replace('/api', `/${this.network}/api`);
         }
-        return `curl -X POST -sSLd "${text}"`;
+        return `curl${headersString} -X POST -sSLd "${text}"`;
       }
-      return ( this.network === 'liquid' ? `curl -sSL "${this.hostname}${text}"` : `curl -sSL "${this.hostname}/${this.network}${text}"` );
+      return ( this.network === 'liquid' ? `curl${headersString} -sSL "${this.hostname}${text}"` : `curl${headersString} -sSL "${this.hostname}/${this.network}${text}"` );
     } else {
-        return `curl -sSL "${this.hostname}${text}"`;
+        return `curl${headersString} -sSL "${this.hostname}${text}"`;
     }
 
   }

From a3055e20f43252bb3ce49571f42a7f348261e919 Mon Sep 17 00:00:00 2001
From: hunicus <93150691+hunicus@users.noreply.github.com>
Date: Mon, 29 Jan 2024 01:56:45 -0500
Subject: [PATCH 2/7] Fix signet and testnet docs pages

---
 frontend/src/app/docs/api-docs/api-docs-data.ts | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/frontend/src/app/docs/api-docs/api-docs-data.ts b/frontend/src/app/docs/api-docs/api-docs-data.ts
index 8998ec59a..6b765e5c6 100644
--- a/frontend/src/app/docs/api-docs/api-docs-data.ts
+++ b/frontend/src/app/docs/api-docs/api-docs-data.ts
@@ -9891,7 +9891,7 @@ export const restApiDocsData = [
       default: "<p>Returns a list of previous deposits made as prepayment for the accelerator service.</p>"
     },
     urlString: "/v1/services/accelerator/deposit-history",
-    showConditions: bitcoinNetworks,
+    showConditions: [""],
     showJsExamples: showJsExamplesDefaultFalse,
     codeExample: {
       default: {
@@ -9939,7 +9939,7 @@ export const restApiDocsData = [
       default: "<p>Return your current available balance, as well as how much funds are currently locked and much you've been charged so far.</p>"
     },
     urlString: "/v1/services/accelerator/balance",
-    showConditions: bitcoinNetworks,
+    showConditions: [""],
     showJsExamples: showJsExamplesDefaultFalse,
     codeExample: {
       default: {
@@ -9973,7 +9973,7 @@ export const restApiDocsData = [
       default: "<p>Return an estimation of the costs to accelerate a transaction.</p>"
     },
     urlString: "/v1/services/accelerator/estimate",
-    showConditions: bitcoinNetworks,
+    showConditions: [""],
     showJsExamples: showJsExamplesDefaultFalse,
     codeExample: {
       default: {
@@ -10017,7 +10017,7 @@ export const restApiDocsData = [
       default: "<p>Send a request to accelerate a transaction.</p>"
     },
     urlString: "/v1/services/accelerator/accelerate",
-    showConditions: bitcoinNetworks,
+    showConditions: [""],
     showJsExamples: showJsExamplesDefaultFalse,
     codeExample: {
       default: {
@@ -10047,7 +10047,7 @@ export const restApiDocsData = [
       default: "<p>Return the history of previous acceleration requests.</p>"
     },
     urlString: "/v1/services/accelerator/history[?status=all|requested|accelerating|mined|completed|failed]",
-    showConditions: bitcoinNetworks,
+    showConditions: [""],
     showJsExamples: showJsExamplesDefaultFalse,
     codeExample: {
       default: {

From b2a130bb17644a700986faea30746172e638c964 Mon Sep 17 00:00:00 2001
From: nymkappa <1612910616@pm.me>
Date: Mon, 29 Jan 2024 11:45:14 +0100
Subject: [PATCH 3/7] [doc] fix copy, formatting and hide accelerator doc title
 if non official instance

---
 frontend/src/app/docs/api-docs/api-docs-data.ts        | 10 +++++-----
 .../src/app/docs/api-docs/api-docs-nav.component.html  |  2 +-
 2 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/frontend/src/app/docs/api-docs/api-docs-data.ts b/frontend/src/app/docs/api-docs/api-docs-data.ts
index 6b765e5c6..a0d292925 100644
--- a/frontend/src/app/docs/api-docs/api-docs-data.ts
+++ b/frontend/src/app/docs/api-docs/api-docs-data.ts
@@ -9888,7 +9888,7 @@ export const restApiDocsData = [
     fragment: "get-deposit-history",
     title: "GET Deposit History",
     description: {
-      default: "<p>Returns a list of previous deposits made as prepayment for the accelerator service.</p>"
+      default: "<p>Returns a list of deposits made as prepayment for the accelerator service.</p>"
     },
     urlString: "/v1/services/accelerator/deposit-history",
     showConditions: [""],
@@ -9936,7 +9936,7 @@ export const restApiDocsData = [
     fragment: "balance",
     title: "GET Available Balance",
     description: {
-      default: "<p>Return your current available balance, as well as how much funds are currently locked and much you've been charged so far.</p>"
+      default: "<p>Returns your currently available balance, currently locked funds, and total fees paid so far.</p>"
     },
     urlString: "/v1/services/accelerator/balance",
     showConditions: [""],
@@ -9970,7 +9970,7 @@ export const restApiDocsData = [
     fragment: "estimate",
     title: "POST Calculate Estimated Costs",
     description: {
-      default: "<p>Return an estimation of the costs to accelerate a transaction.</p>"
+      default: "<p>Returns estimated costs to accelerate a transaction.</p>"
     },
     urlString: "/v1/services/accelerator/estimate",
     showConditions: [""],
@@ -10044,9 +10044,9 @@ export const restApiDocsData = [
     fragment: "history",
     title: "GET Acceleration History",
     description: {
-      default: "<p>Return the history of previous acceleration requests.</p>"
+      default: "<p>Return the history of previous acceleration requests.</p><p>Pass one of the following for <code>:status</code>: <code>all</code>, <code>requested</code>, <code>accelerating</code>, <code>mined</code>, <code>completed</code>, <code>failed</code>.</p>"
     },
-    urlString: "/v1/services/accelerator/history[?status=all|requested|accelerating|mined|completed|failed]",
+    urlString: "/v1/services/accelerator/history?status=:status",
     showConditions: [""],
     showJsExamples: showJsExamplesDefaultFalse,
     codeExample: {
diff --git a/frontend/src/app/docs/api-docs/api-docs-nav.component.html b/frontend/src/app/docs/api-docs/api-docs-nav.component.html
index ec1cde38f..96622c424 100644
--- a/frontend/src/app/docs/api-docs/api-docs-nav.component.html
+++ b/frontend/src/app/docs/api-docs/api-docs-nav.component.html
@@ -1,4 +1,4 @@
 <div *ngFor="let item of tabData">
-  <p *ngIf="( item.type === 'category' ) && ( item.showConditions.indexOf(network.val) > -1 )">{{ item.title }}</p>
+  <p *ngIf="( item.type === 'category' ) && ( item.showConditions.indexOf(network.val) > -1 ) && ( !item.hasOwnProperty('options') || ( item.hasOwnProperty('options') && item.options.hasOwnProperty('officialOnly') && item.options.officialOnly && officialMempoolInstance ))">{{ item.title }}</p>
   <a *ngIf="( item.type !== 'category' ) && ( item.showConditions.indexOf(network.val) > -1 ) && ( !item.hasOwnProperty('options') || ( item.hasOwnProperty('options') && item.options.hasOwnProperty('officialOnly') && item.options.officialOnly && officialMempoolInstance ) || ( item.hasOwnProperty('options') && item.options.hasOwnProperty('auditOnly') && item.options.auditOnly && auditEnabled ) )" [routerLink]="['./']" fragment="{{ item.fragment }}" (click)="navLinkClick($event)">{{ item.title }}</a>
 </div>

From be183ada0a950ebf129bd5db1dcfdda8d82c297a Mon Sep 17 00:00:00 2001
From: nymkappa <1612910616@pm.me>
Date: Sat, 10 Feb 2024 10:56:19 +0100
Subject: [PATCH 4/7] [doc] fix acceleration history endpoint detail

---
 frontend/src/app/docs/api-docs/api-docs-data.ts | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/frontend/src/app/docs/api-docs/api-docs-data.ts b/frontend/src/app/docs/api-docs/api-docs-data.ts
index a0d292925..d2cfc0926 100644
--- a/frontend/src/app/docs/api-docs/api-docs-data.ts
+++ b/frontend/src/app/docs/api-docs/api-docs-data.ts
@@ -9955,8 +9955,8 @@ export const restApiDocsData = [
           headers: "api_key: stacksats",
           response: `{
   "balance": 99900000,
-  "hold": 0,
-  "feesPaid": 200000
+  "hold": 101829,
+  "feesPaid": 133721
 }`,
         },
       }
@@ -10044,15 +10044,15 @@ export const restApiDocsData = [
     fragment: "history",
     title: "GET Acceleration History",
     description: {
-      default: "<p>Return the history of previous acceleration requests.</p><p>Pass one of the following for <code>:status</code>: <code>all</code>, <code>requested</code>, <code>accelerating</code>, <code>mined</code>, <code>completed</code>, <code>failed</code>.</p>"
+      default: "<p>Return the history of previous acceleration requests.</p><p>Pass one of the following for <code>:status</code>: <code>all</code>, <code>requested</code>, <code>accelerating</code>, <code>mined</code>, <code>completed</code>, <code>failed</code>.<br>Pass <code>true</code> in <code>:details</code> to get a detailed <code>history</code> of the acceleration request.</p>"
     },
-    urlString: "/v1/services/accelerator/history?status=:status",
+    urlString: "/v1/services/accelerator/history?status=:status&details=:details",
     showConditions: [""],
     showJsExamples: showJsExamplesDefaultFalse,
     codeExample: {
       default: {
         codeTemplate: {
-          curl: `/api/v1/services/accelerator/history?status=all`,
+          curl: `/api/v1/services/accelerator/history?status=all&details=true`,
           commonJS: ``,
           esModule: ``
         },

From 740f9af9af4574cfe03e6b092ef64f09dfead3ea Mon Sep 17 00:00:00 2001
From: nymkappa <1612910616@pm.me>
Date: Sat, 10 Feb 2024 11:40:19 +0100
Subject: [PATCH 5/7] [doc] additional rest api doc for accelerator

---
 .../src/app/docs/api-docs/api-docs-data.ts    | 123 +++++++++++++++++-
 1 file changed, 117 insertions(+), 6 deletions(-)

diff --git a/frontend/src/app/docs/api-docs/api-docs-data.ts b/frontend/src/app/docs/api-docs/api-docs-data.ts
index d2cfc0926..621f14595 100644
--- a/frontend/src/app/docs/api-docs/api-docs-data.ts
+++ b/frontend/src/app/docs/api-docs/api-docs-data.ts
@@ -9885,7 +9885,7 @@ export const restApiDocsData = [
     type: "endpoint",
     category: "accelerator",
     httpRequestMethod: "GET",
-    fragment: "get-deposit-history",
+    fragment: "accelerator-deposit-history",
     title: "GET Deposit History",
     description: {
       default: "<p>Returns a list of deposits made as prepayment for the accelerator service.</p>"
@@ -9933,7 +9933,7 @@ export const restApiDocsData = [
     type: "endpoint",
     category: "accelerator",
     httpRequestMethod: "GET",
-    fragment: "balance",
+    fragment: "accelerator-balance",
     title: "GET Available Balance",
     description: {
       default: "<p>Returns your currently available balance, currently locked funds, and total fees paid so far.</p>"
@@ -9967,7 +9967,7 @@ export const restApiDocsData = [
     type: "endpoint",
     category: "accelerator",
     httpRequestMethod: "POST",
-    fragment: "estimate",
+    fragment: "accelerator-estimate",
     title: "POST Calculate Estimated Costs",
     description: {
       default: "<p>Returns estimated costs to accelerate a transaction.</p>"
@@ -10011,7 +10011,7 @@ export const restApiDocsData = [
     type: "endpoint",
     category: "accelerator",
     httpRequestMethod: "POST",
-    fragment: "accelerate",
+    fragment: "accelerator-accelerate",
     title: "POST Accelerate A Transaction",
     description: {
       default: "<p>Send a request to accelerate a transaction.</p>"
@@ -10039,9 +10039,9 @@ export const restApiDocsData = [
   {
     options: { officialOnly: true },
     type: "endpoint",
-    category: "history",
+    category: "accelerator",
     httpRequestMethod: "GET",
-    fragment: "history",
+    fragment: "accelerator-history",
     title: "GET Acceleration History",
     description: {
       default: "<p>Return the history of previous acceleration requests.</p><p>Pass one of the following for <code>:status</code>: <code>all</code>, <code>requested</code>, <code>accelerating</code>, <code>mined</code>, <code>completed</code>, <code>failed</code>.<br>Pass <code>true</code> in <code>:details</code> to get a detailed <code>history</code> of the acceleration request.</p>"
@@ -10152,6 +10152,117 @@ export const restApiDocsData = [
       }
     ]
   }
+]`,
+        },
+      }
+    }
+  },
+  {
+    options: { officialOnly: true },
+    type: "endpoint",
+    category: "accelerator",
+    httpRequestMethod: "GET",
+    fragment: "accelerator-pending",
+    title: "GET Pending Acceleration",
+    description: {
+      default: "<p>Return the list of currently accelerated transactions.</p>"
+    },
+    urlString: "/v1/services/accelerator/accelerations",
+    showConditions: [""],
+    showJsExamples: showJsExamplesDefaultFalse,
+    codeExample: {
+      default: {
+        codeTemplate: {
+          curl: `/api/v1/services/accelerator/accelerations`,
+          commonJS: ``,
+          esModule: ``
+        },
+        codeSampleMainnet: {
+          esModule: [],
+          commonJS: [],
+          curl: [],
+          headers: '',
+          response: `[
+  {
+    "txid": "8a183c8ae929a2afb857e7f2acd440aaefdf2797f8f7eab1c5f95ff8602abc81",
+    "added": 1707558316,
+    "feeDelta": 3500,
+    "effectiveVsize": 111,
+    "effectiveFee": 1671,
+    "pools": [
+      111
+    ]
+  },
+  {
+    "txid": "6097f295e21bdd8d725bd8d9ad4dd72b05bd795dc648bfef52150a9b2b7f7a45",
+    "added": 1707560464,
+    "feeDelta": 60000,
+    "effectiveVsize": 812,
+    "effectiveFee": 7790,
+    "pools": [
+      111
+    ]
+  }
+]`,
+        },
+      }
+    }
+  },
+  {
+    options: { officialOnly: true },
+    type: "endpoint",
+    category: "accelerator",
+    httpRequestMethod: "GET",
+    fragment: "accelerator-public-history",
+    title: "GET Acceleration History",
+    description: {
+      default: `<p>Return a list of accelerated transactions.
+      Filters can be applied such as<ul>
+      <li><code>status</code>: <code>all</code>, <code>requested</code>, <code>accelerating</code>, <code>mined</code>, <code>completed</code>, <code>failed</code></li>
+      <li><code>timeframe</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>, <code>all</code></li>
+      <li><code>poolUniqueId</code>: any id from <a target="_blank" href="https://github.com/mempool/mining-pools/blob/master/pools-v2.json">https://github.com/mempool/mining-pools/blob/master/pools-v2.json</a>
+      <li><code>blockHash</code>: a block hash</a>
+      <li><code>blockHeight</code>: a block height</a>
+      <li><code>page</code>: the requested page number if using pagination</a>
+      <li><code>pageLength</code>: the page lenght if using pagination</a>
+      </ul></p>`
+    },
+    urlString: "/v1/services/accelerator/accelerations/history",
+    showConditions: [""],
+    showJsExamples: showJsExamplesDefaultFalse,
+    codeExample: {
+      default: {
+        codeTemplate: {
+          curl: `/api/v1/services/accelerator/accelerations/history?blockHash=00000000000000000000482f0746d62141694b9210a813b97eb8445780a32003`,
+          commonJS: ``,
+          esModule: ``
+        },
+        codeSampleMainnet: {
+          esModule: [],
+          commonJS: [],
+          curl: [],
+          headers: '',
+          response: `[
+  {
+    "txid": "d7e1796d8eb4a09d4e6c174e36cfd852f1e6e6c9f7df4496339933cd32cbdd1d",
+    "status": "completed",
+    "feePaid": 53239,
+    "added": 1707421053,
+    "lastUpdated": 1707422952,
+    "baseFee": 50000,
+    "vsizeFee": 0,
+    "effectiveFee": 146,
+    "effectiveVsize": 141,
+    "feeDelta": 14000,
+    "blockHash": "00000000000000000000482f0746d62141694b9210a813b97eb8445780a32003",
+    "blockHeight": 829559,
+    "pools": [
+      {
+        "pool_unique_id": 111,
+        "username": "foundryusa"
+      }
+    ]
+  }
 ]`,
         },
       }

From a1bd84ea6d5d312f4be4b12af4b8e40988bc814d Mon Sep 17 00:00:00 2001
From: nymkappa <1612910616@pm.me>
Date: Sat, 10 Feb 2024 11:41:30 +0100
Subject: [PATCH 6/7] [doc] separate private/public acceleration history
 endpoint title

---
 frontend/src/app/docs/api-docs/api-docs-data.ts | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/frontend/src/app/docs/api-docs/api-docs-data.ts b/frontend/src/app/docs/api-docs/api-docs-data.ts
index 621f14595..98da17d35 100644
--- a/frontend/src/app/docs/api-docs/api-docs-data.ts
+++ b/frontend/src/app/docs/api-docs/api-docs-data.ts
@@ -10042,7 +10042,7 @@ export const restApiDocsData = [
     category: "accelerator",
     httpRequestMethod: "GET",
     fragment: "accelerator-history",
-    title: "GET Acceleration History",
+    title: "GET Private Acceleration History",
     description: {
       default: "<p>Return the history of previous acceleration requests.</p><p>Pass one of the following for <code>:status</code>: <code>all</code>, <code>requested</code>, <code>accelerating</code>, <code>mined</code>, <code>completed</code>, <code>failed</code>.<br>Pass <code>true</code> in <code>:details</code> to get a detailed <code>history</code> of the acceleration request.</p>"
     },
@@ -10214,7 +10214,7 @@ export const restApiDocsData = [
     category: "accelerator",
     httpRequestMethod: "GET",
     fragment: "accelerator-public-history",
-    title: "GET Acceleration History",
+    title: "GET Public Acceleration History",
     description: {
       default: `<p>Return a list of accelerated transactions.
       Filters can be applied such as<ul>

From fbabd93b5e3d0085abf622c7ec6818bdae49cd94 Mon Sep 17 00:00:00 2001
From: nymkappa <1612910616@pm.me>
Date: Sun, 11 Feb 2024 12:01:09 +0100
Subject: [PATCH 7/7] Update frontend/src/app/docs/api-docs/api-docs-data.ts

Co-authored-by: hunicus <93150691+hunicus@users.noreply.github.com>
---
 frontend/src/app/docs/api-docs/api-docs-data.ts | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/frontend/src/app/docs/api-docs/api-docs-data.ts b/frontend/src/app/docs/api-docs/api-docs-data.ts
index 98da17d35..b28f45195 100644
--- a/frontend/src/app/docs/api-docs/api-docs-data.ts
+++ b/frontend/src/app/docs/api-docs/api-docs-data.ts
@@ -9888,7 +9888,7 @@ export const restApiDocsData = [
     fragment: "accelerator-deposit-history",
     title: "GET Deposit History",
     description: {
-      default: "<p>Returns a list of deposits made as prepayment for the accelerator service.</p>"
+      default: "<p>Returns a list of deposits the user has made as prepayment for the accelerator service.</p>"
     },
     urlString: "/v1/services/accelerator/deposit-history",
     showConditions: [""],
@@ -9936,7 +9936,7 @@ export const restApiDocsData = [
     fragment: "accelerator-balance",
     title: "GET Available Balance",
     description: {
-      default: "<p>Returns your currently available balance, currently locked funds, and total fees paid so far.</p>"
+      default: "<p>Returns the user's currently available balance, currently locked funds, and total fees paid so far.</p>"
     },
     urlString: "/v1/services/accelerator/balance",
     showConditions: [""],
@@ -10014,7 +10014,7 @@ export const restApiDocsData = [
     fragment: "accelerator-accelerate",
     title: "POST Accelerate A Transaction",
     description: {
-      default: "<p>Send a request to accelerate a transaction.</p>"
+      default: "<p>Sends a request to accelerate a transaction.</p>"
     },
     urlString: "/v1/services/accelerator/accelerate",
     showConditions: [""],
@@ -10044,7 +10044,7 @@ export const restApiDocsData = [
     fragment: "accelerator-history",
     title: "GET Private Acceleration History",
     description: {
-      default: "<p>Return the history of previous acceleration requests.</p><p>Pass one of the following for <code>:status</code>: <code>all</code>, <code>requested</code>, <code>accelerating</code>, <code>mined</code>, <code>completed</code>, <code>failed</code>.<br>Pass <code>true</code> in <code>:details</code> to get a detailed <code>history</code> of the acceleration request.</p>"
+      default: "<p>Returns the user's past acceleration requests.</p><p>Pass one of the following for <code>:status</code>: <code>all</code>, <code>requested</code>, <code>accelerating</code>, <code>mined</code>, <code>completed</code>, <code>failed</code>. Pass <code>true</code> in <code>:details</code> to get a detailed <code>history</code> of the acceleration request.</p>"
     },
     urlString: "/v1/services/accelerator/history?status=:status&details=:details",
     showConditions: [""],
@@ -10163,9 +10163,9 @@ export const restApiDocsData = [
     category: "accelerator",
     httpRequestMethod: "GET",
     fragment: "accelerator-pending",
-    title: "GET Pending Acceleration",
+    title: "GET Pending Accelerations",
     description: {
-      default: "<p>Return the list of currently accelerated transactions.</p>"
+      default: "<p>Returns all transactions currently being accelerated.</p>"
     },
     urlString: "/v1/services/accelerator/accelerations",
     showConditions: [""],
@@ -10216,8 +10216,8 @@ export const restApiDocsData = [
     fragment: "accelerator-public-history",
     title: "GET Public Acceleration History",
     description: {
-      default: `<p>Return a list of accelerated transactions.
-      Filters can be applied such as<ul>
+      default: `<p>Returns all past accelerated transactions.
+      Filters can be applied:<ul>
       <li><code>status</code>: <code>all</code>, <code>requested</code>, <code>accelerating</code>, <code>mined</code>, <code>completed</code>, <code>failed</code></li>
       <li><code>timeframe</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>, <code>all</code></li>
       <li><code>poolUniqueId</code>: any id from <a target="_blank" href="https://github.com/mempool/mining-pools/blob/master/pools-v2.json">https://github.com/mempool/mining-pools/blob/master/pools-v2.json</a>