Fix spelling (thirdweb-dev#665)

Co-authored-by: Jonas Daniels <[email protected]>
mattetre · Mar 2, 2023 · 6ef52dc · 6ef52dc
1 parent b6b0855
commit 6ef52dc
Show file tree

Hide file tree

Showing 56 changed files with 105 additions and 103 deletions.
diff --git a/.changeset/metal-ducks-fry.md b/.changeset/metal-ducks-fry.md
@@ -0,0 +1,12 @@
+---
+"@thirdweb-dev/react-native": patch
+"@thirdweb-dev/react-core": patch
+"@thirdweb-dev/storage": patch
+"@thirdweb-dev/wallets": patch
+"@thirdweb-dev/react": patch
+"@thirdweb-dev/auth": patch
+"thirdweb": patch
+"@thirdweb-dev/sdk": patch
+---
+
+Fix spelling throughout all packages
diff --git a/.gitignore b/.gitignore
@@ -10,7 +10,6 @@ dist-ssr
 .cache
 server/dist
 public/dist
-.turbo
 ./packages/contracts-js/abis
 .idea/
 .yalc/

diff --git a/README.md b/README.md
@@ -5,7 +5,7 @@
     <br />
 </p>
 
-<h1 align="center"><a href='http://thirdweb.com/'>thirdweb</a> JavaScript/TypeScript monorepo</h1>
+<h1 align="center"><a href='https://thirdweb.com/'>thirdweb</a> JavaScript/TypeScript monorepo</h1>
 
 <p align="center">
     <a href="https://github.com/thirdweb-dev/js/actions/workflows/build-test-lint.yml">

diff --git a/packages/auth/src/express/routes/logout.ts b/packages/auth/src/express/routes/logout.ts
@@ -31,5 +31,5 @@ export default async function handler(
     }),
   );
 
-  return res.status(200).json({ message: "Succesfully logged out" });
+  return res.status(200).json({ message: "Successfully logged out" });
 }
diff --git a/packages/auth/src/next/routes/logout.ts b/packages/auth/src/next/routes/logout.ts
@@ -31,5 +31,5 @@ export default async function handler(
     }),
   );
 
-  return res.status(200).json({ message: "Succesfully logged out" });
+  return res.status(200).json({ message: "Successfully logged out" });
 }
diff --git a/packages/cli/src/common/file-helper.ts b/packages/cli/src/common/file-helper.ts
@@ -21,7 +21,7 @@ export function findFiles(
     }
     const stat = statSync(filename);
 
-    // brownie has a "depdendencies" directory *inside* the build directory, if we detect that we should skip it
+    // brownie has a "dependencies" directory *inside* the build directory, if we detect that we should skip it
     if (stat.isDirectory() && basename(filename) === "dependencies") {
       logger.debug('skipping "dependencies" directory');
       continue;

diff --git a/packages/cli/src/core/builder/foundry.ts b/packages/cli/src/core/builder/foundry.ts
@@ -150,7 +150,7 @@ export class FoundryBuilder extends BaseBuilder {
   ) {
     // replace the abi with the actual abi
     parsedMetadata.output.abi = abi;
-    // need to re-add libraries if not present since forge stripts it out
+    // need to re-add libraries if not present since forge strips it out
     if (!parsedMetadata.settings.libraries) {
       parsedMetadata.settings.libraries = {};
     }

diff --git a/packages/cli/src/core/builder/solc.ts b/packages/cli/src/core/builder/solc.ts
@@ -70,7 +70,7 @@ export class SolcBuilder extends BaseBuilder {
     }
 
     // write them out to artifacts dir
-    // TODO technically we *could* just return them straight here, we have them in memory anywa?
+    // TODO technically we *could* just return them straight here, we have them in memory anyway?
     Object.keys(output.contracts)
       .filter((contractName) => contractName in sources)
       .forEach((contractName) => {

diff --git a/packages/cli/src/core/detection/detect.ts b/packages/cli/src/core/detection/detect.ts
@@ -19,7 +19,7 @@ export default async function detect(
     new HardhatDetector(),
     new FoundryDetector(),
     new TruffleDetector(),
-    // new BrownieDetector(), TODO brownie does not support outputing metadata yet
+    // new BrownieDetector(), TODO brownie does not support outputting metadata yet
   ];
 
   const possibleProjectTypes = detectors

diff --git a/packages/cli/src/storage/command.ts b/packages/cli/src/storage/command.ts
@@ -63,7 +63,7 @@ export async function upload(
       "Uploading file to IPFS. This may take a while depending on file sizes.",
     );
     uri = await storage.upload(file, { uploadWithoutDirectory: true });
-    spin.succeed("Succesfully uploaded file to IPFS.");
+    spin.succeed("Successfully uploaded file to IPFS.");
   } else {
     return Promise.reject("Invalid path provided");
   }

diff --git a/packages/react-core/.gitignore b/packages/react-core/.gitignore
@@ -2,9 +2,6 @@ node_modules/
 /test-results/
 /playwright-report/
 /playwright/.cache/
-/test-results/
-/playwright-report/
-/playwright/.cache/
 etc/
 temp/
 temp-evm/

diff --git a/packages/react-core/src/core/query-utils/required-param.ts b/packages/react-core/src/core/query-utils/required-param.ts
@@ -1,7 +1,7 @@
 import invariant from "tiny-invariant";
 
 /**
- * Makes a parameter required to be passed, but still allowes it to be null or undefined.
+ * Makes a parameter required to be passed, but still allows it to be null or undefined.
  *
  * @beta
  */

diff --git a/packages/react-core/src/evm/hooks/async/claim-conditions.ts b/packages/react-core/src/evm/hooks/async/claim-conditions.ts
@@ -221,7 +221,7 @@ export function useClaimConditions(
 
 /**
  * Get the reasons why a specific wallet can't claim
- * 
+ *
  * @example
  * ```javascript
  * const { data: claimIneligibilityReasons, isLoading, error } = useClaimIneligibilityReasons(contract, { walletAddress: "{{wallet_address}}" });
@@ -230,7 +230,7 @@ export function useClaimConditions(
  * @param contract - an instance of a contract that extends the  ERC20, ERC721 or ERC1155 spec and implements the `claimConditions` extension.
  * @param eligibilityParams - the parameters for the eligibility check, see: {@link ClaimIneligibilityParams}
  * @param tokenId - the id of the token to fetch the claim conditions for (if the contract is an ERC1155 contract)
- * @returns a response object with the resons for the claim ineligibility
+ * @returns a response object with the reasons for the claim ineligibility
  * @twfeature ERC20ClaimPhasesV2 | ERC20ClaimPhasesV1 | ERC20ClaimConditionsV2 | ERC20ClaimConditionsV1 | ERC721ClaimPhasesV2 | ERC721ClaimPhasesV1 | ERC721ClaimConditionsV2 | ERC721ClaimConditionsV1 | ERC1155ClaimPhasesV2 | ERC1155ClaimPhasesV1 | ERC1155ClaimConditionsV2 | ERC1155ClaimConditionsV1
  * @beta
  */
@@ -290,7 +290,7 @@ export function useClaimIneligibilityReasons(
 
 /**
  * Get the active claim condition for a specific wallet
- * 
+ *
  * @example
  * ```javascript
  * const { data: activeClaimConditionForWallet, isLoading, error } = useActiveClaimConditionForWallet(contract, "{{wallet_address}}");

diff --git a/packages/react-core/src/evm/hooks/async/contracts.ts b/packages/react-core/src/evm/hooks/async/contracts.ts
@@ -368,15 +368,15 @@ export function useContractMetadataUpdate(
 
 /**
  * Get or subscribe to contract events
- * 
+ *
  * @example
  * ```javascript
  * const { data: contractEvents, isLoading } = useContractEvents(contract);
  * ```
  *
  * @param contract - the {@link ValidContractInstance} instance of the contract to listen to events for
  * @param eventName - the name of the event to query for (omit this or pass `undefined` to query for all events)
- * @param options - options incldues the filters ({@link QueryAllEvents}) for the query as well as if you want to subscribe to real-time updates (default: true)
+ * @param options - options includes the filters ({@link QueryAllEvents}) for the query as well as if you want to subscribe to real-time updates (default: true)
  * @returns a response object that includes the contract events
  * @beta
  */

diff --git a/packages/react-core/src/evm/hooks/async/nft.ts b/packages/react-core/src/evm/hooks/async/nft.ts
@@ -170,7 +170,8 @@ export function useTotalCount<TContract extends NFTContract>(
  * ```
  *
  * @param contract - an instance of a {@link NFTContract}
- * @returns a response object that incudes the total minted supply
+ * @param tokenId - required for ERC1155, the tokenId to look up
+ * @returns a response object that includes the total minted supply
  * @beta
  * @twfeature ERC721Supply | ERC1155Enumerable
  */
@@ -218,7 +219,7 @@ export function useTotalCirculatingSupply(
  * ```
  *
  * @param contract - an instance of a {@link NFTContract}
- * @param ownerWalletAddress - the wallet adress to get owned tokens for
+ * @param ownerWalletAddress - the wallet address to get owned tokens for
  * @returns a response object that includes the list of owned tokens
  * @beta
  * @twfeature ERC721Enumerable | ERC1155Enumerable | ERC721Supply
@@ -261,7 +262,8 @@ export function useOwnedNFTs<TContract extends NFTContract>(
  * ```
  *
  * @param contract - an instance of a {@link NFTContract}
- * @param ownerWalletAddress - the wallet adress to check the balance of
+ * @param ownerWalletAddress - the wallet address to check the balance of
+ * @param tokenId - required for ERC1155, the tokenId to look up
  * @returns a response object that includes the total balance of the owner
  * @twfeature ERC721 | ERC1155
  * @beta
@@ -465,9 +467,9 @@ export function useMintNFTSupply(contract: Erc1155) {
  *   return (
  *     <button
  *       disabled={isLoading}
- *       onClick={() => transferNFT({ 
- *         to: "{{wallet_address}}", 
- *         tokenId: 2 
+ *       onClick={() => transferNFT({
+ *         to: "{{wallet_address}}",
+ *         tokenId: 2
  *       })}
  *     >
  *       Transfer
@@ -538,7 +540,7 @@ export function useTransferNFT<TContract extends NFTContract>(
  *       onClick={() => airdropNFT({
  *          tokenId: 2,
  *          addresses: [
- *            { address: "{{wallet_address}}", quantity: 2 }, 
+ *            { address: "{{wallet_address}}", quantity: 2 },
  *            { address: "{{wallet_address}}", quantity: 4 } }
  *          ]
  *       )}

diff --git a/packages/react-core/src/evm/hooks/async/token.ts b/packages/react-core/src/evm/hooks/async/token.ts
@@ -32,7 +32,7 @@ import invariant from "tiny-invariant";
  * ```
  *
  * @param contract - an instance of a {@link TokenContract}
- * @returns a response object that incudes the total minted supply
+ * @returns a response object that includes the total minted supply
  * @twfeature ERC20
  * @beta
  */
@@ -214,7 +214,7 @@ export function useMintToken(contract: RequiredParam<TokenContract>) {
  * ```
  *
  * @param contract - an instance of a {@link TokenContract}
- * @returns a mutation object that can be used to tokens to the wallet specificed in the params
+ * @returns a mutation object that can be used to tokens to the wallet specified in the params
  * @twfeature ERC20ClaimPhasesV2 | ERC20ClaimPhasesV1 | ERC20ClaimConditionsV2 | ERC20ClaimConditionsV1
  * @beta
  */

diff --git a/packages/react-core/src/evm/hooks/contracts/useEditionDrop.ts b/packages/react-core/src/evm/hooks/contracts/useEditionDrop.ts
@@ -3,7 +3,7 @@ import { showDeprecationWarning } from "../../utils/deprecation-warning";
 import { useContract } from "../async/contracts";
 
 /**
- * Hook for getting an instance of an `EditionDrop` contract. This conract is used to interface with ERC1155 compliant NFTs that can be lazily minted.
+ * Hook for getting an instance of an `EditionDrop` contract. This contract is used to interface with ERC1155 compliant NFTs that can be lazily minted.
  * @param contractAddress - the address of the Edition Drop contract, found in your thirdweb dashboard
  *
  * @example

diff --git a/packages/react-core/src/evm/hooks/contracts/useSplit.ts b/packages/react-core/src/evm/hooks/contracts/useSplit.ts
@@ -15,7 +15,7 @@ import { useContract } from "../async/contracts";
  *
  *   // Now you can use the split contract in the rest of the component
  *
- *   // For example, this function will retrun all the receipients of the split
+ *   // For example, this function will return all the recipients of the split
  *   async function getRecipients() {
  *     const recipients = await contract.getAllRecipients()
  *     return recipients

diff --git a/packages/react-core/src/evm/hooks/useNetworkMismatch.ts b/packages/react-core/src/evm/hooks/useNetworkMismatch.ts
@@ -5,7 +5,7 @@ import { useChainId } from "./wallet";
  * Hook for checking whether the connected wallet is on the correct network specified by the `network` passed to the `<ThirdwebProvider />`.
  *
  * ```javascript
- * import { useNetworkMistmatch } from "@thirdweb-dev/react"
+ * import { useNetworkMismatch } from "@thirdweb-dev/react"
  * ```
  *
  * @returns `true` if the chainId of the connected wallet is different from the chainId of the network passed into <ThirdwebProvider />

diff --git a/packages/react-core/src/solana/hooks/auth/useUser.ts b/packages/react-core/src/solana/hooks/auth/useUser.ts
@@ -36,7 +36,7 @@ export function useUser<
         "Please specify an authUrl in the authConfig.",
       );
 
-      // We include credentials so we can getUser even if API is on different URL
+      // We include credentials, so we can getUser even if API is on different URL
       const res = await fetch(`${authConfig.authUrl}/user`, {
         credentials: "include",
       });

diff --git a/packages/react-core/src/solana/hooks/nft/useNFT.ts b/packages/react-core/src/solana/hooks/nft/useNFT.ts
@@ -28,8 +28,7 @@ export function nftGetOneQuery(
 /**
  * Get the metadata for a minted NFT
  * @param program - The NFT program to get NFT metadata from
- * @param - tokenAdress - The mint address of the NFT to get the metadata of
- *
+ * @param tokenAddress - The mint address of the NFT to get the metadata of *
  * @example
  * ```jsx
  * import { useProgram, useNFT } from "@thirdweb-dev/react/solana";

diff --git a/packages/react-core/src/solana/hooks/nft/useTotalSupply.ts b/packages/react-core/src/solana/hooks/nft/useTotalSupply.ts
@@ -21,7 +21,7 @@ export function nftTotalSupplyQuery(
 }
 
 /**
- * Get the totaly supply of NFTs on the program
+ * Get the total supply of NFTs on the program
  * @param program - The NFT program to get the total supply of
  *
  * @example

diff --git a/packages/react-core/src/solana/hooks/wallet/useBalance.ts b/packages/react-core/src/solana/hooks/wallet/useBalance.ts
@@ -27,7 +27,7 @@ export function balanceQuery(sdk: RequiredParam<ThirdwebSDK>) {
 /**
  * Get the currently connected wallet balance
  *
- * @returns the balace of the connected wallet
+ * @returns the balance of the connected wallet
  */
 export function useBalance() {
   const sdk = useSDK();

diff --git a/packages/react-native-compat/.gitignore b/packages/react-native-compat/.gitignore
@@ -60,9 +60,6 @@ buck-out/
 android/app/libs
 android/keystores/debug.keystore
 
-# Expo
-.expo/
-
 # Turborepo
 .turbo/
 

diff --git a/packages/react-native/src/evm/hooks/connectors/useWalletConnect.ts b/packages/react-native/src/evm/hooks/connectors/useWalletConnect.ts
@@ -14,7 +14,7 @@ import UniversalProvider from "@walletconnect/universal-provider/dist/types/Univ
  *
  *
  * @example
- * We can allows user to connect their mobile wallets as follows:
+ * We can allow user to connect their mobile wallets as follows:
  * ```javascript
  * import { useWalletConnect } from "@thirdweb-dev/react-native"
  *
@@ -59,20 +59,20 @@ export function useWalletConnect() {
   }, [wagmiConnectError]);
 
   useEffect(() => {
-    // wagmi storage doesn't support async storage on mobile so we need to manually connect
+    // wagmi storage doesn't support async storage on mobile, so we need to manually connect
     // https://github.com/wagmi-dev/wagmi/discussions/1630
     const getProvider = async () => {
       const provider = await walletConnector.getProvider();
       const univProvider = provider as unknown as UniversalProvider;
 
-      // waiting on wagmi to update to latest universal provider (tag 2.4.2)
+      // waiting on wagmi to update the latest universal provider (tag 2.4.2)
       // univProvider.client.on('session_request_sent', ({ topic, request, chainId }) => {
       //   // redirect to wallet
       //   Linking.openURL(displayUri);
       // });
 
       if (univProvider.client.session.length > 0) {
-        // wc client does not report a successful initialization
+        // wc client does not report a successful initialization,
         // so we need to wait for it to initialize before connecting
         setTimeout(() => {
           connect({ connector: walletConnector });

diff --git a/packages/react/.gitignore b/packages/react/.gitignore
@@ -2,9 +2,6 @@ node_modules/
 /test-results/
 /playwright-report/
 /playwright/.cache/
-/test-results/
-/playwright-report/
-/playwright/.cache/
 etc/
 temp/
 temp-evm/

diff --git a/packages/react/src/core/query-utils/required-param.ts b/packages/react/src/core/query-utils/required-param.ts
@@ -1,7 +1,7 @@
 import invariant from "tiny-invariant";
 
 /**
- * Makes a parameter required to be passed, but still allowes it to be null or undefined.
+ * Makes a parameter required to be passed, but still allows it to be null or undefined.
  *
  * @beta
  */

diff --git a/packages/react/src/evm/connectors/gnosis-safe.ts b/packages/react/src/evm/connectors/gnosis-safe.ts
@@ -9,7 +9,7 @@ import {
   useContext as useWagmiContext,
 } from "wagmi";
 
-// exerpt from https://docs.gnosis-safe.io/backend/available-services
+// excerpt from https://docs.gnosis-safe.io/backend/available-services
 const CHAIN_ID_TO_GNOSIS_SERVER_URL = {
   // mainnet
   1: "https://safe-transaction-mainnet.safe.global",

diff --git a/packages/react/src/evm/hooks/connectors/useMetamask.ts b/packages/react/src/evm/hooks/connectors/useMetamask.ts
@@ -76,7 +76,7 @@ export function useMetamask() {
       });
     }
 
-    // otherwise we have MM avaiable, so we can just use it
+    // otherwise we have MM available, so we can just use it
     return await connect(connector);
   };
 }
diff --git a/packages/react/src/evm/hooks/connectors/useWalletConnect.ts b/packages/react/src/evm/hooks/connectors/useWalletConnect.ts
@@ -14,7 +14,7 @@ globalThis.Buffer = Buffer;
  *
  *
  * @example
- * We can allows user to connect their mobile wallets as follows:
+ * We can allow user to connect their mobile wallets as follows:
  * ```javascript
  * import { useWalletConnect } from "@thirdweb-dev/react"
  *

diff --git a/packages/react/src/evm/hooks/connectors/useWalletLink.ts b/packages/react/src/evm/hooks/connectors/useWalletLink.ts
@@ -56,7 +56,7 @@ export function useCoinbaseWallet() {
 }
 
 /**
- * Convienience hook for connecting to a wallet via WalletLink (coinbase wallet)
+ * Convenience hook for connecting to a wallet via WalletLink (coinbase wallet)
  * @returns a function that will prompt the user to connect their wallet via WalletLink (coinbase wallet)
  * @internal
  */

diff --git a/packages/sdk/src/evm/common/utils.ts b/packages/sdk/src/evm/common/utils.ts
@@ -1,7 +1,6 @@
 /**
  * @internal
  */
-// @ts-expext-error window is not defined
 export const isBrowser = () => typeof window !== "undefined";
 
 /**
-Original file line number
+Diff line change
@@ Expand Up / @@ -10,7 +10,6 @@ dist-ssr @@
     .cache
     server/dist
     public/dist
-    .turbo
     ./packages/contracts-js/abis
     .idea/
     .yalc/
@@ Expand Down @@