chore: spellchecker (#166)

* add spellchecker and run

* fix unintended

* add skiplist to spellcheck

.github/config/.codespellignore

@@ -0,0 +1,6 @@
+initia
+minitia
+expRes
+crate
+Hel
+ser

.github/workflows/spellcheck.yml

@@ -0,0 +1,28 @@
+name: Spell Check
+
+on:
+  pull_request:
+
+jobs:
+  spellcheck:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Run codespell
+        continue-on-error: true
+        run: |
+          sudo apt-get install codespell -y
+          codespell -w --ignore-words=.github/config/.codespellignore --skip="*.git,*.so,*.dylib,go.mod,go.sum,Cargo.toml"
+      - uses: peter-evans/[email protected]
+        if: github.event_name != 'pull_request'
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          commit-message: "chore: fix typos"
+          title: "chore: fix typos"
+          branch: "chore/fix-typos"
+          delete-branch: true
+          body: |
+            This PR fixes typos in the codebase.
+            Please review it, and merge if everything is fine.
+            If there are proto changes, run `make proto-gen` and commit the changes.

api/memory_test.go

@@ -50,7 +50,7 @@ func TestCreateAndDestroyUnmanagedVector(t *testing.T) {
 		var original []byte
 		unmanaged := newUnmanagedVector(original)
 		require.Equal(t, cbool(true), unmanaged.is_none)
-		// We must not make assumtions on the other fields in this case
+		// We must not make assumptions on the other fields in this case
 		copy := copyAndDestroyUnmanagedVector(unmanaged)
 		require.Nil(t, copy)
 	}

api/mocks.go

@@ -20,7 +20,7 @@ func NewLookup() *Lookup {
 	}
 }
 
-// Get wraps the underlying DB's Get method panicing on error.
+// Get wraps the underlying DB's Get method panicking on error.
 func (l Lookup) Get(key []byte) []byte {
 	v, err := l.db.Get(key)
 	if err != nil {
@@ -30,21 +30,21 @@ func (l Lookup) Get(key []byte) []byte {
 	return v
 }
 
-// Set wraps the underlying DB's Set method panicing on error.
+// Set wraps the underlying DB's Set method panicking on error.
 func (l Lookup) Set(key, value []byte) {
 	if err := l.db.Set(key, value); err != nil {
 		panic(err)
 	}
 }
 
-// Delete wraps the underlying DB's Delete method panicing on error.
+// Delete wraps the underlying DB's Delete method panicking on error.
 func (l Lookup) Delete(key []byte) {
 	if err := l.db.Delete(key); err != nil {
 		panic(err)
 	}
 }
 
-// Iterator wraps the underlying DB's Iterator method panicing on error.
+// Iterator wraps the underlying DB's Iterator method panicking on error.
 func (l Lookup) Iterator(start, end []byte) dbm.Iterator {
 	iter, err := l.db.Iterator(start, end)
 	if err != nil {
@@ -54,7 +54,7 @@ func (l Lookup) Iterator(start, end []byte) dbm.Iterator {
 	return iter
 }
 
-// ReverseIterator wraps the underlying DB's ReverseIterator method panicing on error.
+// ReverseIterator wraps the underlying DB's ReverseIterator method panicking on error.
 func (l Lookup) ReverseIterator(start, end []byte) dbm.Iterator {
 	iter, err := l.db.ReverseIterator(start, end)
 	if err != nil {

crates/compiler/src/clean.rs

@@ -83,7 +83,7 @@ impl Clean {
 }
 
 fn validate_manifest(base_path: &Path) -> anyhow::Result<()> {
-    let manifest_path = base_path.join("Move.toml"); // manifest is in pakcage path
+    let manifest_path = base_path.join("Move.toml"); // manifest is in package path
     if !(manifest_path.is_file()) {
         bail!("move package not found in {}", base_path.display())
     }

crates/gas/src/lib.rs

@@ -12,7 +12,7 @@
 //! The reason why we need two different representations is that they serve different purposes:
 //!   - The Rust structs are used for quick (static) lookups by the gas meter and native functions
 //!     when calculating gas costs.
-//!   - The on-chain gas schedule needs to be extensible and unordered so we can upgrate it easily
+//!   - The on-chain gas schedule needs to be extensible and unordered so we can upgrade it easily
 //!     in the future.
 
 #[macro_use]

crates/gas/src/meter.rs

@@ -152,7 +152,7 @@ struct Frame {
 #[derive(Clone)]
 /// The official gas meter used inside the Initia VM.
 /// It maintains an internal gas counter, measured in internal gas units, and carries an environment
-/// consisting all the gas parameters, which it can lookup when performing gas calcuations.
+/// consisting all the gas parameters, which it can lookup when performing gas calculations.
 pub struct InitiaGasMeter {
     gas_params: InitiaGasParameters,
     balance: InternalGas,

crates/json/src/json_to_move.rs

@@ -670,7 +670,7 @@ mod json_arg_testing {
             .unwrap()
         );
 
-        // invalid inner addresss
+        // invalid inner address
         let arg = b"[\"0xgg\"]";
         _ = deserialize_json_args(&code_storage, &mock_state, &ty, arg).unwrap_err();
     }

crates/json/src/json_to_value.rs

@@ -451,7 +451,7 @@ mod json_arg_testing {
             .unwrap()
         );
 
-        // invalid inner addresss
+        // invalid inner address
         let arg = b"[\"0xgg\"]";
         _ = deserialize_json_to_value(&module_id(), &layout, arg).unwrap_err();
     }

crates/natives/src/function_info.rs

@@ -19,7 +19,7 @@ use crate::{
     safely_pop_arg,
 };
 
-// Extract Identifer from a move value of type &String
+// Extract Identifier from a move value of type &String
 fn identifier_from_ref(v: Value) -> SafeNativeResult<Identifier> {
     let bytes = v
         .value_as::<StructRef>()

crates/natives/src/move_stdlib/bcs.rs

@@ -113,7 +113,7 @@ fn native_serialized_size(
         Err(_) => {
             context.charge(gas_params.bcs_serialized_size_failure)?;
 
-            // Re-use the same abort code as bcs::to_bytes.
+            // Reuse the same abort code as bcs::to_bytes.
             return Err(SafeNativeError::Abort {
                 abort_code: BCS_SERIALIZATION_FAILURE,
             });

crates/types/src/compiler.rs

@@ -225,7 +225,7 @@ pub struct CompilerDocgenOptions {
     pub landing_page_template: Option<String>,
 
     /// Package-relative path to a file whose content is added to each generated markdown file.
-    /// This can contain common markdown references fpr this package (e.g. `[move-book]: <url>`).
+    /// This can contain common markdown references for this package (e.g. `[move-book]: <url>`).
     pub references_file: Option<String>,
 }
 

precompile/modules/initia_stdlib/doc/coin.md

@@ -475,7 +475,7 @@ Only fungible asset metadata owner can make changes.
 
 ## Function `mint`
 
-Mint FAs as the owner of metadat object.
+Mint FAs as the owner of metadata object.
 
 
 <pre><code><b>public</b> <b>fun</b> <a href="coin.md#0x1_coin_mint">mint</a>(mint_cap: &<a href="coin.md#0x1_coin_MintCapability">coin::MintCapability</a>, amount: u64): <a href="fungible_asset.md#0x1_fungible_asset_FungibleAsset">fungible_asset::FungibleAsset</a>
@@ -506,7 +506,7 @@ Mint FAs as the owner of metadat object.
 
 ## Function `mint_to`
 
-Mint FAs as the owner of metadat object to the primary fungible store of the given recipient.
+Mint FAs as the owner of metadata object to the primary fungible store of the given recipient.
 
 
 <pre><code><b>public</b> <b>fun</b> <a href="coin.md#0x1_coin_mint_to">mint_to</a>(mint_cap: &<a href="coin.md#0x1_coin_MintCapability">coin::MintCapability</a>, recipient: <b>address</b>, amount: u64)
@@ -539,7 +539,7 @@ Mint FAs as the owner of metadat object to the primary fungible store of the giv
 
 ## Function `burn`
 
-Burn FAs as the owner of metadat object.
+Burn FAs as the owner of metadata object.
 
 
 <pre><code><b>public</b> <b>fun</b> <a href="coin.md#0x1_coin_burn">burn</a>(burn_cap: &<a href="coin.md#0x1_coin_BurnCapability">coin::BurnCapability</a>, fa: <a href="fungible_asset.md#0x1_fungible_asset_FungibleAsset">fungible_asset::FungibleAsset</a>)

precompile/modules/initia_stdlib/doc/collection.md

@@ -872,7 +872,7 @@ Provides the count of the current selection if supply tracking is used
 ## Function `nfts`
 
 get nft list from collection
-if <code>start_after</code> is not none, seach nfts in range (start_after, ...]
+if <code>start_after</code> is not none, search nfts in range (start_after, ...]
 
 
 <pre><code>#[view]

precompile/modules/initia_stdlib/doc/dex.md

@@ -2584,7 +2584,7 @@ CONTRACT: not allow until LBP is ended
 
 ## Function `single_asset_provide_liquidity`
 
-Signle asset provide liquidity directly
+Single asset provide liquidity directly
 CONTRACT: cannot provide more than the pool amount to prevent huge price impact
 CONTRACT: not allow until LBP is ended
 

precompile/modules/initia_stdlib/doc/dispatchable_fungible_asset.md

@@ -10,7 +10,7 @@ The dispatchable_fungible_asset wraps the existing fungible_asset module and add
 to customize the logic for withdraw and deposit operations. For example:
 
 - Deflation token: a fixed percentage of token will be destructed upon transfer.
-- Transfer allowlist: token can only be transfered to addresses in the allow list.
+- Transfer allowlist: token can only be transferred to addresses in the allow list.
 - Predicated transfer: transfer can only happen when some certain predicate has been met.
 - Loyalty token: a fixed loyalty will be paid to a designated address when a fungible asset transfer happens
 
@@ -285,7 +285,7 @@ Note: it does not move the underlying object.
 ## Function `transfer_assert_minimum_deposit`
 
 Transfer an <code>amount</code> of fungible asset from <code>from_store</code>, which should be owned by <code>sender</code>, to <code>receiver</code>.
-The recipient is guranteed to receive asset greater than the expected amount.
+The recipient is guaranteed to receive asset greater than the expected amount.
 Note: it does not move the underlying object.
 
 

precompile/modules/initia_stdlib/doc/ed25519.md

@@ -133,7 +133,7 @@ The size of a serialized signature, in bytes.
 
 ## Function `public_key_from_bytes`
 
-Contructs an PublicKey struct, given 32-byte representation.
+Constructs an PublicKey struct, given 32-byte representation.
 
 
 <pre><code><b>public</b> <b>fun</b> <a href="ed25519.md#0x1_ed25519_public_key_from_bytes">public_key_from_bytes</a>(bytes: <a href="../../move_nursery/../move_stdlib/doc/vector.md#0x1_vector">vector</a>&lt;u8&gt;): <a href="ed25519.md#0x1_ed25519_PublicKey">ed25519::PublicKey</a>

precompile/modules/initia_stdlib/doc/fungible_asset.md

@@ -1301,7 +1301,7 @@ This can only be called at object creation time as constructor_ref is only avail
 
 ## Function `is_fungible_asset`
 
-Retrun true if given address has Metadata else return false
+Return true if given address has Metadata else return false
 
 
 <pre><code>#[view]

precompile/modules/initia_stdlib/doc/math128.md

@@ -343,7 +343,7 @@ Returns square root of x, precisely floor(sqrt(x))
     <b>let</b> res = 1 &lt;&lt; ((<a href="math128.md#0x1_math128_floor_log2">floor_log2</a>(x) + 1) &gt;&gt; 1);
     // We <b>use</b> standard newton-rhapson iteration <b>to</b> improve the initial approximation.
     // The <a href="../../move_nursery/../move_stdlib/doc/error.md#0x1_error">error</a> term evolves <b>as</b> delta_i+1 = delta_i^2 / 2 (quadratic convergence).
-    // It turns out that after 5 iterations the delta is smaller than 2^-64 and thus below the treshold.
+    // It turns out that after 5 iterations the delta is smaller than 2^-64 and thus below the threshold.
     res = (res + x / res) &gt;&gt; 1;
     res = (res + x / res) &gt;&gt; 1;
     res = (res + x / res) &gt;&gt; 1;

precompile/modules/initia_stdlib/doc/math64.md

@@ -301,7 +301,7 @@ Returns square root of x, precisely floor(sqrt(x))
     <b>let</b> res = 1 &lt;&lt; ((<a href="math64.md#0x1_math64_floor_log2">floor_log2</a>(x) + 1) &gt;&gt; 1);
     // We <b>use</b> standard newton-rhapson iteration <b>to</b> improve the initial approximation.
     // The <a href="../../move_nursery/../move_stdlib/doc/error.md#0x1_error">error</a> term evolves <b>as</b> delta_i+1 = delta_i^2 / 2 (quadratic convergence).
-    // It turns out that after 4 iterations the delta is smaller than 2^-32 and thus below the treshold.
+    // It turns out that after 4 iterations the delta is smaller than 2^-32 and thus below the threshold.
     res = (res + x / res) &gt;&gt; 1;
     res = (res + x / res) &gt;&gt; 1;
     res = (res + x / res) &gt;&gt; 1;

precompile/modules/initia_stdlib/doc/minitswap.md

@@ -3962,7 +3962,7 @@ Event emitted when arb reverted
         <a href="../../move_nursery/../move_stdlib/doc/error.md#0x1_error_invalid_state">error::invalid_state</a>(<a href="minitswap.md#0x1_minitswap_EEMERGENCY">EEMERGENCY</a>)
     );
 
-    // check metdata
+    // check metadata
     <b>let</b> share_token_metadata = <a href="fungible_asset.md#0x1_fungible_asset_metadata_from_asset">fungible_asset::metadata_from_asset</a>(&share_token);
     <b>assert</b>!(
         share_token_metadata == <a href="minitswap.md#0x1_minitswap_share_token_metadata">share_token_metadata</a>(),
@@ -4366,7 +4366,7 @@ Event emitted when arb reverted
             // and then calculate arb fee and get actual <b>return</b> amount which is same <b>with</b> return_amount_before_swap_fee - swap_fee_amount - arb_fee_amount
             // <b>to</b> make actual <b>return</b> amount <b>to</b> <b>return</b> amount, set return_amount_before_swap_fee = return_amount_before_swap_fee + return_diff
             // <b>where</b> return_diff = target <b>return</b> amount - actual <b>return</b> amount
-            // and recalculate offer amount repeatly until <b>return</b> amount &lt;= actual <b>return</b> amount
+            // and recalculate offer amount repeatedly until <b>return</b> amount &lt;= actual <b>return</b> amount
             // note that actual <b>return</b> is always small or equal <b>with</b> target <b>return</b> amount
 
             // adjust fee. <b>return</b> amount before swap fee = <b>return</b> amount * 1 / (1 - f)

precompile/modules/initia_stdlib/doc/nft.md

@@ -126,7 +126,7 @@ a small optimization to support either and take a fixed amount of 34-bytes.
 
 ## Struct `MutatorRef`
 
-This enables mutating descritpion and URI by higher level services.
+This enables mutating description and URI by higher level services.
 
 
 <pre><code><b>struct</b> <a href="nft.md#0x1_nft_MutatorRef">MutatorRef</a> <b>has</b> drop, store

precompile/modules/initia_stdlib/doc/object.md

@@ -550,7 +550,7 @@ The version of ref does not match with object core version.
 
 <a id="0x1_object_MAXIMUM_OBJECT_NESTING"></a>
 
-Maximum nesting from one object to another. That is objects can technically have infinte
+Maximum nesting from one object to another. That is objects can technically have infinite
 nesting, but any checks such as transfer will only be evaluated this deep.
 
 

precompile/modules/initia_stdlib/doc/primary_fungible_store.md

@@ -660,7 +660,7 @@ Transfer <code>amount</code> of fungible asset from sender's primary store to re
 ## Function `transfer_assert_minimum_deposit`
 
 Transfer <code>amount</code> of fungible asset from sender's primary store to receiver's primary store.
-Use the minimum deposit assertion api to make sure receipient will receive a minimum amount of fund.
+Use the minimum deposit assertion api to make sure recipient will receive a minimum amount of fund.
 
 
 <pre><code><b>public</b> entry <b>fun</b> <a href="primary_fungible_store.md#0x1_primary_fungible_store_transfer_assert_minimum_deposit">transfer_assert_minimum_deposit</a>&lt;T: key&gt;(sender: &<a href="../../move_nursery/../move_stdlib/doc/signer.md#0x1_signer">signer</a>, metadata: <a href="object.md#0x1_object_Object">object::Object</a>&lt;T&gt;, recipient: <b>address</b>, amount: u64, expected: u64)

precompile/modules/initia_stdlib/doc/property_map.md

@@ -352,7 +352,7 @@ Maximum number of characters in a property name
 ## Function `burn`
 
 Burns the entire property map
-TODO: hanlde when table is not empty
+TODO: handle when table is not empty
 
 
 <pre><code><b>public</b> <b>fun</b> <a href="property_map.md#0x1_property_map_burn">burn</a>(ref: <a href="property_map.md#0x1_property_map_MutatorRef">property_map::MutatorRef</a>)

precompile/modules/initia_stdlib/doc/stableswap.md

@@ -112,7 +112,7 @@
 <code>extend_ref: <a href="object.md#0x1_object_ExtendRef">object::ExtendRef</a></code>
 </dt>
 <dd>
- Extend Refernce
+ Extend Reference
 </dd>
 <dt>
 <code>ann: <a href="stableswap.md#0x1_stableswap_Ann">stableswap::Ann</a></code>

precompile/modules/initia_stdlib/doc/staking.md

@@ -926,7 +926,7 @@ util function to convert Unbonding => UnbondingResponse for third party queriers
 
 ## Function `get_delegation`
 
-Get delegation info of specifed addr and validator
+Get delegation info of specified addr and validator
 
 
 <pre><code>#[view]
@@ -2116,7 +2116,7 @@ Get <code>share</code> from <code><a href="staking.md#0x1_staking_Delegation">De
 
 ## Function `destroy_empty_delegation`
 
-Destory empty delegation
+Destroy empty delegation
 
 
 <pre><code><b>public</b> <b>fun</b> <a href="staking.md#0x1_staking_destroy_empty_delegation">destroy_empty_delegation</a>(delegation: <a href="staking.md#0x1_staking_Delegation">staking::Delegation</a>)
@@ -2485,7 +2485,7 @@ Get <code>unbonding_amount</code> from <code><a href="staking.md#0x1_staking_Unb
 
 ## Function `destroy_empty_unbonding`
 
-Destory empty unbonding
+Destroy empty unbonding
 
 
 <pre><code><b>public</b> <b>fun</b> <a href="staking.md#0x1_staking_destroy_empty_unbonding">destroy_empty_unbonding</a>(unbonding: <a href="staking.md#0x1_staking_Unbonding">staking::Unbonding</a>)
@@ -2576,7 +2576,7 @@ Deposit the unbonding into recipient's account.
 
 ## Function `withdraw_unbonding`
 
-Withdraw specifed <code>amount</code> of unbonding_amount from the unbonding.
+Withdraw specified <code>amount</code> of unbonding_amount from the unbonding.
 
 
 <pre><code><b>public</b> <b>fun</b> <a href="staking.md#0x1_staking_withdraw_unbonding">withdraw_unbonding</a>(<a href="account.md#0x1_account">account</a>: &<a href="../../move_nursery/../move_stdlib/doc/signer.md#0x1_signer">signer</a>, metadata: <a href="object.md#0x1_object_Object">object::Object</a>&lt;<a href="fungible_asset.md#0x1_fungible_asset_Metadata">fungible_asset::Metadata</a>&gt;, validator: <a href="../../move_nursery/../move_stdlib/doc/string.md#0x1_string_String">string::String</a>, release_time: u64, amount: u64): <a href="staking.md#0x1_staking_Unbonding">staking::Unbonding</a>

precompile/modules/initia_stdlib/sources/coin.move

@@ -199,7 +199,7 @@ module initia_std::coin {
     // Admin operations
     //
 
-    /// Mint FAs as the owner of metadat object.
+    /// Mint FAs as the owner of metadata object.
     public fun mint(mint_cap: &MintCapability, amount: u64): FungibleAsset acquires ManagingRefs {
         let metadata = mint_cap.metadata;
         let metadata_addr = object::object_address(&metadata);
@@ -213,7 +213,7 @@ module initia_std::coin {
         fungible_asset::mint(&refs.mint_ref, amount)
     }
 
-    /// Mint FAs as the owner of metadat object to the primary fungible store of the given recipient.
+    /// Mint FAs as the owner of metadata object to the primary fungible store of the given recipient.
     public fun mint_to(
         mint_cap: &MintCapability, recipient: address, amount: u64
     ) acquires ManagingRefs {
@@ -229,7 +229,7 @@ module initia_std::coin {
         primary_fungible_store::mint(&refs.mint_ref, recipient, amount)
     }
 
-    /// Burn FAs as the owner of metadat object.
+    /// Burn FAs as the owner of metadata object.
     public fun burn(burn_cap: &BurnCapability, fa: FungibleAsset) acquires ManagingRefs {
         let metadata = burn_cap.metadata;
         let metadata_addr = object::object_address(&metadata);

precompile/modules/initia_stdlib/sources/crypto/ed25519.move

@@ -40,7 +40,7 @@ module initia_std::ed25519 {
     // Functions
     //
 
-    /// Contructs an PublicKey struct, given 32-byte representation.
+    /// Constructs an PublicKey struct, given 32-byte representation.
     public fun public_key_from_bytes(bytes: vector<u8>): PublicKey {
         assert!(
             std::vector::length(&bytes) == PUBLIC_KEY_SIZE,