Fix spellcheck

CashScript · Sep 24, 2024 · 1d2b05f · 1d2b05f
1 parent 037757a
commit 1d2b05f
Show file tree

Hide file tree

Showing 15 changed files with 60 additions and 35 deletions.
diff --git a/.cspell.json b/.cspell.json
@@ -33,6 +33,7 @@
         "cashc",
         "cashproof",
         "cashscript",
+        "cashtokens",
         "castable",
         "checkdatasig",
         "checkdatasigverify",
@@ -79,6 +80,7 @@
         "INPUTBYTECODE",
         "INPUTINDEX",
         "INPUTSEQUENCENUMBER",
+        "ints",
         "kalis",
         "keypair",
         "keypairs",
@@ -98,6 +100,7 @@
         "meep",
         "minimaldata",
         "minimalif",
+        "mocknet",
         "n",
         "noncompressed",
         "nonschnorr",
@@ -109,6 +112,7 @@
         "numequal",
         "numequalverify",
         "numnotequal",
+        "NOTEQUAL",
         "op",
         "opcode",
         "opcodes",
@@ -156,21 +160,28 @@
         "sigs",
         "spedn",
         "startup",
+        "standardness",
         "tagline",
         "teardown",
         "tendo",
         "timeout",
+        "timeops",
+        "timelock",
+        "timelocks",
         "toaltstack",
         "troutner",
         "tuple",
         "tuples",
+        "typeof",
         "txid",
         "TXINPUTCOUNT",
         "TXLOCKTIME",
         "TXOUTPUTCOUNT",
         "txvalue",
         "TXVERSION",
         "unary",
+        "unlocker",
+        "unlockers",
         "utxo",
         "utxo's",
         "UTXOBYTECODE",
@@ -185,29 +196,43 @@
         "workdir"
     ],
     "ignoreWords": [
+        "bitcats",
         "bitcoincashjs",
+        "branchup",
+        "bchguru",
         "cashcompiler",
+        "cashninjas",
         "cherian",
+        "CSCriptNum",
         "docu",
+        "fundme",
+        "hardhat",
         "infima",
         "jedex",
         "lichos",
+        "mainnetjs",
         "maxdepth",
         "networkprovider",
         "outputnulldata",
         "outputp",
+        "pako",
+        "popd",
+        "pushd",
         "setfiletype",
         "tada",
+        "tapswap",
         "txage",
         "txbytecode",
         "txhashoutputs",
         "txtime",
+        "vite",
         "withage",
         "withfeeperbyte",
         "withhardcodedfee",
         "withminchange",
         "withopreturn",
-        "withtime"
+        "withtime",
+        "XBVJRKV"
     ],
     "ignorePaths": [
         // Do not spellcheck NPM files

diff --git a/packages/cashscript/src/LibauthTemplate.ts b/packages/cashscript/src/LibauthTemplate.ts
@@ -101,7 +101,7 @@ export const buildTemplate = async ({
       };
 
       // add extra unlocking and locking script for P2PKH inputs spent alongside our contract
-      // this is needed for correct cross-referrences in the template
+      // this is needed for correct cross-references in the template
       template.scripts[unlockScriptName] = {
         name: unlockScriptName,
         script:

diff --git a/packages/cashscript/src/Transaction.ts b/packages/cashscript/src/Transaction.ts
@@ -278,7 +278,7 @@ export class Transaction {
       // Compare nfts in- and outputs, check if inputs have nfts corresponding to outputs
       // Keep list of nfts in inputs without matching output
       // First check immutable nfts, then mutable & minting nfts together
-      // This is so an immutible input gets matched first and is removed from the list of unused nfts
+      // This is so an immutable input gets matched first and is removed from the list of unused nfts
       let unusedNfts = listNftsInputs;
       for (const nftInput of listNftsInputs) {
         if (nftInput.capability === 'none') {

diff --git a/packages/cashscript/src/TransactionBuilder.ts b/packages/cashscript/src/TransactionBuilder.ts
@@ -52,7 +52,7 @@ export class TransactionBuilder {
       (!unlocker && utxos.some((utxo) => !isUnlockableUtxo(utxo)))
       || (unlocker && utxos.some((utxo) => isUnlockableUtxo(utxo)))
     ) {
-      throw new Error('Either all UTXOs must have an individual unlocker speciifed, or no UTXOs must have an individual unlocker specified and a shared unlocker must be provided');
+      throw new Error('Either all UTXOs must have an individual unlocker specified, or no UTXOs must have an individual unlocker specified and a shared unlocker must be provided');
     }
 
     if (!unlocker) {

diff --git a/packages/cashscript/test/debugging.test.ts b/packages/cashscript/test/debugging.test.ts
@@ -694,7 +694,7 @@ describe('Debugging tests', () => {
     });
 
     // test_multiline_non_require_error
-    it('should fail with correct error message and statament when a multiline non-require statement fails', async () => {
+    it('should fail with correct error message and statement when a multiline non-require statement fails', async () => {
       const contract = new Contract(artifact3, [], { provider });
 
       provider.addUtxo(contract.address, randomUtxo());

diff --git a/website/docs/basics/about-bch.md b/website/docs/basics/about-bch.md
@@ -5,7 +5,7 @@ sidebar_label: About Bitcoin Cash
 
 Bitcoin Cash (ticker BCH) is one of the biggest cryptocurrencies. Bitcoin Cash is a fork of Bitcoin started in 2017 because of differences in vision for the future of the Bitcoin project.
 
-Bitcoin Cash shares many of the same fundamentals as Bitcoin (BTC) like the *Proof-of-Work* consensus alrgorithm and the *UTXO data-model*. However regarding smart contract programmability, Bitcoin Cash has significantly diverged from Bitcoin (BTC). We will first cover the UTXO data model and then delve into the smart contract capabilities of Bitcoin Cash.
+Bitcoin Cash shares many of the same fundamentals as Bitcoin (BTC) like the *Proof-of-Work* consensus algorithm and the *UTXO data-model*. However regarding smart contract programmability, Bitcoin Cash has significantly diverged from Bitcoin (BTC). We will first cover the UTXO data model and then delve into the smart contract capabilities of Bitcoin Cash.
 
 :::info
 To learn more about the Bitcoin Basics refer to the book ['Mastering Bitcoin'](https://github.com/bitcoinbook/bitcoinbook). There is also a modified version for BCH specifically called ['Mastering Bitcoin Cash'](https://github.com/Bitcoin-com/mastering-bitcoin-cash).
@@ -31,4 +31,4 @@ The locking and unlocking scripts of regular transactions and smart contracts on
 
 ### CashScript
 
-CashScript is a high-level programming language for smart contracts on Bitcoin Cash that offers a strong abstraction for a smoother development experience. The CashScript syntax is based on Ethereum's smart contract language Solidity, but its functionality is very different since smart contracts on Bitcoin Cash differ greatly from smart contracts on Ethereum.
+CashScript is a high-level programming language for smart contracts on Bitcoin Cash that offers a strong abstraction for a smoother development experience. The CashScript syntax is based on Ethereum's smart contract language Solidity, but its functionality is very different since smart contracts on Bitcoin Cash differ greatly from smart contracts on Ethereum.
diff --git a/website/docs/basics/getting-started.md b/website/docs/basics/getting-started.md
@@ -20,7 +20,7 @@ With the CashScript playground there's a nice integrated editor to get started,
 
 To write CashScript smart contracts locally you use a code editor. For the best developer experience, we recommend to use VS Code with the CashScript extension. This way it will automatically recognize `.cash` files and offer highlighting and autocompletion.
 
-:::note prerequisties
+:::note prerequisites
 - Basic familiarity with the command line
 - Node.js installed
 - A code editor (VS Code recommended)
@@ -149,4 +149,4 @@ const transferDetails = await contract.functions
 console.log(transferDetails);
 ```
 
-Congrats 🎉! You've successfully created a transaction spending from a Bitcoin Cash smart contract! 
+Congrats 🎉! You've successfully created a transaction spending from a Bitcoin Cash smart contract!
diff --git a/website/docs/guides/debugging.md b/website/docs/guides/debugging.md
@@ -26,14 +26,14 @@ If a CashScript transaction is evaluated with `.debug()` or is sent to a network
 ```bash
 HodlVault.cash:23 Require statement failed at input 0 in contract HodlVault.cash at line 23.
 Failing statement: require(price >= priceTarget)
-Bithauth IDE: [link]
+Bitauth IDE: [link]
 ```
 
 Read the error message to see which line in the CashScript contract causes the transaction validation to fail. Investigate whether the contract function invocation is the issue (on the TypeScript SDK side) or whether the issue is in the CashScript contract itself (so you'd need to update your contract and recompile the artifact). If it is not clear **why** the CashScript contract is failing on that line, then you can use the following two strategies: console logging & Bitauth IDE stack trace.
 
 ### Console Logging
 
-To help with debugging you can add `console.log` statements to your CashScript contract file to log variables. This way you investigate whether the variables have the expected values when they get to the failing `require` statement in the CashScript file. After adding the `console.log` statements, recompile your contract so they are added to your contract's Artifact. 
+To help with debugging you can add `console.log` statements to your CashScript contract file to log variables. This way you investigate whether the variables have the expected values when they get to the failing `require` statement in the CashScript file. After adding the `console.log` statements, recompile your contract so they are added to your contract's Artifact.
 
 ### Bitauth IDE
 
@@ -50,7 +50,7 @@ const uri = await transaction.bitauthUri();
 It is unsafe to debug transactions on mainnet as private keys will be exposed to BitAuth IDE and transmitted over the network.
 :::
 
-The Bithauth IDE will show you the two-way mapping between the CashScript contract code generated opcodes. Here is [a Bithauth IDE link][BitauthIDE] for the basic `TransferWithTimeout` contract as an example:
+The Bitauth IDE will show you the two-way mapping between the CashScript contract code generated opcodes. Here is [a Bitauth IDE link][BitauthIDE] for the basic `TransferWithTimeout` contract as an example:
 
 ```js
 // "TransferWithTimeout" contract constructor parameters
@@ -73,7 +73,7 @@ OP_3 OP_ROLL OP_1 OP_ROLL OP_CHECKSIG OP_VERIFY /*         require(checkSig(send
 OP_1 OP_ROLL OP_CHECKLOCKTIMEVERIFY OP_DROP     /*         require(tx.time >= timeout);                                         */
 OP_1 OP_NIP                                     /*     }                                                                        */
 OP_ENDIF                                        /* }                                                                            */
-                                                /*      
+                                                /*
 ```
 
 ## Advanced Transaction Builder
@@ -88,12 +88,12 @@ When a transaction gets rejected by a full node, it will return a cryptic error
 mandatory-script-verify-flag-failed (Script failed an OP_VERIFY operation) (code 16)
 ```
 
-Read the message carefully to investigate whether the issue is a failing script (failing OpCode) or whether a standardness rule like minimum-relay-fee is violated. 
+Read the message carefully to investigate whether the issue is a failing script (failing OpCode) or whether a standardness rule like minimum-relay-fee is violated.
 If the cause is a failing OpCode, you can check the contract's Artifact to see how many appearances this OpCode has. Sometimes the OpCode only appears once or twice, indicating where the failing `require` statement is. Other times you might see 15 appearances of the OpCode leaving you to try the next strategies.
 
 ### Removing Contract Checks
 
-If your contract fails, you can remove (or comment out) the lines that are the likely cause of the error. After recompiling to a new Artifact you can test whether the remaining subcontract works or fails with a different error. If this is the case, then you learned that there is an issue in the removed CashScript code block. In the worst case, when you have no indication from the failing opcode (previous strategy), then you will have to try to remove different parts of your contract and try different sub-contracts repeatedly. 
+If your contract fails, you can remove (or comment out) the lines that are the likely cause of the error. After recompiling to a new Artifact you can test whether the remaining subcontract works or fails with a different error. If this is the case, then you learned that there is an issue in the removed CashScript code block. In the worst case, when you have no indication from the failing opcode (previous strategy), then you will have to try to remove different parts of your contract and try different sub-contracts repeatedly.
 
 To use this strategy effectively, the contract setup with funding should be automated as to avoid having to send testnet coins manually to each different subcontract. However inefficient, this strategy should always be able to get you to find the failing line in your CashScript contract. Then you can investigate whether the issue is the contract invocation or the `require` statement in the CashScript file.
 

diff --git a/website/docs/guides/optimization.md b/website/docs/guides/optimization.md
@@ -109,7 +109,7 @@ console.log(contract.opcount);
 console.log(contract.bytesize);
 ```
 
-With this workflow, you can make changes to the contract and the run the JavaScript program to 
+With this workflow, you can make changes to the contract and the run the JavaScript program to
 get an accurate measure of how the bytesize of your contract changes with different optimizations.
 
 ## To optimize or not to optimize?
@@ -120,5 +120,5 @@ In the context of optimizing contract bytecode, there's an important remark to c
 
 >We should forget about small efficiencies, say about 97% of the time: premature optimization is the root of all evil. Yet we should not pass up our opportunities in that critical 3%.
 
-It's worth considering whether optimizing the redeem script is necessary at all. If the contract is accepted by the network, and there is no glaring inefficiency in the bytecode, perhaps the best optimization is to not to obsess prematurely about things like blocksize.
+It's worth considering whether optimizing the redeem script is necessary at all. If the contract is accepted by the network, and there is no glaring inefficiency in the bytecode, perhaps the best optimization is to not to obsess prematurely about things like block size.
 
diff --git a/website/docs/language/globals.md b/website/docs/language/globals.md
@@ -71,7 +71,7 @@ int tx.locktime
 Represents the `nLocktime` field of the transaction. This is similar to the [`tx.time`][tx.time] global variable but `tx.time` can only be used in `require` statements, not for variable declaration.
 
 :::tip
- The usecase for `tx.locktime` is to read the `nLocktime` value and add to the local state. Example usage for this is demonstrated in the [Sablier example](/docs/guides/covenants#keeping-local-state-in-nfts).
+ The use case for `tx.locktime` is to read the `nLocktime` value and add to the local state. Example usage for this is demonstrated in the [Sablier example](/docs/guides/covenants#keeping-local-state-in-nfts).
 :::
 
 ### tx.inputs

diff --git a/website/docs/sdk/examples.md b/website/docs/sdk/examples.md
@@ -14,11 +14,11 @@ We will break up the development of the smart contract application in 4 manageab
 
 ### Creating the keypairs
 
-To put the `HodlVault.cash` contract to use in a TypeScript application, we have to use the CashScript SDK in combination with a BCH library such as [Libauth][libauth], [Mainnetjs][mainnetjs] or [BCHJS][bchjs]. These libraries are used to generate public/private keys for the contract participants. 
+To put the `HodlVault.cash` contract to use in a TypeScript application, we have to use the CashScript SDK in combination with a BCH library such as [Libauth][libauth], [Mainnetjs][mainnetjs] or [BCHJS][bchjs]. These libraries are used to generate public/private keys for the contract participants.
 In this example we'll use [Libauth][libauth] to generate the keys `alicePriv`, `alicePub`, `oracle` & `oraclePub`. Then we can use these keys to create the smart contract.
 
 :::caution
-These 'private keys' are public just for testing, in other contexts you want to very carefully treat private keys as `environment variables`. You would also make sure to use a secure seed phrase and not 'CashScript Examples'... 
+These 'private keys' are public just for testing, in other contexts you want to very carefully treat private keys as `environment variables`. You would also make sure to use a secure seed phrase and not 'CashScript Examples'...
 :::
 
 ```ts title="common.ts"
@@ -116,7 +116,7 @@ export class PriceOracle {
 
 ### Sending a Transaction
 
-Finnally, we can put all of this together to create a working smart contract application. We use the generated keys as a contract arguments directly or in a `SignatureTemplate` to create a transaction signature.
+Finally, we can put all of this together to create a working smart contract application. We use the generated keys as a contract arguments directly or in a `SignatureTemplate` to create a transaction signature.
 
 ```ts title="hodl_vault.ts"
 import { stringify } from '@bitauth/libauth';
@@ -163,4 +163,4 @@ console.log(stringify(tx));
 [bchjs]: https://bchjs.fullstack.cash/
 [mainnetjs]: https://mainnet.cash/
 [libauth]: https://libauth.org/
-[github-examples]: https://github.com/CashScript/cashscript/tree/master/examples
+[github-examples]: https://github.com/CashScript/cashscript/tree/master/examples
diff --git a/website/docs/sdk/instantiation.md b/website/docs/sdk/instantiation.md
@@ -62,7 +62,7 @@ contract.address: string
 A contract's regular address (without token-support) can be retrieved through the `address` member field.
 
 :::note
-Wallets will not allow you to send CashTokens to this address. For that you must use the [tokenAddress](#tokenaddress) below. Wallets which have not upgraded might not recognize this new address type.
+Wallets will not allow you to send CashTokens to this address. For that you must use the [tokenAddress](#tokenAddress) below. Wallets which have not upgraded might not recognize this new address type.
 :::
 
 #### Example

diff --git a/website/docs/sdk/transactions-advanced.md b/website/docs/sdk/transactions-advanced.md
@@ -43,10 +43,10 @@ It is possible to create custom unlockers by implementing the `Unlocker` interfa
 
 #### Example
 ```ts
-import { contract, aliceTemplate, aliceAdress, transactionBuilder } from './somewhere.js';
+import { contract, aliceTemplate, aliceAddress, transactionBuilder } from './somewhere.js';
 
 const contractUtxos = await contract.getUtxos();
-const aliceUtxos = await provider.getUtxos(aliceAdress);
+const aliceUtxos = await provider.getUtxos(aliceAddress);
 
 transactionBuilder.addInput(contractUtxos[0], contract.unlock.spend());
 transactionBuilder.addInput(aliceUtxos[0], aliceTemplate.unlockP2PKH());
@@ -69,10 +69,10 @@ Adds a list of input UTXOs, either with a single shared unlocker or with individ
 
 #### Example
 ```ts
-import { contract, aliceTemplate, aliceAdress, transactionBuilder } from './somewhere.js';
+import { contract, aliceTemplate, aliceAddress, transactionBuilder } from './somewhere.js';
 
 const contractUtxos = await contract.getUtxos();
-const aliceUtxos = await provider.getUtxos(aliceAdress);
+const aliceUtxos = await provider.getUtxos(aliceAddress);
 
 // Use a single unlocker for all inputs you're adding at a time
 transactionBuilder.addInputs(contractUtxos, contract.unlock.spend());

diff --git a/website/docs/showcase.md b/website/docs/showcase.md
@@ -58,7 +58,7 @@ The CashTokens Studio is an application for creating CashTokens and for their ma
     <a href="https://badgers.cash/" target="_blank"><img style={{borderRadius: '100%'}} src="/img/badgers.png" /></a>
 </div>
 
-BadgerCoin is a fungible CashToken using a novel distibution mechanism. BadgerCoins are earned through staking Bitcoin Cash in the Badgers Smart Contract. The staking duration is predetermined, and depending on the stake amount and period you earn tokens. The website allows for anyone to invoke contract unlocks.
+BadgerCoin is a fungible CashToken using a novel distribution mechanism. BadgerCoins are earned through staking Bitcoin Cash in the Badgers Smart Contract. The staking duration is predetermined, and depending on the stake amount and period you earn tokens. The website allows for anyone to invoke contract unlocks.
 
 ## FundMe.cash
 
@@ -76,4 +76,4 @@ FundMe is a new BCH crowdfunding platform using WalletConnect. Fundme campaigns
     <a href="https://unspent.app/" target="_blank"><img src="/img/unspent_phi.png" /></a>
 </div>
 
-Unspent Phi allows users to convert Bitcoin Cash they have today into a series of periodic payments over a long period of time.  It's a set of simple contracts that rely on rolling timelocks and introspection rather than signatures; meaning as long as the correct recipients are paid, anyone may build and submit transactions. 
+Unspent Phi allows users to convert Bitcoin Cash they have today into a series of periodic payments over a long period of time.  It's a set of simple contracts that rely on rolling timelocks and introspection rather than signatures; meaning as long as the correct recipients are paid, anyone may build and submit transactions.