Merge pull request #260 from trilitech/staging

Update main from staging Jan 12

.github/workflows/tests.yml

@@ -0,0 +1,38 @@
+name: Tests
+
+on:
+  pull_request:
+    types: [opened, reopened, synchronize]
+
+jobs:
+
+  checkChangedFiles:
+    runs-on: ubuntu-latest
+    outputs:
+      files: ${{ steps.files.outputs.added_modified }}
+    steps:
+      - uses: actions/checkout@v2
+      - id: files
+        uses: Ana06/[email protected]
+        with:
+          format: 'csv'
+          filter: '*.mdx?'
+
+  test:
+    runs-on: ubuntu-latest
+    needs: checkChangedFiles
+    if: ${{ needs.checkChangedFiles.outputs.files != '' }}
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 18
+      - run: npm ci
+      - run: npm run test -- --reporter JSON --reporter-option output=mocha.json --filesToCheck=${{ needs.checkChangedFiles.outputs.files }}
+        continue-on-error: true
+      - run: ls
+      - uses: dorny/test-reporter@v1
+        with:
+          name: Mocha tests
+          path: 'mocha.json'
+          reporter: mocha-json

.gitignore

@@ -6,3 +6,5 @@ node_modules
 out
 build
 
+filesToTest.txt
+

README.md

@@ -37,6 +37,12 @@ npm run start
 
 Finally, open [http://localhost:3000](http://localhost:3000) in your browser to view the website.
 
+## Tests
+
+The workflow `.github/workflows/tests.yml` runs automated tests on pull requests.
+To run tests locally, run `npm run test -- --filesToCheck=docs/developing.md,docs/architecture.mdx`, where `--filesToCheck` is a comma-separated list of the MD and MDX files to test.
+
+Docusaurus automatically checks for broken links and markdown-encoded images when you run `npm run build`.
 
 ## License
 

docs/architecture/rpc.md

@@ -20,7 +20,7 @@ By default, RPC servers are private and do not accept all requests from every cl
 
 When you work with a Tezos client, such as the Octez command-line client or the Taquito SDK, you select a public RPC node to send transactions to, or you can use a private RPC node that you have access to.
 
-If you're using a testnet, you can get a list of public RPC nodes for that network at https://teztnets.xyz.
+If you're using a testnet, you can get a list of public RPC nodes for that network at https://teztnets.com.
 
 Other sources of public nodes include:
 

docs/architecture/tokens/FA2.md

@@ -2,7 +2,7 @@
 title: FA2 tokens
 authors: "Claude Barde, Aymeric Bethencourt, Tim McMackin"
 last_update:
-  date: 28 November 2023
+  date: 29 December 2023
 ---
 
 The FA2 standard supports several different token types, including:
@@ -19,6 +19,10 @@ If the contract has only one type of token, its ID must be 0, but if it has mult
 
 For the full details of the FA2 standard, see [Tezos Improvement Proposal 12 (TZIP-12)](https://gitlab.com/tezos/tzip/-/blob/master/proposals/tzip-12/tzip-12.md), which defines the standard.
 
+## Examples
+
+For examples of FA2 contracts, see [Sample smart contracts](../../smart-contracts/samples).
+
 ## Metadata
 
 FA2 tokens have metadata that describes what the token represents.

docs/developing/octez-client/installing.md

@@ -58,12 +58,12 @@ Then, initialize it to use the RPC node of your choice:
 1. Set the RPC node to use:
 
    1. Get the URL of a public RPC node or a private node that you have access to.
-   For example, you can get the URL of a testnet node from https://teztnets.xyz/, such as `https://rpc.ghostnet.teztnets.xyz` for Ghostnet.
+   For example, you can get the URL of a testnet node from https://teztnets.com/, such as `https://rpc.ghostnet.teztnets.com` for Ghostnet.
 
    1. Set your Octez client to use this node by running this command on the command line, replacing the Ghostnet URL with the URL that you copied:
 
       ```bash
-      octez-client --endpoint https://rpc.ghostnet.teztnets.xyz config update
+      octez-client --endpoint https://rpc.ghostnet.teztnets.com config update
       ```
 
       If you are using a testnet, Octez shows a warning that you are not using Mainnet.

docs/developing/testnets.md

@@ -2,11 +2,11 @@
 title: Using sandboxes and testnets
 authors: 'Mathias Hiron, Nomadic Labs, Tim McMackin, TriliTech'
 last_update:
-  date: 18 October 2023
+  date: 29 December 2023
 ---
 
 :::note
-The Tezos testnets are overseen and coordinated by [Oxhead Alpha](https://oxheadalpha.com/). The current testnets and a description of what each is used for are listed at https://teztnets.xyz/.
+The current testnets and a description of what each is used for are listed at https://teztnets.com/.
 :::
 
 ## Testing without a node
@@ -43,7 +43,7 @@ _Permanent test networks_ are networks that are meant to run indefinitely. In pa
 
 For the `Ghostnet` permanent network, the governance is controlled by a single entity that manages the network, with a special upgrade mechanism.
 
-At the moment, the main such network is `Ghostnet`. It follows the currently active protocol on `Mainnet`, and upgrades to the next protocol during the Adoption period on `Mainnet`. That is, after the last round of voting and before it activates on `Mainnet`. The objective is to provide a rehearsal event for `Mainnet` migration. This process is controlled by the Oxhead Alpha team.
+At the moment, the main such network is `Ghostnet`. It follows the currently active protocol on `Mainnet`, and upgrades to the next protocol during the Adoption period on `Mainnet`. That is, after the last round of voting and before it activates on `Mainnet`. The objective is to provide a rehearsal event for `Mainnet` migration.
 
 For developers, using a permanent network like `Ghostnet` is convenient compared to other public networks, as it makes it possible to keep contracts running for a long time without having to deal with the trouble of setting things up on a new network when the previous one gets shut down. Services such as indexers, explorers, or public nodes also tend to keep running more reliably on `Ghostnet` than on non-permanent networks.
 
@@ -56,14 +56,14 @@ As the protocol on `Ghostnet` migrates to the newly adopted amendment a few days
 #### Getting tez testnet tokens
 
 In order to get tez tokens to use when testing your application on testnet, you can use a faucet. You
-can request some tokens from the [Ghostnet faucet](https://faucet.ghostnet.teztnets.xyz/)
+can request some tokens from the [Ghostnet faucet](https://faucet.ghostnet.teztnets.com/)
 
 
 ### Protocol test networks
 
 _Protocol test networks_ are networks that are created specifically for a given version of the protocol.
 
-When an amendment is proposed, a corresponding network is usually created by the Oxhead Alpha team. This network gets joined by more bakers as the proposal is selected and moves through the different periods of the self-amendment process. If the protocol passes the 3 votes of the amendment, joining a test protocol early gives you about 2.5 months to test all the changes that will be made to Mainnet. If the protocol is not adopted, it usually gets discarded. Otherwise, it remains active until a different protocol is adopted.
+When an amendment is proposed, a corresponding network is created. This network gets joined by more bakers as the proposal is selected and moves through the different periods of the self-amendment process. If the protocol passes the 3 votes of the amendment, joining a test protocol early gives you about 2.5 months to test all the changes that will be made to Mainnet. If the protocol is not adopted, it usually gets discarded. Otherwise, it remains active until a different protocol is adopted.
 
 This means there is usually one or two such running networks: one for the current version of the protocol running on `Mainnet`, and possibly one for the proposed protocol that is going through the amendment process, if there is one.
 
@@ -93,7 +93,7 @@ The two periodic protocols currently are `Mondaynet` and `Dailynet`.
 
 ### Public nodes and faucets
 
-To connect to existing public nodes for these networks, or to get some testnet-only tez on these from a faucet, check [https://teztnets.xyz](https://teztnets.xyz/). The faucets and infrastructure for deploying test networks are maintained by [Oxhead Alpha](https://www.oxheadalpha.com/).
+To connect to existing public nodes for these networks, or to get some testnet-only tez on these from a faucet, check [https://teztnets.com](https://teztnets.com/).
 
 Other sources of public nodes include:
 

docs/developing/wallet-setup.md

@@ -26,9 +26,9 @@ On testnets, tokens are free so you don't have to spend real currency to work wi
 The process for changing the network is different for each wallet type.
 These steps are for the Temple wallet:
 
-1. Go to https://teztnets.xyz/, which lists Tezos testnets.
+1. Go to https://teztnets.com/, which lists Tezos testnets.
 1. Click **Ghostnet**.
-1. Copy one of the public RPC endpoints for Ghostnet, such as `https://rpc.ghostnet.teztnets.xyz`.
+1. Copy one of the public RPC endpoints for Ghostnet, such as `https://rpc.ghostnet.teztnets.com`.
 These URLs accept Tezos transactions from wallets and other applications.
 1. In the Temple app, open the settings and then click **Default node (RPC)**.
 1. Click the plus `+` symbol to add an RPC node.
@@ -47,7 +47,7 @@ Follow these steps to get testnet tez for the wallet:
 1. From your wallet, get the address of your account, which starts with `tz1`.
 This is the address that applications use to work with your wallet.
 
-1. Go to the Ghostnet faucet at https://faucet.ghostnet.teztnets.xyz.
+1. Go to the Ghostnet faucet at https://faucet.ghostnet.teztnets.com.
 
 1. On the faucet page, paste your wallet address into the input field labeled "Or fund any address" and click the button for the amount of tez to add to your wallet.
 20 tez is enough to work with, and you can return to the faucet later if you need more tez.