Use Web3.js to interact with the ZKsync Era network.
Please refer to the comprehensive API documentation for a complete overview of this plugin's capabilities. Usage documentation that includes explanations and code samples is available as part of the official Web3.js plugin for ZKsync SDK docs.
-
RPC methods:
The
RpcMethodsclass implements the ZKsync JSON-RPC API. -
Constants: The
constantspackage includes well-known addresses, such as the address of the L1 ETH token. -
Types: The
typespackage defines enums, interfaces, and types that are used for interacting with the ZKsync Era network. -
Utilities: The
utilspackage exposes helpful functions and contract definitions that can be used with the Web3.js plugin for ZKsync. -
Wallet: The
ZKSyncWalletclass allows developers to create, manage, and use ZKsync accounts. -
Paymasters: The plugin includes a number of
helpful utilities for working with
ZKsync paymasters,
including a
getPaymasterParamsfunction for generating paymaster parameters to add to a transaction. -
Smart contracts: The
ContractFactoryclass can be used to deploy smart contracts to the ZKsync Era network. The return type of theContractFactory.deploymethod is the standard Web3.js Contract class. -
Smart accounts: The
SmartAccountclass can be used to create ZKsync smart accounts with custom logic for building and signing transactions. There are factory functions for creating ECDSA smart accounts and multi-signature ECDSA smart accounts.
Pull requests are welcome. Please make sure to update tests as appropriate. For major changes, please open an Issue first to discuss what you would like to change.
This plugin was created using the Web3.js Plugin Template.