diff --git a/NBXplorer/wwwroot/api.json b/NBXplorer/wwwroot/api.json index 8a7e35934..71544ebf9 100644 --- a/NBXplorer/wwwroot/api.json +++ b/NBXplorer/wwwroot/api.json @@ -1195,6 +1195,7 @@ "/v1/cryptos/{cryptoCode}/derivations/{derivationScheme}/addresses/unused": { "get": { "summary": "Get a new unused address", + "operationId": "GetUnused", "description": "Retrieves a new unused address from the specified derivation scheme. This endpoint allows you to generate new addresses for receiving funds, ensuring that you do not reuse addresses.", "tags": [ "Derivations" @@ -1297,6 +1298,7 @@ "/v1/cryptos/{cryptoCode}/derivations/{derivationScheme}/psbt/create": { "post": { "summary": "Create a PSBT", + "operationId": "CreatePSBT", "description": "A [Partially Signed Bitcoin Transaction (PSBT)](https://github.com/bitcoin/bips/blob/master/bip-0174.mediawiki) is a standard format to represent a transaction with pending signatures associated to it. A PSBT can be signed independently by many signers, and combined together before broadcast.", "tags": [ "Derivations" @@ -1441,6 +1443,7 @@ }, "post": { "summary": "Generate a hot wallet", + "operationId": "GenerateWallet", "description": "NBXplorer will generate and save a mnemonic and create a derivationScheme.", "tags": [ "Derivations" @@ -1923,6 +1926,7 @@ "/v1/cryptos/{cryptoCode}/derivations/{derivationScheme}/transactions": { "get": { "summary": "Get transactions for a derivation scheme", + "operationId": "ListTransactionDerivationScheme", "description": "Retrieves a list of transactions associated with the specified derivation scheme (wallet).", "tags": [ "Derivations", @@ -2071,6 +2075,7 @@ "/v1/cryptos/{cryptoCode}/derivations/{derivationScheme}/utxos": { "get": { "summary": "Get UTXOs for a derivation scheme", + "operationId": "ListUTXOsDerivationScheme", "description": "Retrieves the list of unspent transaction outputs (UTXOs) associated with the specified derivation scheme.", "tags": [ "Derivations" @@ -2390,6 +2395,7 @@ "/v1/cryptos/{cryptoCode}/connect": { "get": { "summary": "WebSocket connection for events", + "operationId": "WebSocket", "description": "Establishes a WebSocket connection to receive real-time events for the specified cryptocurrency. (Check [Query Event Stream for the data format](#tag/Events/operation/EventStream))", "tags": [ "Events" @@ -2501,6 +2507,7 @@ "/v1/cryptos/{cryptoCode}/events/latest": { "get": { "summary": "Query event stream from most recent", + "operationId": "GetLatest", "tags": [ "Events" ], @@ -3717,6 +3724,7 @@ "/v1/cryptos/{cryptoCode}/broadcast": { "post": { "summary": "Broadcast a transaction", + "operationId": "Broadcast", "description": "Broadcasts a raw transaction to the network for the specified cryptocurrency.", "tags": [ "Transactions" diff --git a/README.md b/README.md index 819628c37..46043db7c 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,21 @@ The explorer supports P2SH,P2PKH,P2WPKH,P2WSH and Multi-sig derivation. This explorer is not meant to be exposed on internet, but should be used as an internal tool for tracking the UTXOs of your own service. -It has a bunch of features: +## Typical usage + +You start by [Creating a wallet (hot wallet)](https://dgarage.github.io/NBXplorer/#tag/Derivations/operation/GenerateWallet), or [Tracking a derivation scheme (cold wallet)](https://dgarage.github.io/NBXplorer/#tag/Derivations/operation/Track). + +Second, [Get the next unused address](https://dgarage.github.io/NBXplorer/#tag/Derivations/operation/GetUnused) to get paid. + +Listen to events through [Polling](https://dgarage.github.io/NBXplorer/#tag/Events/operation/GetLatest), [Long Polling](https://dgarage.github.io/NBXplorer/#tag/Events/operation/EventStream) or [Web Sockets](https://dgarage.github.io/NBXplorer/#tag/Events/operation/WebSocket). + +You can then [List transactions](https://dgarage.github.io/NBXplorer/#tag/Derivations/operation/ListTransactionDerivationScheme), [List UTXOs](https://dgarage.github.io/NBXplorer/#tag/Derivations/operation/ListUTXOsDerivationScheme), or [Create a PSBT](https://dgarage.github.io/NBXplorer/#tag/Derivations/operation/CreatePSBT) for your app to sign. + +When the transaction is signed, [Broadcast it](https://dgarage.github.io/NBXplorer/#tag/Transactions/operation/Broadcast). + +You can also track multiple derivation schemes or individual addresses by [Creating a group](https://dgarage.github.io/NBXplorer/#tag/Groups/operation/Create). + +## General features * Can pass arguments via environment variable, command line or configuration file * Automatically reconnect to your node if the connection goes temporarily down diff --git a/docs/API.md b/docs/API.md index c7eff3096..cb7505d27 100644 --- a/docs/API.md +++ b/docs/API.md @@ -120,4 +120,3 @@ The content of this cookie must be used is used as HTTP BASIC authentication to This can be disabled with `--noauth` or `NBXPLORER_NOAUTH=1`. Also, NBXPlorer listen by default on `127.0.0.1`, if you want to access it from another machine, run `--bind "0.0.0.0"`. -