Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: correct errors in documentation #76

Merged
merged 3 commits into from
Jul 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/sdk/20.go/00.introduction/00.overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,5 @@ interfaces and comprehensive documentation.
- **Interoperability**: Compatible with existing Ethereum tools and infrastructure.

::callout{icon="i-heroicons-light-bulb"}
To get started with `zksync2-go`, follow the [installation instructions](/sdk/go/introduction/installation) provided.
To use the `zksync2-go`, visit the [Getting Started](/sdk/go/guides/getting-started) page.
::
2 changes: 2 additions & 0 deletions content/sdk/20.go/01.guides/00.getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -943,4 +943,6 @@ func main() {
}
::

::callout{icon="i-heroicons-light-bulb"}
Examples are configured to interact with `ZKsync Era`, and `Sepolia` test networks.
::
8 changes: 4 additions & 4 deletions content/sdk/20.go/01.guides/02.accounts-l1-l2.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ For a comprehensive example demonstrating the deposit workflow, refer to the fol

::collapsible

```sh
```bash
package main

import (
Expand Down Expand Up @@ -132,7 +132,7 @@ func main() {
- Deposit ERC20 tokens

::collapsible
```sh
```bash

package main

Expand Down Expand Up @@ -297,7 +297,7 @@ For a complete example of how to execute the deposit workflow, take a look at th

::collapsible

```sh
```bash
package main

import (
Expand Down Expand Up @@ -359,7 +359,7 @@ func main() {
- Withdraw ERC20 token

::collapsible
```sh
```bash

package main

Expand Down
2 changes: 1 addition & 1 deletion content/sdk/30.python/00.introduction/00.overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,5 +33,5 @@ library. Most objects exported by `zksync2` inherit from `web3.py` objects and o
For more detailed information and advanced usage, refer to the [official ZKsync documentation](https://docs.zksync.io/sdk).

::callout{icon="i-heroicons-light-bulb"}
To use the `Python SDK`, visit the [Getting Started](/sdk/python/guides/getting-started) page.
To use the `zksync2-python`, visit the [Getting Started](/sdk/python/guides/getting-started) page.
::
3 changes: 3 additions & 0 deletions content/sdk/30.python/01.guides/00.getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -384,4 +384,7 @@ if __name__ == "__main__":
f"{zk_web3.zksync.get_balance(paymaster_address, EthBlockParams.LATEST.value)}")
print(f"Paymaster Crown token balance after mint: {token_contract.functions.balanceOf(paymaster_address).call()}")
::

::callout{icon="i-heroicons-light-bulb"}
Examples are configured to interact with `ZKsync Era` and `Sepolia` test networks.
::
2 changes: 1 addition & 1 deletion content/sdk/40.java/00.introduction/00.overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,5 +41,5 @@ The `zksync2-java` library is designed with simplicity in mind, offering straigh
documentation to help developers get started quickly and efficiently.

::callout{icon="i-heroicons-light-bulb"}
To use the zksync2-java, visit the [Getting started](/sdk/java/guides/getting-started) page.
To use the `zksync2-java`, visit the [Getting started](/sdk/java/guides/getting-started) page.
::
2 changes: 1 addition & 1 deletion content/sdk/50.swift/00.introduction/00.overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,5 @@ interactions, and account management.
ensures robust security and scalability, enabling applications to handle a high volume of transactions with minimal overhead.

::callout{icon="i-heroicons-light-bulb"}
To use the zksync2-swift, visit the [Getting started](/sdk/swift/introduction/installation) page.
To use the `zksync2-swift`, visit the [Getting started](/sdk/swift/introduction/installation) page.
::
8 changes: 7 additions & 1 deletion content/sdk/60.rust/00.getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,11 +157,13 @@ let deposit_transaction_hash = {
println!("Deposit transaction hash: {:?}", deposit_transaction_hash);
```

**NOTE:** Each token inside ZKsync has an address. If `ERC-20` tokens are being bridged,
::callout{icon="i-heroicons-light-bulb"}
Each token inside ZKsync has an address. If `ERC-20` tokens are being bridged,
you should supply the token's L1 address by calling the `token` method from `DepositRequest`,
or zero address (`0x0000000000000000000000000000000000000000`) if you want to deposit ETH.
Note, that for the `ERC-20` tokens the address of their corresponding L2 token will be
different from the one on Ethereum.
::

After the transaction is submitted to the Ethereum node, its status can be tracked using
the transaction hash:
Expand Down Expand Up @@ -306,3 +308,7 @@ let withdraw_receipt_l1 = zk_wallet_2.get_eth_provider().unwrap().get_transactio

[sdk]: https://github.com/lambdaclass/zksync-web3-rs/
[tokio]: https://tokio.rs/

::callout{icon="i-heroicons-exclamation-triangle" color="amber"}
For development and testing, it is recommended to use burner wallets. Avoid using real private keys to prevent security risks.
::
4 changes: 4 additions & 0 deletions content/sdk/60.rust/contract-deployment-and-interaction.md
Original file line number Diff line number Diff line change
Expand Up @@ -296,3 +296,7 @@ async fn interact_with_contract() {
[test-node]: https://github.com/matter-labs/era-test-node/
[abi]: https://raw.githubusercontent.com/lambdaclass/zksync-web3-rs/7ae7bec0323d878beac2b74f00256f8589b4a206/examples/contract-deployment/Greeter.abi
[bin]: https://raw.githubusercontent.com/lambdaclass/zksync-web3-rs/7ae7bec0323d878beac2b74f00256f8589b4a206/examples/contract-deployment/Greeter.bin

::callout{icon="i-heroicons-exclamation-triangle" color="amber"}
For development and testing, it is recommended to use burner wallets. Avoid using real private keys to prevent security risks.
::
Loading