Website updates

Author: rkalis

website/docs/releases/migration-notes.md

@@ -5,32 +5,38 @@ title: Migration Notes
 ## v0.7 to v0.8
 
 ### cashc compiler
-- `cashc` is now a [Pure ESM package](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c). This means that you can no longer use `require` to import `cashscript`. For more information, see the [ESM documentation](https://nodejs.org/api/esm.html).
-- `LockingBytecodeP2SH` has been renamed to `LockingBytecodeP2SH20` but it is recommended to use the newly introduced `LockingBytecodeP2SH32` instead.
+`cashc` is now a [Pure ESM package](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c). This means that you can no longer use `require` to import `cashscript`. For more information, see the [ESM documentation](https://nodejs.org/api/esm.html).
+
+`LockingBytecodeP2SH` should be replaced with `LockingBytecodeP2SH20` to keep the same behaviour, or updated to `LockingBytecodeP2SH32` to use the recommended new `P2SH32` Address type.
 
 ### CashScript SDK
-- `cashscript` is now a [Pure ESM package](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c). This means that you can no longer use `require` to import `cashscript`. For more information, see the [ESM documentation](https://nodejs.org/api/esm.html).
-- The SDK now returns `p2sh32` addresses by default. The address type can be changed to the old `p2sh20` in the options object when initializing a contract.
-- The configuration of the network provider is also part of this options object.
-  ```ts
-  // old
-  const contract = new Contract(artifact, constructorArgs, provider);
-
-  // new
-  const options = { provider, addressType: 'p2sh20' };
-  const contract = new Contract(artifact, constructorArgs, options);
-  ```
-
-- Network options `"testnet"` & `"staging"` have been renamed to `"testnet3"` and `"testnet4"` respectively in version 0.7.3. The old option names are removed with this major release.
-- You can no longer use `number` inputs for constructor arguments, function arguments, or input/output amounts. Use `bigint` instead.
-- `contract.getBalance()` and `contract.getUtxos()` now return `bigint` for satoshi amounts instead of `number`.
-- `contract.getRedeemScriptHex()` has been replaced with `contract.bytecode`.
+`cashscript` is now a [Pure ESM package](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c). This means that you can no longer use `require` to import `cashscript`. For more information, see the [ESM documentation](https://nodejs.org/api/esm.html).
+
+#### Contract instantiation
+When instantiating a `Contract` object, you now have to pass an options object as a third parameter instead of a network provider. This options object contains the network provider, as well as the address type. The address type defaults to `p2sh32` but can be changed to `p2sh20` if you want to keep the same address type as in earlier versions of the SDK.
+```ts
+// old
+const contract = new Contract(artifact, constructorArgs, provider);
+
+// new
+const options = { provider, addressType: 'p2sh20' };
+const contract = new Contract(artifact, constructorArgs, options);
+```
+
+#### SIGHASH_UTXO
+All signature templates use `SIGHASH_ALL | SIGHASH_UTXOS` now, to keep using the only the previous `SIGHASH_ALL` overwrite it in the following way:
+```ts
+const sig = new SignatureTemplate(wif, HashType.SIGHASH_ALL);
+```
+Note that you *need* to use only `SIGHASH_ALL` if you're still using "old-style" covenants (from CashScript v0.6.0 and lower). It is recommended to upgrade to the new "native" covenants (from CashScript v0.7.0 and higher) instead.
+
+#### bigint
+You can no longer use `number` inputs for constructor arguments, function arguments, or input/output amounts. Use `bigint` instead. `contract.getBalance()` and `contract.getUtxos()` now also return `bigint` for satoshi amounts instead of `number`.
+
+#### Name changes & removal of deprecated features
+- Network options `"testnet"` and `"staging"` should be replaced with `"testnet3"` and `"testnet4"` respectively.
+- `contract.getRedeemScriptHex()` should be replaced with `contract.bytecode`.
 - `BitboxNetworkProvider` has been removed since Bitbox is long deprecated. Switch to modern solutions like `ElectrumNetworkProvider` instead.
-- :boom: **BREAKING**: All signature templates use  `SIGHASH_ALL | SIGHASH_UTXOS` now, to keep using the only the previous `SIGHASH_ALL` overwrite it in the following way:
- ```ts
-  const sig = new SignatureTemplate(wif, HashType.SIGHASH_ALL);
-  ```
-  Note that you *need* to use only `SIGHASH_ALL` if you're still using "old-style" covenants (from CashScript v0.6.0 and lower). It is recommended to upgrade to the new "native" covenants (from CashScript v0.7.0 and higher) instead.
 
 ## v0.6 to v0.7
 ### cashc compiler

website/docs/releases/release-notes.md

@@ -13,7 +13,7 @@ This release also contains several breaking changes, please refer to the [migrat
 - :sparkles: Add `LockingBytecodeP2SH32` to generate the new P2SH32 standard locking script.
 - :bug: Fix optimisation bug that caused `OP_0NOTEQUAL` to be applied to non-integer values.
 - :boom: **BREAKING**: Move to Pure ESM.
-- :boom: **BREAKING**: renamed `LockingBytecodeP2SH` to `LockingBytecodeP2SH20` but it is recommended to change over to the new P2SH32 for security reasons.
+- :boom: **BREAKING**: Rename `LockingBytecodeP2SH` to `LockingBytecodeP2SH20` - but it is recommended to change over to the new P2SH32 for security reasons.
 
 #### CashScript SDK
 - :sparkles: Add support for CashTokens.
@@ -22,13 +22,14 @@ This release also contains several breaking changes, please refer to the [migrat
   - UTXOs that are passed into `.from()` can also include this `token` field to send tokens.
   - Add `.withoutTokenChange()` to disable automatic token change outputs.
   - Note that only the `ElectrumNetworkProvider` supports CashTokens at this time.
+  - Note that NFTs do not support automatic UTXO selection
 - :sparkles: Add `contract.tokenAddress` to get the token-enabled address of a contract.
 - :sparkles: Add `fromP2PKH()` to add P2PKH inputs to a smart contract transaction.
   - Note: this was in the SDK before as `experimentalFromP2PKH()`. It has now been released as an official feature.
 - :boom: **BREAKING**: Move to Pure ESM.
 - :boom: **BREAKING**: Remove `"testnet"` & `"staging"` network options.
 - :boom: **BREAKING**: `contract.address` returns `p2sh32` address by default, this can be configured to be `p2sh20` on contract initialization.
-- :boom: **BREAKING**: Moved the configuration of the network provider to an options object on contract initialization.
+- :boom: **BREAKING**: Move the configuration of the network provider to an options object on contract initialization.
 - :boom: **BREAKING**: Use `bigint` rather than `number` for all instances of "script numbers" (e.g. function arguments) and satoshi amounts.
 - :boom: **BREAKING**: Replace `contract.getRedeemScriptHex()` with `contract.bytecode`.
 - :boom: **BREAKING**: Remove `BitboxNetworkProvider`.

website/docusaurus.config.js

@@ -8,8 +8,8 @@ module.exports = {
   projectName: 'cashscript',
   themeConfig: {
     prism: {
-      theme: require('prism-react-renderer/themes/nightOwlLight'),
-      darkTheme: require('prism-react-renderer/themes/nightOwl'),
+      theme: require('prism-react-renderer').themes.nightOwlLight,
+      darkTheme: require('prism-react-renderer').themes.nightOwl,
       additionalLanguages: ['solidity', 'antlr4'],
     },
     image: 'img/logo.svg',
@@ -18,7 +18,7 @@ module.exports = {
         alt: 'CashScript',
         src: 'img/logo.svg',
       },
-      links: [
+      items: [
         {to: '/docs/basics/about', label: 'Docs', position: 'right'},
         {
           href: 'https://playground.cashscript.org',
@@ -31,6 +31,7 @@ module.exports = {
           position: 'right',
         },
       ],
+      style: 'dark',
     },
     footer: {
       style: 'light',
@@ -90,12 +91,10 @@ module.exports = {
       ],
       copyright: `<b>Donations:</b> bitcoincash:qz6uftqp7dyc4ca9e94d7wsle06u0z2ccc223dkpl8`,
     },
-    googleAnalytics: {
-      trackingID: 'UA-26805430-6',
-    },
     algolia: {
-      apiKey: 'b0b29787f1ed36aa2c1057bf4f6e6dde',
-      indexName: 'cashscript',
+      apiKey: 'd1e059f9bd6bf56667612a41a5115c6b',
+      appId: 'XBVJRKV38F',
+      indexName: 'cashscript'
     },
   },
   presets: [
@@ -128,5 +127,6 @@ module.exports = {
         ],
       },
     ],
+    ['@branchup/docusaurus-plugin-simple-analytics', {}],
   ],
 };

website/package.json

@@ -9,13 +9,14 @@
     "deploy": "docusaurus deploy"
   },
   "dependencies": {
-    "@docusaurus/core": "^2.0.0-alpha.58",
-    "@docusaurus/plugin-client-redirects": "^2.0.0-alpha.58",
-    "@docusaurus/preset-classic": "^2.0.0-alpha.58",
-    "classnames": "^2.2.6",
-    "prism-react-renderer": "^1.1.1",
-    "react": "^16.8.4",
-    "react-dom": "^16.8.4"
+    "@branchup/docusaurus-plugin-simple-analytics": "^1.1.0",
+    "@docusaurus/core": "^2.4.1",
+    "@docusaurus/plugin-client-redirects": "^2.4.1",
+    "@docusaurus/preset-classic": "^2.4.1",
+    "classnames": "^2.3.2",
+    "prism-react-renderer": "^2.0.4",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0"
   },
   "browserslist": {
     "production": [

website/src/css/custom.css

@@ -45,6 +45,11 @@
   --ifm-code-font-size: 95%;
 }
 
+.navbar--dark {
+  --ifm-navbar-background-color: var(--ifm-color-dark);
+  --ifm-navbar-link-hover-color: var(--ifm-color-secondary);
+}
+
 html[data-theme="dark"] {
   /* Theme colours inverted in dark mode */
   --ifm-color-primary: #04FF84;

website/src/pages/index.js

@@ -11,51 +11,43 @@ const features = [
     title: 'Efficient and Reliable Verification',
     description: (
       <>
-        <p>
-          Smart contracts on Bitcoin Cash are stateless and UTXO-based. This
-          model allows transactions to be verified independently and efficiently.
-          Because there is no state that can impact the execution of these smart
-          contracts, the results are deterministic and predictable.
-        </p>
+        Smart contracts on Bitcoin Cash are stateless and UTXO-based. This
+        model allows transactions to be verified independently and efficiently.
+        Because there is no state that can impact the execution of these smart
+        contracts, the results are deterministic and predictable.
       </>
     ),
   },
   {
     title: 'Private and Isolated Contracts',
     description: (
       <>
-        <p>
-          Because of Bitcoin Cash' UTXO-based model, each contract is fully
-          independent and isolated from each other. This limits systemic risk
-          and makes contract upgrades much simpler. Furthermore, Bitcoin Cash
-          contracts use P2SH, preserving the privacy of participants.
-        </p>
+        Because of Bitcoin Cash' UTXO-based model, each contract is fully
+        independent and isolated from each other. This limits systemic risk
+        and makes contract upgrades much simpler. Furthermore, Bitcoin Cash
+        contracts use P2SH, preserving the privacy of participants.
       </>
     ),
   },
   {
     title: 'Strong Abstraction',
     description: (
       <>
-        <p>
-          Bitcoin Cash transactions run on a virtual machine called Bitcoin Script.
-          Writing bytecode for this virtual machine is difficult and error-prone.
-          CashScript offers a strong abstraction for writing Bitcoin Cash smart
-          contracts, improving developer experience and reliability of contracts.
-        </p>
+        Bitcoin Cash transactions run on a virtual machine called Bitcoin Script.
+        Writing bytecode for this virtual machine is difficult and error-prone.
+        CashScript offers a strong abstraction for writing Bitcoin Cash smart
+        contracts, improving developer experience and reliability of contracts.
       </>
     ),
   },
   {
     title: 'DeFi on Bitcoin Cash',
     description: (
       <>
-        <p>
-          Most DeFi applications are currently running on top of Ethereum. Bitcoin
-          Cash contracts use a different and functionally more limited paradigm.
-          But with techniques such as covenants, local state and trust-minimised
-          price oracles, DeFi is very much possible on Bitcoin Cash.
-        </p>
+        Most DeFi applications are currently running on top of Ethereum. Bitcoin
+        Cash contracts use a different and functionally more limited paradigm.
+        But with techniques such as covenants, local state and trust-minimised
+        price oracles, DeFi is very much possible on Bitcoin Cash.
       </>
     ),
   },