diff --git a/docs/developing/testnets.md b/docs/developing/testnets.md index 53341a819..1f50a1401 100644 --- a/docs/developing/testnets.md +++ b/docs/developing/testnets.md @@ -17,7 +17,7 @@ Waiting for the next block every time you inject a new transaction takes a lot o To make testing a lot faster, options are available, depending on the language and tools you are using, that don't use a network or even a single node at all, and skip all the consensus mechanism steps. -- The **Michelson interpreter** is an OCaml function that can be used by tools to simulate a call to any entry point of any smart contract, given an initial value of the storage and parameters. Some programming languages like **LIGO** or **Smartpy** use this as part of their testing frameworks. +- The **Michelson interpreter** is an OCaml function that can be used by tools to simulate a call to any entry point of any smart contract, given an initial value of the storage and parameters. Some programming languages like **LIGO** or **SmartPy** use this as part of their testing frameworks. - The **mockup mode** of `octez-client` can be used to test contract calls and other features such as some RPC calls, all without running an actual node, saving the time of going through the consensus mechanism and waiting to get blocks created and validated. Tools like **Completium**, built by the team behind the **Archetype** language, use this for their testing framework. Find out more in the [documentation of the mockup mode](https://tezos.gitlab.io/user/mockup.html). diff --git a/docs/overview/common-applications.md b/docs/overview/common-applications.md index db0ee374a..135f2348a 100644 --- a/docs/overview/common-applications.md +++ b/docs/overview/common-applications.md @@ -22,7 +22,7 @@ Tezos is being used by the French Armies and Gendarmerie's Information Center to In recent years, the concept of Central Bank Digital Currencies (CBDCs) has gained traction, with several countries around the world exploring their own CBDC projects. Société Générale carried out a series of successful tests [using Tezos](https://decrypt.co/112127/societe-generales-crypto-division-lands-regulatory-approval-france) to explore the potential of CBDCs. In September 2020, the bank announced that it had completed a pilot program using a custom-built version of the Tezos blockchain to simulate the issuance and circulation of CBDCs. The pilot involved testing the technology's ability to handle transactions, make payments, and settle transactions in a digital environment. -The Califonia DMV is also using Tezos for its project to [put car titles on the blockchain](https://fortune.com/crypto/2023/01/26/california-announces-dmv-run-blockchain-through-partnership-with-tezos/). +The California DMV is also using Tezos for its project to [put car titles on the blockchain](https://fortune.com/crypto/2023/01/26/california-announces-dmv-run-blockchain-through-partnership-with-tezos/). [Sword Group](https://www.sword-group.com/2020/09/28/sword-launches-tezos-digisign/) an international technology company, launched DigiSign, an open-source tool built on Tezos that enables users to digitally sign, certify, and verify the authenticity of digital documents. diff --git a/docs/smart-contracts/creating.md b/docs/smart-contracts/creating.md index 1803df43d..63f788fbd 100644 --- a/docs/smart-contracts/creating.md +++ b/docs/smart-contracts/creating.md @@ -10,7 +10,7 @@ This documentation provides step-by-step instructions for creating smart contrac ## Choosing your smart contract language Tezos supports a variety of smart contract [languages](./languages): Michelson, SmartPy, LIGO, Archetype. -You can select a language based on your familarity with programming paragims, the complexity of the contract you want to deploy, and the specific features you require. Here's a more detailed table for each language: +You can select a language based on your familiarity with programming paradigms, the complexity of the contract you want to deploy, and the specific features you require. Here's a more detailed table for each language: | | **Michelson** | **SmartPy** | **LIGO** | **Archetype** | |:----------------:|:----------------------------------------------------------:|:-----------------------------------------------------:|:-------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------:| @@ -18,7 +18,7 @@ You can select a language based on your familarity with programming paragims, th | **Capabilities** | Full control over contract, optimal for gas efficiency | Easy to write, automatically manages stack operations | Statically-typed, strong error checking | Specialized for formal verification and correctness | | **Use Cases** | Optimized contracts, developers with blockchain experience | Python developers, rapid prototyping | Developers familiar with static typing, variety of mainstream programming backgrounds | High-security contracts, developers looking for formal proof of contract behavior | -For beginners, we recommand **SmartPy** or **LIGO** for their higher-level more abstracted approach. +For beginners, we recommend **SmartPy** or **LIGO** for their higher-level more abstracted approach. ## Making a strategic choice diff --git a/docs/smart-contracts/data-types/primitive-data-types.md b/docs/smart-contracts/data-types/primitive-data-types.md index d7d56e3f7..629d5cfce 100644 --- a/docs/smart-contracts/data-types/primitive-data-types.md +++ b/docs/smart-contracts/data-types/primitive-data-types.md @@ -137,8 +137,8 @@ For more information about serialization, see [Serialization](../serialization). Boolean types on Tezos (`bool`) work the same way as in most programming languages. -- A boolean value can be `True` or `False` -- Comparison operators produce boolean values +- A Boolean value can be `True` or `False` +- Comparison operators produce Boolean values - Boolean values can be used in conditional statements or `while` loops - The usual logic operators are supported: `AND`, `OR`, `XOR`, `NOT` diff --git a/docs/smart-contracts/languages/ligo.md b/docs/smart-contracts/languages/ligo.md index 9ac6b4da6..9da88a75c 100644 --- a/docs/smart-contracts/languages/ligo.md +++ b/docs/smart-contracts/languages/ligo.md @@ -8,7 +8,7 @@ LIGO is a functional programming language that is intended to be both user-frien LIGO offers two syntaxes: -- JsLIGO, a sytax that is inspired by TypeScript/JavaScript +- JsLIGO, a syntax that is inspired by TypeScript/JavaScript - CameLIGO, a syntax that is inspired by OCaml You can use either syntax and compile to Michelson to run on Tezos. @@ -16,7 +16,7 @@ You can use either syntax and compile to Michelson to run on Tezos. To learn LIGO, see these tutorials: - [Deploy a smart contract with CameLIGO](../../tutorials/smart-contract/cameligo) -- [Deploy a smart contract with jsLIGO](../../tutorials/smart-contract/jsligo) +- [Deploy a smart contract with JsLIGO](../../tutorials/smart-contract/jsligo) Let's define a LIGO contract in the two flavours above. diff --git a/docs/tutorials/create-an-nft/nft-tznft.md b/docs/tutorials/create-an-nft/nft-tznft.md index 32e49af96..3b5ffea1f 100644 --- a/docs/tutorials/create-an-nft/nft-tznft.md +++ b/docs/tutorials/create-an-nft/nft-tznft.md @@ -505,7 +505,7 @@ The command is the same as for the sandbox: The block explorer shows information about the contract that manages the NFTs, including a list of all NFTs in the contract, who owns them, and a list of recent transactions. -Now the NFTs are on Tezos ghostnet and you can transfer and manipulate them just like you did in the sandbox. +Now the NFTs are on Tezos Ghostnet and you can transfer and manipulate them just like you did in the sandbox. You may need to create and fund more account aliases to transfer them, but the commands are the same. For example, to transfer NFTs to an account with the alias `other-account`, run this command: diff --git a/docs/tutorials/create-an-nft/nft-web-app.md b/docs/tutorials/create-an-nft/nft-web-app.md index cff2304c5..6985c2410 100644 --- a/docs/tutorials/create-an-nft/nft-web-app.md +++ b/docs/tutorials/create-an-nft/nft-web-app.md @@ -16,7 +16,7 @@ You will learn: ## Prerequisites -This tutorial uses [Javascript](https://www.javascript.com/), so it will be easier if you are familiar with JavaScript. +This tutorial uses [JavaScript](https://www.javascript.com/), so it will be easier if you are familiar with JavaScript. - You do not need any familiarity with any of the libraries in the tutorial, including [Taquito](https://tezostaquito.io/), a JavaScript library that helps developers access Tezos. diff --git a/docs/tutorials/dapp.md b/docs/tutorials/dapp.md index a99d3b936..c5ffe475e 100644 --- a/docs/tutorials/dapp.md +++ b/docs/tutorials/dapp.md @@ -22,7 +22,7 @@ sequenceDiagram You will learn : - How to create a Tezos project with Taqueria. -- How to create a smart contract in jsLIGO. +- How to create a smart contract in JsLIGO. - How to deploy the smart contract a real testnet named Ghostnet. - How to create a frontend dApp using Taquito library and interact with a Tezos browser wallet. - How to use an indexer like TZKT. diff --git a/docs/tutorials/dapp/part-2.md b/docs/tutorials/dapp/part-2.md index 5e8b8b8a9..eace5e0d6 100644 --- a/docs/tutorials/dapp/part-2.md +++ b/docs/tutorials/dapp/part-2.md @@ -84,7 +84,7 @@ sequenceDiagram Explanation: - - `...store` do a copy by value of your object. [Have a look on the Functional updates documentation](https://ligolang.org/docs/language-basics/maps-records/#functional-updates). Note: you cannot do assignment like this `store.pokeTraces=...` in jsLIGO, there are no concept of Classes, use `Functional updates` instead. + - `...store` do a copy by value of your object. [Have a look on the Functional updates documentation](https://ligolang.org/docs/language-basics/maps-records/#functional-updates). Note: you cannot do assignment like this `store.pokeTraces=...` in JsLIGO, there are no concept of Classes, use `Functional updates` instead. - `Map.add(...`: Add a key, value entry to a map. For more information about [Map](https://ligolang.org/docs/language-basics/maps-records/#maps). - `export type storage = {...};` a `Record` type is declared, it is an [object structure](https://ligolang.org/docs/language-basics/maps-records#records). - `Tezos.get_self_address()` is a native function that returns the current contract address running this code. Have a look on [Tezos native functions](https://ligolang.org/docs/reference/current-reference). diff --git a/docs/tutorials/join-dal-baker/run-baker.md b/docs/tutorials/join-dal-baker/run-baker.md index 141334146..79180c327 100644 --- a/docs/tutorials/join-dal-baker/run-baker.md +++ b/docs/tutorials/join-dal-baker/run-baker.md @@ -6,7 +6,7 @@ The baking daemon is launched almost as usual, the only difference is that we us octez-baker-alpha run with local node "$HOME/.tezos-node" my_baker --liquidity-baking-toggle-vote on --adaptive-issuance-vote on --dal-node http://127.0.0.1 >> "$HOME/octez-baker.log" 2>&1 ``` -We can check that the DAL is now subscribed to the relevant topics by retrying the following RPC, which should now return all the topics of the form `{"slot_index":,"pkh":"
"}` where `index` varies between `0` included and the number of slot indexes (`32` on Weeklynet) exluded: +We can check that the DAL is now subscribed to the relevant topics by retrying the following RPC, which should now return all the topics of the form `{"slot_index":,"pkh":"
"}` where `index` varies between `0` included and the number of slot indexes (`32` on Weeklynet) excluded: ``` curl http://localhost:10732/p2p/gossipsub/topics @@ -17,7 +17,7 @@ We can also look at the baker logs to see if it manages to inject the expected o - inject a preattestation for it (log message: "injected preattestation ... for my_baker (<address>) for level ..., round ...") - receive a block (log message: "received new head ... at level ..., round ...") - inject an attestation for it (log message: "injected attestation ... for my_baker (<address>) for level ..., round ...") -- inject a DAL attestation indicating which of the shards assigned to the baker have been seen on the DAL network (log message: "injected DAL attestation ... for level ..., round ..., with bitset ... for my_baker (<address>) to attest slots published at level ..."); if no shard was seen (either because they did not reach the DAL node for some reason or simply because nothing was published on the DAL at the targetted level), the operation is skipped (log message: "Skipping the injection of the DAL attestation for attestation level ..., round ..., as currently no slot published at level ... is attestable.") +- inject a DAL attestation indicating which of the shards assigned to the baker have been seen on the DAL network (log message: "injected DAL attestation ... for level ..., round ..., with bitset ... for my_baker (<address>) to attest slots published at level ..."); if no shard was seen (either because they did not reach the DAL node for some reason or simply because nothing was published on the DAL at the targeted level), the operation is skipped (log message: "Skipping the injection of the DAL attestation for attestation level ..., round ..., as currently no slot published at level ... is attestable.") Optionally, we can also launch an accuser which will monitor the behaviour of the other Weeklynet bakers and denounce them to the Tezos protocol if they are caught double-signing any block or consensus operation. diff --git a/docs/tutorials/join-dal-baker/run-node.md b/docs/tutorials/join-dal-baker/run-node.md index 8232802df..540bf3c20 100644 --- a/docs/tutorials/join-dal-baker/run-node.md +++ b/docs/tutorials/join-dal-baker/run-node.md @@ -6,7 +6,7 @@ Once the Octez node has been configured to join Weeklynet, we can launch it and octez-node run --rpc-addr 127.0.0.1:8732 --log-output="$HOME/octez-node.log" ``` -At first launch, the node will generate a fresh identity file used to identify itself on the Weeklynet L1 network, it then bootstraps the chain which means that it downloads and applies all the blocks. This takes a variable amount of time depending on when during the week these instructions are followed but at worse, on a tuesday evening, it takes a few hours. Fortunately, we can continue to set up our Weeklynet baking infrastructure while the node is bootstrapping, all we have to do for this is to use another, already bootstrapped, node as RPC endpoint for `octez-client` when we want to interact with the chain. +At first launch, the node will generate a fresh identity file used to identify itself on the Weeklynet L1 network, it then bootstraps the chain which means that it downloads and applies all the blocks. This takes a variable amount of time depending on when during the week these instructions are followed but at worst, on a Tuesday evening, it takes a few hours. Fortunately, we can continue to set up our Weeklynet baking infrastructure while the node is bootstrapping, all we have to do for this is to use another, already bootstrapped, node as RPC endpoint for `octez-client` when we want to interact with the chain. A public RPC endpoint URL for Weeklynet is linked from the https://teztnets.com/weeklynet-about page, let's record it in a shell variable: ``` diff --git a/docs/tutorials/mobile/part-1.md b/docs/tutorials/mobile/part-1.md index 64bced378..59c2bf7f5 100644 --- a/docs/tutorials/mobile/part-1.md +++ b/docs/tutorials/mobile/part-1.md @@ -7,7 +7,7 @@ last_update: On this first section, you will: -- Create the game smart contract importing an existing Ligo library +- Create the game smart contract importing an existing LIGO library - Deploy your smart contract to the Ghostnet - Get the Shifumi Git repository folders to copy the game UI and CSS for the second party @@ -22,7 +22,7 @@ On this first section, you will: taq install @taqueria/plugin-ligo ``` -1. Download the Ligo Shifumi template, and copy the files to Taqueria **contracts** folder: +1. Download the LIGO Shifumi template, and copy the files to Taqueria **contracts** folder: ```bash TAQ_LIGO_IMAGE=ligolang/ligo:1.2.0 taq ligo --command "init contract --template shifumi-jsligo shifumiTemplate" diff --git a/docs/tutorials/mobile/part-2.md b/docs/tutorials/mobile/part-2.md index ce96dc543..eda7a7d5e 100644 --- a/docs/tutorials/mobile/part-2.md +++ b/docs/tutorials/mobile/part-2.md @@ -22,7 +22,7 @@ A web3 mobile application is not different from a web2 one in terms of its basic ionic start app blank --type react ``` -1. Generate smart contract types from the taqueria plugin: +1. Generate smart contract types from the Taqueria plugin: This command generates Typescript classes from the smart contract interface definition that is used on the frontend. @@ -452,7 +452,7 @@ A web3 mobile application is not different from a web2 one in terms of its basic - `import "@ionic..."`: Default standard Ionic imports. - `import ... from "@airgap/beacon-types" ... from "@taquito/beacon-wallet" ... from "@taquito/taquito"`: Require libraries to interact with the Tezos node and the wallet. - - `export class Action implements ActionCisor, ActionPaper, ActionStone {...}`: Representation of the Ligo variant `Action` in Typescript, which is needed when passing arguments on `Play` function. + - `export class Action implements ActionCisor, ActionPaper, ActionStone {...}`: Representation of the LIGO variant `Action` in Typescript, which is needed when passing arguments on `Play` function. - `export type Session = {...}`: Taqueria exports the global storage type but not this sub-type from the storage type; it is needed for later, so extract a copy. - `export const UserContext = React.createContext(null)`: Global React context that is passed along pages. More info on React context [here](https://beta.reactjs.org/learn/passing-data-deeply-with-context). - `const refreshStorage = async (event?: CustomEvent): Promise => {...`: A useful function to force the smart contract storage to refresh on React state changes (user balance, state of the game). diff --git a/docs/tutorials/smart-contract.md b/docs/tutorials/smart-contract.md index 93f8ea809..84ee56f22 100644 --- a/docs/tutorials/smart-contract.md +++ b/docs/tutorials/smart-contract.md @@ -24,6 +24,6 @@ You can run the tutorial with the version of the language you are most familiar You do not need an experience in these languages to run the tutorial. - To use SmartPy, a language similar to Python, see [Deploy a smart contract with SmartPy](./smart-contract/smartpy) -- To use jsLIGO, a language similar to JavaScript and TypeScript, see [Deploy a smart contract with jsLIGO](./smart-contract/jsligo) +- To use JsLIGO, a language similar to JavaScript and TypeScript, see [Deploy a smart contract with JsLIGO](./smart-contract/jsligo) - To use CameLIGO, a language similar to OCaml, see [Deploy a smart contract with CameLIGO](./smart-contract/cameligo) - To learn the Archetype language, try [Deploy a smart contract with Archetype](./smart-contract/archetype). diff --git a/docs/tutorials/smart-contract/archetype.md b/docs/tutorials/smart-contract/archetype.md index f1043ae38..05c958f4e 100644 --- a/docs/tutorials/smart-contract/archetype.md +++ b/docs/tutorials/smart-contract/archetype.md @@ -10,7 +10,7 @@ It uses the completium-cli command-line tool, which lets you work with Archetype - If you are more familiar with Python, try [Deploy a smart contract with SmartPy](./smartpy). - If you are more familiar with OCaml, try [Deploy a smart contract with CameLIGO](./cameligo). -- If you are more familiar with JavaScript, try [Deploy a smart contract with jsLIGO](./jsligo). +- If you are more familiar with JavaScript, try [Deploy a smart contract with JsLIGO](./jsligo). In this tutorial, you will learn how to: diff --git a/docs/tutorials/smart-contract/cameligo.mdx b/docs/tutorials/smart-contract/cameligo.mdx index 713ab1163..77524c426 100644 --- a/docs/tutorials/smart-contract/cameligo.mdx +++ b/docs/tutorials/smart-contract/cameligo.mdx @@ -8,7 +8,7 @@ last_update: This tutorial covers writing and deploying a simple smart contract with the LIGO programming language. Specifically, this tutorial uses the CameLIGO version of LIGO, which has syntax similar to OCaml, but you don't need any experience with OCaml or LIGO to do this tutorial. -- If you are more familiar with JavaScript, try [Deploy a smart contract with jsLIGO](./jsligo). +- If you are more familiar with JavaScript, try [Deploy a smart contract with JsLIGO](./jsligo). - If you are more familiar with Python, try [Deploy a smart contract with SmartPy](./smartpy). - To learn the Archetype language, try [Deploy a smart contract with Archetype](./archetype). diff --git a/docs/tutorials/smart-contract/jsligo.mdx b/docs/tutorials/smart-contract/jsligo.mdx index 55e8a0bea..2d98625d1 100644 --- a/docs/tutorials/smart-contract/jsligo.mdx +++ b/docs/tutorials/smart-contract/jsligo.mdx @@ -1,12 +1,12 @@ --- -title: Deploy a smart contract with jsLIGO +title: Deploy a smart contract with JsLIGO authors: 'John Joubert, Sasha Aldrick, Claude Barde, Tim McMackin' last_update: date: 3 January 2024 --- This tutorial covers writing and deploying a simple smart contract with the LIGO programming language. -Specifically, this tutorial uses the jsLIGO version of LIGO, which has syntax similar to JavaScript, but you don't need any experience with JavaScript or LIGO to do this tutorial. +Specifically, this tutorial uses the JsLIGO version of LIGO, which has syntax similar to JavaScript, but you don't need any experience with JavaScript or LIGO to do this tutorial. - If you are more familiar with Python, try [Deploy a smart contract with SmartPy](./smartpy). - If you are more familiar with OCaml, try [Deploy a smart contract with CameLIGO](./cameligo). diff --git a/docs/tutorials/smart-contract/smartpy.mdx b/docs/tutorials/smart-contract/smartpy.mdx index 0102c4a39..a51717c5e 100644 --- a/docs/tutorials/smart-contract/smartpy.mdx +++ b/docs/tutorials/smart-contract/smartpy.mdx @@ -9,7 +9,7 @@ This tutorial covers writing and deploying a simple smart contract with the Smar SmartPy has syntax similar to Python, but you don't need any experience with Python or SmartPy to do this tutorial. - If you are more familiar with OCaml, try [Deploy a smart contract with CameLIGO](./cameligo). -- If you are more familiar with JavaScript, try [Deploy a smart contract with jsLIGO](./jsligo). +- If you are more familiar with JavaScript, try [Deploy a smart contract with JsLIGO](./jsligo). - To learn the Archetype language, try [Deploy a smart contract with Archetype](./archetype). SmartPy is a high-level programming language that you can use to write smart contracts for the Tezos blockchain. diff --git a/docs/unity/quickstart.md b/docs/unity/quickstart.md index dea0105da..d127ca169 100644 --- a/docs/unity/quickstart.md +++ b/docs/unity/quickstart.md @@ -19,7 +19,7 @@ These instructions cover: 1. In your Unity project, in the Package Manager panel, click the `+` symbol and then click **Add package from git URL**. -1. Enter the url `https://github.com/trilitech/tezos-unity-sdk.git` and click **Add**. +1. Enter the URL `https://github.com/trilitech/tezos-unity-sdk.git` and click **Add**. The Package Manager panel downloads and installs the SDK. You can see its assets in the Project panel under Packages > Tezos Unity SDK. diff --git a/docs/unity/reference/DAppMetadata.md b/docs/unity/reference/DAppMetadata.md index 2e9a3dc4f..6bb60fce2 100644 --- a/docs/unity/reference/DAppMetadata.md +++ b/docs/unity/reference/DAppMetadata.md @@ -15,7 +15,7 @@ These properties are read-only: - `Name`: The name of the project, which is shown in wallet applications when users connect to the project - `Url`: The home page of the project - `Icon`: The URL to a favicon for the project -- `Description`: A description of hte project +- `Description`: A description of the project ## Methods diff --git a/docs/unity/scenes.md b/docs/unity/scenes.md index 7a27b7864..75bb36ed6 100644 --- a/docs/unity/scenes.md +++ b/docs/unity/scenes.md @@ -56,7 +56,7 @@ This scene includes buttons that link to the other scenes. ## Wallet Connection scene -This scene shows how to to use the TezosAuthenticator prefab to connect to a user's wallet and get information about their account. +This scene shows how to use the TezosAuthenticator prefab to connect to a user's wallet and get information about their account. The scene uses the platform type to determine how to connect to a user's wallet. In the TezosAuthenticator `SetPlatformFlags` function, it checks what platform it is running on: