Merge branch 'staging' into consolidated-languages

.github/workflows/tests.yml

@@ -30,7 +30,6 @@ jobs:
       - 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

.gitignore

@@ -3,6 +3,7 @@ node_modules
 .env.local
 .DS_Store
 .docusaurus/*
+.vscode/*
 out
 build
 

.vscode/settings.json

@@ -0,0 +1,8 @@
+{
+  "grammarly.selectors": [
+    {
+      "language": "markdown",
+      "scheme": "file"
+    }
+  ]
+}

docs/smart-contracts/multisig-usage.md

@@ -6,7 +6,7 @@ last_update:
 
 ## Generating the Specialized Multisig Contract Code
 
-Make sure you have already followed the [setup steps](./multisig-specialized/#setting-up) before continuing.
+Make sure you have already followed the [setup steps](./multisig-specialized#setting-up) before continuing.
 
 To see a list of supported contracts and actions, run:
 `stack exec -- lorentz-contract-multisig --help`
@@ -54,7 +54,7 @@ CallStack (from HasCallStack):
 
 ## Generating the Initial Storage
 Note, this section uses the
-[bash functions defined here](./multisig-specialized/#getting-your-public-key).
+[bash functions defined here](./multisig-specialized#getting-your-public-key).
 
 The Generic Multisig allows us to set administrators of the contract
 (`signerKeys`) and the number of those administrators required to sign

docs/tutorials.mdx

@@ -109,6 +109,14 @@ These tutorials are intended for developers who are familiar with Tezos and want
   link="Start tutorial"
 />
 
+<TutorialCard
+  title="Learn and play with security"
+  emoji="🛡️"
+  href="/tutorials/security"
+  description="Learn and try to hack web3 applications"
+  link="Start tutorial"
+/>
+
 <TutorialCard
   title="Create a mobile game on Tezos"
   emoji="📱"

docs/tutorials/create-an-nft/nft-web-app/defining-functions.md

@@ -121,56 +121,55 @@ For example, if the wallet is not connected, disable buttons for transactions th
 1. Add this code to build the function structure
    ```javascript
    const requestNFT = async () => {
-    }
-    ```
+   }
+   ```
 1. Add the following code inside the `requestNFT` function to set up button state:
 
    ```javascript
-    if (!buttonActive) {
-      return;
-    }
-    buttonActive = false;
-    statusMessage = "Minting NFT...";
+   if (!buttonActive) {
+     return;
+   }
+   buttonActive = false;
+   statusMessage = "Minting NFT...";
    ```
-  This asynchronous function, requestNFT, checks if a button (likely associated with minting an NFT) is active, and if so, it deactivates the button and sets a status message indicating that the NFT minting process has begun.
+   This asynchronous function, requestNFT, checks if a button (likely associated with minting an NFT) is active, and if so, it deactivates the button and sets a status message indicating that the NFT minting process has begun.
 
 1. Add the following code inside the `requestNFT` function to define the metadata for a specific NFT.
 
    ```javascript
-    const metadata = "7b226172746966616374557269223a22697066733a2f2f516d57476342434c516132387955505634355172444e47545a6e6a56784b6434416546565a4233666166486f5950222c2261747472696275746573223a5b5d2c2263726561746f7273223a5b22747a3157584b32795776416861466458456a73587548656e6667664472396d7157694277225d2c2264617465223a22323032332d30342d31335431373a32343a35312e3035353930335a222c22646563696d616c73223a302c226465736372697074696f6e223a22547a6f7563616e206973206120736d616c6c20636f6c6c656374696f6e206f662066756e6e7920746f7563616e73206f6e207468652054657a6f7320426c6f636b636861696e2e222c22646973706c6179557269223a22697066733a2f2f516d634d484a514c475444646a363873554d4b42687a3669464538326f36504144386e61755a6b4b4b43426d7173222c22666f726d617473223a5b7b2264696d656e73696f6e73223a7b22756e6974223a227078222c2276616c7565223a2235313278363430227d2c2266696c654e616d65223a2261727469666163742e706e67222c2266696c6553697a65223a3232383532332c226d696d6554797065223a22696d6167652f706e67222c22757269223a22697066733a2f2f516d57476342434c516132387955505634355172444e47545a6e6a56784b6434416546565a4233666166486f5950227d2c7b2264696d656e73696f6e73223a7b22756e6974223a227078222c2276616c7565223a2235313278363430227d2c2266696c654e616d65223a22646973706c61792e706e67222c2266696c6553697a65223a3232373534322c226d696d6554797065223a22696d6167652f706e67222c22757269223a22697066733a2f2f516d634d484a514c475444646a363873554d4b42687a3669464538326f36504144386e61755a6b4b4b43426d7173227d2c7b2264696d656e73696f6e73223a7b22756e6974223a227078222c2276616c7565223a2233323078343030227d2c2266696c654e616d65223a227468756d626e61696c2e706e67222c2266696c6553697a65223a3131323837382c226d696d6554797065223a22696d6167652f706e67222c22757269223a22697066733a2f2f516d593334616a6872757a66784a3979387358704b4365625a4a524638435a69443270487931534254375a4b5475227d5d2c22696d616765223a22697066733a2f2f516d634d484a514c475444646a363873554d4b42687a3669464538326f36504144386e61755a6b4b4b43426d7173222c226d696e746572223a224b543141713477576d56616e70516871345454666a5a584235416a467078313569514d4d222c226d696e74696e67546f6f6c223a2268747470733a2f2f6f626a6b742e636f6d2f6d696e745632222c226e616d65223a22547a6f7563616e20233438222c22726967687473223a224e6f204c6963656e7365202f20416c6c20526967687473205265736572766564222c22726f79616c74696573223a7b22646563696d616c73223a342c22736861726573223a7b22747a3157584b32795776416861466458456a73587548656e6667664472396d7157694277223a3530307d7d2c2273796d626f6c223a224f424a4b54434f4d222c2274616773223a5b22746f7563616e222c2262697264222c226d6f6465726e222c22617274225d2c227468756d626e61696c557269223a22697066733a2f2f516d593334616a6872757a66784a3979387358704b4365625a4a524638435a69443270487931534254375a4b5475227d"
-
-    const metadatamap = new MichelsonMap()
-    metadatamap.set('',metadata)
-    ```
-    Metadata for NFTs provides detailed information about the token, describing its unique attributes. This context helps in distinguishing each NFT.
-
-    In the provided code, a new MichelsonMap instance is initialized to handle Tezos's native map data type, a structure used to store key-value pairs where each key is unique. The MichelsonMap utility allows for easier interaction with Tezos's smart contract language, Michelson. By setting the metadata with an empty string as its key, the data is prepared for either storage or use within the Tezos contract.
-
-  1. Add the following code inside the `requestNFT` function to access the wallet and mint an NFT.
-
-    ```javascript
-    try {
-      console.log("setting the wallet");
-      Tezos.setWalletProvider(wallet);
-
-      console.log("getting contract");
-      const contract = await Tezos.wallet.at(contractAddress);
-      console.log("minting");
-      const op = await contract.methods.mint(metadatamap,address).send();
-
-      console.log(`Waiting for ${op.opHash} to be confirmed...`);
-      const hash = await op.confirmation(3).then(() => op.opHash);
-      console.log(`Operation injected: https://ghost.tzstats.com/${hash}`);
-    } catch (error) {
-      console.error("Error minting NFT:", error);
-    } finally {
-      statusMessage = "Mint another NFT";
-      buttonActive = true;
-    }
+   const metadata = "7b226172746966616374557269223a22697066733a2f2f516d57476342434c516132387955505634355172444e47545a6e6a56784b6434416546565a4233666166486f5950222c2261747472696275746573223a5b5d2c2263726561746f7273223a5b22747a3157584b32795776416861466458456a73587548656e6667664472396d7157694277225d2c2264617465223a22323032332d30342d31335431373a32343a35312e3035353930335a222c22646563696d616c73223a302c226465736372697074696f6e223a22547a6f7563616e206973206120736d616c6c20636f6c6c656374696f6e206f662066756e6e7920746f7563616e73206f6e207468652054657a6f7320426c6f636b636861696e2e222c22646973706c6179557269223a22697066733a2f2f516d634d484a514c475444646a363873554d4b42687a3669464538326f36504144386e61755a6b4b4b43426d7173222c22666f726d617473223a5b7b2264696d656e73696f6e73223a7b22756e6974223a227078222c2276616c7565223a2235313278363430227d2c2266696c654e616d65223a2261727469666163742e706e67222c2266696c6553697a65223a3232383532332c226d696d6554797065223a22696d6167652f706e67222c22757269223a22697066733a2f2f516d57476342434c516132387955505634355172444e47545a6e6a56784b6434416546565a4233666166486f5950227d2c7b2264696d656e73696f6e73223a7b22756e6974223a227078222c2276616c7565223a2235313278363430227d2c2266696c654e616d65223a22646973706c61792e706e67222c2266696c6553697a65223a3232373534322c226d696d6554797065223a22696d6167652f706e67222c22757269223a22697066733a2f2f516d634d484a514c475444646a363873554d4b42687a3669464538326f36504144386e61755a6b4b4b43426d7173227d2c7b2264696d656e73696f6e73223a7b22756e6974223a227078222c2276616c7565223a2233323078343030227d2c2266696c654e616d65223a227468756d626e61696c2e706e67222c2266696c6553697a65223a3131323837382c226d696d6554797065223a22696d6167652f706e67222c22757269223a22697066733a2f2f516d593334616a6872757a66784a3979387358704b4365625a4a524638435a69443270487931534254375a4b5475227d5d2c22696d616765223a22697066733a2f2f516d634d484a514c475444646a363873554d4b42687a3669464538326f36504144386e61755a6b4b4b43426d7173222c226d696e746572223a224b543141713477576d56616e70516871345454666a5a584235416a467078313569514d4d222c226d696e74696e67546f6f6c223a2268747470733a2f2f6f626a6b742e636f6d2f6d696e745632222c226e616d65223a22547a6f7563616e20233438222c22726967687473223a224e6f204c6963656e7365202f20416c6c20526967687473205265736572766564222c22726f79616c74696573223a7b22646563696d616c73223a342c22736861726573223a7b22747a3157584b32795776416861466458456a73587548656e6667664472396d7157694277223a3530307d7d2c2273796d626f6c223a224f424a4b54434f4d222c2274616773223a5b22746f7563616e222c2262697264222c226d6f6465726e222c22617274225d2c227468756d626e61696c557269223a22697066733a2f2f516d593334616a6872757a66784a3979387358704b4365625a4a524638435a69443270487931534254375a4b5475227d"
+
+   const metadatamap = new MichelsonMap()
+   metadatamap.set('',metadata)
+   ```
+   Metadata for NFTs provides detailed information about the token, describing its unique attributes. This context helps in distinguishing each NFT.
+
+   In the provided code, a new MichelsonMap instance is initialized to handle Tezos's native map data type, a structure used to store key-value pairs where each key is unique. The MichelsonMap utility allows for easier interaction with Tezos's smart contract language, Michelson. By setting the metadata with an empty string as its key, the data is prepared for either storage or use within the Tezos contract.
+
+1. Add the following code inside the `requestNFT` function to access the wallet and mint an NFT.
+
+   ```javascript
+   try {
+     console.log("setting the wallet");
+     Tezos.setWalletProvider(wallet);
+
+     console.log("getting contract");
+     const contract = await Tezos.wallet.at(contractAddress);
+     console.log("minting");
+     const op = await contract.methods.mint(metadatamap,address).send();
+
+     console.log(`Waiting for ${op.opHash} to be confirmed...`);
+     const hash = await op.confirmation(3).then(() => op.opHash);
+     console.log(`Operation injected: https://ghost.tzstats.com/${hash}`);
+   } catch (error) {
+     console.error("Error minting NFT:", error);
+   } finally {
+     statusMessage = "Mint another NFT";
+     buttonActive = true;
+   }
    ```
    Taquito can fetch the user's tez balance from the connected wallet.
    To get the tez balances, the app uses the [Beacon SDK](../../../dApps/wallets).
    The `mint` function takes two parameters: a metadata for the NFT and the user's wallet address.
 
-
 You'll start the app and mint NFTs with your dApp in the next section!

docs/tutorials/security.md

@@ -0,0 +1,75 @@
+---
+title: Learn and play with security
+authors: 'Benjamin Fuentes (Marigold)'
+last_update:
+  date: 11 January 2024
+---
+
+# Security
+
+Web3 or the decentralized web introduces a new set of security challenges while reducing risks and enforcing security on the other side.
+
+Users can interact directly with the blockchain network without any third-party protection because the paradigm is now READ-WRITE-OWN. No one is responsible for guarding your keys or seed phrase and protecting you against scams.
+
+On the other hand, cryptography, especially hashing, ensures that the data is never altered or removed without agreement from the supporting network. Clients do not have to trust a centralized provider; implicit trust is built into the blockchain.
+
+### Off-chain attacks
+
+Off-chain attacks are a serious threat to the security and reliability of decentralized applications. They can exploit various vulnerabilities in the design, implementation, or deployment of smart contracts or user interfaces. Some examples of off-chain attacks are:
+
+- Bugs: A bug is a flaw or error in the code or logic of a smart contract or a frontend. For instance, a frontend may point to a non-existent smart contract address or invoke an entrypoint with incorrect parameters. This can result in loss of funds, incorrect execution, or denial of service. Bugs can be avoided by proper testing, auditing, and maintenance of the code.
+- Impersonation: An impersonation attack is when an attacker pretends to be someone else, such as a legitimate service provider, a trusted party, or a user. For example, an attacker may create a phishing UI that mimics the appearance and functionality of a real frontend, but sends the user's funds or data to the attacker's address. Alternatively, an attacker may deploy a copy of a contract on the network, with slight modifications that benefit the attacker. Impersonation attacks can be prevented by verifying the identity and authenticity of the parties involved, such as using digital signatures, checksums, or domain verification.
+- Replay attacks: A replay attack is when an attacker reuses a valid transaction from one context to another, without the consent or knowledge of the original sender. For example, an attacker may copy a L1 transaction to a L2 transaction, and execute it on a different chain or layer. This can result in double-spending, unauthorized actions, or inconsistent states. Replay attacks can be mitigated by introducing nonce and chain_id fields in the transactions, which ensure that each transaction is unique and valid for a specific context. Alternatively, a timestamp can be used as a nonce, which makes it easy to detect outdated or replayed transactions.
+- Trusting and no verifying: This situation occurs when a user or a contract blindly accepts or relies on data or information from an off-chain source without verifying its accuracy or integrity. For example, a user may trust an off-chain API that provides market data from an oracle or an exchange without checking if the data is correct, manipulated, or even inexistent. Similarly, a user may sign a transaction payload from a wallet without inspecting its content or destination. Trust and no verification can lead to false assumptions, incorrect decisions, or malicious actions. Trust and no verification can be avoided by applying the principle of "trust but verify," which means that any off-chain data or information should be validated by multiple sources, cross-checked with on-chain data, or confirmed by the user before using it.
+- FrontRunning and MEV (Maximum Extractable Value): MEV is an economic phenomenon that can be exploited by miners, validators, and sequencers who can arbitrarily include, exclude, or re-order transactions within the blocks they produce. MEV strategies involve executing a set of on-chain interactions prepared by off-chain actors like humans or bots.
+  It can be done by the baker itself because the list is known in advance at each period, or by any bots listening to the gossip network.
+  Examples of common MEV strategies:
+
+  - Sandwiching: When a large order is spotted on mempool, the attacker buys before and sells the tokens after. The large transaction will raise the price of the token. If you buy before the price increases and sell after the price increases, you earn the difference. If you cannot reorder the transaction yourself like a baker does, you will have to put higher gas, which is called PGA or Priority Gas Auctions.
+
+  - Front running: Bakers and sequencers can simulate any transaction extracted from the mempool and look at the wallet increase of balance. If it is an arbitrage opportunity, then the attacker can decide to copy and place his own transaction before the others.
+  - Arbitrage: Arbitrage is the process of buying and selling the same assets across different markets to capitalize on price discrepancies between them. It is not even considered a hack as it is the job of common traders and regulate the global market price
+
+  → **SOLUTION**: Against MEV, there are a few solutions:
+
+  - Reordering of transactions can be tackled through honest bakers or using Flashbots/Flashbake. Flashbake is proposing a private, off-chain system to send a transaction to a baker. It benefits the Tezos network and its users in a few ways: less mempool congestion and quicker inclusion of not publicly visible transactions.
+  - Place an encrypted order, and reveal/execute it later time, or use a feature of Tezos named TimeLock. The goal is the same: hide the transaction until the last moment so no one can place an order ahead of it. This requires a smart contract to handle this kind of order and keep track of previous data to be able to execute the transaction. Anterior currency pairs history values in the context of a swap, for example.
+
+### On-chain attacks
+
+This training session will cover the topic of on-chain attacks, which are cyberattacks that target the blockchain network and its components. On-chain attacks can exploit various types of vulnerabilities, such as:
+
+- Programming errors that affect the security and functionality of smart contracts, which are self-executing agreements that run on the blockchain. Smart contracts can have a larger attack surface than traditional applications, as they interact with other contracts and users on the network and so are subject to higher interest from hackers in draining funds.
+- Different kinds of leaks:
+  - Replay attacks: These occur when an attacker intercepts and retransmits a valid transaction on a different blockchain network, causing the same transaction to be executed twice.
+  - Memory overflow: This happens when a smart contract runs out of memory or enters an unexpected context, allowing attackers to exploit a part of the code.
+  - Re-entrancy attacks: These are a type of recursive call vulnerability that allows an attacker to repeatedly call a function within a smart contract before the previous call is finished, resulting in multiple withdrawals or transfers of funds.
+- Blockchain user trust and management:
+  - Administrators: These are the entities that have the highest level of authority and control over the contract. They can perform actions such as deploying, upgrading, pausing, or terminating the contract.
+  - Lambda / mutable code: This refers to the parts of the contract code that can be changed after deployment, such as parameters, variables, or functions.
+  - Checking roles: This is the process of verifying whether a user has the right to execute a certain part of the code, such as calling a function or modifying a state variable.
+  - Trustable oracles: These are the external sources of data that your contract relies on, such as prices, events, or outcomes.
+
+In this training session, we will use a hands-on approach to learn how to identify, prevent, and mitigate on-chain attacks. We will work with sample code that contains several bugs and vulnerabilities and we will try to fix them step by step. We will also discuss best practices and recommendations for developing secure and reliable smart contracts and blockchain applications.
+
+## Prerequisites
+
+In the next sections, some code needs to be executed. [Taqueria requires to be installed on your machine](https://taqueria.io/docs/getting-started/installation/).
+
+To compile the code, run these commands:
+
+```bash
+npm i
+TAQ_LIGO_IMAGE=ligolang/ligo:1.1.0 taq compile <MY_CONTRACT_FILE>.jsligo
+```
+
+> Alternative: You can use the Ligo compiler directly and it can be installed [here](https://ligolang.org/docs/intro/installation/?lang=jsligo)
+> You will have to compile the parameters and the storage yourself. Instead of using the taq command, use this one :
+>
+> ```bash
+> ligo compile contract ./contracts/<MY_CONTRACT_FILE>.jsligo
+> ```
+
+---
+
+When you're ready, go to [Part 1: Programming errors](./security/part-1)