matter-labs / zksync-lite-docs

zkSync Lite documentation

zkSync Lite Docs

zkSync Documentation for the v1 | CHANGELOG

This repository contains the zkSync documentation hosted at docs.lite.zksync.io/

Development

Prerequisites

A Node.js installation running Node.js version 16.

Local run

yarn install --check-cache
yarn docs:dev

Development

CI pipeline will check that the files are formatted according markdownlint founds no issues in document and spelling is correct. Also, there should be no dead links.

You can check it locally as follows:

yarn
yarn md:lint
yarn cspell

If cspell doesn't recognize a word but you're sure that it's correct, consider adding it to the cspell-zksync.txt.

Deployment

master branch is automatically deployed to https://console.firebase.google.com/u/0/project/zksync-web-docs

Deploying altogether

will do:

• install node modules;
• prepare, test and build documentation;
• afterwards all contained into the dist folder will be deployed in form of the static website

yarn install --check-cache
yarn docs:build
yarn firebase deploy

Extra documentation

cSpell

Configuration in cspell.json:

• version — version of the setting file, always 0.1
• language — language - current active spelling language
• words[] — words - list of words to be always considered correct
• dictionaries[]

"dictionaryDefinitions": [
    {
      "name": "zksync", "path": "./cspell-zksync.txt"
    }
]

{
  "version": "0.1",
  // language - current active spelling language
  "language": "en",
  // words - list of words to be always considered correct
  "words": [],
  "dictionaries": ["typescript", "zksync"],
  //
  "dictionaryDefinitions": [
  {
    "name": "zksync", "path": "./cspell-zksync.txt"
  }
]
}

---

ZKsync Ecosystem

• Start building with ZKsync v2 🚀
• Integration Docs
• Available API & protocols
• zkWallet
• Alternative Withdrawal
• zkScan
• ’out-of-gas’ issue solver

---

• Matter Labs: creators of the ZKsync
• ZKsync Homepage

---

BTW, we're hiring: See open positions

License

zkWallet is distributed under the terms of both the MIT license, and the Apache License (v.2.0).

See LICENSE-APACHE, LICENSE-MIT for details.

zksync-lite-docs's Issues

Dsa

i18n for zksync docs

In order to help more developer get to know zksync, involves in the eco-system and contribute. Will be beneficial to developers and zksync both to make zksync docs have multiple language options.

🧾 Expected Behaviour

Have i18n configured in the project, and have multiple languages options.

🔨 Current Behaviour

zksync docs only have an English version.

✅ Acceptance criteria

• User able to choose a different language for zksync docs
• Chinese version of docs

Axelar

https://github.com/axelarnetwork/axelar-examples

BRIDGE TO ZKSYNC IS MISSING ON zkBridge PROTOCOL

BRIDGE TO ZKSYNC IS MISSING ON zkBridge PROTOCOL , it will be lovely if the Team can work on it
link to there website below
https://zkbridge.com/token

Withdraw issue

Nft withdrawal

The automated release is failing 🚨

🚨 The automated release from the master branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you can benefit from your bug fixes and new features again.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can fix this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the master branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here are some links that can help you:

• Usage documentation
• Frequently Asked Questions
• Support channels

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

---

Cannot push to the Git repository.

semantic-release cannot push the version tag to the branch master on the remote Git repository with URL https://[secure]@github.com/matter-labs/zksync-docs.

This can be caused by:

• a misconfiguration of the repositoryUrl option
• the repository being unavailable
• or missing push permission for the user configured via the Git credentials on your CI environment

---

Good luck with your project ✨

Your semantic-release bot 📦🚀

Zksync

RaidGuild Request: indexed.wtf doc edits and additions

Hello blessed devs,
@dvush @gluk64 @ly0va @popzxc @shamatar @slumber @vladbochok

We here at Raid Guild have brought you indexed.wtf and are taking care to make sure the docs we display for each Layer 2 and side-chain project are accurate and filled with information the dev teams would like to highlight specifically. Having easily accessible information about all these solutions will bring more attention to your project.

Please find the markdown for the docs for your project below.

Kindly review, edit and provide any missing details and information at your taste and discretion as project leaders.

Moving forward we aim to keep indexed.wtf as current and beneficial to developers researching the ecosystem as possible. Please feel free at any time to submit an issue or PR to update the displayed information.

Thank you for your attention to this matter.

Best,
The Indexed Army
We stand for accurate data.

www.RaidGuild.org
@chair28980 @kittyslasher

# Matter Labs

## Description

<!-- Please update description if necessary. Please feel free to update/eliminate/include headers below.-->

zkSync (built by Matter Labs) is a scaling and privacy engine for Ethereum. Its current functionality scope includes low gas transfers of ETH and ERC20 tokens in the Ethereum network. This document is a high-level description of the zkSync development ecosystem.

## Consensus Type


## Tx Cost


## Average TPS

##Finality Time

## Governance/validator Token

## Transactional Token

## Resources

[Website](https://matter-labs.io/)

[Github](https://github.com/matter-labs)

[Developer Docs]()

## Social Media & Community

[Telegram](https://t.me/matterlabs)

[Twitter](https://twitter.com/the_matter_labs)

[Medium](https://medium.com/matter-labs)

[Gitter](https://gitter.im/matter-labs/community)

Add decentralized storage section on developer guide

Hey there, do we have plan to add dStorage section on developer guide to let zksync's devs to learn about dStorage solutions like ethereum's wiki: https://ethereum.org/en/developers/docs/storage/

JS wallet creation is missing accountId

Expected Behaviour

Following the steps to create a Wallet here, I would expect to be able to complete all the steps successfully.

I continue getting an Error("Unknown account") that is thrown from the code sample here

🙋‍️ Possible Solution [optional]

I added await syncWallet.resolveAccountId(); and that created the accountId, and I was able to complete the rest of the steps successfully.

Note: I got the idea for the solution by looking at the Rust SDK docs which have a similar method wallet.update_account_id().await?;. I think the JS docs should be updated to include this step as well.

error happened while import zksync in js

I'm trying to connect to zksync by js. However, something wrong happened when I import zksync lib. My node version is 18.15.0

the log shows:
/data/shiweixu/zksync/node_modules/zksync/build/utils.js:23
exports.IERC20_INTERFACE = new ethers_1.utils.Interface(require('../abi/IERC20.json').abi);
^

TypeError: Cannot read properties of undefined (reading 'Interface')
at Object. (/data/shiweixu/zksync/node_modules/zksync/build/utils.js:23:47)
at Module._compile (node:internal/modules/cjs/loader:1254:14)
at Module._extensions..js (node:internal/modules/cjs/loader:1308:10)
at Module.load (node:internal/modules/cjs/loader:1117:32)
at Module._load (node:internal/modules/cjs/loader:958:12)
at Module.require (node:internal/modules/cjs/loader:1141:19)
at require (node:internal/modules/cjs/helpers:110:18)
at Object. (/data/shiweixu/zksync/node_modules/zksync/build/eth-message-signer.js:33:17)
at Module._compile (node:internal/modules/cjs/loader:1254:14)
at Module._extensions..js (node:internal/modules/cjs/loader:1308:10)

and the code of the file is only one line:
import * as zksync from 'zksync';

Does era support create2 method?