From bc020a4c7c68e7bcfcbf9f1b1f4f2c5dc7bd8ba6 Mon Sep 17 00:00:00 2001 From: Groxan <257Byte@gmail.com> Date: Fri, 25 Dec 2020 17:37:11 +0300 Subject: [PATCH] Update docs --- README.md | 20 +++++++++++++++----- Tzkt.Api/Description.md | 6 +++--- Tzkt.Api/Startup.cs | 6 +++--- 3 files changed, 21 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 02a166a83..563c31eea 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![Made With](https://img.shields.io/badge/made%20with-C%23-success.svg?)](https://docs.microsoft.com/en-gb/dotnet/csharp/language-reference/) [![License: MIT](https://img.shields.io/github/license/baking-bad/netezos.svg)](https://opensource.org/licenses/MIT) -TzKT is a lightweight Tezos blockchain indexer with an advanced API created by the [Baking Bad](https://baking-bad.org/docs) team with huge support from the [Tezos Foundation](https://tezos.foundation/). +TzKT is a lightweight [Tezos](https://tezos.com/) blockchain indexer with an advanced API created by the [Baking Bad](https://baking-bad.org/docs) team with huge support from the [Tezos Foundation](https://tezos.foundation/). The indexer fetches raw data from the Tezos node, then processes it and stores in the database in such a way as to provide effective access to the blockchain data. For example, getting operations by hash, or getting all operations of the particular account, or getting detailed baking rewards, etc. None of this can be accessed via node RPC, but TzKT indexer makes this data (and much more) available. @@ -254,9 +254,19 @@ dotnet Tzkt.Api.dll That's it. By default API is available on ports 5000 (HTTP) and 5001 (HTTPS). If you want to use HTTPS, you also need to configure certificates. If you want to run API on a different port, add the `"Kestrel"` section to the `appsettings.json` (see example below). -## Install Tzkt Indexer and API for Delphinet +## Install Tzkt Indexer and API for testnets -In general the steps are the same as for the mainnet, you just need to use different database, different snapshot and different appsettings (chain id and RPC endpoint). Anyway, let's do it from scratch. +In general the steps are the same as for the mainnet, you just need to use different database, different snapshot and different appsettings (chain id and RPC endpoint). Here are some presets for testnets: + - Delphinet: + - Snapshot: https://tzkt-snapshots.s3.eu-central-1.amazonaws.com/delphi_tzkt_148.backup + - RPC node: https://delphinet-tezos.giganode.io/ + - Chain id: NetXm8tYqnMWky1 + - Edonet: + - Snapshot: https://tzkt-snapshots.s3.eu-central-1.amazonaws.com/edo_tzkt_34.backup + - RPC node: https://edonet-tezos.giganode.io/ + - Chain id: NetXSp4gfdanies + +Anyway, let's do it, for reference, from scratch for the delphinet. ### Prepare database @@ -275,7 +285,7 @@ postgres=# \q ````c cd ~ -wget "https://tzkt-snapshots.s3.eu-central-1.amazonaws.com/delphi_tzkt_143.backup" -O delphi_tzkt_db.backup +wget "https://tzkt-snapshots.s3.eu-central-1.amazonaws.com/delphi_tzkt_148.backup" -O delphi_tzkt_db.backup ```` #### Restore database from the snapshot @@ -458,7 +468,7 @@ That's it. ## Have a question? Feel free to contact us via: -- Slack: https://tezos-dev.slack.com #baking-bad +- Slack: https://tezos-dev.slack.com/archives/CV5NX7F2L - Telegram: https://t.me/baking_bad_chat - Twitter: https://twitter.com/TezosBakingBad - Email: hello@baking-bad.org diff --git a/Tzkt.Api/Description.md b/Tzkt.Api/Description.md index ec31ed0d9..ac73ffd3b 100644 --- a/Tzkt.Api/Description.md +++ b/Tzkt.Api/Description.md @@ -17,8 +17,8 @@ by placing the label **"Powered by TzKT API"** with a direct link to [tzkt.io](h TzKT API is available for the following Tezos networks and on the following base URLs: - Mainnet: `https://api.tzkt.io/` or `https://api.mainnet.tzkt.io/` ([view docs](https://api.tzkt.io)) -- Carthagenet: `https://api.carthagenet.tzkt.io/` ([view docs](https://api.carthage.tzkt.io)) -- Delphinet: `https://api.delphinet.tzkt.io/` ([view docs](https://api.delphi.tzkt.io)) +- Delphinet: `https://api.delphinet.tzkt.io/` ([view docs](https://api.delphinet.tzkt.io)) +- Edonet: `https://api.edonet.tzkt.io/` ([view docs](https://api.edonet.tzkt.io)) ### Staging environment @@ -40,4 +40,4 @@ Feel free to ask any questions about TzKT Explorer and Tezos in general. Our tea - Email: hello@baking-bad.org - Twitter: https://twitter.com/TezosBakingBad - Telegram: [tg://resolve?domain=baking_bad_chat](tg://resolve?domain=baking_bad_chat) -- Slack: https://tezos-dev.slack.com #baking-bad +- Slack: https://tezos-dev.slack.com/archives/CV5NX7F2L diff --git a/Tzkt.Api/Startup.cs b/Tzkt.Api/Startup.cs index 919a0dc16..005372da1 100644 --- a/Tzkt.Api/Startup.cs +++ b/Tzkt.Api/Startup.cs @@ -77,7 +77,7 @@ public void ConfigureServices(IServiceCollection services) services.AddOpenApiDocument(options => { - options.DocumentName = "v1.2"; + options.DocumentName = "v1.3.1"; options.PostProcess = document => { document.Info.Title = "TzKT API"; @@ -85,7 +85,7 @@ public void ConfigureServices(IServiceCollection services) if (File.Exists("Description.md")) document.Info.Description = File.ReadAllText("Description.md"); - document.Info.Version = "v1.2"; + document.Info.Version = "v1.3.1"; document.Info.Contact = new NSwag.OpenApiContact { Name = "Baking Bad Team", @@ -119,7 +119,7 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env) app.UseOpenApi(options => { options.Path = "/v1/swagger.json"; - options.DocumentName = "v1.2"; + options.DocumentName = "v1.3.1"; }); app.UseRouting();