From 75acbbfc55c382658bdd7c6523e65fb12c11ef67 Mon Sep 17 00:00:00 2001 From: 257Byte <257Byte@gmail.com> Date: Thu, 3 Feb 2022 14:32:02 +0300 Subject: [PATCH] Update docs and default configs --- README.md | 29 ++++++++++++++++++----------- Tzkt.Api/Swagger/Description.md | 4 ++-- Tzkt.Sync/appsettings.json | 4 ++-- 3 files changed, 22 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 453ecf604..8bd56bbbc 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](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/). +TzKT is the most advanced [Tezos](https://tezos.com/) blockchain indexer with powerful 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. @@ -155,6 +155,15 @@ Like this: "FilePath": "sync.health" }, + "TokenMetadata": { + "Enabled": false, + "DipDupUrl": "https://metadata.dipdup.net/v1/graphql", + "Network": "mainnet", + "BatchSize": 10000, + "PeriodSec": 30, + "OverriddenMetadata": [] + }, + "Logging": { "LogLevel": { "Default": "Information", @@ -217,7 +226,8 @@ Like this: "MaxConnections": 1000, "MaxOperationSubscriptions": 50, "MaxBigMapSubscriptions": 50, - "MaxAccountsSubscriptions": 50 + "MaxAccountsSubscriptions": 50, + "MaxTokenTransfersSubscriptions": 50 }, "ConnectionStrings": { @@ -284,27 +294,24 @@ That's it. By default API is available on ports 5000 (HTTP) and 5001 (HTTPS). If ## Install Tzkt Indexer and API for testnets In general the steps are the same as for the mainnet, you just need to use different RPC endpoint and DB snapshot. Here are some presets for testnets: - - Granadanet: - - Snapshot: https://tzkt.fra1.digitaloceanspaces.com/snapshots/tzkt_v1.7_granadanet.backup - - RPC node: https://rpc.tzkt.io/granadanet/ - Hangzhou2net: - Snapshot: https://tzkt.fra1.digitaloceanspaces.com/snapshots/tzkt_v1.7_hangzhou2net.backup - RPC node: https://rpc.tzkt.io/hangzhou2net/ ### Testnet installation using docker containers -First of all, install `git`, `make`, `docker`, `docker-compose`, then run the following commands (commands provided for Granadanet, for Hangzhou2net use the `hangzhou-` prefix): +First of all, install `git`, `make`, `docker`, `docker-compose`, then run the following commands: ````sh git clone https://github.com/baking-bad/tzkt.git cd tzkt/ -make granada-init #run this command if you want to restore the DB from the latest snapshot -make granada-start -# for hangzhou2net used port 5020 -curl http://127.0.0.1:5010/v1/head +make hangzhou-init #run this command if you want to restore the DB from the latest snapshot +make hangzhou-start + +curl http://127.0.0.1:5020/v1/head -make granada-stop +make hangzhou-stop ```` ## Have a question? diff --git a/Tzkt.Api/Swagger/Description.md b/Tzkt.Api/Swagger/Description.md index 386eb88ab..48cac88be 100644 --- a/Tzkt.Api/Swagger/Description.md +++ b/Tzkt.Api/Swagger/Description.md @@ -29,8 +29,8 @@ And don't forget to star TzKT project [on GitHub](https://github.com/baking-bad/ TzKT API is free for everyone and for both commercial and non-commercial usage. If your application or service uses the TzKT API in any forms: directly on frontend or indirectly on backend, -you should mention that fact on your website or application by placing the label -**"Powered by TzKT API"** with a direct link to [tzkt.io](https://tzkt.io). +you must mention that fact on your website or application by placing the label +**"Powered by TzKT API"** or **"Built with TzKT API"** with a direct link to [tzkt.io](https://tzkt.io). # Rate Limits diff --git a/Tzkt.Sync/appsettings.json b/Tzkt.Sync/appsettings.json index 8ecbc6124..b92c84492 100644 --- a/Tzkt.Sync/appsettings.json +++ b/Tzkt.Sync/appsettings.json @@ -26,8 +26,8 @@ "Enabled": false, "DipDupUrl": "https://metadata.dipdup.net/v1/graphql", "Network": "mainnet", - "BatchSize": 100, - "PeriodSec": 60, + "BatchSize": 10000, + "PeriodSec": 30, "OverriddenMetadata": [] }, "Logging": {