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 ccc5b329e..48cdd2f3d 100644 --- a/frontend/src/app/docs/api-docs/api-docs-data.ts +++ b/frontend/src/app/docs/api-docs/api-docs-data.ts @@ -2649,6 +2649,508 @@ export const restApiDocsData = [ } } }, + { + type: 'category', + category: 'accelerator-public', + fragment: 'accelerator-public', + title: 'Accelerator (Public)', + showConditions: [''], + options: { officialOnly: true }, + }, + { + options: { officialOnly: true }, + type: 'endpoint', + category: 'accelerator-public', + httpRequestMethod: 'POST', + fragment: 'accelerator-estimate', + title: 'POST Calculate Estimated Costs', + description: { + default: '
Returns estimated costs to accelerate a transaction. Optionally set the X-Mempool-Auth header to get customized estimation.
Request a LN invoice to accelerate a transaction.
' + }, + urlString: '/v1/services/payments/bitcoin', + showConditions: [''], + showJsExamples: showJsExamplesDefaultFalse, + codeExample: { + default: { + codeTemplate: { + curl: `%{1}" "[[hostname]][[baseNetworkUrl]]/api/v1/services/payments/bitcoin`, //custom interpolation technique handled in replaceCurlPlaceholder() + commonJS: ``, + esModule: `` + }, + codeSampleMainnet: { + esModule: [], + commonJS: [], + curl: ['product=ee13ebb99632377c15c94980357f674d285ac413452050031ea6dcd3e9b2dc29&amount=12500'], + headers: '', + response: `[ + { + "btcpayInvoiceId": "4Ww53d7VgSa596jmCFufe7", + "btcDue": "0.000625", + "addresses": { + "BTC": "bc1qcvqx2kr5mktd7gvym0atrrx0sn27mwv5kkghl3m78kegndm5t8ksvcqpja", + "BTC_LNURLPAY": null, + "BTC_LightningLike": "lnbc625u1pngl0wzpp56j7cqghsw2y5q7vdu9shmpxgpzsx4pqra4wcm9vdnvqegutplk2qdxj2pskjepqw3hjqnt9d4cx7mmvypqkxcm9d3jhyct5daezq2z0wfjx2u3qf9zr5grpvd3k2mr9wfshg6t0dckk2ef3xdjkyc3e8ymrxv3nxumkxvf4vvungwfcxqen2dmxxcmngepj8q6kzce5xyengdfjxq6nqvpnx9jkzdnyvdjrxefevgexgcej8yknzdejxqmrjd3jx5mrgdpj9ycqzpuxqrpr5sp58593dzj2uauaj3afa7x47qeam8k9yyqrh9qasj2ssdzstew6qv3q9qxpqysgqj8qshfkxmj0gfkly5xfydysvsx55uhnc6fgpw66uf6hl8leu07454axe2kq0q788yysg8guel2r36d6f75546nkhmdcmec4mmlft8dsq62rnsj" + } + } +]`, + }, + } + } + }, + { + options: { officialOnly: true }, + type: 'endpoint', + category: 'accelerator-public', + httpRequestMethod: 'GET', + fragment: 'accelerator-pending', + title: 'GET Pending Accelerations', + description: { + default: 'Returns all transactions currently being accelerated.
' + }, + 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-public', + httpRequestMethod: 'GET', + fragment: 'accelerator-public-history', + title: 'GET Acceleration History', + description: { + default: `Returns all past accelerated transactions. + Filters can be applied:
status: all, requested, accelerating, mined, completed, failedtimeframe: 24h, 3d, 1w, 1m, 3m, 6m, 1y, 2y, 3y, 4y, allminedByPoolUniqueId: any id from pools-v2.json
+ blockHash: a block hash
+ blockHeight: a block height
+ page: the requested page number if using pagination (min: 1)
+ pageLength: the page lenght if using pagination (min: 1, max: 50)
+ from: unix timestamp (overrides timeframe)
+ to: unix timestamp (overrides timeframe)
+ Returns a list of top ups the user has made as prepayment for the accelerator service.
' + }, + urlString: '/v1/services/accelerator/top-up-history', + showConditions: [''], + showJsExamples: showJsExamplesDefaultFalse, + codeExample: { + default: { + codeTemplate: { + curl: `/api/v1/services/accelerator/top-up-history`, + commonJS: ``, + esModule: `` + }, + codeSampleMainnet: { + esModule: [], + commonJS: [], + curl: [], + headers: 'X-Mempool-Auth: 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-private', + httpRequestMethod: 'GET', + fragment: 'accelerator-balance', + title: 'GET Available Balance', + description: { + default: 'Returns the user\'s currently available balance, currently locked funds, and total fees paid so far.
' + }, + urlString: '/v1/services/accelerator/balance', + showConditions: [''], + showJsExamples: showJsExamplesDefaultFalse, + codeExample: { + default: { + codeTemplate: { + curl: `/api/v1/services/accelerator/balance`, + commonJS: ``, + esModule: `` + }, + codeSampleMainnet: { + esModule: [], + commonJS: [], + curl: [], + headers: 'X-Mempool-Auth: stacksats', + response: `{ + "balance": 99900000, + "hold": 101829, + "feesPaid": 133721 +}`, + }, + } + } + }, + { + options: { officialOnly: true }, + type: 'endpoint', + category: 'accelerator-private', + httpRequestMethod: 'POST', + fragment: 'accelerator-accelerate', + title: 'POST Accelerate A Transaction (Pro)', + description: { + default: 'Sends a request to accelerate a transaction.
' + }, + urlString: '/v1/services/accelerator/accelerate', + showConditions: [''], + 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: 'X-Mempool-Auth: stacksats', + response: `HTTP/1.1 200 OK`, + }, + } + } + }, + { + options: { officialOnly: true }, + type: 'endpoint', + category: 'accelerator-private', + httpRequestMethod: 'GET', + fragment: 'accelerator-history', + title: 'GET Acceleration History', + description: { + default: 'Returns the user\'s past acceleration requests.
Pass one of the following for :status (required): all, requested, accelerating, mined, completed, failed.
Pass true in :details to get a detailed history of the acceleration request.
Sends a request to cancel an acceleration in the accelerating status.
You can retrieve eligible acceleration id using the history endpoint GET /api/v1/services/accelerator/history?status=accelerating.'
+ },
+ urlString: '/v1/services/accelerator/cancel',
+ showConditions: [''],
+ showJsExamples: showJsExamplesDefaultFalse,
+ codeExample: {
+ default: {
+ codeTemplate: {
+ curl: `%{1}" "[[hostname]][[baseNetworkUrl]]/api/v1/services/accelerator/cancel`, //custom interpolation technique handled in replaceCurlPlaceholder()
+ commonJS: ``,
+ esModule: ``
+ },
+ codeSampleMainnet: {
+ esModule: [],
+ commonJS: [],
+ curl: ['id=42'],
+ headers: 'X-Mempool-Auth: stacksats',
+ response: `HTTP/1.1 200 OK`,
+ },
+ }
+ }
+ },
{
type: 'category',
category: 'addresses',
@@ -11949,508 +12451,6 @@ export const restApiDocsData = [
}
}
},
- {
- type: 'category',
- category: 'accelerator-public',
- fragment: 'accelerator-public',
- title: 'Accelerator (Public)',
- showConditions: [''],
- options: { officialOnly: true },
- },
- {
- options: { officialOnly: true },
- type: 'endpoint',
- category: 'accelerator-public',
- httpRequestMethod: 'POST',
- fragment: 'accelerator-estimate',
- title: 'POST Calculate Estimated Costs',
- description: {
- default: '
Returns estimated costs to accelerate a transaction. Optionally set the X-Mempool-Auth header to get customized estimation.
Request a LN invoice to accelerate a transaction.
' - }, - urlString: '/v1/services/payments/bitcoin', - showConditions: [''], - showJsExamples: showJsExamplesDefaultFalse, - codeExample: { - default: { - codeTemplate: { - curl: `%{1}" "[[hostname]][[baseNetworkUrl]]/api/v1/services/payments/bitcoin`, //custom interpolation technique handled in replaceCurlPlaceholder() - commonJS: ``, - esModule: `` - }, - codeSampleMainnet: { - esModule: [], - commonJS: [], - curl: ['product=ee13ebb99632377c15c94980357f674d285ac413452050031ea6dcd3e9b2dc29&amount=12500'], - headers: '', - response: `[ - { - "btcpayInvoiceId": "4Ww53d7VgSa596jmCFufe7", - "btcDue": "0.000625", - "addresses": { - "BTC": "bc1qcvqx2kr5mktd7gvym0atrrx0sn27mwv5kkghl3m78kegndm5t8ksvcqpja", - "BTC_LNURLPAY": null, - "BTC_LightningLike": "lnbc625u1pngl0wzpp56j7cqghsw2y5q7vdu9shmpxgpzsx4pqra4wcm9vdnvqegutplk2qdxj2pskjepqw3hjqnt9d4cx7mmvypqkxcm9d3jhyct5daezq2z0wfjx2u3qf9zr5grpvd3k2mr9wfshg6t0dckk2ef3xdjkyc3e8ymrxv3nxumkxvf4vvungwfcxqen2dmxxcmngepj8q6kzce5xyengdfjxq6nqvpnx9jkzdnyvdjrxefevgexgcej8yknzdejxqmrjd3jx5mrgdpj9ycqzpuxqrpr5sp58593dzj2uauaj3afa7x47qeam8k9yyqrh9qasj2ssdzstew6qv3q9qxpqysgqj8qshfkxmj0gfkly5xfydysvsx55uhnc6fgpw66uf6hl8leu07454axe2kq0q788yysg8guel2r36d6f75546nkhmdcmec4mmlft8dsq62rnsj" - } - } -]`, - }, - } - } - }, - { - options: { officialOnly: true }, - type: 'endpoint', - category: 'accelerator-public', - httpRequestMethod: 'GET', - fragment: 'accelerator-pending', - title: 'GET Pending Accelerations', - description: { - default: 'Returns all transactions currently being accelerated.
' - }, - 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-public', - httpRequestMethod: 'GET', - fragment: 'accelerator-public-history', - title: 'GET Acceleration History', - description: { - default: `Returns all past accelerated transactions. - Filters can be applied:
status: all, requested, accelerating, mined, completed, failedtimeframe: 24h, 3d, 1w, 1m, 3m, 6m, 1y, 2y, 3y, 4y, allminedByPoolUniqueId: any id from pools-v2.json
- blockHash: a block hash
- blockHeight: a block height
- page: the requested page number if using pagination (min: 1)
- pageLength: the page lenght if using pagination (min: 1, max: 50)
- from: unix timestamp (overrides timeframe)
- to: unix timestamp (overrides timeframe)
- Returns a list of top ups the user has made as prepayment for the accelerator service.
' - }, - urlString: '/v1/services/accelerator/top-up-history', - showConditions: [''], - showJsExamples: showJsExamplesDefaultFalse, - codeExample: { - default: { - codeTemplate: { - curl: `/api/v1/services/accelerator/top-up-history`, - commonJS: ``, - esModule: `` - }, - codeSampleMainnet: { - esModule: [], - commonJS: [], - curl: [], - headers: 'X-Mempool-Auth: 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-private', - httpRequestMethod: 'GET', - fragment: 'accelerator-balance', - title: 'GET Available Balance', - description: { - default: 'Returns the user\'s currently available balance, currently locked funds, and total fees paid so far.
' - }, - urlString: '/v1/services/accelerator/balance', - showConditions: [''], - showJsExamples: showJsExamplesDefaultFalse, - codeExample: { - default: { - codeTemplate: { - curl: `/api/v1/services/accelerator/balance`, - commonJS: ``, - esModule: `` - }, - codeSampleMainnet: { - esModule: [], - commonJS: [], - curl: [], - headers: 'X-Mempool-Auth: stacksats', - response: `{ - "balance": 99900000, - "hold": 101829, - "feesPaid": 133721 -}`, - }, - } - } - }, - { - options: { officialOnly: true }, - type: 'endpoint', - category: 'accelerator-private', - httpRequestMethod: 'POST', - fragment: 'accelerator-accelerate', - title: 'POST Accelerate A Transaction (Pro)', - description: { - default: 'Sends a request to accelerate a transaction.
' - }, - urlString: '/v1/services/accelerator/accelerate', - showConditions: [''], - 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: 'X-Mempool-Auth: stacksats', - response: `HTTP/1.1 200 OK`, - }, - } - } - }, - { - options: { officialOnly: true }, - type: 'endpoint', - category: 'accelerator-private', - httpRequestMethod: 'GET', - fragment: 'accelerator-history', - title: 'GET Acceleration History', - description: { - default: 'Returns the user\'s past acceleration requests.
Pass one of the following for :status (required): all, requested, accelerating, mined, completed, failed.
Pass true in :details to get a detailed history of the acceleration request.
Sends a request to cancel an acceleration in the accelerating status.
You can retrieve eligible acceleration id using the history endpoint GET /api/v1/services/accelerator/history?status=accelerating.'
- },
- urlString: '/v1/services/accelerator/cancel',
- showConditions: [''],
- showJsExamples: showJsExamplesDefaultFalse,
- codeExample: {
- default: {
- codeTemplate: {
- curl: `%{1}" "[[hostname]][[baseNetworkUrl]]/api/v1/services/accelerator/cancel`, //custom interpolation technique handled in replaceCurlPlaceholder()
- commonJS: ``,
- esModule: ``
- },
- codeSampleMainnet: {
- esModule: [],
- commonJS: [],
- curl: ['id=42'],
- headers: 'X-Mempool-Auth: stacksats',
- response: `HTTP/1.1 200 OK`,
- },
- }
- }
- },
];
export const faqData = [