Update docs, fix spelling

baking-bad · Mar 14, 2023 · 83e432f · 83e432f
1 parent 921ca1b
commit 83e432f
Show file tree

Hide file tree

Showing 32 changed files with 106 additions and 104 deletions.
diff --git 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
@@ -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
+mumbai-db-start:
+	docker-compose -f docker-compose.mumbai.yml up -d mumbai-db
diff --git 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
@@ -304,7 +304,7 @@ public async Task<ActionResult<IEnumerable<BigMapKey>>> GetKeys(
         /// Returns the specified bigmap key.
         /// </remarks>
         /// <param name="id">Bigmap Id</param>
-        /// <param name="key">Either a key hash (`expr123...`) or a plain value (`abcde...`).
+        /// <param name="key">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"}`.</param>
         /// <param name="micheline">Format of the bigmap key and value: `0` - JSON, `1` - JSON string, `2` - Micheline, `3` - Micheline string</param>
         /// <returns></returns>
@@ -347,7 +347,7 @@ public async Task<ActionResult<BigMapKey>> GetKey(
         /// Returns updates history for the specified bigmap key.
         /// </remarks>
         /// <param name="id">Bigmap Id</param>
-        /// <param name="key">Either a key hash (`expr123...`) or a plain value (`abcde...`).
+        /// <param name="key">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"}`.</param>
         /// <param name="sort">Sorts bigmap updates by specified field. Supported fields: `id` (default).</param>
         /// <param name="offset">Specifies which or how many items should be skipped</param>
@@ -479,7 +479,7 @@ public async Task<ActionResult<IEnumerable<BigMapKeyHistorical>>> GetHistoricalK
         /// </remarks>
         /// <param name="id">Bigmap Id</param>
         /// <param name="level">Level of the block at which you want to get bigmap key</param>
-        /// <param name="key">Either a key hash (`expr123...`) or a plain value (`abcde...`).
+        /// <param name="key">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"}`.</param>
         /// <param name="micheline">Format of the bigmap key and value: `0` - JSON, `1` - JSON string, `2` - Micheline, `3` - Micheline string</param>
         /// <returns></returns>

diff --git a/Tzkt.Api/Controllers/ContractsController.cs b/Tzkt.Api/Controllers/ContractsController.cs
@@ -973,7 +973,7 @@ public async Task<ActionResult<IEnumerable<BigMapKey>>> GetBigMapByNameKeys(
         /// <param name="name">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.</param>
-        /// <param name="key">Either a key hash (`expr123...`) or a plain value (`abcde...`).
+        /// <param name="key">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"}`.</param>
         /// <param name="micheline">Format of the bigmap key and value: `0` - JSON, `1` - JSON string, `2` - Micheline, `3` - Micheline string</param>
         /// <returns></returns>
@@ -1028,7 +1028,7 @@ public async Task<ActionResult<BigMapKey>> GetKey(
         /// <param name="name">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.</param>
-        /// <param name="key">Either a key hash (`expr123...`) or a plain value (`abcde...`).
+        /// <param name="key">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"}`.</param>
         /// <param name="sort">Sorts bigmap updates by specified field. Supported fields: `id` (default).</param>
         /// <param name="offset">Specifies which or how many items should be skipped</param>
@@ -1184,7 +1184,7 @@ public async Task<ActionResult<IEnumerable<BigMapKeyHistorical>>> 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.</param>
         /// <param name="level">Level of the block at which you want to get bigmap key</param>
-        /// <param name="key">Either a key hash (`expr123...`) or a plain value (`abcde...`).
+        /// <param name="key">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"}`.</param>
         /// <param name="micheline">Format of the bigmap key and value: `0` - JSON, `1` - JSON string, `2` - Micheline, `3` - Micheline string</param>
         /// <returns></returns>

diff --git a/Tzkt.Api/Controllers/OperationsController.cs b/Tzkt.Api/Controllers/OperationsController.cs
@@ -1618,7 +1618,7 @@ public async Task<ActionResult<int>> GetVdfRevelationsCount(
         /// <remarks>
         /// Returns a list of drain delegate operations.
         /// </remarks>
-        /// <param name="anyof">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.</param>
+        /// <param name="anyof">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.</param>
         /// <param name="delegate">Filters by drained baker. Allowed fields for `.eqx` mode: none.</param>
         /// <param name="target">Filters by target. Allowed fields for `.eqx` mode: none.</param>
         /// <param name="level">Filters by level.</param>
@@ -2229,7 +2229,7 @@ public async Task<ActionResult<int>> GetOriginationsCount(
         /// <param name="initiator">Filters transactions by initiator. Allowed fields for `.eqx` mode: `target`.</param>
         /// <param name="sender">Filters transactions by sender. Allowed fields for `.eqx` mode: `target`.</param>
         /// <param name="target">Filters transactions by target. Allowed fields for `.eqx` mode: `sender`, `initiator`.</param>
-        /// <param name="amount">Filters transactions by amount (microtez).</param>
+        /// <param name="amount">Filters transactions by amount (micro tez).</param>
         /// <param name="id">Filters transactions by id.</param>
         /// <param name="level">Filters transactions by level.</param>
         /// <param name="timestamp">Filters transactions by timestamp.</param>
@@ -2482,7 +2482,7 @@ public async Task<ActionResult<IEnumerable<TransactionOperation>>> GetTransactio
         /// <param name="initiator">Filters transactions by initiator. Allowed fields for `.eqx` mode: `target`.</param>
         /// <param name="sender">Filters transactions by sender. Allowed fields for `.eqx` mode: `target`.</param>
         /// <param name="target">Filters transactions by target. Allowed fields for `.eqx` mode: `sender`, `initiator`.</param>
-        /// <param name="amount">Filters transactions by amount (microtez).</param>
+        /// <param name="amount">Filters transactions by amount (micro tez).</param>
         /// <param name="level">Filters transactions by level.</param>
         /// <param name="timestamp">Filters transactions by timestamp.</param>
         /// <param name="entrypoint">Filters transactions by entrypoint called on the target contract.</param>

diff --git 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
         /// </summary>
         /// <remarks>
-        /// Returns a total number of smnart rollups.
+        /// Returns a total number of smart rollups.
         /// </remarks>
         /// <param name="filter">Filter</param>
         /// <returns></returns>
@@ -128,7 +128,7 @@ public async Task<ActionResult<IEnumerable<SrStaker>>> GetSmartRollupStakers(
 
         #region commitments
         /// <summary>
-        /// Get smart rollup commitments
+        /// Get smart rollup commitments count
         /// </summary>
         /// <remarks>
         /// Returns a total number of smart rollup commitments.
@@ -183,7 +183,7 @@ public async Task<ActionResult<IEnumerable<SrCommitment>>> GetSmartRollupCommitm
 
         #region games
         /// <summary>
-        /// Get smart rollup games
+        /// Get smart rollup games count
         /// </summary>
         /// <remarks>
         /// Returns a total number of smart rollup refutation games.
@@ -241,7 +241,7 @@ public async Task<ActionResult<IEnumerable<SrGame>>> GetSmartRollupGames(
         /// Get inbox messages count
         /// </summary>
         /// <remarks>
-        /// Returns a total number of smnart rollup inbox messages.
+        /// Returns a total number of smart rollup inbox messages.
         /// </remarks>
         /// <param name="filter">Filter</param>
         /// <returns></returns>

diff --git a/Tzkt.Api/Controllers/SuggestController.cs b/Tzkt.Api/Controllers/SuggestController.cs
@@ -43,7 +43,7 @@ public IEnumerable<object> GetProposals()
 
         [OpenApiIgnore]
         [HttpGet("proposals/{search}")]
-        public IEnumerable<object> GetProposals([Required] string search)
+        public IEnumerable<object> GetProposals([Required] string _)
         {
             // obsolete
             return Enumerable.Empty<object>();
@@ -59,7 +59,7 @@ public IEnumerable<object> GetProtocols()
 
         [OpenApiIgnore]
         [HttpGet("protocols/{search}")]
-        public IEnumerable<object> GetProtocols([Required] string search)
+        public IEnumerable<object> GetProtocols([Required] string _)
         {
             // obsolete
             return Enumerable.Empty<object>();

diff --git 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; }
 
         /// <summary>
-        /// Number of `increase_paid_storage` operations sent by the acount
+        /// Number of `increase_paid_storage` operations sent by the account
         /// </summary>
         public int IncreasePaidStorageCount { get; set; }
 
         /// <summary>
-        /// Number of `update_consensus_key` operations sent by the acount
+        /// Number of `update_consensus_key` operations sent by the account
         /// </summary>
         public int UpdateConsensusKeyCount { get; set; }
 
         /// <summary>
-        /// Number of `drain_delegate` operations related to the acount
+        /// Number of `drain_delegate` operations related to the account
         /// </summary>
         public int DrainDelegateCount { get; set; }
 
         /// <summary>
-        /// Number of `smart_rollup_add_messages` operations related to the acount
+        /// Number of `smart_rollup_add_messages` operations related to the account
         /// </summary>
         public int SmartRollupAddMessagesCount { get; set; }
 
         /// <summary>
-        /// Number of `smart_rollup_cement` operations related to the acount
+        /// Number of `smart_rollup_cement` operations related to the account
         /// </summary>
         public int SmartRollupCementCount { get; set; }
 
         /// <summary>
-        /// Number of `smart_rollup_execute_outbox_message` operations related to the acount
+        /// Number of `smart_rollup_execute_outbox_message` operations related to the account
         /// </summary>
         public int SmartRollupExecuteCount { get; set; }
 
         /// <summary>
-        /// Number of `smart_rollup_originate` operations related to the acount
+        /// Number of `smart_rollup_originate` operations related to the account
         /// </summary>
         public int SmartRollupOriginateCount { get; set; }
 
         /// <summary>
-        /// Number of `smart_rollup_publish` operations related to the acount
+        /// Number of `smart_rollup_publish` operations related to the account
         /// </summary>
         public int SmartRollupPublishCount { get; set; }
 
         /// <summary>
-        /// Number of `smart_rollup_recover_bond` operations related to the acount
+        /// Number of `smart_rollup_recover_bond` operations related to the account
         /// </summary>
         public int SmartRollupRecoverBondCount { get; set; }
 
         /// <summary>
-        /// Number of `smart_rollup_refute` operations related to the acount
+        /// Number of `smart_rollup_refute` operations related to the account
         /// </summary>
         public int SmartRollupRefuteCount { get; set; }
 
         /// <summary>
-        /// Number of smart rollup refutation games related to the acount
+        /// Number of smart rollup refutation games related to the account
         /// </summary>
         public int RefutationGamesCount { get; set; }
 
         /// <summary>
-        /// Number of active smart rollup refutation games related to the acount
+        /// Number of active smart rollup refutation games related to the account
         /// </summary>
         public int ActiveRefutationGamesCount { get; set; }
 

diff --git 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; }
 
         /// <summary>
-        /// Number of `smart_rollup_cement` operations related to the acount
+        /// Number of `smart_rollup_cement` operations related to the account
         /// </summary>
         public int SmartRollupCementCount { get; set; }
 
         /// <summary>
-        /// Number of `smart_rollup_execute_outbox_message` operations related to the acount
+        /// Number of `smart_rollup_execute_outbox_message` operations related to the account
         /// </summary>
         public int SmartRollupExecuteCount { get; set; }
 
         /// <summary>
-        /// Number of `smart_rollup_originate` operations related to the acount
+        /// Number of `smart_rollup_originate` operations related to the account
         /// </summary>
         public int SmartRollupOriginateCount { get; set; }
 
         /// <summary>
-        /// Number of `smart_rollup_publish` operations related to the acount
+        /// Number of `smart_rollup_publish` operations related to the account
         /// </summary>
         public int SmartRollupPublishCount { get; set; }
 
         /// <summary>
-        /// Number of `smart_rollup_recover_bond` operations related to the acount
+        /// Number of `smart_rollup_recover_bond` operations related to the account
         /// </summary>
         public int SmartRollupRecoverBondCount { get; set; }
 
         /// <summary>
-        /// Number of `smart_rollup_refute` operations related to the acount
+        /// Number of `smart_rollup_refute` operations related to the account
         /// </summary>
         public int SmartRollupRefuteCount { get; set; }
 
         /// <summary>
-        /// Number of smart rollup refutation games related to the acount
+        /// Number of smart rollup refutation games related to the account
         /// </summary>
         public int RefutationGamesCount { get; set; }
 
         /// <summary>
-        /// Number of active smart rollup refutation games related to the acount
+        /// Number of active smart rollup refutation games related to the account
         /// </summary>
         public int ActiveRefutationGamesCount { get; set; }