From 83e432fe0f8cd67ed2ebb58d34d40a2ff0e2d487 Mon Sep 17 00:00:00 2001 From: Maksim Strebkov <257byte@gmail.com> Date: Tue, 14 Mar 2023 16:09:04 +0300 Subject: [PATCH] Update docs, fix spelling --- .env.sample | 2 +- Makefile | 34 +++++++++---------- README.md | 3 ++ Tzkt.Api/Controllers/BigMapsController.cs | 6 ++-- Tzkt.Api/Controllers/ContractsController.cs | 6 ++-- Tzkt.Api/Controllers/OperationsController.cs | 6 ++-- .../Controllers/SmartRollupsController.cs | 8 ++--- Tzkt.Api/Controllers/SuggestController.cs | 4 +-- Tzkt.Api/Models/Accounts/Delegate.cs | 24 ++++++------- Tzkt.Api/Models/Accounts/SmartRollup.cs | 16 ++++----- Tzkt.Api/Models/Accounts/User.cs | 22 ++++++------ Tzkt.Api/Models/Baking/BakerRewards.cs | 2 +- Tzkt.Api/Models/Baking/DelegatorRewards.cs | 2 +- Tzkt.Api/Models/Baking/RewardSplit.cs | 2 +- Tzkt.Api/Models/BigMaps/BigMap.cs | 4 +-- Tzkt.Api/Models/BigMaps/BigMapUpdate.cs | 10 +++--- .../ExpressionAlreadyRegisteredError.cs | 2 +- .../Operations/UpdateConsensusKeyOperation.cs | 2 +- Tzkt.Api/Models/PeriodInfo.cs | 1 - Tzkt.Api/Models/SmartRollups/SrGame.cs | 4 +-- Tzkt.Api/Models/SmartRollups/SrGameInfo.cs | 4 +-- Tzkt.Api/Models/Voting/VotingPeriod.cs | 1 - .../RefutationGameStatusParameter.cs | 2 +- Tzkt.Api/Parameters/SrCommitmentFilter.cs | 2 +- Tzkt.Api/Parameters/SrGameFilter.cs | 2 +- Tzkt.Api/Parameters/SrGameInfoFilter.cs | 2 +- Tzkt.Api/Parameters/SrStakerFilter.cs | 2 +- Tzkt.Api/Repositories/BigMapsRepository.cs | 6 ++-- Tzkt.Api/Swagger/Description.md | 1 + Tzkt.Api/Swagger/TypescriptSdk.md | 4 +-- Tzkt.Api/Swagger/WsExamples.md | 2 +- ...kathmandu.yml => docker-compose.mumbai.yml | 22 ++++++------ 32 files changed, 106 insertions(+), 104 deletions(-) rename docker-compose.kathmandu.yml => docker-compose.mumbai.yml (50%) diff --git a/.env.sample b/.env.sample index ec8f903f3..fb0f660bd 100644 --- a/.env.sample +++ b/.env.sample @@ -1,5 +1,5 @@ ConnectionStrings__DefaultConnection="host=127.0.0.1;port=5432;database=tzkt_db;username=tzkt;password=qwerty;" -TezosNode__Endpoint="https://mainnet-tezos.giganode.io/" +TezosNode__Endpoint="https://rpc.tzkt.io/mainnet" TezosNode_Timeout=60 Logging__LogLevel__Default=Debug HealthChecks__Enabled=false diff --git a/Makefile b/Makefile index 140f044d9..2c4d6382b 100644 --- a/Makefile +++ b/Makefile @@ -89,24 +89,24 @@ lima-stop: lima-db-start: docker-compose -f docker-compose.lima.yml up -d lima-db -kathmandu-init: - docker-compose -f docker-compose.kathmandu.yml up -d kathmandu-db - docker-compose -f docker-compose.kathmandu.yml exec -T kathmandu-db psql -U tzkt postgres -c '\l' - docker-compose -f docker-compose.kathmandu.yml exec -T kathmandu-db dropdb -U tzkt --if-exists tzkt_db - docker-compose -f docker-compose.kathmandu.yml exec -T kathmandu-db createdb -U tzkt -T template0 tzkt_db - docker-compose -f docker-compose.kathmandu.yml exec -T kathmandu-db apt update - docker-compose -f docker-compose.kathmandu.yml exec -T kathmandu-db apt install -y wget - docker-compose -f docker-compose.kathmandu.yml exec -T kathmandu-db wget "https://snapshots.tzkt.io/tzkt_v1.11_kathmandunet.backup" -O tzkt_db.backup - docker-compose -f docker-compose.kathmandu.yml exec -T kathmandu-db pg_restore -U tzkt -O -x -v -d tzkt_db -e -j 4 tzkt_db.backup - docker-compose -f docker-compose.kathmandu.yml exec -T kathmandu-db rm tzkt_db.backup - docker-compose -f docker-compose.kathmandu.yml exec -T kathmandu-db apt autoremove --purge -y wget +mumbai-init: + docker-compose -f docker-compose.mumbai.yml up -d mumbai-db + docker-compose -f docker-compose.mumbai.yml exec -T mumbai-db psql -U tzkt postgres -c '\l' + docker-compose -f docker-compose.mumbai.yml exec -T mumbai-db dropdb -U tzkt --if-exists tzkt_db + docker-compose -f docker-compose.mumbai.yml exec -T mumbai-db createdb -U tzkt -T template0 tzkt_db + docker-compose -f docker-compose.mumbai.yml exec -T mumbai-db apt update + docker-compose -f docker-compose.mumbai.yml exec -T mumbai-db apt install -y wget + docker-compose -f docker-compose.mumbai.yml exec -T mumbai-db wget "https://snapshots.tzkt.io/tzkt_v1.12_mumbainet.backup" -O tzkt_db.backup + docker-compose -f docker-compose.mumbai.yml exec -T mumbai-db pg_restore -U tzkt -O -x -v -d tzkt_db -e -j 4 tzkt_db.backup + docker-compose -f docker-compose.mumbai.yml exec -T mumbai-db rm tzkt_db.backup + docker-compose -f docker-compose.mumbai.yml exec -T mumbai-db apt autoremove --purge -y wget docker-compose pull -kathmandu-start: - docker-compose -f docker-compose.kathmandu.yml up -d +mumbai-start: + docker-compose -f docker-compose.mumbai.yml up -d -kathmandu-stop: - docker-compose -f docker-compose.kathmandu.yml down +mumbai-stop: + docker-compose -f docker-compose.mumbai.yml down -kathmandu-db-start: - docker-compose -f docker-compose.kathmandu.yml up -d kathmandu-db \ No newline at end of file +mumbai-db-start: + docker-compose -f docker-compose.mumbai.yml up -d mumbai-db \ No newline at end of file diff --git a/README.md b/README.md index 9a18b7c34..da4d8c68d 100644 --- a/README.md +++ b/README.md @@ -260,6 +260,9 @@ In general the steps are the same as for the mainnet, you will just need to use - Limanet: - Snapshot: https://snapshots.tzkt.io/tzkt_v1.11_limanet.backup - RPC node: https://rpc.tzkt.io/limanet/ + - Mumbainet: + - Snapshot: https://snapshots.tzkt.io/tzkt_v1.12_mumbainet.backup + - RPC node: https://rpc.tzkt.io/mumbainet/ ### Testnets & docker diff --git a/Tzkt.Api/Controllers/BigMapsController.cs b/Tzkt.Api/Controllers/BigMapsController.cs index d711cb5f2..1b6ff716c 100644 --- a/Tzkt.Api/Controllers/BigMapsController.cs +++ b/Tzkt.Api/Controllers/BigMapsController.cs @@ -304,7 +304,7 @@ public async Task>> GetKeys( /// Returns the specified bigmap key. /// /// Bigmap Id - /// Either a key hash (`expr123...`) or a plain value (`abcde...`). + /// Either a key hash (`expr123...`) or a plain value (`foo...`). /// Even if the key is complex (an object or an array), you can specify it as is, for example, `/keys/{"address":"tz123","nat":"123"}`. /// Format of the bigmap key and value: `0` - JSON, `1` - JSON string, `2` - Micheline, `3` - Micheline string /// @@ -347,7 +347,7 @@ public async Task> GetKey( /// Returns updates history for the specified bigmap key. /// /// Bigmap Id - /// Either a key hash (`expr123...`) or a plain value (`abcde...`). + /// Either a key hash (`expr123...`) or a plain value (`foo...`). /// Even if the key is complex (an object or an array), you can specify it as is, for example, `/keys/{"address":"tz123","nat":"123"}`. /// Sorts bigmap updates by specified field. Supported fields: `id` (default). /// Specifies which or how many items should be skipped @@ -479,7 +479,7 @@ public async Task>> GetHistoricalK /// /// Bigmap Id /// Level of the block at which you want to get bigmap key - /// Either a key hash (`expr123...`) or a plain value (`abcde...`). + /// Either a key hash (`expr123...`) or a plain value (`foo...`). /// Even if the key is complex (an object or an array), you can specify it as is, for example, `/keys/{"address":"tz123","nat":"123"}`. /// Format of the bigmap key and value: `0` - JSON, `1` - JSON string, `2` - Micheline, `3` - Micheline string /// diff --git a/Tzkt.Api/Controllers/ContractsController.cs b/Tzkt.Api/Controllers/ContractsController.cs index 5ecb448e6..c1f1da899 100644 --- a/Tzkt.Api/Controllers/ContractsController.cs +++ b/Tzkt.Api/Controllers/ContractsController.cs @@ -973,7 +973,7 @@ public async Task>> GetBigMapByNameKeys( /// Bigmap name is the last piece of the bigmap storage path. /// For example, if the storage path is `ledger` or `assets.ledger`, then the name is `ledger`. /// If there are multiple bigmaps with the same name, for example `assets.ledger` and `tokens.ledger`, you can specify the full path. - /// Either a key hash (`expr123...`) or a plain value (`abcde...`). + /// Either a key hash (`expr123...`) or a plain value (`foo...`). /// Even if the key is complex (an object or an array), you can specify it as is, for example, `/keys/{"address":"tz123","nat":"123"}`. /// Format of the bigmap key and value: `0` - JSON, `1` - JSON string, `2` - Micheline, `3` - Micheline string /// @@ -1028,7 +1028,7 @@ public async Task> GetKey( /// Bigmap name is the last piece of the bigmap storage path. /// For example, if the storage path is `ledger` or `assets.ledger`, then the name is `ledger`. /// If there are multiple bigmaps with the same name, for example `assets.ledger` and `tokens.ledger`, you can specify the full path. - /// Either a key hash (`expr123...`) or a plain value (`abcde...`). + /// Either a key hash (`expr123...`) or a plain value (`foo...`). /// Even if the key is complex (an object or an array), you can specify it as is, for example, `/keys/{"address":"tz123","nat":"123"}`. /// Sorts bigmap updates by specified field. Supported fields: `id` (default). /// Specifies which or how many items should be skipped @@ -1184,7 +1184,7 @@ public async Task>> GetHistoricalK /// For example, if the storage path is `ledger` or `assets.ledger`, then the name is `ledger`. /// If there are multiple bigmaps with the same name, for example `assets.ledger` and `tokens.ledger`, you can specify the full path. /// Level of the block at which you want to get bigmap key - /// Either a key hash (`expr123...`) or a plain value (`abcde...`). + /// Either a key hash (`expr123...`) or a plain value (`foo...`). /// Even if the key is complex (an object or an array), you can specify it as is, for example, `/keys/{"address":"tz123","nat":"123"}`. /// Format of the bigmap key and value: `0` - JSON, `1` - JSON string, `2` - Micheline, `3` - Micheline string /// diff --git a/Tzkt.Api/Controllers/OperationsController.cs b/Tzkt.Api/Controllers/OperationsController.cs index 9eb5c0881..67f6a102e 100644 --- a/Tzkt.Api/Controllers/OperationsController.cs +++ b/Tzkt.Api/Controllers/OperationsController.cs @@ -1618,7 +1618,7 @@ public async Task> GetVdfRevelationsCount( /// /// Returns a list of drain delegate operations. /// - /// Filtersby any of the specified fields. Example: `anyof.delegate.target=tz1...` will return operations where `delegate` OR `target` is equal to the specified value. This parameter is useful when you need to retrieve all operations associated with a specified account. + /// Filters by any of the specified fields. Example: `anyof.delegate.target=tz1...` will return operations where `delegate` OR `target` is equal to the specified value. This parameter is useful when you need to retrieve all operations associated with a specified account. /// Filters by drained baker. Allowed fields for `.eqx` mode: none. /// Filters by target. Allowed fields for `.eqx` mode: none. /// Filters by level. @@ -2229,7 +2229,7 @@ public async Task> GetOriginationsCount( /// Filters transactions by initiator. Allowed fields for `.eqx` mode: `target`. /// Filters transactions by sender. Allowed fields for `.eqx` mode: `target`. /// Filters transactions by target. Allowed fields for `.eqx` mode: `sender`, `initiator`. - /// Filters transactions by amount (microtez). + /// Filters transactions by amount (micro tez). /// Filters transactions by id. /// Filters transactions by level. /// Filters transactions by timestamp. @@ -2482,7 +2482,7 @@ public async Task>> GetTransactio /// Filters transactions by initiator. Allowed fields for `.eqx` mode: `target`. /// Filters transactions by sender. Allowed fields for `.eqx` mode: `target`. /// Filters transactions by target. Allowed fields for `.eqx` mode: `sender`, `initiator`. - /// Filters transactions by amount (microtez). + /// Filters transactions by amount (micro tez). /// Filters transactions by level. /// Filters transactions by timestamp. /// Filters transactions by entrypoint called on the target contract. diff --git a/Tzkt.Api/Controllers/SmartRollupsController.cs b/Tzkt.Api/Controllers/SmartRollupsController.cs index 19ccd10dd..cf57e8483 100644 --- a/Tzkt.Api/Controllers/SmartRollupsController.cs +++ b/Tzkt.Api/Controllers/SmartRollupsController.cs @@ -27,7 +27,7 @@ public SmartRollupsController(SmartRollupsRepository srCommitments, StateCache s /// Get smart rollups count /// /// - /// Returns a total number of smnart rollups. + /// Returns a total number of smart rollups. /// /// Filter /// @@ -128,7 +128,7 @@ public async Task>> GetSmartRollupStakers( #region commitments /// - /// Get smart rollup commitments + /// Get smart rollup commitments count /// /// /// Returns a total number of smart rollup commitments. @@ -183,7 +183,7 @@ public async Task>> GetSmartRollupCommitm #region games /// - /// Get smart rollup games + /// Get smart rollup games count /// /// /// Returns a total number of smart rollup refutation games. @@ -241,7 +241,7 @@ public async Task>> GetSmartRollupGames( /// Get inbox messages count /// /// - /// Returns a total number of smnart rollup inbox messages. + /// Returns a total number of smart rollup inbox messages. /// /// Filter /// diff --git a/Tzkt.Api/Controllers/SuggestController.cs b/Tzkt.Api/Controllers/SuggestController.cs index 3143c7e3f..ad9c962b4 100644 --- a/Tzkt.Api/Controllers/SuggestController.cs +++ b/Tzkt.Api/Controllers/SuggestController.cs @@ -43,7 +43,7 @@ public IEnumerable GetProposals() [OpenApiIgnore] [HttpGet("proposals/{search}")] - public IEnumerable GetProposals([Required] string search) + public IEnumerable GetProposals([Required] string _) { // obsolete return Enumerable.Empty(); @@ -59,7 +59,7 @@ public IEnumerable GetProtocols() [OpenApiIgnore] [HttpGet("protocols/{search}")] - public IEnumerable GetProtocols([Required] string search) + public IEnumerable GetProtocols([Required] string _) { // obsolete return Enumerable.Empty(); diff --git a/Tzkt.Api/Models/Accounts/Delegate.cs b/Tzkt.Api/Models/Accounts/Delegate.cs index 2e2aac6b4..fb69d4fff 100644 --- a/Tzkt.Api/Models/Accounts/Delegate.cs +++ b/Tzkt.Api/Models/Accounts/Delegate.cs @@ -287,62 +287,62 @@ public class Delegate : Account public int TransferTicketCount { get; set; } /// - /// Number of `increase_paid_storage` operations sent by the acount + /// Number of `increase_paid_storage` operations sent by the account /// public int IncreasePaidStorageCount { get; set; } /// - /// Number of `update_consensus_key` operations sent by the acount + /// Number of `update_consensus_key` operations sent by the account /// public int UpdateConsensusKeyCount { get; set; } /// - /// Number of `drain_delegate` operations related to the acount + /// Number of `drain_delegate` operations related to the account /// public int DrainDelegateCount { get; set; } /// - /// Number of `smart_rollup_add_messages` operations related to the acount + /// Number of `smart_rollup_add_messages` operations related to the account /// public int SmartRollupAddMessagesCount { get; set; } /// - /// Number of `smart_rollup_cement` operations related to the acount + /// Number of `smart_rollup_cement` operations related to the account /// public int SmartRollupCementCount { get; set; } /// - /// Number of `smart_rollup_execute_outbox_message` operations related to the acount + /// Number of `smart_rollup_execute_outbox_message` operations related to the account /// public int SmartRollupExecuteCount { get; set; } /// - /// Number of `smart_rollup_originate` operations related to the acount + /// Number of `smart_rollup_originate` operations related to the account /// public int SmartRollupOriginateCount { get; set; } /// - /// Number of `smart_rollup_publish` operations related to the acount + /// Number of `smart_rollup_publish` operations related to the account /// public int SmartRollupPublishCount { get; set; } /// - /// Number of `smart_rollup_recover_bond` operations related to the acount + /// Number of `smart_rollup_recover_bond` operations related to the account /// public int SmartRollupRecoverBondCount { get; set; } /// - /// Number of `smart_rollup_refute` operations related to the acount + /// Number of `smart_rollup_refute` operations related to the account /// public int SmartRollupRefuteCount { get; set; } /// - /// Number of smart rollup refutation games related to the acount + /// Number of smart rollup refutation games related to the account /// public int RefutationGamesCount { get; set; } /// - /// Number of active smart rollup refutation games related to the acount + /// Number of active smart rollup refutation games related to the account /// public int ActiveRefutationGamesCount { get; set; } diff --git a/Tzkt.Api/Models/Accounts/SmartRollup.cs b/Tzkt.Api/Models/Accounts/SmartRollup.cs index 9535a4f79..0090c2c7e 100644 --- a/Tzkt.Api/Models/Accounts/SmartRollup.cs +++ b/Tzkt.Api/Models/Accounts/SmartRollup.cs @@ -115,42 +115,42 @@ public class SmartRollup : Account public int TransferTicketCount { get; set; } /// - /// Number of `smart_rollup_cement` operations related to the acount + /// Number of `smart_rollup_cement` operations related to the account /// public int SmartRollupCementCount { get; set; } /// - /// Number of `smart_rollup_execute_outbox_message` operations related to the acount + /// Number of `smart_rollup_execute_outbox_message` operations related to the account /// public int SmartRollupExecuteCount { get; set; } /// - /// Number of `smart_rollup_originate` operations related to the acount + /// Number of `smart_rollup_originate` operations related to the account /// public int SmartRollupOriginateCount { get; set; } /// - /// Number of `smart_rollup_publish` operations related to the acount + /// Number of `smart_rollup_publish` operations related to the account /// public int SmartRollupPublishCount { get; set; } /// - /// Number of `smart_rollup_recover_bond` operations related to the acount + /// Number of `smart_rollup_recover_bond` operations related to the account /// public int SmartRollupRecoverBondCount { get; set; } /// - /// Number of `smart_rollup_refute` operations related to the acount + /// Number of `smart_rollup_refute` operations related to the account /// public int SmartRollupRefuteCount { get; set; } /// - /// Number of smart rollup refutation games related to the acount + /// Number of smart rollup refutation games related to the account /// public int RefutationGamesCount { get; set; } /// - /// Number of active smart rollup refutation games related to the acount + /// Number of active smart rollup refutation games related to the account /// public int ActiveRefutationGamesCount { get; set; } diff --git a/Tzkt.Api/Models/Accounts/User.cs b/Tzkt.Api/Models/Accounts/User.cs index 44a59c890..7b10d81f9 100644 --- a/Tzkt.Api/Models/Accounts/User.cs +++ b/Tzkt.Api/Models/Accounts/User.cs @@ -186,57 +186,57 @@ public class User : Account public int TransferTicketCount { get; set; } /// - /// Number of `increase_paid_storage` operations sent by the acount + /// Number of `increase_paid_storage` operations sent by the account /// public int IncreasePaidStorageCount { get; set; } /// - /// Number of `drain_delegate` operations related to the acount + /// Number of `drain_delegate` operations related to the account /// public int DrainDelegateCount { get; set; } /// - /// Number of `smart_rollup_add_messages` operations related to the acount + /// Number of `smart_rollup_add_messages` operations related to the account /// public int SmartRollupAddMessagesCount { get; set; } /// - /// Number of `smart_rollup_cement` operations related to the acount + /// Number of `smart_rollup_cement` operations related to the account /// public int SmartRollupCementCount { get; set; } /// - /// Number of `smart_rollup_execute_outbox_message` operations related to the acount + /// Number of `smart_rollup_execute_outbox_message` operations related to the account /// public int SmartRollupExecuteCount { get; set; } /// - /// Number of `smart_rollup_originate` operations related to the acount + /// Number of `smart_rollup_originate` operations related to the account /// public int SmartRollupOriginateCount { get; set; } /// - /// Number of `smart_rollup_publish` operations related to the acount + /// Number of `smart_rollup_publish` operations related to the account /// public int SmartRollupPublishCount { get; set; } /// - /// Number of `smart_rollup_recover_bond` operations related to the acount + /// Number of `smart_rollup_recover_bond` operations related to the account /// public int SmartRollupRecoverBondCount { get; set; } /// - /// Number of `smart_rollup_refute` operations related to the acount + /// Number of `smart_rollup_refute` operations related to the account /// public int SmartRollupRefuteCount { get; set; } /// - /// Number of smart rollup refutation games related to the acount + /// Number of smart rollup refutation games related to the account /// public int RefutationGamesCount { get; set; } /// - /// Number of active smart rollup refutation games related to the acount + /// Number of active smart rollup refutation games related to the account /// public int ActiveRefutationGamesCount { get; set; } diff --git a/Tzkt.Api/Models/Baking/BakerRewards.cs b/Tzkt.Api/Models/Baking/BakerRewards.cs index a2bd33f8e..50bf9b9e6 100644 --- a/Tzkt.Api/Models/Baking/BakerRewards.cs +++ b/Tzkt.Api/Models/Baking/BakerRewards.cs @@ -133,7 +133,7 @@ public class BakerRewards public long DoubleEndorsingLosses { get; set; } /// - /// Rewards for detecting double preendorsing (accusing someone of prevalidating two different blocks at the same level). + /// Rewards for detecting double preendorsing (accusing someone of pre-validating two different blocks at the same level). /// public long DoublePreendorsingRewards { get; set; } diff --git a/Tzkt.Api/Models/Baking/DelegatorRewards.cs b/Tzkt.Api/Models/Baking/DelegatorRewards.cs index 47159e11b..2541fbf01 100644 --- a/Tzkt.Api/Models/Baking/DelegatorRewards.cs +++ b/Tzkt.Api/Models/Baking/DelegatorRewards.cs @@ -133,7 +133,7 @@ public class DelegatorRewards public long DoubleEndorsingLosses { get; set; } /// - /// Rewards for detecting double preendorsing (accusing someone of prevalidating two different blocks at the same level). + /// Rewards for detecting double preendorsing (accusing someone of pre-validating two different blocks at the same level). /// public long DoublePreendorsingRewards { get; set; } diff --git a/Tzkt.Api/Models/Baking/RewardSplit.cs b/Tzkt.Api/Models/Baking/RewardSplit.cs index 865d721d7..48b34e84c 100644 --- a/Tzkt.Api/Models/Baking/RewardSplit.cs +++ b/Tzkt.Api/Models/Baking/RewardSplit.cs @@ -134,7 +134,7 @@ public class RewardSplit public long DoubleEndorsingLosses { get; set; } /// - /// Rewards for detecting double preendorsing (accusing someone of prevalidating two different blocks at the same level). + /// Rewards for detecting double preendorsing (accusing someone of pre-validating two different blocks at the same level). /// public long DoublePreendorsingRewards { get; set; } diff --git a/Tzkt.Api/Models/BigMaps/BigMap.cs b/Tzkt.Api/Models/BigMaps/BigMap.cs index 45beee293..b720f5bd2 100644 --- a/Tzkt.Api/Models/BigMaps/BigMap.cs +++ b/Tzkt.Api/Models/BigMaps/BigMap.cs @@ -24,7 +24,7 @@ public class BigMap /// /// List of tags ( `metadata`, `token_metadata`,`ledger`, or `null` if there are no tags) /// - public List Tags => BigMapTags.ToList(_Tags); + public List Tags => BigMapTags.ToList(TagFlags); /// /// Bigmap status (`true` - active, `false` - removed) @@ -67,6 +67,6 @@ public class BigMap public object ValueType { get; set; } [JsonIgnore] - public BigMapTag _Tags { get; set; } + public BigMapTag TagFlags { get; set; } } } diff --git a/Tzkt.Api/Models/BigMaps/BigMapUpdate.cs b/Tzkt.Api/Models/BigMaps/BigMapUpdate.cs index fa0bf691e..8ab73961c 100644 --- a/Tzkt.Api/Models/BigMaps/BigMapUpdate.cs +++ b/Tzkt.Api/Models/BigMaps/BigMapUpdate.cs @@ -49,17 +49,17 @@ public class BigMapUpdate public BigMapKeyShort Content { get; set; } [JsonIgnore] - public BigMapTag _Tags { get; set; } + public BigMapTag TagFlags { get; set; } public IEnumerable EnumerateTags() { - if (_Tags >= BigMapTag.Metadata) + if (TagFlags >= BigMapTag.Metadata) { - if ((_Tags & BigMapTag.Metadata) != 0) + if ((TagFlags & BigMapTag.Metadata) != 0) yield return BigMapTag.Metadata; - else if ((_Tags & BigMapTag.TokenMetadata) != 0) + else if ((TagFlags & BigMapTag.TokenMetadata) != 0) yield return BigMapTag.TokenMetadata; - else if ((_Tags & BigMapTag.Ledger) != 0) + else if ((TagFlags & BigMapTag.Ledger) != 0) yield return BigMapTag.Ledger; } } diff --git a/Tzkt.Api/Models/Operations/Errors/ExpressionAlreadyRegisteredError.cs b/Tzkt.Api/Models/Operations/Errors/ExpressionAlreadyRegisteredError.cs index 0386da441..5b454928d 100644 --- a/Tzkt.Api/Models/Operations/Errors/ExpressionAlreadyRegisteredError.cs +++ b/Tzkt.Api/Models/Operations/Errors/ExpressionAlreadyRegisteredError.cs @@ -6,7 +6,7 @@ public class ExpressionAlreadyRegisteredError : OperationError { /// /// Type of an error, `Expression_already_registered` - an operation tried to register - /// an already existing global consant + /// an already existing global constant /// https://tezos.gitlab.io/api/errors.html - full list of errors /// [JsonPropertyName("type")] diff --git a/Tzkt.Api/Models/Operations/UpdateConsensusKeyOperation.cs b/Tzkt.Api/Models/Operations/UpdateConsensusKeyOperation.cs index 97353890d..2ff7b3f0c 100644 --- a/Tzkt.Api/Models/Operations/UpdateConsensusKeyOperation.cs +++ b/Tzkt.Api/Models/Operations/UpdateConsensusKeyOperation.cs @@ -74,7 +74,7 @@ public class UpdateConsensusKeyOperation : Operation public string Status { get; set; } /// - /// Index of the cycle from which the conssensus key will be active + /// Index of the cycle from which the consensus key will be active /// public int ActivationCycle { get; set; } diff --git a/Tzkt.Api/Models/PeriodInfo.cs b/Tzkt.Api/Models/PeriodInfo.cs index c5a34df27..8d61b936e 100644 --- a/Tzkt.Api/Models/PeriodInfo.cs +++ b/Tzkt.Api/Models/PeriodInfo.cs @@ -24,7 +24,6 @@ public class PeriodInfo /// `testing` - If the proposal is approved in the Exploration Period, the testing (or 'cooldown') period begins and bakers start testing the new protocol /// `promotion` - delegates can cast one vote to promote or not the tested proposal using the ballot operation /// `adoption` - after the proposal is actually accepted, the ecosystem has some time to prepare to the upgrade - /// Learn more: https://tezos.gitlab.io/whitedoc/voting.html /// public string Kind { get; set; } diff --git a/Tzkt.Api/Models/SmartRollups/SrGame.cs b/Tzkt.Api/Models/SmartRollups/SrGame.cs index a0eed0b4c..f16b7e601 100644 --- a/Tzkt.Api/Models/SmartRollups/SrGame.cs +++ b/Tzkt.Api/Models/SmartRollups/SrGame.cs @@ -19,12 +19,12 @@ public class SrGame public Alias Initiator { get; set; } /// - /// Initiator's verson of a valid commitment + /// Initiator's version of a valid commitment /// public SrCommitmentInfo InitiatorCommitment { get; set; } /// - /// Opponent, who was acused in publishing a wrong commitment. + /// Opponent, who was accused in publishing a wrong commitment. /// public Alias Opponent { get; set; } diff --git a/Tzkt.Api/Models/SmartRollups/SrGameInfo.cs b/Tzkt.Api/Models/SmartRollups/SrGameInfo.cs index b4b88ac72..a8cba3b92 100644 --- a/Tzkt.Api/Models/SmartRollups/SrGameInfo.cs +++ b/Tzkt.Api/Models/SmartRollups/SrGameInfo.cs @@ -13,12 +13,12 @@ public class SrGameInfo public Alias Initiator { get; set; } /// - /// Initiator's verson of a valid commitment + /// Initiator's version of a valid commitment /// public SrCommitmentInfo InitiatorCommitment { get; set; } /// - /// Opponent, who was acused in publishing a wrong commitment. + /// Opponent, who was accused in publishing a wrong commitment. /// public Alias Opponent { get; set; } diff --git a/Tzkt.Api/Models/Voting/VotingPeriod.cs b/Tzkt.Api/Models/Voting/VotingPeriod.cs index 1cb557f26..69b39b769 100644 --- a/Tzkt.Api/Models/Voting/VotingPeriod.cs +++ b/Tzkt.Api/Models/Voting/VotingPeriod.cs @@ -44,7 +44,6 @@ public class VotingPeriod /// `testing` - If the proposal is approved in the Exploration Period, the testing (or 'cooldown') period begins and bakers start testing the new protocol /// `promotion` - delegates can cast one vote to promote or not the tested proposal using the ballot operation /// `adoption` - after the proposal is actually accepted, the ecosystem has some time to prepare to the upgrade - /// Learn more: https://tezos.gitlab.io/whitedoc/voting.html /// public string Kind { get; set; } diff --git a/Tzkt.Api/Parameters/RefutationGameStatusParameter.cs b/Tzkt.Api/Parameters/RefutationGameStatusParameter.cs index b9ae9be76..778f8b392 100644 --- a/Tzkt.Api/Parameters/RefutationGameStatusParameter.cs +++ b/Tzkt.Api/Parameters/RefutationGameStatusParameter.cs @@ -6,7 +6,7 @@ namespace Tzkt.Api { [ModelBinder(BinderType = typeof(RefutationGameStatusBinder))] [JsonSchemaExtensionData("x-tzkt-extension", "query-parameter")] - [JsonSchemaExtensionData("x-tzkt-query-parameter", "none,ongiong,loser,draw")] + [JsonSchemaExtensionData("x-tzkt-query-parameter", "none,ongoing,loser,draw")] public class RefutationGameStatusParameter : INormalizable { /// diff --git a/Tzkt.Api/Parameters/SrCommitmentFilter.cs b/Tzkt.Api/Parameters/SrCommitmentFilter.cs index 645f73a87..5bc702da2 100644 --- a/Tzkt.Api/Parameters/SrCommitmentFilter.cs +++ b/Tzkt.Api/Parameters/SrCommitmentFilter.cs @@ -60,7 +60,7 @@ public class SrCommitmentFilter : INormalizable public TimestampParameter lastTime { get; set; } /// - /// Filter by commitment status (`pending`, `cemented`, `exxecuted`, `refuted`, or `orphan`). + /// Filter by commitment status (`pending`, `cemented`, `executed`, `refuted`, or `orphan`). /// Click on the parameter to expand more details. /// public SrCommitmentStatusParameter status { get; set; } diff --git a/Tzkt.Api/Parameters/SrGameFilter.cs b/Tzkt.Api/Parameters/SrGameFilter.cs index b9389929b..b585cbae2 100644 --- a/Tzkt.Api/Parameters/SrGameFilter.cs +++ b/Tzkt.Api/Parameters/SrGameFilter.cs @@ -29,7 +29,7 @@ public class SrGameFilter : INormalizable public SrCommitmentInfoFilter initiatorCommitment { get; set; } /// - /// Filter by opponent (who was acused in publishing a wrong commitment). + /// Filter by opponent (who was accused in publishing a wrong commitment). /// Click on the parameter to expand more details. /// public AccountParameter opponent { get; set; } diff --git a/Tzkt.Api/Parameters/SrGameInfoFilter.cs b/Tzkt.Api/Parameters/SrGameInfoFilter.cs index bec1caa86..df997df6a 100644 --- a/Tzkt.Api/Parameters/SrGameInfoFilter.cs +++ b/Tzkt.Api/Parameters/SrGameInfoFilter.cs @@ -23,7 +23,7 @@ public class SrGameInfoFilter : INormalizable public SrCommitmentInfoFilter initiatorCommitment { get; set; } /// - /// Filter by opponent (who was acused in publishing a wrong commitment). + /// Filter by opponent (who was accused in publishing a wrong commitment). /// Click on the parameter to expand more details. /// public AccountParameter opponent { get; set; } diff --git a/Tzkt.Api/Parameters/SrStakerFilter.cs b/Tzkt.Api/Parameters/SrStakerFilter.cs index 2840748a3..e0be48cdc 100644 --- a/Tzkt.Api/Parameters/SrStakerFilter.cs +++ b/Tzkt.Api/Parameters/SrStakerFilter.cs @@ -18,7 +18,7 @@ public class SrStakerFilter : INormalizable public AddressParameter address { get; set; } /// - /// Filter by staker's bond status (`active`, `returned`, or `lost`). + /// Filter by staker bond status (`active`, `returned`, or `lost`). /// Click on the parameter to expand more details. /// public SrBondStatusParameter bondStatus { get; set; } diff --git a/Tzkt.Api/Repositories/BigMapsRepository.cs b/Tzkt.Api/Repositories/BigMapsRepository.cs index 4f38a8de8..36175fe57 100644 --- a/Tzkt.Api/Repositories/BigMapsRepository.cs +++ b/Tzkt.Api/Repositories/BigMapsRepository.cs @@ -1008,7 +1008,7 @@ public async Task> GetUpdates( Timestamp = Times[row.Level], Contract = Accounts.GetAlias(bigmap.ContractId), Path = bigmap.StoragePath, - _Tags = (Data.Models.BigMapTag)bigmap.Tags, + TagFlags = (Data.Models.BigMapTag)bigmap.Tags, Content = key == null ? null : new BigMapKeyShort { Hash = key.KeyHash, @@ -1088,7 +1088,7 @@ public async Task> GetUpdates( Timestamp = Times[row.Level], Contract = Accounts.GetAlias(row.ContractId), Path = row.StoragePath, - _Tags = (Data.Models.BigMapTag)row.Tags, + TagFlags = (Data.Models.BigMapTag)row.Tags, Content = key == null ? null : new BigMapKeyShort { Hash = key.KeyHash, @@ -1195,7 +1195,7 @@ BigMap ReadBigMap(dynamic row, MichelineFormat format) ValueType = (int)format < 2 ? (RawJson)Schema.Create(Micheline.FromBytes(row.ValueType) as MichelinePrim).Humanize() : (RawJson)Micheline.ToJson(row.ValueType), - _Tags = (Data.Models.BigMapTag)row.Tags + TagFlags = (Data.Models.BigMapTag)row.Tags }; } diff --git a/Tzkt.Api/Swagger/Description.md b/Tzkt.Api/Swagger/Description.md index 3a161d6ca..0cf4f0728 100644 --- a/Tzkt.Api/Swagger/Description.md +++ b/Tzkt.Api/Swagger/Description.md @@ -8,6 +8,7 @@ TzKT API is available for the following Tezos networks with the following base U - Mainnet: `https://api.tzkt.io/` or `https://api.mainnet.tzkt.io/` ([view docs](https://api.tzkt.io)) - Ghostnet: `https://api.ghostnet.tzkt.io/` ([view docs](https://api.ghostnet.tzkt.io)) - Limanet: `https://api.limanet.tzkt.io/` ([view docs](https://api.limanet.tzkt.io)) +- Mumbainet: `https://api.mumbainet.tzkt.io/` ([view docs](https://api.mumbainet.tzkt.io)) We also provide a staging environment for testing newest features and pre-updating client applications before deploying to production: diff --git a/Tzkt.Api/Swagger/TypescriptSdk.md b/Tzkt.Api/Swagger/TypescriptSdk.md index ffa443f5f..6c11a66ff 100644 --- a/Tzkt.Api/Swagger/TypescriptSdk.md +++ b/Tzkt.Api/Swagger/TypescriptSdk.md @@ -1,9 +1,9 @@ TzKT API is accompanied by a Typescript SDK you can use both on the client side and on the backend. -It offers fully typed reponse models and a convenient query builder with autocompletion. Also it is designed to be tree-shakeable and to introduce a minimal overhead to the bundle size. +It offers fully typed response models and a convenient query builder with autocompletion. Also it is designed to support tree-shaking and to introduce a minimal overhead to the bundle size. Check out the following resources: * [SDK reference](https://sdk.tzkt.io/) -* [Github repo](https://github.com/tzkt/api-sdk-ts) +* [GitHub repo](https://github.com/tzkt/api-sdk-ts) ## Installation diff --git a/Tzkt.Api/Swagger/WsExamples.md b/Tzkt.Api/Swagger/WsExamples.md index 75f6298f4..a26a85d9d 100644 --- a/Tzkt.Api/Swagger/WsExamples.md +++ b/Tzkt.Api/Swagger/WsExamples.md @@ -122,7 +122,7 @@ init(); ## Python simple client -Install SignalR package via pypi: +Install SignalR package via `pypi`: ````sh > pip install signalrcore diff --git a/docker-compose.kathmandu.yml b/docker-compose.mumbai.yml similarity index 50% rename from docker-compose.kathmandu.yml rename to docker-compose.mumbai.yml index eb38af265..443e6c736 100644 --- a/docker-compose.kathmandu.yml +++ b/docker-compose.mumbai.yml @@ -1,8 +1,8 @@ version: '3' services: - kathmandu-db: - container_name: kathmandu-db + mumbai-db: + container_name: mumbai-db restart: always image: postgres:13 environment: @@ -14,28 +14,28 @@ services: ports: - 127.0.0.1:5434:5432 - kathmandu-api: - container_name: kathmandu-api + mumbai-api: + container_name: mumbai-api restart: always image: bakingbad/tzkt-api:latest depends_on: - - kathmandu-db + - mumbai-db environment: - ConnectionStrings__DefaultConnection: host=kathmandu-db;port=5432;database=${POSTGRES_DB:-tzkt_db};username=${POSTGRES_USER:-tzkt};password=${POSTGRES_PASSWORD:-qwerty};command timeout=${COMMAND_TIMEOUT:-600}; + ConnectionStrings__DefaultConnection: host=mumbai-db;port=5432;database=${POSTGRES_DB:-tzkt_db};username=${POSTGRES_USER:-tzkt};password=${POSTGRES_PASSWORD:-qwerty};command timeout=${COMMAND_TIMEOUT:-600}; Kestrel__Endpoints__Http__Url: http://0.0.0.0:5000 ports: - 0.0.0.0:5030:5000 - kathmandu-sync: - container_name: kathmandu-sync + mumbai-sync: + container_name: mumbai-sync restart: always image: bakingbad/tzkt-sync:latest environment: - ConnectionStrings__DefaultConnection: host=kathmandu-db;port=5432;database=${POSTGRES_DB:-tzkt_db};username=${POSTGRES_USER:-tzkt};password=${POSTGRES_PASSWORD:-qwerty};command timeout=${COMMAND_TIMEOUT:-600}; + ConnectionStrings__DefaultConnection: host=mumbai-db;port=5432;database=${POSTGRES_DB:-tzkt_db};username=${POSTGRES_USER:-tzkt};password=${POSTGRES_PASSWORD:-qwerty};command timeout=${COMMAND_TIMEOUT:-600}; Kestrel__Endpoints__Http__Url: http://0.0.0.0:5001 - TezosNode__Endpoint: https://rpc.tzkt.io/kathmandunet/ + TezosNode__Endpoint: https://rpc.tzkt.io/mumbainet/ depends_on: - - kathmandu-db + - mumbai-db ports: - 0.0.0.0:5031:5001