Skip to content

Commit b1c9334

Browse files
softsimonsoftsimon
committed
Changing API path and updating API Docs for asset icons.
1 parent a456978 commit b1c9334

File tree

4 files changed

+84
-20
lines changed

4 files changed

+84
-20
lines changed

‎backend/src/index.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -272,8 +272,8 @@ class Server {
272272

273273
if (config.MEMPOOL.NETWORK === 'liquid') {
274274
this.app
275-
.get(config.MEMPOOL.API_URL_PREFIX + 'liquid/icons', routes.getAllLiquidIcon)
276-
.get(config.MEMPOOL.API_URL_PREFIX + 'liquid/icon/:assetId', routes.getLiquidIcon)
275+
.get(config.MEMPOOL.API_URL_PREFIX + 'assets/icons', routes.getAllLiquidIcon)
276+
.get(config.MEMPOOL.API_URL_PREFIX + 'asset/:assetId/icon', routes.getLiquidIcon)
277277
;
278278
}
279279

‎frontend/src/app/components/docs/api-docs-nav.component.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,10 @@
3030
<ng-template [ngIf]="network.val === 'liquid'">
3131
<p>Assets</p>
3232
<a [routerLink]="['./']" fragment="get-assets" (click)="collapseItem.toggle()">GET Assets</a>
33+
<a [routerLink]="['./']" fragment="get-assets-icons" (click)="collapseItem.toggle()">GET Assets Icons</a>
3334
<a [routerLink]="['./']" fragment="get-asset-transactions" (click)="collapseItem.toggle()">GET Asset Transactions</a>
3435
<a [routerLink]="['./']" fragment="get-asset-supply" (click)="collapseItem.toggle()">GET Asset Supply</a>
36+
<a [routerLink]="['./']" fragment="get-asset-icon" (click)="collapseItem.toggle()">GET Asset Icon</a>
3537
</ng-template>
3638

3739
<p>Blocks</p>

‎frontend/src/app/components/docs/api-docs.component.html

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -275,6 +275,32 @@
275275
<app-code-template [hostname]="hostname" [code]="code.assetSupply" [network]="network.val" ></app-code-template>
276276
</div>
277277

278+
<div class="endpoint-container" id="get-assets-icons">
279+
<a class="section-header" [routerLink]="['./']" fragment="get-assets-icons">GET Asset Icons <span>Assets</span></a>
280+
<div class="endpoint">
281+
<div class="subtitle" i18n="Api docs endpoint">Endpoint</div>
282+
<a [href]="wrapUrl(network.val, code.assetIcons)" target="_blank">GET /liquid/api/v1/assets/icons</a>
283+
</div>
284+
<div class="description">
285+
<div class="subtitle" i18n>Description</div>
286+
<div>Get all the Asset IDs that has icons.</div>
287+
</div>
288+
<app-code-template [hostname]="hostname" [code]="code.assetIcons" [network]="network.val" ></app-code-template>
289+
</div>
290+
291+
<div class="endpoint-container" id="get-asset-icon">
292+
<a class="section-header" [routerLink]="['./']" fragment="get-asset-icon">GET Asset Icon <span>Assets</span></a>
293+
<div class="endpoint">
294+
<div class="subtitle" i18n="Api docs endpoint">Endpoint</div>
295+
<a [href]="wrapUrl(network.val, code.assetIcon)" target="_blank">GET /liquid/api/v1/asset/:asset_id/icon</a>
296+
</div>
297+
<div class="description">
298+
<div class="subtitle" i18n>Description</div>
299+
<div>Get the icon of the specified asset.</div>
300+
</div>
301+
<app-code-template [hostname]="hostname" [code]="code.assetIcon" [network]="network.val" ></app-code-template>
302+
</div>
303+
278304
</div>
279305

280306
<div class="api-category">

‎frontend/src/app/components/docs/api-docs.component.ts

Lines changed: 54 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -642,24 +642,6 @@ export class ApiDocsComponent implements OnInit {
642642
console.log(asset);
643643
`,
644644
},
645-
codeSampleMainnet: {
646-
esModule: [],
647-
commonJS: [],
648-
curl: [],
649-
response: ''
650-
},
651-
codeSampleTestnet: {
652-
esModule: [],
653-
commonJS: [],
654-
curl: [],
655-
response: ''
656-
},
657-
codeSampleSignet: {
658-
esModule: [],
659-
commonJS: [],
660-
curl: [],
661-
response: ''
662-
},
663645
codeSampleLiquid: {
664646
esModule: [`6f0279e9ed041c3d710a9f57d0c02928416460c4b722ae3457a11eec381c526d`],
665647
commonJS: [`6f0279e9ed041c3d710a9f57d0c02928416460c4b722ae3457a11eec381c526d`],
@@ -693,6 +675,60 @@ export class ApiDocsComponent implements OnInit {
693675
response: ''
694676
},
695677
},
678+
assetIcons: {
679+
codeTemplate: {
680+
curl: `/api/v1/assets/icons`,
681+
commonJS: `
682+
const { %{0}: { assets } } = mempoolJS();
683+
684+
const assetsIcons = await assets.getAssetsIcons();
685+
686+
document.getElementById("result").textContent = JSON.stringify(assetsIcons, undefined, 2);
687+
`,
688+
esModule: `
689+
const { %{0}: { assets } } = mempoolJS();
690+
691+
const assetsIcons = await assets.getAssetsIcons();
692+
console.log(assetsIcons);
693+
`,
694+
},
695+
codeSampleLiquid: {
696+
esModule: [`6f0279e9ed041c3d710a9f57d0c02928416460c4b722ae3457a11eec381c526d`],
697+
commonJS: [`6f0279e9ed041c3d710a9f57d0c02928416460c4b722ae3457a11eec381c526d`],
698+
curl: [`6f0279e9ed041c3d710a9f57d0c02928416460c4b722ae3457a11eec381c526d`],
699+
response: `[
700+
"6f0279e9ed041c3d710a9f57d0c02928416460c4b722ae3457a11eec381c526d",
701+
"ce091c998b83c78bb71a632313ba3760f1763d9cfcffae02258ffa9865a37bd2"
702+
...
703+
]`,
704+
},
705+
},
706+
assetIcon: {
707+
codeTemplate: {
708+
curl: `/api/v1/asset/%{1}/icon`,
709+
commonJS: `
710+
const { %{0}: { assets } } = mempoolJS();
711+
712+
const asset_id = '%{1}';
713+
const assetIcon = await assets.getAssetIcon({ asset_id });
714+
715+
document.getElementById("result").textContent = JSON.stringify(assetIcon, undefined, 2);
716+
`,
717+
esModule: `
718+
const { %{0}: { assets } } = mempoolJS();
719+
720+
const asset_id = '%{1}';
721+
const assetIcon = await assets.getAssetIcon({ asset_id });
722+
console.log(assetIcon);
723+
`,
724+
},
725+
codeSampleLiquid: {
726+
esModule: [`6f0279e9ed041c3d710a9f57d0c02928416460c4b722ae3457a11eec381c526d`],
727+
commonJS: [`6f0279e9ed041c3d710a9f57d0c02928416460c4b722ae3457a11eec381c526d`],
728+
curl: [`6f0279e9ed041c3d710a9f57d0c02928416460c4b722ae3457a11eec381c526d`],
729+
response: `PNG`,
730+
},
731+
},
696732
assetTransactions: {
697733
codeTemplate: {
698734
curl: `/api/asset/%{1}/txs`,

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy