Skip to content

Commit

Permalink
Update snapshots
Browse files Browse the repository at this point in the history
  • Loading branch information
Groxan committed Mar 3, 2021
1 parent ef0e184 commit 36a8f49
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 13 deletions.
2 changes: 1 addition & 1 deletion Dockerfile-snapshot
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
FROM cirrusci/wget

RUN wget "https://tzkt-snapshots.s3.eu-central-1.amazonaws.com/tzkt_1.3.2.backup" -O tzkt_db.backup
RUN wget "https://tzkt-snapshots.s3.eu-central-1.amazonaws.com/tzkt_v1.4.backup" -O tzkt_db.backup
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The indexer fetches raw data from the Tezos node, then processes it and stores i
- **More detailed data.** TzKT not only collects blockchain data, but also processes and extends it with unique properties or even entities. For example, TzKT was the first indexer introduced synthetic operation types such as "migration" or "revelation penalty", which fill in the gaps in account history (because this data is missed in the blockchain), and the only indexer that correctly distinguishes smart contracts among all contracts.
- **Data quality comes first!** You will never see an incorrect account balance, or total rolls, or missed operations, etc. TzKT was built by professionals who know Tezos from A to Z (or, in other words, from TZ to KT 😼).
- **Advanced API.** TzKT provides a REST-like API, so you don't have to connect to the database directly. In addition to basic data access TzKT API has a lot of cool features such as exporting account statements, calculating historical balances (at any block), injecting metadata and much more. See the [API documentation](https://api.tzkt.io), automatically generated using Swagger (Open API 3 specification).
- **Websocket API.** TzKT allows subscribing to various blockchain events, such as new block or new transaction, and receive data immediately via websocket. TzKT uses SignalR, which is very easy to use and for which there are many client libraries for different languages.
- **WebSocket API.** TzKT allows to subscribe to real-time blockchain data, such as new blocks or new operations, etc. via WebSocket. TzKT uses SignalR, which is very easy to use and for which there are many client libraries for different languages.
- **Low resource consumption.** TzKT is fairly lightweight. The indexer consumes up to 128MB of RAM, and the API up to 256MB-1024MB, depending on the configured cache size.
- **No local node needed.** TzKT indexer works well even with remote RPC node. By default it uses [tezos.giganode.io](https://tezos.giganode.io/), the most performant public RPC node in Tezos, which is more than enough for most cases.
- **Quick start.** Indexer bootstrap takes ~15 minutes by using snapshots publicly available for all supported networks. Of course, you can run full synchronization from scratch as well.
Expand Down Expand Up @@ -87,7 +87,7 @@ postgres=# \q
#### Download fresh snapshot

````c
wget "https://tzkt-snapshots.s3.eu-central-1.amazonaws.com/tzkt_329.backup" -O /tmp/tzkt_db.backup
wget "https://tzkt-snapshots.s3.eu-central-1.amazonaws.com/tzkt_v1.4.backup" -O /tmp/tzkt_db.backup
````

#### Restore database from the snapshot
Expand Down Expand Up @@ -259,12 +259,12 @@ That's it. By default API is available on ports 5000 (HTTP) and 5001 (HTTPS). If

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/
- Snapshot: https://tzkt-snapshots.s3.eu-central-1.amazonaws.com/delphi_tzkt_v1.4.backup
- RPC node: https://rpc.tzkt.io/delphinet/
- 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/
- Snapshot: https://tzkt-snapshots.s3.eu-central-1.amazonaws.com/edo2_tzkt_v1.4.backup
- RPC node: https://rpc.tzkt.io/edo2net/
- Chain id: NetXSp4gfdanies

Anyway, let's do it, for reference, from scratch for the delphinet.
Expand All @@ -285,7 +285,7 @@ postgres=# \q
#### Download fresh snapshot

````c
wget "https://tzkt-snapshots.s3.eu-central-1.amazonaws.com/delphi_tzkt_148.backup" -O /tmp/delphi_tzkt_db.backup
wget "https://tzkt-snapshots.s3.eu-central-1.amazonaws.com/delphi_tzkt_v1.4.backup" -O /tmp/delphi_tzkt_db.backup
````

#### Restore database from the snapshot
Expand Down
2 changes: 1 addition & 1 deletion Tzkt.Api/Swagger/Description.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Introduction

TzKT Explorer provides a free REST-like API and Websocket API for accessing detailed Tezos blockchain data and helps developers build more services and applications on top of Tezos.
TzKT Explorer provides a free REST-like API and WebSocket API for accessing detailed Tezos blockchain data and helps developers build more services and applications on top of Tezos.
TzKT is an open-source project, so you can easily clone and build it and use it as a self-hosted service to avoid any risks depending on third-party services.

TzKT API is available for the following Tezos networks with the following base URLs:
Expand Down
4 changes: 2 additions & 2 deletions Tzkt.Api/Swagger/Swagger.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ namespace Tzkt.Api.Swagger
{
public static class Swagger
{
const string Version = "v1.4.0-preview1";
const string Version = "v1.4";
const string Path = "/v1/swagger.json";

public static void AddOpenApiDocument(this IServiceCollection services)
Expand Down Expand Up @@ -66,7 +66,7 @@ public static void AddOpenApiDocument(this IServiceCollection services)
},
new
{
name = "Websocket API",
name = "WebSocket API",
tags = document.Tags.Select(x => x.Name).ToList()
}
}
Expand Down
4 changes: 2 additions & 2 deletions Tzkt.Api/Swagger/WsGetStarted.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
TzKT Events is a Websocket API based on [SignalR](https://docs.microsoft.com/aspnet/signalr/overview/getting-started/introduction-to-signalr)
TzKT Events is a WebSocket API based on [SignalR](https://docs.microsoft.com/aspnet/signalr/overview/getting-started/introduction-to-signalr)
that enables receiving data from the Tezos blockchain in real-time.

This is a very useful feature, especially when you need to receive updates immediately, as soon as they appear on the node and are indexed by the indexer.
Expand All @@ -8,7 +8,7 @@ Events base URL: `https://{baseUrl}/v1/events`

## Message types

After connecting to the websocket and subscribing to some events the client starts receiving messages from the server.
After connecting to the WebSocket and subscribing to some events the client starts receiving messages from the server.
There are three message types that the server sends to the client:

#### 1. State message
Expand Down

0 comments on commit 36a8f49

Please sign in to comment.