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:
Providerprovides 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.Walletwraps 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: >= 18(installation guide)ethers: ^6.7.1
yarn add zksdk
yarn add ethers@6 # ethers is a peer dependency of zksdkimport { Provider, utils, types } from "zksdk";
import { ethers } from "ethers";
const provider = Provider.getDefaultProvider(types.Network.Sepolia); // zkSync Era testnet (L2)
const ethProvider = ethers.getDefaultProvider("sepolia"); // Sepolia 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 Sepolia networkTransfer funds among accounts on L2 network.
const receiver = Wallet.createRandom();
const transfer = await wallet.transfer({
to: receiver,
token: utils.ETH_ADDRESS,
amount: ethers.parseEther("1.0"),
});Transfer funds from L1 to L2 network.
const deposit = await wallet.deposit({
token: utils.ETH_ADDRESS,
amount: ethers.parseEther("1.0"),
});Transfer funds from L2 to L1 network.
const withdrawal = await wallet.withdraw({
token: utils.ETH_ADDRESS,
amount: ethers.parseEther("1.0"),
});For running tests, use:
yarn test:wait # waits for local-setup to be ready
yarn test:prepare # prepares the environment (deploys token on both layers, etc.)
yarn testFor running test coverage, use:
yarn test:coverage
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent