Utilities - ZKsync SDK Docs

The utilities library contains essential utilities for building on ZKsync Era.

Manage contracts utils

from zksync2.manage_contracts.utils import *

Functions

ZKsync Era main contract

def zksync_abi_default():

IERC20

For interacting with native tokens.

def get_erc20_abi():

Contract deployer

Used for deploying smart contracts.

def icontract_deployer_abi_default():

L1 and L2 bridges

Bridge interface ABIs for L1 and L2.

def l1_bridge_abi_default():

def l2_bridge_abi_default():

Bridgehub

The ABI of the Bridgehub interface.

def bridgehub_abi_default():

NonceHolder

Used for managing deployment nonce.

def nonce_holder_abi_default():

ZkSync Hyperchain

The ABI of the IZkSyncHyperchain interface.

def get_zksync_hyperchain():

Core utils

Constants

L1 to L2 alias offset

Used for applying and undoing aliases on addresses during bridging from L1 to L2.

L1_TO_L2_ALIAS_OFFSET = "0x1111000000000000000000000000000000001111"

Useful addresses

ETH token layer 1

ADDRESS_DEFAULT = "0x0000000000000000000000000000000000000000"

ETH token alias on ZkSync Era

L2_ETH_TOKEN_ADDRESS = "0x000000000000000000000000000000000000800a"

ETH token alias on ZkSync Era

L2_BASE_TOKEN_ADDRESS = "0x000000000000000000000000000000000000800a"

Bootloader

BOOTLOADER_FORMAL_ADDRESS = "0x0000000000000000000000000000000000008001"

ZkSyncAddresses

from zksync2.manage_contracts.deploy_addresses import ZkSyncAddresses

Contract deployer

CONTRACT_DEPLOYER_ADDRESS.value = "0x0000000000000000000000000000000000008006"

L1 messenger

MESSENGER_ADDRESS = "0x0000000000000000000000000000000000008008"

Nonce holder

NONCE_HOLDER_ADDRESS = "0x0000000000000000000000000000000000008003"

EIP712Meta

from zksync2.module.request_types import EIP712Meta

Gas

`GAS_PER_PUB_DATA_DEFAULT`

Use a large amount of gas per pubdata for signing on layer 2.
The amount ensures any reasonable limit is accepted.

The operator is NOT required to use the actual value and can use any value up to that signed by the user.

GAS_PER_PUB_DATA_DEFAULT = 50000

`DEPOSIT_GAS_PER_PUBDATA_LIMIT`

The current required gas per pubdata for L1->L2 transactions.

DEPOSIT_GAS_PER_PUBDATA_LIMIT = 800;

Functions

`applyL1ToL2Alias`

Converts the address that submitted a transaction to the inbox on L1 to the msg.sender viewed on L2.

Returns the msg.sender of the L1->L2 transaction as the address of the contract that initiated the transaction.

More info

During a normal transaction, if contract A calls contract B, the msg.sender is A.
During L1->L2 communication, if an EOA X calls contract B, the msg.sender is X.
During L1->L2 communication, if a contract A calls contract B, the msg.sender is applyL1ToL2Alias(A). ::

Inputs

Parameter	Type	Description
`address`	string	Contract address.

def apply_l1_to_l2_alias(address: HexStr):

Example

l1ContractAddress = "0x702942B8205E5dEdCD3374E5f4419843adA76Eeb"
l2ContractAddress = applyL1ToL2Alias(l1ContractAddress)
# l2ContractAddress = "0x813A42B8205E5DedCd3374e5f4419843ADa77FFC"

`get_custom_bridge_data`

Returns the calldata sent by an L1 ERC20 bridge to its L2 counterpart during token-bridging.

Inputs

Parameter	Type	Description
`token_contract`	`Contract`	Token contract.

def get_custom_bridge_data(token_contract) -> bytes:

`is_eth`

Returns true if token represents ETH on L1 or L2.

Inputs

Parameter	Type	Description
`token`	`HexStr`	The token address.

def is_eth(address: HexStr) -> bool:

Example

is_l1_eth = is_eth(ADDRESS_DEFAULT); // true
is_l2_eth = is_eth(L2_ETH_TOKEN_ADDRESS); // true

`undoL1ToL2Alias`

Converts and returns the msg.sender viewed on L2 to the address that submitted a transaction to the inbox on L1.

Inputs

Parameter	Type	Description
`address`	string	Sender address.

def undo_l1_to_l2_alias(address: HexStr):

Example

l2ContractAddress = "0x813A42B8205E5DedCd3374e5f4419843ADa77FFC"
l1ContractAddress = undo_l1_to_l2_alias(l2ContractAddress)
# const l1ContractAddress = "0x702942B8205E5dEdCD3374E5f4419843adA76Eeb"

`is_address_eq`

Compares stringified addresses, taking into account the fact that addresses might be represented in different casing.

Inputs

Parameter	Type	Description
`a`	`HexStr`	The first address to compare.
`b`	`HexStr`	The second address to compare.

Contract Interfaces

System contracts for interacting with the ZKsync Era network using ABI.

Paymaster Utilities

Essential utilities for using paymasters on ZKsync Era