Fix spellcheck

rkalis · rkalis · commit 3d0512aee847 · 2025-06-19T08:42:25.000+02:00
diff --git a/.cspell.json b/.cspell.json
@@ -23,6 +23,7 @@
         "bitcore",
         "bitfield",
         "bitfield's",
+        "bitshift",
         "blackie",
         "blockbook",
         "booland",
@@ -82,6 +83,8 @@
         "INPUTINDEX",
         "INPUTSEQUENCENUMBER",
         "ints",
+        "introspected",
+        "introspecting",
         "kalis",
         "keypair",
         "keypairs",
@@ -138,6 +141,7 @@
         "prevouts",
         "priv",
         "pubkey",
+        "pubkeys",
         "pubkeytype",
         "pushbytes",
         "pushdata",
@@ -155,6 +159,7 @@
         "scripthash",
         "sdks",
         "secp",
+        "segwit",
         "setup",
         "sig",
         "sighash",
@@ -185,6 +190,7 @@
         "unary",
         "unlocker",
         "unlockers",
+        "unreached",
         "utxo",
         "utxo's",
         "UTXOBYTECODE",
@@ -217,6 +223,7 @@
         "getrawtransaction",
         "hardhat",
         "hodlvault",
+        "incl",
         "infima",
         "jedex",
         "lichos",
@@ -227,6 +234,7 @@
         "outputnulldata",
         "outputp",
         "pako",
+        "paytaca",
         "popd",
         "pushd",
         "sendrawtransaction",
diff --git a/examples/transfer_with_timeout.ts b/examples/transfer_with_timeout.ts
@@ -58,8 +58,8 @@ const transferTx = await transactionBuilder.send();
 console.log('transfer transaction details:', stringify(transferTx));
 
 // Select a 2nd contract UTXO to spend from
-const updatecContractUtxos = await contract.getUtxos();
-const contractInputUtxo2 = updatecContractUtxos.find(utxo => utxo.satoshis > 5_000n);
+const updateContractUtxos = await contract.getUtxos();
+const contractInputUtxo2 = updateContractUtxos.find(utxo => utxo.satoshis > 5_000n);
 if (!contractInputUtxo2) throw new Error('No contract UTXO with enough satoshis found');
 const inputAmount2 = contractInputUtxo2.satoshis;
 
diff --git a/packages/cashc/src/generation/GenerateTargetTraversal.ts b/packages/cashc/src/generation/GenerateTargetTraversal.ts
@@ -211,7 +211,7 @@ export default class GenerateTargetTraversalWithLocation extends AstTraversal {
 
       // Replace the location data of the final check (e.g. (x == 1)) with the location data of the
       // full require statement including the removed OP_VERIFY (e.g. require(x == 1)), because
-      // the check opcode (e.g. OP_EQUAL) now represents the entire require statement (incl implicit OP_VERIFY)
+      // the check opcode (e.g. OP_EQUAL) now represents the entire require statement (including implicit OP_VERIFY)
       this.locationData.pop();
       this.locationData.push({ location, positionHint });
     } else {
diff --git a/packages/cashscript/src/advanced/LibauthTemplate.ts b/packages/cashscript/src/advanced/LibauthTemplate.ts
@@ -407,7 +407,7 @@ export const getLibauthTemplates = (
   for (const [inputIndex, input] of (txn.inputs as StandardUnlockableUtxo[]).entries()) {
     // If template exists on the input, it indicates this is a P2PKH (Pay to Public Key Hash) input
     if ('template' in input.unlocker) {
-      // @ts-ignore TODO: Remove UtxoP2PKH type and only use UnlockableUtxo in Libaith Template generation
+      // @ts-ignore TODO: Remove UtxoP2PKH type and only use UnlockableUtxo in Libauth Template generation
       input.template = input.unlocker?.template; // Added to support P2PKH inputs in buildTemplate
       Object.assign(p2pkhEntities, generateTemplateEntitiesP2PKH(inputIndex));
       Object.assign(p2pkhScripts, generateTemplateScriptsP2PKH(input.unlocker.template, inputIndex));
diff --git a/packages/cashscript/test/TransactionBuilder.test.ts b/packages/cashscript/test/TransactionBuilder.test.ts
@@ -212,7 +212,7 @@ describe('Transaction Builder', () => {
 
   // TODO: Consider improving error messages checked below to also include the input/output index
 
-  it('should fail when trying to send to invalid addres', async () => {
+  it('should fail when trying to send to invalid address', async () => {
     const p2pkhUtxos = (await p2pkhInstance.getUtxos()).filter(isNonTokenUtxo).sort(utxoComparator).reverse();
 
     expect(() => {
diff --git a/packages/cashscript/test/debugging.test.ts b/packages/cashscript/test/debugging.test.ts
@@ -134,7 +134,7 @@ describe('Debugging tests', () => {
       expect(transaction).toLog(expectedSecondLog);
     });
 
-    // This is an edge case because of optimisationn position hint merging
+    // This is an edge case because of optimisation position hint merging
     it('should log the correct variable value inside a notif statement', async () => {
       const transaction = new TransactionBuilder({ provider })
         .addInput(contractUtxo, contractTestLogs.unlock.test_log_inside_notif_statement(false))
diff --git a/packages/cashscript/test/fixture/debugging/debugging_contracts.ts b/packages/cashscript/test/fixture/debugging/debugging_contracts.ts
@@ -271,7 +271,7 @@ contract Test(pubkey owner) {
 }
 `;
 
-const CONTRACT_TEST_MULTPLE_LOGS = `
+const CONTRACT_TEST_MULTIPLE_LOGS = `
 contract Test(pubkey owner) {
   function transfer(sig ownerSig, int num) {
     require(checkSig(ownerSig, owner));
@@ -319,5 +319,5 @@ export const artifactTestMultilineRequires = compileString(CONTRACT_TEST_MULTILI
 export const artifactTestZeroHandling = compileString(CONTRACT_TEST_ZERO_HANDLING);
 export const artifactTestLogs = compileString(CONTRACT_TEST_LOGS);
 export const artifactTestConsecutiveLogs = compileString(CONTRACT_TEST_CONSECUTIVE_LOGS);
-export const artifactTestMultipleLogs = compileString(CONTRACT_TEST_MULTPLE_LOGS);
+export const artifactTestMultipleLogs = compileString(CONTRACT_TEST_MULTIPLE_LOGS);
 export const artifactTestMultipleConstructorParameters = compileString(CONTRACT_TEST_MULTIPLE_CONSTRUCTOR_PARAMETERS);
diff --git a/packages/cashscript/test/fixture/debugging/multi_contract_debugging_contracts.ts b/packages/cashscript/test/fixture/debugging/multi_contract_debugging_contracts.ts
diff --git a/packages/cashscript/test/multi-contract-debugging.test.ts b/packages/cashscript/test/multi-contract-debugging.test.ts
@@ -17,7 +17,7 @@ import {
 import p2pkhArtifact from './fixture/p2pkh.artifact.js';
 import bigintArtifact from './fixture/bigint.artifact.js';
 import '../src/test/JestExtensions.js';
-import { ARTIFACT_FUNCTION_NAME_COLLISION, ARTIFACT_NAME_COLLISION, ARTIFACT_CONTRACT_NAME_COLLISION, ARTIFACT_SAME_NAME_DIFFERENT_PATH } from './fixture/debugging/multicontract_debugging_contracts.js';
+import { ARTIFACT_FUNCTION_NAME_COLLISION, ARTIFACT_NAME_COLLISION, ARTIFACT_CONTRACT_NAME_COLLISION, ARTIFACT_SAME_NAME_DIFFERENT_PATH } from './fixture/debugging/multi_contract_debugging_contracts.js';
 import { addressToLockScript } from '../src/utils.js';
 import SiblingIntrospectionArtifact from './fixture/SiblingIntrospection.artifact.js';
 
diff --git a/packages/utils/src/optimisations.ts b/packages/utils/src/optimisations.ts
@@ -136,5 +136,5 @@ const unprovableOptimisations = [
 ] as [string, string][];
 
 // Note: we moved these optimisations into a single file, but kept the exact same order as before,
-// because the order in which oprimisations are applied can impact the output.
+// because the order in which optimisations are applied can impact the output.
 export const optimisationReplacements = [...provableOptimisations, ...unprovableOptimisations];
diff --git a/packages/utils/src/script.ts b/packages/utils/src/script.ts
@@ -274,7 +274,7 @@ function replaceOps(
       const patternLength = [...pattern.matchAll(/\s+/g)].length + 1;
       const replacementLength = replacement === '' ? 0 : [...replacement.matchAll(/\s+/g)].length + 1;
 
-      // We get the locationdata entries for every opcode in the pattern
+      // We get the locationData entries for every opcode in the pattern
       const patternLocations = newLocationData.slice(scriptIndex, scriptIndex + patternLength);
 
       // We get the lowest start location and highest end location of the pattern
diff --git a/website/docs/basics/about-bch.md b/website/docs/basics/about-bch.md
@@ -13,9 +13,9 @@ To learn more about the Bitcoin Basics refer to the book ['Mastering Bitcoin'](h
 
 ## How BCH differs from BTC
 
-Although BCH and BTC share the same Bitcoin fundamentals, both projects have significantly diverged in some ereas since 2017. For example, Bitcoin Cash does not have Segwit or Taproot, instead Bitcoin Cash has had multiple upgrades specifically focused on improving the smart contract capabilities. Bitcoin Cash has re-enabled many useful opcodes, has introduce native introspection, has added CashTokens, has reworked the script limits and introduced BigInts.
+Although BCH and BTC share the same Bitcoin fundamentals, both projects have significantly diverged in some areas since 2017. For example, Bitcoin Cash does not have Segwit or Taproot, instead Bitcoin Cash has had multiple upgrades specifically focused on improving the smart contract capabilities. Bitcoin Cash has re-enabled many useful opcodes, has introduce native introspection, has added CashTokens, has reworked the script limits and introduced BigInts.
 
-So part that **has** significantly diverged between BTC and BCH is the *virual machine* (VM), the environment in which smart contracts are evaluated. So the greatly improved VM specifically is what makes it possible to write powerful smart contracts on BCH in the first place!
+So part that **has** significantly diverged between BTC and BCH is the *virtual machine* (VM), the environment in which smart contracts are evaluated. So the greatly improved VM specifically is what makes it possible to write powerful smart contracts on BCH in the first place!
 
 ## UTXO model
 Bitcoin Cash transactions work with in- and outputs. All current balances are so called *Unspent Transaction Outputs (UTXOs)*, which simply means they can be used as inputs for future spending transactions.
@@ -26,7 +26,7 @@ UTXOs are locked using a locking script that specifies the conditions to spend t
 
 ## P2PKH transactions
 
-The most used locking/unlocking script pattern is called *Pay-to-Public-Key-Hash (P2PKH)*, where the locking script contains the hash of a public key and expects the unlocking script to contain a public key and transaction signature. The locking script then checks that the provided public key matches the stored hash, and that the transaction signature is valid. 
+The most used locking/unlocking script pattern is called *Pay-to-Public-Key-Hash (P2PKH)*, where the locking script contains the hash of a public key and expects the unlocking script to contain a public key and transaction signature. The locking script then checks that the provided public key matches the stored hash, and that the transaction signature is valid.
 
 The P2PKH pattern is used in regular Bitcoin Cash wallets. These wallets only know how to spend from inputs with this pattern, where the public-key-hash in question is the owners' public key. The user's wallet balance then is simply the sum of all UTXOs that can be spent by the user's public keys.
 
diff --git a/website/docs/basics/getting-started.md b/website/docs/basics/getting-started.md
@@ -6,7 +6,7 @@ title: Getting Started
 
 To get started with writing CashScript smart contracts quickly, it is recommended to try out the [CashScript Playground](https://playground.cashscript.org/), a web application which lets you easily write and create contracts!
 
-The Playground has a code-editor and CashScript compiler easily accesible, without any prerequisites. Further, the playground allows to easily create contracts, wallets and build transactions.
+The Playground has a code-editor and CashScript compiler easily accessible, without any prerequisites. Further, the playground allows to easily create contracts, wallets and build transactions.
 
 :::tip
 The [CashScript Playground](https://playground.cashscript.org/) is a great way to get started without doing any JavaScript/TypeScript coding, this way you can focus on learning just CashScript!
@@ -153,7 +153,7 @@ import { MockNetworkProvider, Contract, SignatureTemplate, TransactionBuilder, r
 import { alicePub, bobPriv, bobPub } from './keys.js';
 import artifact from './TransferWithTimeout.json' with { type: 'json' };
 
-// Initialise a mocknetwork provider for easy testing
+// Initialise a mock network provider for easy testing
 const provider = new MockNetworkProvider();
 
 // Instantiate a new TransferWithTimeout contract
diff --git a/website/docs/compiler/script-limits.md b/website/docs/compiler/script-limits.md
@@ -38,8 +38,8 @@ Bitcoin Cash enforces an operation cost limit (op-cost) per transaction input. T
 Since longer input scripts allow for a larger compute budget, some contracts use zero-padding (adding non-functional bytes) to "buy" more computation power without changing logic. You can find the exact op-cost per operation in the [op-cost-table][op-cost-table].
 
 ```ts
-function maxOperationCost(unlockingBytecodeLength) {  
-  return (41n + unlockingBytecodeLength) * 800n;  
+function maxOperationCost(unlockingBytecodeLength) {
+  return (41n + unlockingBytecodeLength) * 800n;
 }
 ```
 
@@ -75,7 +75,7 @@ function calculateDust(outputSize: number): number {
 ```
 
 Before CashTokens `546` bytes was often used as good default value, however with tokenData outputs have become larger in size.
-For ease of development, it is standard practice to use 1,000 satoshis as dust to outputs. 
+For ease of development, it is standard practice to use 1,000 satoshis as dust to outputs.
 
 :::note
 The standard practice of 1,000 satoshis as dust amount for outputs is only considering `P2PH`, `P2SH` and `P2PK` output types.
@@ -84,12 +84,12 @@ For `P2MS` (raw multisig) a higher dust limits may be required, you can [find mo
 
 ### Output Standardness
 
-Bitcoin Cash only allows a few types of `lockingbytecode` scripts for outputs in the normal network relay rules. These are called 'standard outputs', contrasted to 'non-standard outputs' which cause the transaction not to relay on the network.
+Bitcoin Cash only allows a few types of `lockingBytecode` scripts for outputs in the normal network relay rules. These are called 'standard outputs', contrasted to 'non-standard outputs' which cause the transaction not to relay on the network.
 
 There's 4 types of standard output types: `P2PKH`, `P2SH` (which includes `P2SH20` & `P2SH32`), `P2MS` and `OP_RETURN` data-outputs. For more details see the [standard outputs documentation][standard-outputs-docs].
 
 :::caution
-The `lockingbytecode` standardness rules can be important for smart contract developers, and is why CashScript has helpers like `LockingBytecodeP2PKH`, `LockingBytecodeP2SH32` and `LockingBytecodeNullData`.
+The `lockingBytecode` standardness rules can be important for smart contract developers, and is why CashScript has helpers like `LockingBytecodeP2PKH`, `LockingBytecodeP2SH32` and `LockingBytecodeNullData`.
 :::
 
 ## Summary table
@@ -110,4 +110,4 @@ For further details on transaction validation and standardness rules, see the [d
 [op-cost-table]: https://github.com/bitjson/bch-vm-limits/blob/master/operation-costs.md
 [standardness-docs]: https://documentation.cash/protocol/blockchain/transaction-validation/network-level-validation-rules#standard-transactions.html
 [standard-outputs-docs]: https://documentation.cash/protocol/blockchain/transaction/locking-script.html
-[info-dust-limit]: https://bitcoincashresearch.org/t/friday-night-challenge-worst-case-dust/1181/2
+[info-dust-limit]: https://bitcoincashresearch.org/t/friday-night-challenge-worst-case-dust/1181/2
diff --git a/website/docs/guides/walletconnect.md b/website/docs/guides/walletconnect.md
@@ -59,7 +59,7 @@ async function proposeWcTransaction(){
   // use the CashScript SDK to build a transaction
   const transactionBuilder = new TransactionBuilder({provider: store.provider})
   transactionBuilder.addInputs(userInputUtxos, placeholderUnlocker)
-  transactionBuilder.addOpReturnOutput(opreturnData)
+  transactionBuilder.addOpReturnOutput(opReturnData)
   transactionBuilder.addOutput(contractOutput)
   if(changeAmount > 550n) transactionBuilder.addOutput(changeOutput)
 
@@ -71,7 +71,7 @@ async function proposeWcTransaction(){
   // construct SourceOutputs from transaction input, see source code
   const sourceOutputs = generateSourceOutputs(transactionBuilder.inputs)
 
-  // we don't need to add the contractInfo to the wcSourceOutputs here  
+  // we don't need to add the contractInfo to the wcSourceOutputs here
   const wcSourceOutputs = sourceOutputs.map((sourceOutput, index) => {
     return { ...sourceOutput, ...decodedTransaction.inputs[index] }
   })
@@ -100,7 +100,7 @@ import { Contract } from "cashscript";
 import { hexToBin, decodeTransaction } from "@bitauth/libauth";
 
 async function unlockHodlVault(){
-  // create a placeholdes for the unlocking arguments
+  // create a placeholder for the unlocking arguments
   const placeholderSig = Uint8Array.from(Array(65))
   const placeholderPubKey = Uint8Array.from(Array(33));
 
diff --git a/website/docs/language/contracts.md b/website/docs/language/contracts.md
@@ -31,10 +31,10 @@ contract HTLC(pubkey sender, pubkey recipient, int expiration, bytes32 hash) {
 
 ### Constructor Arguments
 
-The constructor arguments are provided when initializing a specific instance of a smart contract. The provided constructor arguments are added to the start of the contract's script before the opcode logic. Because the constructor arguments are part of the full smart contract script, they are conceptually similar to hard-coded constants in your contract logic. Constructor arguments are a way to create 'global constants' accesible from different functions inside your contract.
+The constructor arguments are provided when initializing a specific instance of a smart contract. The provided constructor arguments are added to the start of the contract's script before the opcode logic. Because the constructor arguments are part of the full smart contract script, they are conceptually similar to hard-coded constants in your contract logic. Constructor arguments are a way to create 'global constants' accessible from different functions inside your contract.
 
 :::info
-The typings for the constructor arguments are only semantic and used when initilaizing the contract with the SDK. This means when not using the SDK you could still pass a different byte length item to `bytes32 hash`.
+The typings for the constructor arguments are only semantic and used when initializing the contract with the SDK. This means when not using the SDK you could still pass a different byte length item to `bytes32 hash`.
 :::
 
 :::note
@@ -61,7 +61,7 @@ contract TransferWithTimeout(pubkey sender, pubkey recipient, int timeout) {
 
 ### Function Arguments
 
-The function arguments are provided when attempting to spend from the contract. This means that these arguments can be crafted in a specific way by anyone to see if they can exploit the contract logic. Because of this it is important to realize these are 'untrusted arguments'. 
+The function arguments are provided when attempting to spend from the contract. This means that these arguments can be crafted in a specific way by anyone to see if they can exploit the contract logic. Because of this it is important to realize these are 'untrusted arguments'.
 
 In CashScript the types for the function arguments are **not** enforced automatically at the contract level. This can be especially relevant for types like `bool`, `bytesX` and other semantic bytes types. Instead this type information is only used by the SDK to check whether these arguments match the expected type during transaction building.
 
diff --git a/website/docs/language/types.md b/website/docs/language/types.md
@@ -144,7 +144,7 @@ string answer = question.split(15)[0].split(8)[1]; // Answer is "Cash"
 ```
 
 :::note
-It is not supported to use a variable for the tupleIndex. Instead you can assign both sides of the tuple as shown below and use either element conditional on the value of the variable. 
+It is not supported to use a variable for the tupleIndex. Instead you can assign both sides of the tuple as shown below and use either element conditional on the value of the variable.
 :::
 
 It is also possible to assign both sides of the tuple at once with a destructuring syntax:
@@ -183,11 +183,11 @@ See the following table for information on which types can be cast to other whic
 When casting integer types to bytes of a certain size, the integer value is padded with zeros, e.g. `bytes4(0) == 0x00000000`. It is also possible to pad with a variable number of zeros by passing in a `size` parameter, which indicates the size of the output, e.g. `bytes(0, 4 - 2) == 0x0000`.
 
 :::tip
-Using `bytes20 placeholderPkh= bytes20(0)` will generate a 20 byte zero-array programmatically, whereas 
+Using `bytes20 placeholderPkh= bytes20(0)` will generate a 20 byte zero-array programmatically, whereas
 `bytes20 placeholderPkh= 0x0000000000000000000000000000000000000000` will actually take 20 bytes of space in your contract.
 :::
 
-Casting an integer to a fixed-size byte-length can be a very important when storing local state in an nftCommitment. When casting a script number to bytes, developers need to consider what the preferable fixed-size length is for each indivual case depending on the interger range. Below we add a table with info on the maximum integer size for common cases:
+Casting an integer to a fixed-size byte-length can be a very important when storing local state in an nftCommitment. When casting a script number to bytes, developers need to consider what the preferable fixed-size length is for each individual case depending on the integer range. Below we add a table with info on the maximum integer size for common cases:
 
 | Integer Type    | Max integer value                  | Max Byte Size in Script Number Format  |
 | --------------  | -----------------------------------| ---------------------------------------|
diff --git a/website/docs/sdk/instantiation.md b/website/docs/sdk/instantiation.md
diff --git a/website/docs/sdk/testing-setup.md b/website/docs/sdk/testing-setup.md
diff --git a/website/docs/showcase.md b/website/docs/showcase.md
