Skip to content

Commit

Permalink
Replace from azure to github pages
Browse files Browse the repository at this point in the history
  • Loading branch information
NicolasDorier committed Nov 25, 2024
1 parent 8275c6e commit 0bf9492
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 17 deletions.
16 changes: 4 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ It has a bunch of features:

* Can pass arguments via environment variable, command line or configuration file
* Automatically reconnect to your node if the connection goes temporarily down
* An easy to use [REST API](https://nbxplorerdocs.z5.web.core.windows.net/)
* An easy to use [REST API](https://dgarage.github.io/NBXplorer/)
* Persistence via [Postgres](./docs/docs/Postgres-Schema.md)
* Connect via RPC to broadcast transaction instead of using the P2P protocol like this example
* Connect via RPC to your trusted node to get the proper fee rate.
Expand Down Expand Up @@ -49,7 +49,7 @@ It currently supports the following altcoins:
* Ufo
* Viacoin

Read our [API Specification](https://nbxplorerdocs.z5.web.core.windows.net/).
Read our [API Specification](https://dgarage.github.io/NBXplorer/).

## Prerequisite

Expand Down Expand Up @@ -101,7 +101,7 @@ Example, if you have ltc node and btc node on regtest (default configuration), a

## How to use the API?

Check [the API documentation](https://nbxplorerdocs.z5.web.core.windows.net/), you can then use any client library:
Check [the API documentation](https://dgarage.github.io/NBXplorer/), you can then use any client library:

* [NBXplorer.NodeJS](https://github.com/junderw/NBXplorer.NodeJS) for NodeJS clients.
* [NBXplorer.Client](https://www.nuget.org/packages/NBxplorer.Client) for .NET clients.
Expand Down Expand Up @@ -198,7 +198,7 @@ If you need to see old payments, you need to configure `--[crypto]startheight` t

[Postman](https://www.getpostman.com) is a useful tool for testing and experimenting with REST API's.

You can test the [NBXplorer API](https://nbxplorerdocs.z5.web.core.windows.net/) quickly and easily using Postman.
You can test the [NBXplorer API](https://dgarage.github.io/NBXplorer/) quickly and easily using Postman.

If you use cookie authentication (enabled by default) in your locally run NBXplorer, you need to set that up in Postman:

Expand Down Expand Up @@ -354,11 +354,3 @@ Then run the tests.
## Licence

This project is under MIT License.

## Special thanks

Special thanks to Digital Garage for allowing me to open source the project, which is based on an internal work I have done on Elements.

Thanks to the DG Lab Blockchain Team who had to fight with lots of bugs. (in particular kallewoof :p)

Thanks to Metaco SA, whose constant challenging projects refine my taste on what a perfect Bitcoin API should be.
10 changes: 5 additions & 5 deletions docs/API.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ NBXplorer is a multi crypto currency lightweight block explorer.

NBXplorer does not index the whole blockchain, rather, it listens transactions and blocks from a trusted full node and index only addresses and transactions which belongs to a `DerivationScheme` that you decide to track.

This document describes the concepts, while the [API endpoints are documented here](https://nbxplorerdocs.z5.web.core.windows.net/).
This document describes the concepts, while the [API endpoints are documented here](https://dgarage.github.io/NBXplorer/).

## Table of content

Expand Down Expand Up @@ -76,7 +76,7 @@ Note: Taproot is incompatible with all other options.

A derivation scheme tracked source's format is `DERIVATIONSCHEME:derivationScheme` (eg. `DERIVATIONSCHEME:xpub1`).

You can create one by calling [Tracking derivation scheme](https://nbxplorerdocs.z5.web.core.windows.net/#tag/Derivations/operation/Track).
You can create one by calling [Tracking derivation scheme](https://dgarage.github.io/NBXplorer/#tag/Derivations/operation/Track).

### <a name="groups"></a>Groups

Expand All @@ -87,19 +87,19 @@ Additionally, specific addresses can be tracked through the group.
Every address attached by a child tracked source will be added to the group, including all related UTXOs and transactions.

A group can have any number of children, and a group can also be a child of another group.
Please note that all the children are returned by [Get a group](https://nbxplorerdocs.z5.web.core.windows.net/#tag/Groups/operation/Get). As such, it is advised not to add too many children to avoid slowing down this call.
Please note that all the children are returned by [Get a group](https://dgarage.github.io/NBXplorer/#tag/Groups/operation/Get). As such, it is advised not to add too many children to avoid slowing down this call.

A group tracked source's format is `GROUP:groupid`.

You can create a new group by calling [Create a group](https://nbxplorerdocs.z5.web.core.windows.net/#tag/Groups/operation/Create).
You can create a new group by calling [Create a group](https://dgarage.github.io/NBXplorer/#tag/Groups/operation/Create).

### <a name="addresses"></a>Addresses

This refers to a tracked source that monitors a single address. It functions similarly to a group, but with only one specific address to it.

The address tracked source's format is `ADDRESS:bc1...`.

You can create one by calling [Tracking an address](https://nbxplorerdocs.z5.web.core.windows.net/#tag/Legacy/operation/TrackSingleAddress).
You can create one by calling [Tracking an address](https://dgarage.github.io/NBXplorer/#tag/Legacy/operation/TrackSingleAddress).

## Authentication

Expand Down

0 comments on commit 0bf9492

Please sign in to comment.