Skip to content

Commit 5ea5818

Browse files
committed
fix md syntax issues
1 parent 89a421d commit 5ea5818

File tree

122 files changed

+349
-216
lines changed
  • public/content
    • developers
    • translations
      • cs/developers/docs/smart-contracts
      • de/developers
        • docs
          • consensus-mechanisms/pos/rewards-and-penalties
          • smart-contracts/formal-verification
        • tutorials
      • el/developers/docs
      • es/developers
      • fa/developers/docs
      • fr/developers
      • hi/developers/docs/smart-contracts/formal-verification
      • hu/developers/docs
        • consensus-mechanisms/pos/rewards-and-penalties
        • networking-layer/portal-network
        • smart-contracts/formal-verification
      • id/developers/tutorials
      • it/developers
        • docs
          • consensus-mechanisms/pos/rewards-and-penalties
          • networking-layer/portal-network
          • smart-contracts/formal-verification
        • tutorials
      • ja/developers
      • pt-br/developers
        • docs
          • networking-layer/portal-network
          • smart-contracts/formal-verification
        • tutorials
      • ro/developers/tutorials
      • tr/developers
      • zh-tw/developers/docs
      • zh/developers
        • docs
          • networking-layer/portal-network
          • smart-contracts/formal-verification
        • tutorials

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

122 files changed

+349
-216
lines changed

public/content/developers/docs/networking-layer/portal-network/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ The benefits of this network design are:
5555
- reduce dependence on centralized providers
5656
- Reduce Internet bandwidth usage
5757
- Minimized or zero syncing
58-
- Accessible to resource-constrained devices (<1 GB RAM, <100 MB disk space, 1 CPU)
58+
- Accessible to resource-constrained devices (\<1 GB RAM, \<100 MB disk space, 1 CPU)
5959

6060
The diagram below shows the functions of existing clients that can be delivered by the Portal Network, enabling users to access these functions on very low-resource devices.
6161

public/content/developers/docs/smart-contracts/formal-verification/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ Low-level formal specifications can be given as either Hoare-style properties or
7070

7171
### Hoare-style properties {#hoare-style-properties}
7272

73-
[Hoare Logic](https://en.wikipedia.org/wiki/Hoare_logic) provides a set of formal rules for reasoning about the correctness of programs, including smart contracts. A Hoare-style property is represented by a Hoare triple {_P_}_c_{_Q_}, where _c_ is a program and _P_ and _Q_ are predicates on the state of the _c_ (i.e., the program), formally described as _preconditions_ and _postconditions_, respectively.
73+
[Hoare Logic](https://en.wikipedia.org/wiki/Hoare_logic) provides a set of formal rules for reasoning about the correctness of programs, including smart contracts. A Hoare-style property is represented by a Hoare triple \{_P_}_c_\{_Q_}, where _c_ is a program and _P_ and _Q_ are predicates on the state of the _c_ (i.e., the program), formally described as _preconditions_ and _postconditions_, respectively.
7474

7575
A precondition is a predicate describing the conditions required for the correct execution of a function; users calling into the contract must satisfy this requirement. A postcondition is a predicate describing the condition that a function establishes if correctly executed; users can expect this condition to be true after calling into the function. An _invariant_ in Hoare logic is a predicate that is preserved by execution of a function (i.e., it doesn't change).
7676

public/content/developers/tutorials/creating-a-wagmi-ui-for-your-contract/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -561,7 +561,7 @@ These days there are a lot of [L2 scaling solution](https://ethereum.org/en/laye
561561
}
562562
```
563563

564-
# Conclusion {#conclusion}
564+
## Conclusion {#conclusion}
565565

566566
Of course, you don't really care about providing a user interface for `Greeter`. You want to create a user interface for your own contracts. To create your own application, run these steps:
567567

public/content/developers/tutorials/erc-721-vyper-annotated-code/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -696,7 +696,7 @@ code clearer and therefore easier to secure. So to create your own Vyper ERC-721
696696
contract](https://github.com/vyperlang/vyper/blob/master/examples/tokens/ERC721.vy) and modify it
697697
to implement the business logic you want.
698698

699-
# Conclusion {#conclusion}
699+
## Conclusion {#conclusion}
700700

701701
For review, here are some of the most important ideas in this contract:
702702

public/content/developers/tutorials/erc20-annotated-code/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -681,7 +681,7 @@ the way normal addition does.
681681

682682
These are the four functions that do the actual work: `_transfer`, `_mint`, `_burn`, and `_approve`.
683683

684-
#### The \_transfer function {#\_transfer}
684+
#### The _transfer function {#_transfer}
685685

686686
```solidity
687687
/**
@@ -757,7 +757,7 @@ is atomic, nothing can happen in the middle of it.
757757
Finally, emit a `Transfer` event. Events are not accessible to smart contracts, but code running outside the blockchain
758758
can listen for events and react to them. For example, a wallet can keep track of when the owner gets more tokens.
759759

760-
#### The \_mint and \_burn functions {#\_mint-and-\_burn}
760+
#### The _mint and _burn functions {#_mint-and-_burn}
761761

762762
These two functions (`_mint` and `_burn`) modify the total supply of tokens.
763763
They are internal and there is no function that calls them in this contract,
@@ -819,7 +819,7 @@ Make sure to update `_totalSupply` when the total number of tokens changes.
819819

820820
The `_burn` function is almost identical to `_mint`, except it goes in the other direction.
821821

822-
#### The \_approve function {#\_approve}
822+
#### The _approve function {#_approve}
823823

824824
This is the function that actually specifies allowances. Note that it allows an owner to specify
825825
an allowance that is higher than the owner's current balance. This is OK because the balance is
@@ -904,7 +904,7 @@ are not designed to handle it.
904904
This is the hook function to be called during transfers. It is empty here, but if you need
905905
it to do something you just override it.
906906

907-
# Conclusion {#conclusion}
907+
## Conclusion {#conclusion}
908908

909909
For review, here are some of the most important ideas in this contract (in my opinion, yours is likely to vary):
910910

public/content/developers/tutorials/hello-world-smart-contract-fullstack/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,7 @@ In your project directory type:
263263
npm install --save-dev @nomiclabs/hardhat-ethers "ethers@^5.0.0"
264264
```
265265

266-
### Step 13: Update hardhat.config.js {#step-13-update-hardhat.configjs}
266+
### Step 13: Update hardhat.config.js {#step-13-update-hardhat-configjs}
267267

268268
We’ve added several dependencies and plugins so far, now we need to update `hardhat.config.js` so that our project knows about all of them.
269269

public/content/developers/tutorials/how-to-mint-an-nft/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ published: 2021-04-22
1212
[3LAU](https://www.forbes.com/sites/abrambrown/2021/03/03/3lau-nft-nonfungible-tokens-justin-blau/?sh=5f72ef64643b): $11 Million
1313
[Grimes](https://www.theguardian.com/music/2021/mar/02/grimes-sells-digital-art-collection-non-fungible-tokens): $6 Million
1414

15-
All of them minted their NFTs using Alchemy’s powerful API. In this tutorial, we’ll teach you how to do the same in <10 minutes.
15+
All of them minted their NFTs using Alchemy’s powerful API. In this tutorial, we’ll teach you how to do the same in \<10 minutes.
1616

1717
“Minting an NFT” is the act of publishing a unique instance of your ERC-721 token on the blockchain. Using our smart contract from [Part 1 of this NFT tutorial series](/developers/tutorials/how-to-write-and-deploy-an-nft/), let’s flex our Web3 skills and mint an NFT. At the end of this tutorial, you’ll be able to mint as many NFTs as your heart (and wallet) desires!
1818

public/content/developers/tutorials/how-to-write-and-deploy-an-nft/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@ Now that we’re inside our project folder, we’ll use npm init to initialize t
7373

7474
It doesn’t really matter how you answer the installation questions; here is how we did it for reference:
7575

76+
```json
7677
package name: (my-nft)
7778
version: (1.0.0)
7879
description: My first NFT!
@@ -95,6 +96,7 @@ It doesn’t really matter how you answer the installation questions; here is ho
9596
"author": "",
9697
"license": "ISC"
9798
}
99+
```
98100

99101
Approve the package.json, and we’re good to go!
100102

@@ -255,6 +257,7 @@ We’ve added several dependencies and plugins so far, now we need to update har
255257

256258
Update your hardhat.config.js to look like this:
257259

260+
```js
258261
/**
259262
* @type import('hardhat/config').HardhatUserConfig
260263
*/
@@ -272,6 +275,7 @@ Update your hardhat.config.js to look like this:
272275
}
273276
},
274277
}
278+
```
275279

276280
## Step 14: Compile our contract {#compile-contract}
277281

public/content/developers/tutorials/reverse-engineering-a-contract/index.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,8 @@ Contracts are always executed from the first byte. This is the initial part of t
5151
| 4 | MSTORE | Empty |
5252
| 5 | PUSH1 0x04 | 0x04 |
5353
| 7 | CALLDATASIZE | CALLDATASIZE 0x04 |
54-
| 8 | LT | CALLDATASIZE<4 |
55-
| 9 | PUSH2 0x005e | 0x5E CALLDATASIZE<4 |
54+
| 8 | LT | CALLDATASIZE\<4 |
55+
| 9 | PUSH2 0x005e | 0x5E CALLDATASIZE\<4 |
5656
| C | JUMPI | Empty |
5757

5858
This code does two things:
@@ -117,8 +117,8 @@ The `NOT` is bitwise, so it reverses the value of every bit in the call value.
117117
| -----: | ------------ | --------------------------------------------------------------------------- |
118118
| 1AC | DUP3 | Value\* 2^256-CALLVALUE-1 0x00 Value\* CALLVALUE 0x75 0 6 CALLVALUE |
119119
| 1AD | GT | Value\*>2^256-CALLVALUE-1 0x00 Value\* CALLVALUE 0x75 0 6 CALLVALUE |
120-
| 1AE | ISZERO | Value\*<=2^256-CALLVALUE-1 0x00 Value\* CALLVALUE 0x75 0 6 CALLVALUE |
121-
| 1AF | PUSH2 0x01df | 0x01DF Value\*<=2^256-CALLVALUE-1 0x00 Value\* CALLVALUE 0x75 0 6 CALLVALUE |
120+
| 1AE | ISZERO | Value\*\<=2^256-CALLVALUE-1 0x00 Value\* CALLVALUE 0x75 0 6 CALLVALUE |
121+
| 1AF | PUSH2 0x01df | 0x01DF Value\*\<=2^256-CALLVALUE-1 0x00 Value\* CALLVALUE 0x75 0 6 CALLVALUE |
122122
| 1B2 | JUMPI |
123123

124124
We jump if `Value*` is smaller than 2^256-CALLVALUE-1 or equal to it. This looks like logic to prevent overflow. And indeed, we see that after a few nonsense operations (writing to memory is about to get deleted, for example) at offset 0x01DE the contract reverts if the overflow is detected, which is normal behavior.
@@ -429,7 +429,7 @@ The code in offsets 0x138-0x143 is identical to what we saw in 0x103-0x10E in `s
429429
| 194 | DUP3 | 0x04 0x20 0x00 0x04 CALLDATASIZE 0x0153 0xDA |
430430
| 195 | DUP5 | CALLDATASIZE 0x04 0x20 0x00 0x04 CALLDATASIZE 0x0153 0xDA |
431431
| 196 | SUB | CALLDATASIZE-4 0x20 0x00 0x04 CALLDATASIZE 0x0153 0xDA |
432-
| 197 | SLT | CALLDATASIZE-4<32 0x00 0x04 CALLDATASIZE 0x0153 0xDA |
432+
| 197 | SLT | CALLDATASIZE-4\<32 0x00 0x04 CALLDATASIZE 0x0153 0xDA |
433433
| 198 | ISZERO | CALLDATASIZE-4>=32 0x00 0x04 CALLDATASIZE 0x0153 0xDA |
434434
| 199 | PUSH2 0x01a0 | 0x01A0 CALLDATASIZE-4>=32 0x00 0x04 CALLDATASIZE 0x0153 0xDA |
435435
| 19C | JUMPI | 0x00 0x04 CALLDATASIZE 0x0153 0xDA |
@@ -469,8 +469,8 @@ Let's see what happens if the function _does_ get the call data it needs.
469469
| 172 | DUP2 | 0x04 calldataload(4) 0x04 calldataload(4) 0xDA |
470470
| 173 | SLOAD | Storage[4] calldataload(4) 0x04 calldataload(4) 0xDA |
471471
| 174 | DUP2 | calldataload(4) Storage[4] calldataload(4) 0x04 calldataload(4) 0xDA |
472-
| 175 | LT | calldataload(4)<Storage[4] calldataload(4) 0x04 calldataload(4) 0xDA |
473-
| 176 | PUSH2 0x017e | 0x017EC calldataload(4)<Storage[4] calldataload(4) 0x04 calldataload(4) 0xDA |
472+
| 175 | LT | calldataload(4)\<Storage[4] calldataload(4) 0x04 calldataload(4) 0xDA |
473+
| 176 | PUSH2 0x017e | 0x017EC calldataload(4)\<Storage[4] calldataload(4) 0x04 calldataload(4) 0xDA |
474474
| 179 | JUMPI | calldataload(4) 0x04 calldataload(4) 0xDA |
475475

476476
If the first word is not less than Storage[4], the function fails. It reverts without any returned value:

public/content/developers/tutorials/sending-transactions-using-web3-and-alchemy/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ This is what we will be using in this tutorial.
5555

5656
Okay, now that we have a few of these questions out of the way, let’s move on to the tutorial. Feel free to ask questions anytime in the Alchemy [discord](https://discord.gg/gWuC7zB)!
5757

58-
### 7\. How to send secure, gas-optimized, and private transactions? {how-to-send-secure-gas-optimized-and-private-transactions}
58+
### 7\. How to send secure, gas-optimized, and private transactions? {#how-to-send-secure-gas-optimized-and-private-transactions}
5959

6060
- [Alchemy has a suite of Transact APIs](https://docs.alchemy.com/reference/transact-api-quickstart). You can use these to send reinforced transactions, simulate transactions before they happen, send private transactions, and send gas-optimized transactions
6161
- You can also use the [Notify API](https://docs.alchemy.com/docs/alchemy-notify) to be alerted when your transaction is pulled from the mempool and added to the chain

0 commit comments

Comments
 (0)