matter-labs / zksync-lite-docs

zkSync Lite documentation
https://docs.lite.zksync.io/
MIT License
773 stars 489 forks source link

fix: fix multiple problems in docs #242

Closed popzxc closed 2 years ago

popzxc commented 2 years ago

Bunch of small fixes in docs.

Resolves: ZKS-544, ZKS-818, ZKS-824.

linear[bot] commented 2 years ago
ZKS-544 Typo in zksync-rs docs on zksync.io

There is the following snippet in the rust sdk tutorial: ``` let another_cred = WalletCredentials::from_seed(address, &[1u8; 32]); let another_wallet = Wallet::new(provider, cred).await; ``` You can search the page to find it. Instead of `cread` the `another_cred` should be used.

ZKS-818 Fix docs: add "MintNFT" as a tx fee type to method declarations where it is absent but should be

for example there is the method `getTransactionsBatchFee` with `txTypes`: `("Transfer" | "Withdraw" | "FastWithdraw" | ChangePubKeyFee | LegacyChangePubKeyFee)[]` "MintNFT" is absent there ![image.png](https://uploads.linear.app/4bb823c3-564c-41c7-bf34-4cbddb4d5a42/e4c91a50-18a6-4497-ba8b-028166a57ed3/bff6d353-4505-4d88-b880-98bb277bcf96)

ZKS-824 Incorrect info in docs: 'Tokens' type in docs is not correct

``` export interface Tokens { // Tokens are indexed by their symbol (e.g. "ETH") [token: string]: { address: string; id: number; symbol: string; }; } ``` [https://zksync.io/api/sdk/js/types.html#tokens-and-common-types](https://zksync.io/api/sdk/js/types.html#tokens-and-common-types)☝️\ but actually Tokens type is ``` export interface Tokens { // Tokens are indexed by their symbol (e.g. "ETH") [token: string]: { address: string; id: number; symbol: string; decimals: number; }; } ```

github-actions[bot] commented 2 years ago

Visit the preview URL for this PR (updated for commit 88ec0b4):

(expires Fri, 04 Mar 2022 10:02:30 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

keriat commented 2 years ago

:tada: This PR is included in version 2.11.1 :tada:

The release is available on GitHub release

Your semantic-release bot :package::rocket: