Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
zksync-web3
Advanced tools
In order to provide easy access to all the features of zkSync Era, the zksync-web3
JavaScript SDK was created,
which is made in a way that has an interface very similar to those of ethers. In
fact, ethers
is a peer dependency of our library and most of the objects exported by zksync-web3
(
e.g. Wallet
, Provider
etc.) inherit from the corresponding ethers
objects and override only the fields that need
to be changed.
While most of the existing SDKs should work out of the box, deploying smart contracts or using unique zkSync features, like account abstraction, requires providing additional fields to those that Ethereum transactions have by default.
The library is made in such a way that after replacing ethers
with zksync-web3
most client apps will work out of
box.
🔗 For a detailed walkthrough, refer to the official documentation.
To begin, it is useful to have a basic understanding of the types of objects available and what they are responsible for, at a high level:
Provider
provides connection to the zkSync Era blockchain, which allows querying the blockchain state, such as account, block or transaction details,
querying event logs or evaluating read-only code using call. Additionally, the client facilitates writing to the blockchain by sending
transactions.Wallet
wraps all operations that interact with an account. An account generally has a private key, which can be used to sign a variety of
types of payloads. It provides easy usage of the most common features.node: >= 14.20.0
(installation guide)ethers: ~5.7.0
yarn add zksync-web3
yarn add ethers@5 # ethers is a peer dependency of zksync-web3
import { Wallet, Provider, utils } from "zksync-web3";
import { ethers } from "ethers";
const provider = new Provider("https://testnet.era.zksync.dev"); // zkSync Era testnet (L2)
const ethProvider = ethers.getDefaultProvider("goerli"); // goerli testnet (L1)
const blockNumber = await provider.getBlockNumber();
const block = await provider.getBlock("latest");
const PRIVATE_KEY = process.env.PRIVATE_KEY;
const wallet = new Wallet(PRIVATE_KEY, provider, ethProvider);
const ethBalance = await wallet.getBalance(); // balance on zkSync Era network
const ethBalanceL1 = await wallet.getBalanceL1(); // balance on goerli network
Transfer funds among accounts on L2 network.
const receiver = Wallet.createRandom();
const transfer = await wallet.transfer({
to: receiver,
token: utils.ETH_ADDRESS,
amount: ethers.utils.parseEther("1.0"),
});
Transfer funds from L1 to L2 network.
const deposit = await wallet.deposit({
token: utils.ETH_ADDRESS,
amount: ethers.utils.parseEther("1.0"),
});
Transfer funds from L2 to L1 network.
const withdrawal = await wallet.withdraw({
token: utils.ETH_ADDRESS,
amount: ethers.utils.parseEther("1.0"),
});
We welcome contributions from the community! If you're interested in contributing to the zksync-web JavaScript SDK, please take a look at our CONTRIBUTING.md for guidelines and details on the process.
Thank you for making zksync-web3 JavaScript SDK better! 🙌
FAQs
A Web3 library for interacting with the ZkSync Layer 2 scaling solution.
The npm package zksync-web3 receives a total of 33,052 weekly downloads. As such, zksync-web3 popularity was classified as popular.
We found that zksync-web3 demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.