Utilities

zksync-web3 provides some useful utilities for zkSync builders. They can be imported the following way:

import { utils } from "zksync-web3";

Most of the utilities are used internally by the zkSync team. So this document will describe only those which should be helpful for you.

The "address" of ether

While Ether is actually a token deployed on the address:

export const L2_ETH_TOKEN_ADDRESS = "0x000000000000000000000000000000000000800a";

zkSync also allow a more friendly zero address alias in our SDK and API:

export const ETH_ADDRESS = "0x0000000000000000000000000000000000000000";

ABI of zkSync smart contract

export const ZKSYNC_MAIN_ABI = new utils.Interface(require("../abi/IZkSync.json"));

IERC20 interface

Convenient when interacting with native tokens on zkSync.

export const IERC20 = new utils.Interface(require("../abi/IERC20.json"));

Encoding paymaster params

Utility method that returns the correctly formed paymasterParams object for the common paymaster flows.

export function getPaymasterParams(paymasterAddress: Address, paymasterInput: PaymasterInput): PaymasterParams

The definition of the PaymasterInput can be found here.

Useful gas constants

Currently, there is no method to accurately estimate the required gasPerPubdataLimit. That's why for now, it is highly recommended to provide the DEFAULT_GAS_PER_PUBDATA_LIMIT. Users are not charged more by providing it. Later on it will be possible to query the current recommended limit.

const GAS_PER_PUBDATA_BYTE = 17;

// The large L2 gas per pubdata to sign. This gas is enough to ensure that
// any reasonable limit will be accepted. Note, that the operator is NOT required to
// use the honest value of gas per pubdata and it can use any value up to the one signed by the user.
// In the future releases, we will provide a way to estimate the current gasPerPubdata.
export const DEFAULT_GAS_PER_PUBDATA_LIMIT = 50000;

export const RECOMMENDED_GAS_LIMIT = {
    DEPOSIT: 600_000,
    EXECUTE: 620_000,
    ERC20_APPROVE: 50_000
};