Skip to content

Commit

Permalink
fix(iota): more typos (#943)
Browse files Browse the repository at this point in the history
* fix(iota): more typos

* more typos

* more typos

* one more typo

* remove comment

---------

Co-authored-by: DaughterOfMars <[email protected]>
  • Loading branch information
thibault-martinez and DaughterOfMars authored Jul 4, 2024
1 parent 2e72d93 commit b072978
Show file tree
Hide file tree
Showing 10 changed files with 21 additions and 21 deletions.
4 changes: 2 additions & 2 deletions crates/iota-framework/docs/deepbook/clob.md
Original file line number Diff line number Diff line change
Expand Up @@ -1641,11 +1641,11 @@ Place a market order to the order book.
// We first retrieve the PriceLevel <b>with</b> 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 <b>to</b> fully fill the market order,
// we <b>move</b> on <b>to</b> 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.
Expand Down
6 changes: 3 additions & 3 deletions crates/iota-framework/docs/deepbook/clob_v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -2782,11 +2782,11 @@ Place a market order to the order book.
// We first retrieve the PriceLevel <b>with</b> 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 <b>to</b> fully fill the market order,
// we <b>move</b> on <b>to</b> 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.
Expand Down Expand Up @@ -3822,7 +3822,7 @@ The latter is the corresponding depth list
<b>let</b> (price_low_, _) = <a href="critbit.md#0xdee9_critbit_min_leaf">critbit::min_leaf</a>(&pool.bids);
<b>let</b> (price_high_, _) = <a href="critbit.md#0xdee9_critbit_max_leaf">critbit::max_leaf</a>(&pool.bids);

// If price_low is greater than the higest element in the tree, we <b>return</b> empty
// If price_low is greater than the highest element in the tree, we <b>return</b> empty
<b>if</b> (price_low &gt; price_high_) {
<b>return</b> (price_vec, depth_vec)
};
Expand Down
4 changes: 2 additions & 2 deletions crates/iota-framework/docs/iota-framework/transfer_policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <code><a href="transfer_policy.md#0x2_transfer_policy_TransferRequest">TransferRequest</a></code> can be "confimed" via <code>confirm_request</code> call.
the <code><a href="transfer_policy.md#0x2_transfer_policy_TransferRequest">TransferRequest</a></code> can be "confirmed" via <code>confirm_request</code> call.

- <code><a href="transfer_policy.md#0x2_transfer_policy_TransferPolicy">TransferPolicy</a></code> 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
Expand Down Expand Up @@ -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 <code><a href="transfer_policy.md#0x2_transfer_policy_TransferPolicy">TransferPolicy</a></code>, transfer <code><a href="transfer_policy.md#0x2_transfer_policy_TransferPolicyCap">TransferPolicyCap</a></code> to the transaction
sender.

Expand Down
4 changes: 2 additions & 2 deletions crates/iota-framework/docs/stardust/nft.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ The <code><a href="nft.md#0x107a_nft_Nft">Nft</a></code> module initializer.
<a href="../move-stdlib/string.md#0x1_string_utf8">string::utf8</a>(b"description"),
<a href="../move-stdlib/string.md#0x1_string_utf8">string::utf8</a>(b"creator"),

// The extra IRC27-nested fileds.
// The extra IRC27-nested fields.
<a href="../move-stdlib/string.md#0x1_string_utf8">string::utf8</a>(b"version"),
<a href="../move-stdlib/string.md#0x1_string_utf8">string::utf8</a>(b"media_type"),
<a href="../move-stdlib/string.md#0x1_string_utf8">string::utf8</a>(b"collection_name"),
Expand All @@ -159,7 +159,7 @@ The <code><a href="nft.md#0x107a_nft_Nft">Nft</a></code> module initializer.
<a href="../move-stdlib/string.md#0x1_string_utf8">string::utf8</a>(b"{immutable_metadata.description}"),
<a href="../move-stdlib/string.md#0x1_string_utf8">string::utf8</a>(b"{immutable_metadata.issuer_name}"),

// The extra IRC27-nested fileds.
// The extra IRC27-nested fields.
<a href="../move-stdlib/string.md#0x1_string_utf8">string::utf8</a>(b"{immutable_metadata.version}"),
<a href="../move-stdlib/string.md#0x1_string_utf8">string::utf8</a>(b"{immutable_metadata.media_type}"),
<a href="../move-stdlib/string.md#0x1_string_utf8">string::utf8</a>(b"{immutable_metadata.collection_name}"),
Expand Down
6 changes: 3 additions & 3 deletions crates/iota-framework/packages/deepbook/sources/clob.move
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions crates/iota-framework/packages/deepbook/sources/clob_v2.move
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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)
};
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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<phantom T> has store, copy, drop {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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<T>(pub: &Publisher, ctx: &mut TxContext) {
Expand Down
4 changes: 2 additions & 2 deletions crates/iota-framework/packages/stardust/sources/nft/nft.move
Original file line number Diff line number Diff line change
Expand Up @@ -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"),
Expand All @@ -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}"),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ impl Migration {
// a certain milestone timestamp remains the same between runs.
//
// This guarantees that fresh ids created through the transaction
// context will also map to the same objects betwen runs.
// context will also map to the same objects between runs.
outputs.sort_by_key(|(header, _)| (header.ms_timestamp(), header.output_id()));
foundries.sort_by_key(|(header, _)| (header.ms_timestamp(), header.output_id()));
info!("Migrating foundries...");
Expand Down

0 comments on commit b072978

Please sign in to comment.