From 2547e44d70271fe5faf9656386fc0f584b95351b Mon Sep 17 00:00:00 2001 From: Thibault Martinez Date: Thu, 4 Jul 2024 10:12:03 +0200 Subject: [PATCH] fix(iota): more typos (#943) * fix(iota): more typos * more typos * more typos * one more typo * remove comment --------- Co-authored-by: DaughterOfMars --- crates/iota-framework/docs/deepbook/clob.md | 4 ++-- crates/iota-framework/docs/deepbook/clob_v2.md | 6 +++--- .../iota-framework/docs/iota-framework/transfer_policy.md | 4 ++-- crates/iota-framework/docs/stardust/nft.md | 4 ++-- crates/iota-framework/packages/deepbook/sources/clob.move | 6 +++--- .../iota-framework/packages/deepbook/sources/clob_v2.move | 6 +++--- .../packages/iota-framework/sources/crypto/group_ops.move | 2 +- .../iota-framework/sources/kiosk/transfer_policy.move | 4 ++-- .../iota-framework/packages/stardust/sources/nft/nft.move | 4 ++-- 9 files changed, 20 insertions(+), 20 deletions(-) diff --git a/crates/iota-framework/docs/deepbook/clob.md b/crates/iota-framework/docs/deepbook/clob.md index f0dc3afb83b..2265cfc8f30 100644 --- a/crates/iota-framework/docs/deepbook/clob.md +++ b/crates/iota-framework/docs/deepbook/clob.md @@ -1641,11 +1641,11 @@ Place a market order to the order book. // We first retrieve the PriceLevel with the lowest price by calling min_leaf on the asks Critbit Tree. // We then match the market order by iterating through open orders on that price level in ascending order of the order id. // Open orders that are being filled are removed from the order book. - // We stop the iteration untill all quantities are filled. + // We stop the iteration until all quantities are filled. // If the total quantity of open orders at the lowest price level is not large enough to fully fill the market order, // we move on to the next price level by calling next_leaf on the asks Critbit Tree and repeat the same procedure. // Continue iterating over the price levels in ascending order until the market order is completely filled. - // If ther market order cannot be completely filled even after consuming all the open ask orders, + // If their market order cannot be completely filled even after consuming all the open ask orders, // the unfilled quantity will be cancelled. // Market ask order follows similar procedure. // The difference is that market ask order is matched against the open bid orders. diff --git a/crates/iota-framework/docs/deepbook/clob_v2.md b/crates/iota-framework/docs/deepbook/clob_v2.md index c690d12ea97..d5337549d4d 100644 --- a/crates/iota-framework/docs/deepbook/clob_v2.md +++ b/crates/iota-framework/docs/deepbook/clob_v2.md @@ -2782,11 +2782,11 @@ Place a market order to the order book. // We first retrieve the PriceLevel with the lowest price by calling min_leaf on the asks Critbit Tree. // We then match the market order by iterating through open orders on that price level in ascending order of the order id. // Open orders that are being filled are removed from the order book. - // We stop the iteration untill all quantities are filled. + // We stop the iteration until all quantities are filled. // If the total quantity of open orders at the lowest price level is not large enough to fully fill the market order, // we move on to the next price level by calling next_leaf on the asks Critbit Tree and repeat the same procedure. // Continue iterating over the price levels in ascending order until the market order is completely filled. - // If ther market order cannot be completely filled even after consuming all the open ask orders, + // If their market order cannot be completely filled even after consuming all the open ask orders, // the unfilled quantity will be cancelled. // Market ask order follows similar procedure. // The difference is that market ask order is matched against the open bid orders. @@ -3822,7 +3822,7 @@ The latter is the corresponding depth list let (price_low_, _) = critbit::min_leaf(&pool.bids); let (price_high_, _) = critbit::max_leaf(&pool.bids); - // If price_low is greater than the higest element in the tree, we return empty + // If price_low is greater than the highest element in the tree, we return empty if (price_low > price_high_) { return (price_vec, depth_vec) }; diff --git a/crates/iota-framework/docs/iota-framework/transfer_policy.md b/crates/iota-framework/docs/iota-framework/transfer_policy.md index 9a29b18e940..8a6277ba248 100644 --- a/crates/iota-framework/docs/iota-framework/transfer_policy.md +++ b/crates/iota-framework/docs/iota-framework/transfer_policy.md @@ -16,7 +16,7 @@ hot potato or transaction will fail. - Type owner (creator) can set any Rules as long as the ecosystem supports them. All of the Rules need to be resolved within a single transaction (eg pay royalty and pay fixed commission). Once required actions are performed, -the TransferRequest can be "confimed" via confirm_request call. +the TransferRequest can be "confirmed" via confirm_request call. - TransferPolicy aims to be the main interface for creators to control trades of their types and collect profits if a fee is required on sales. Custom @@ -428,7 +428,7 @@ available for use, the type can not be traded in kiosks. ## Function `default` -Initialize the Tranfer Policy in the default scenario: Create and share +Initialize the Transfer Policy in the default scenario: Create and share the TransferPolicy, transfer TransferPolicyCap to the transaction sender. diff --git a/crates/iota-framework/docs/stardust/nft.md b/crates/iota-framework/docs/stardust/nft.md index 97779e5e400..39f10200fa8 100644 --- a/crates/iota-framework/docs/stardust/nft.md +++ b/crates/iota-framework/docs/stardust/nft.md @@ -143,7 +143,7 @@ The Nft module initializer. string::utf8(b"description"), string::utf8(b"creator"), - // The extra IRC27-nested fileds. + // The extra IRC27-nested fields. string::utf8(b"version"), string::utf8(b"media_type"), string::utf8(b"collection_name"), @@ -159,7 +159,7 @@ The Nft module initializer. string::utf8(b"{immutable_metadata.description}"), string::utf8(b"{immutable_metadata.issuer_name}"), - // The extra IRC27-nested fileds. + // The extra IRC27-nested fields. string::utf8(b"{immutable_metadata.version}"), string::utf8(b"{immutable_metadata.media_type}"), string::utf8(b"{immutable_metadata.collection_name}"), diff --git a/crates/iota-framework/packages/deepbook/sources/clob.move b/crates/iota-framework/packages/deepbook/sources/clob.move index 3cba68d3b63..0c4fb46c59d 100644 --- a/crates/iota-framework/packages/deepbook/sources/clob.move +++ b/crates/iota-framework/packages/deepbook/sources/clob.move @@ -133,7 +133,7 @@ module deepbook::clob { // Orders that are submitted earlier has lower order ids. // 64 bits are sufficient for order ids whereas 32 bits are not. // Assuming a maximum TPS of 100K/s of Iota chain, it would take (1<<63) / 100000 / 3600 / 24 / 365 = 2924712 years to reach the full capacity. - // The highest bit of the order id is used to denote the order tyep, 0 for bid, 1 for ask. + // The highest bit of the order id is used to denote the order type, 0 for bid, 1 for ask. order_id: u64, // Only used for limit orders. price: u64, @@ -768,11 +768,11 @@ module deepbook::clob { // We first retrieve the PriceLevel with the lowest price by calling min_leaf on the asks Critbit Tree. // We then match the market order by iterating through open orders on that price level in ascending order of the order id. // Open orders that are being filled are removed from the order book. - // We stop the iteration untill all quantities are filled. + // We stop the iteration until all quantities are filled. // If the total quantity of open orders at the lowest price level is not large enough to fully fill the market order, // we move on to the next price level by calling next_leaf on the asks Critbit Tree and repeat the same procedure. // Continue iterating over the price levels in ascending order until the market order is completely filled. - // If ther market order cannot be completely filled even after consuming all the open ask orders, + // If their market order cannot be completely filled even after consuming all the open ask orders, // the unfilled quantity will be cancelled. // Market ask order follows similar procedure. // The difference is that market ask order is matched against the open bid orders. diff --git a/crates/iota-framework/packages/deepbook/sources/clob_v2.move b/crates/iota-framework/packages/deepbook/sources/clob_v2.move index 68a9dd5a17d..e95e159f000 100644 --- a/crates/iota-framework/packages/deepbook/sources/clob_v2.move +++ b/crates/iota-framework/packages/deepbook/sources/clob_v2.move @@ -1289,11 +1289,11 @@ module deepbook::clob_v2 { // We first retrieve the PriceLevel with the lowest price by calling min_leaf on the asks Critbit Tree. // We then match the market order by iterating through open orders on that price level in ascending order of the order id. // Open orders that are being filled are removed from the order book. - // We stop the iteration untill all quantities are filled. + // We stop the iteration until all quantities are filled. // If the total quantity of open orders at the lowest price level is not large enough to fully fill the market order, // we move on to the next price level by calling next_leaf on the asks Critbit Tree and repeat the same procedure. // Continue iterating over the price levels in ascending order until the market order is completely filled. - // If ther market order cannot be completely filled even after consuming all the open ask orders, + // If their market order cannot be completely filled even after consuming all the open ask orders, // the unfilled quantity will be cancelled. // Market ask order follows similar procedure. // The difference is that market ask order is matched against the open bid orders. @@ -2010,7 +2010,7 @@ module deepbook::clob_v2 { let (price_low_, _) = critbit::min_leaf(&pool.bids); let (price_high_, _) = critbit::max_leaf(&pool.bids); - // If price_low is greater than the higest element in the tree, we return empty + // If price_low is greater than the highest element in the tree, we return empty if (price_low > price_high_) { return (price_vec, depth_vec) }; diff --git a/crates/iota-framework/packages/iota-framework/sources/crypto/group_ops.move b/crates/iota-framework/packages/iota-framework/sources/crypto/group_ops.move index 8bb462cc5dc..048fdac5aae 100644 --- a/crates/iota-framework/packages/iota-framework/sources/crypto/group_ops.move +++ b/crates/iota-framework/packages/iota-framework/sources/crypto/group_ops.move @@ -19,7 +19,7 @@ module iota::group_ops { ///////////////////////////////////////////////////// ////// Generic functions for group operations. ////// - // The caller provides a type identifer that should match the types of enum [Groups] in group_ops.rs. + // The caller provides a type identifier that should match the types of enum [Groups] in group_ops.rs. // General wrapper for all group elements. public struct Element has store, copy, drop { diff --git a/crates/iota-framework/packages/iota-framework/sources/kiosk/transfer_policy.move b/crates/iota-framework/packages/iota-framework/sources/kiosk/transfer_policy.move index 36a5a875230..5abe500e2c6 100644 --- a/crates/iota-framework/packages/iota-framework/sources/kiosk/transfer_policy.move +++ b/crates/iota-framework/packages/iota-framework/sources/kiosk/transfer_policy.move @@ -16,7 +16,7 @@ /// - Type owner (creator) can set any Rules as long as the ecosystem supports /// them. All of the Rules need to be resolved within a single transaction (eg /// pay royalty and pay fixed commission). Once required actions are performed, -/// the `TransferRequest` can be "confimed" via `confirm_request` call. +/// the `TransferRequest` can be "confirmed" via `confirm_request` call. /// /// - `TransferPolicy` aims to be the main interface for creators to control trades /// of their types and collect profits if a fee is required on sales. Custom @@ -130,7 +130,7 @@ module iota::transfer_policy { } #[allow(lint(self_transfer, share_owned))] - /// Initialize the Tranfer Policy in the default scenario: Create and share + /// Initialize the Transfer Policy in the default scenario: Create and share /// the `TransferPolicy`, transfer `TransferPolicyCap` to the transaction /// sender. entry fun default(pub: &Publisher, ctx: &mut TxContext) { diff --git a/crates/iota-framework/packages/stardust/sources/nft/nft.move b/crates/iota-framework/packages/stardust/sources/nft/nft.move index 9a753319a17..5ffbd7677d1 100644 --- a/crates/iota-framework/packages/stardust/sources/nft/nft.move +++ b/crates/iota-framework/packages/stardust/sources/nft/nft.move @@ -45,7 +45,7 @@ module stardust::nft { string::utf8(b"description"), string::utf8(b"creator"), - // The extra IRC27-nested fileds. + // The extra IRC27-nested fields. string::utf8(b"version"), string::utf8(b"media_type"), string::utf8(b"collection_name"), @@ -61,7 +61,7 @@ module stardust::nft { string::utf8(b"{immutable_metadata.description}"), string::utf8(b"{immutable_metadata.issuer_name}"), - // The extra IRC27-nested fileds. + // The extra IRC27-nested fields. string::utf8(b"{immutable_metadata.version}"), string::utf8(b"{immutable_metadata.media_type}"), string::utf8(b"{immutable_metadata.collection_name}"),