Skip to content

Commit 4d922f5

Browse files
Merge branch 'main' of https://github.com/0xPolygon/polygon-docs into km/tools
2 parents a71ecec + e2d82ae commit 4d922f5

File tree

22 files changed

+272
-172
lines changed

22 files changed

+272
-172
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ Welcome to the Polygon Knowledge Layer! This documentation is built using [the M
66
- Polygon zkEVM
77
- Polygon PoS
88
- Polygon Miden
9+
- Dev Tools
910

1011
In addition, we include top-level sections for Tools and Tutorials to support developers in their journey with Polygon technology.
1112

@@ -82,8 +83,10 @@ Whenever we are happy with `main`, a trigger can be manually done through GitHub
8283

8384
## Contact and support
8485

85-
For any queries or support, join our Polygon Slack channel at `#disc_tkd_techdocs`. Current team members:
86+
For any queries or support, please open a ticket at https://support.polygon.technology/support/home.
87+
88+
## Current Technical Knowledge Documentation (TKD) team members
8689

87-
- Grace Torrellas (@0xgraciegrace)
8890
- Anthony Matlala (@EmpieichO)
89-
- Katharine Murphy (@kmurphypolygon)
91+
- Katharine Murphy (@kmurphypolygon)
92+
- Hans (@hsutaiyu)

docs/cdk/get-started/quickstart-validium.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,6 +183,17 @@ You should see a page similar to this:
183183
<img src="/img/cdk/cdk-tx-view-on-block-explorer.png" alt="bridge" width="90%" height="30%" />
184184
</div>
185185

186+
!!! warning "Troubleshooting stuck transactions with MetaMask"
187+
If you encounter a stuck transaction, it is likely due to an incorrect nonce setting.
188+
189+
To resolve this issue, follow the steps below:
190+
191+
1. Open Metamask and navigate to your account.
192+
2. Click on **Settings**.
193+
3. In the **Settings** menu, select **Advanced**.
194+
4. Locate the option **Clear activity and nonce data** and click on it.
195+
5. This resets the nonce data associated with the account, which often resolves transaction-related issues.
196+
186197
## 5. Test the bridge
187198

188199
CDK has a native bridge with UI that allows you to transfer funds between the L1 and the L2 validium.
@@ -201,6 +212,9 @@ CDK has a native bridge with UI that allows you to transfer funds between the L1
201212

202213
5.1.4 Click on **Connect a wallet > MetaMask**.
203214

215+
!!! note
216+
You won't see this view the second time around.
217+
204218
<div align="center">
205219
<img src="/img/cdk/cdk-bridge.png" alt="bridge" width="90%" height="30%" />
206220
</div>
@@ -211,7 +225,7 @@ CDK has a native bridge with UI that allows you to transfer funds between the L1
211225
<img src="/img/cdk/cdk-bridge-connected.png" alt="bridge" width="90%" height="30%" />
212226
</div>
213227

214-
5.1.6 Enter the amount (e.g. 5) to bridge and click **Continue**, you will see the **Confirm Bridge** page.
228+
5.1.6 Enter the amount (e.g. 5) to bridge and click **Continue**, after confirming you understood what you're doing, you will see the **Confirm Bridge** page.
215229

216230
5.1.7 Click **Bridge** and approve the transaction on the MetaMask pop-up:
217231

207 KB
Loading

docs/miden/vm/architecture/introduction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ $$
1414
x' - (x + y) = 0 \text{ | degree} = 1
1515
$$
1616

17-
In the above, the constraint equation is followed by the implied algebraic degree of the constraint. This degree is determined by the number of multiplications between trace columns. If a constraint does not involve any multiplications between columns, its degree is $1$. If a constraint involves multiplication between two columns, its degree is $2$. If we need to multiply three columns together, the degree is $3$ ect.
17+
In the above, the constraint equation is followed by the implied algebraic degree of the constraint. This degree is determined by the number of multiplications between trace columns. If a constraint does not involve any multiplications between columns, its degree is $1$. If a constraint involves multiplication between two columns, its degree is $2$. If we need to multiply three columns together, the degree is $3$ etc.
1818

1919
The maximum allowed constraint degree in Miden VM is $9$. If a constraint degree grows beyond that, we frequently need to introduce additional columns to reduce the degree.
2020

docs/miden/vm/architecture/stack/field-ops.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -232,7 +232,7 @@ The effect on the rest of the stack is:
232232

233233
## `EXT2MUL`
234234

235-
The `EXT2MUL` operation pops top $4$ values from the top of the stack, performs mulitplication between the two extension field elements, and pushes the resulting $4$ values onto the stack. The diagram below illustrates this graphically.
235+
The `EXT2MUL` operation pops top $4$ values from the top of the stack, performs multiplication between the two extension field elements, and pushes the resulting $4$ values onto the stack. The diagram below illustrates this graphically.
236236

237237
![ext2mul](../../../../img/miden/vm/design/stack/field-operations/EXT2MUL.png)
238238

docs/miden/vm/tools/debugger.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ The Miden debugger supports the following commands:
44

55
| Command | Shortcut | Arguments | Description |
66
| --- | --- | --- | --- |
7-
| next | n | count? | Steps `count` clock cycles. Will step `1` cycle of `count` is ommitted. |
7+
| next | n | count? | Steps `count` clock cycles. Will step `1` cycle of `count` is omitted. |
88
| continue | c | - | Executes the program until completion, failure or a breakpoint. |
9-
| back | b | count? | Backward step `count` clock cycles. Will back-step `1` cycle of `count` is ommitted. |
9+
| back | b | count? | Backward step `count` clock cycles. Will back-step `1` cycle of `count` is omitted. |
1010
| rewind | r | - | Executes the program backwards until the beginning, failure or a breakpoint. |
1111
| print | p | - | Displays the complete state of the virtual machine. |
12-
| print mem | p m | address? | Displays the memory value at `address`. If `address` is ommitted, didisplays all the memory values. |
13-
| print stack | p s | index? | Displays the stack value at `index`. If `index` is ommitted, displays all the stack values. |
12+
| print mem | p m | address? | Displays the memory value at `address`. If `address` is omitted, didisplays all the memory values. |
13+
| print stack | p s | index? | Displays the stack value at `index`. If `index` is omitted, displays all the stack values. |
1414
| clock | c | - | Displays the current clock cycle. |
1515
| quit | q | - | Quits the debugger. |
1616
| help | h | - | Displays the help message. |

docs/pos/architecture/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The Polygon Network is broadly divided into three layers:
1818
* **Heimdall layer** — a set of proof-of-stake Heimdall nodes running in parallel to the Ethereum mainnet, monitoring the set of staking contracts deployed on the Ethereum mainnet, and committing the Polygon Network checkpoints to the Ethereum mainnet. Heimdall is based on Tendermint.
1919
* **Bor layer** — a set of block-producing Bor nodes shuffled by Heimdall nodes. Bor is based on Go Ethereum.
2020

21-
![Figure: Ethereum, Bor and Heimdall archictecture](../../img/pos/architecture.png)
21+
![Figure: Ethereum, Bor and Heimdall architecture](../../img/pos/architecture.png)
2222

2323
## Staking smart contracts on Ethereum
2424

docs/pos/concepts/transactions/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11

22

3-
The Transactions subsection provides information about the EIP-1559 as it applies to how gas estimations and costing of transations work on Polygon PoS. Further on, are discussions on new and old types of transaction formats and how they are processed in Polygon PoS.
3+
The Transactions subsection provides information about the EIP-1559 as it applies to how gas estimations and costs of transactions work on Polygon PoS. Further on, are discussions on new and old types of transaction formats and how they are processed in Polygon PoS.
44

55
Regarding account abstraction, the subsection contains a simplified overview of the different components of ERC-4337 and how these components work together. These are altogether; `UserOperation`, `Bundler`, `EntryPoint`, and `Contract Account`. Optional ERC-4337 components are `Paymasters` and `Aggregators`.
66

docs/tools/gas/matic-faucet.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ We have listed three faucet tools you can use to receive MATIC testnet tokens, a
1010
- [Polygon faucet](https://faucet.polygon.technology/)
1111
- [Alchemy MATIC faucet](https://mumbaifaucet.com/)
1212
- [QuickNode multi-chain faucet](https://faucet.quicknode.com/drip)
13+
- [LearnWeb3 Mumbai MATIC Faucet](https://learnweb3.io/faucets/polygon_mumbai)
14+
- [LearnWeb3 zkEVM MATIC Faucet](https://learnweb3.io/faucets/polygon_zkevm)
1315

1416
In addition, Polygon faucet also provides Polygon zkEVM testnet ETH tokens.
1517

@@ -76,3 +78,11 @@ In order to receive MATIC Mumbai tokens using QuickNode faucet,
7678
![img](../../img/tools/gas/quicknode-faucet3.png)
7779

7880
- You can also view your transaction details on [Polygonscan](https://mumbai.polygonscan.com/) by clicking on the TxHash.
81+
82+
## LearnWeb3 Faucets
83+
84+
In order to receive MATIC tokens on Mumbai or zkEVM using the LearnWeb3 Faucet:
85+
86+
- Head over to the [Mumbai Faucet](https://learnweb3.io/faucets/polygon_mumbai) or the [zkEVM Faucet](https://learnweb3.io/faucets/polygon_zkevm).
87+
- Sign in to LearnWeb3 by clicking **Sign In** in the top-right. Connect your GitHub if you haven't already done so to gain access to the faucet.
88+
- Enter your wallet address and request MATIC tokens

docs/zkEVM/architecture/protocol/lxly-bridge.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ Once sequenced batches have been verified, the _Global Exit Tree_ gets updated,
8282

8383
The Rollup Manager manages the following lists of availability;
8484

85-
- Rollup consensus mechanisms. The list may consists of Consensus contracts such as PolygonZkEVM.sol or zkValidium.sol.
85+
- Rollup consensus mechanisms. The list may consist of Consensus contracts such as PolygonZkEVM.sol or zkValidium.sol.
8686
- Verifier contracts. For example, the PolygonZkEVM.sol uses the _Verifier.sol_ SC for verification of batches.
8787

8888
Governance SC oversees Consensus mechanisms and Verifiers that can be added to the respective lists.
@@ -104,7 +104,7 @@ The [Rollup Manager SC](https://github.com/0xPolygonHermez/zkevm-contracts/blob/
104104

105105
- The developer selects the Consensus and Verifier for the required rollup amongst those available in the Rollup Manager's lists,
106106
- Requests creation of a rollup with the selected specifications,
107-
- Governance SC invokes the Rollup Manager's `AddNewRollupType()` function,
107+
- Governance SC invokes the Rollup Manager's `addNewRollupType()` function,
108108
- Once, a rollup is created, the transfer of assets can be processed in the usual manner.
109109

110110
### Overall flow of events
@@ -118,11 +118,11 @@ The below diagram captures the following flow of events, most of which are handl
118118
- Verification of batches,
119119
- Updating the Global Exit Root.
120120

121-
![Figure 3: Events flow related to RollupManager.sol](../../../img/zkEVM/lxly-3-flow-rollupmanager.png)
121+
![Figure 3: Events flow related to RollupManager.sol](../../../img/zkEVM/lxly-bridge-diagram.png)
122122

123123
## Conclusion
124124

125-
Although the LXLY Bridge is still a work in progress, it is designed to be Polygon's talisman for accomplishing multi-chain interoperability.
125+
Although the LXLY Bridge is still in development, it is a central component to Polygon's aggregaton layer which offers multi-chain interoperability.
126126

127127
The LXLY Bridge currently works with the Polygon zkEVM as the L2 and the Ethereum network as L1.
128128

0 commit comments

Comments
 (0)