Class SmartAccount

Creates a SmartAccount instance with provided signer and provider. By default, uses signPayloadWithECDSA and populateTransactionECDSA.

Example

import { SmartAccount, types, Web3ZKsyncL2 } from "web3-plugin-zksync";

const ADDRESS = "<ADDRESS>";
const PRIVATE_KEY = "<PRIVATE_KEY>";

const l2 = Web3ZKsyncL2.initWithDefaultProvider(types.Network.Sepolia);
const account = new SmartAccount(
  {address: ADDRESS, secret: PRIVATE_KEY},
  l2
);
Copy

Returns a context (provider + Signer) instance for connecting to an L2 network.

Creates a new instance of SmartAccount connected to a provider or detached from any provider if null is provided.

Example

import { SmartAccount, types, Web3ZKsyncL2 } from "web3-plugin-zksync";

const ADDRESS = "<ADDRESS>";
const PRIVATE_KEY = "<PRIVATE_KEY>";

const sepoliaProvider = Web3ZKsyncL2.initWithDefaultProvider(types.Network.Sepolia);
const sepoliaAccount = new SmartAccount(
  {address: ADDRESS, secret: PRIVATE_KEY},
  sepoliaProvider
);

const mainnetProvider = Web3ZKsyncL2.initWithDefaultProvider(types.Network.Mainnet);
const mainnetAccount = sepoliaAccount.connect(mainnetProvider);
Copy

Returns all token balances of the account.

Example

import { SmartAccount, types, Web3ZKsyncL2 } from "web3-plugin-zksync";

const ADDRESS = "<ADDRESS>";
const PRIVATE_KEY = "<PRIVATE_KEY>";

const l2 = Web3ZKsyncL2.initWithDefaultProvider(types.Network.Sepolia);
const account = new SmartAccount(
  {address: ADDRESS, secret: PRIVATE_KEY},
  l2
);

const balances = await account.getAllBalances();
Copy

Returns the balance of the account.

Example

import { SmartAccount, types, Web3ZKsyncL2 } from "web3-plugin-zksync";

const ADDRESS = "<ADDRESS>";
const PRIVATE_KEY = "<PRIVATE_KEY>";

const l2 = Web3ZKsyncL2.initWithDefaultProvider(types.Network.Sepolia);
const account = new SmartAccount(
  {address: ADDRESS, secret: PRIVATE_KEY},
  l2
);

const balance = await account.getBalance();
Copy

Returns the deployment nonce of the account.

Example

import { SmartAccount, types, Web3ZKsyncL2 } from "web3-plugin-zksync";

const ADDRESS = "<ADDRESS>";
const PRIVATE_KEY = "<PRIVATE_KEY>";

const l2 = Web3ZKsyncL2.initWithDefaultProvider(types.Network.Sepolia);
const account = new SmartAccount(
  {address: ADDRESS, secret: PRIVATE_KEY},
  l2
);

const nonce = await account.getDeploymentNonce();
Copy

Populates the transaction tx using the provided TransactionBuilder function. If tx.from is not set, it sets the value from the getAddress method which can be utilized in the TransactionBuilder function.

Example

import { constants, SmartAccount, types, Web3ZKsyncL2 } from "web3-plugin-zksync";

const ADDRESS = "<ADDRESS>";
const PRIVATE_KEY = "<PRIVATE_KEY>";

const l2 = Web3ZKsyncL2.initWithDefaultProvider(types.Network.Sepolia);
const account = new SmartAccount(
  {address: ADDRESS, secret: PRIVATE_KEY},
  l2
);

const populatedTx = await account.populateTransaction({
  type: constants.EIP712_TX_TYPE,
  to: "<RECEIVER>",
  value: 7_000_000_000,
});
Copy

Sends tx to the Network. The signTransaction is called first to ensure transaction is properly signed.

Example

import { SmartAccount, types, Web3ZKsyncL2 } from "web3-plugin-zksync";

const ADDRESS = "<ADDRESS>";
const PRIVATE_KEY = "<PRIVATE_KEY>";

const l2 = Web3ZKsyncL2.initWithDefaultProvider(types.Network.Sepolia);
const account = new SmartAccount(
  {address: ADDRESS, secret: PRIVATE_KEY},
  l2
);

const signedTx = await account.sendTransaction({
  to: "<RECEIVER>",
  value: 7_000_000_000,
});
Copy

Signs a message using the provided PayloadSigner function.

Example

import { SmartAccount, types, Web3ZKsyncL2 } from "web3-plugin-zksync";

const ADDRESS = "<ADDRESS>";
const PRIVATE_KEY = "<PRIVATE_KEY>";

const l2 = Web3ZKsyncL2.initWithDefaultProvider(types.Network.Sepolia);
const account = new SmartAccount(
  {address: ADDRESS, secret: PRIVATE_KEY},
  l2
);

const signedMessage = await account.signMessage('Hello World!');
Copy

Signs the transaction tx using the provided PayloadSigner function, returning the fully signed transaction. The populateTransaction method is called first to ensure that all necessary properties for the transaction to be valid have been populated.

Example

import { SmartAccount, types, Web3ZKsyncL2 } from "web3-plugin-zksync";

const ADDRESS = "<ADDRESS>";
const PRIVATE_KEY = "<PRIVATE_KEY>";

const l2 = Web3ZKsyncL2.initWithDefaultProvider(types.Network.Sepolia);
const account = new SmartAccount(
  {address: ADDRESS, secret: PRIVATE_KEY},
  l2
);

const signedTx = await account.signTransaction({
  to: "<RECEIVER>",
  value: 7_000_000_000,
});
Copy

Signs a typed data using the provided PayloadSigner function.

Example

import { SmartAccount, types, Web3ZKsyncL2 } from "web3-plugin-zksync";

const ADDRESS = "<ADDRESS>";
const PRIVATE_KEY = "<PRIVATE_KEY>";

const l2 = Web3ZKsyncL2.initWithDefaultProvider(types.Network.Sepolia);
const account = new SmartAccount(
  {address: ADDRESS, secret: PRIVATE_KEY},
  l2
);

const signedTypedData = await account.signTypedData(
  {name: 'Example', version: '1', chainId: 270},
  {
    Person: [
      {name: 'name', type: 'string'},
      {name: 'age', type: 'uint8'},
    ],
  },
  {name: 'John', age: 30}
);
Copy

Transfer ETH or any ERC20 token within the same interface.

Example: Transfer ETH.

import { constants, SmartAccount, types, Web3ZKsyncL2 } from "web3-plugin-zksync";

const ADDRESS = "<ADDRESS>";
const PRIVATE_KEY = "<PRIVATE_KEY>";

const l2 = Web3ZKsyncL2.initWithDefaultProvider(types.Network.Sepolia);
const account = new SmartAccount(
  {address: ADDRESS, secret: PRIVATE_KEY},
  l2
);

const transferTx = await account.transfer({
  token: constants.ETH_ADDRESS,
  to: "<RECEIVER>",
  amount: 10_000_000n,
});

const receipt = await transferTx.wait();

console.log(`The sum of ${receipt.value} ETH was transferred to ${receipt.to}`);
Copy

Example: Transfer ETH using paymaster to facilitate fee payment with an ERC20 token.

import { constants, paymasterUtils, SmartAccount, types, Web3ZKsyncL2 } from "web3-plugin-zksync";

const ADDRESS = "<ADDRESS>";
const PRIVATE_KEY = "<PRIVATE_KEY>";

const token = "0x927488F48ffbc32112F1fF721759649A89721F8F"; // Crown token which can be minted for free
const paymaster = "0x13D0D8550769f59aa241a41897D4859c87f7Dd46"; // Paymaster for Crown token

const l2 = Web3ZKsyncL2.initWithDefaultProvider(types.Network.Sepolia);
const account = new SmartAccount(
  {address: ADDRESS, secret: PRIVATE_KEY},
  l2
);

const transferTx = await account.transfer({
  to: Wallet.createRandom().address,
  amount: 10_000_000n,
  paymasterParams: paymasterUtils.getPaymasterParams(paymaster, {
    type: "ApprovalBased",
    token: token,
    minimalAllowance: 1,
    innerInput: new Uint8Array(),
  }),
});

const receipt = await transferTx.wait();

console.log(`The sum of ${receipt.value} ETH was transferred to ${receipt.to}`);
Copy

Initiates the withdrawal process which withdraws ETH or any ERC20 token from the associated account on L2 network to the target account on L1 network.

Example: Withdraw ETH.

import { constants, SmartAccount, types, Web3ZKsyncL2 } from "web3-plugin-zksync";

const ADDRESS = "<ADDRESS>";
const PRIVATE_KEY = "<PRIVATE_KEY>";

const l2 = Web3ZKsyncL2.initWithDefaultProvider(types.Network.Sepolia);
const account = new SmartAccount(
  {address: ADDRESS, secret: PRIVATE_KEY},
  l2
);

const withdrawTx = await account.withdraw({
  token: constants.ETH_ADDRESS,
  amount: 10_000_000n,
});
Copy

Example: Withdraw ETH using paymaster to facilitate fee payment with an ERC20 token.

import { constants, paymasterUtils, SmartAccount, types, Web3ZKsyncL2 } from "web3-plugin-zksync";

const ADDRESS = "<ADDRESS>";
const PRIVATE_KEY = "<PRIVATE_KEY>";

const token = "0x927488F48ffbc32112F1fF721759649A89721F8F"; // Crown token which can be minted for free
const paymaster = "0x13D0D8550769f59aa241a41897D4859c87f7Dd46"; // Paymaster for Crown token

const l2 = Web3ZKsyncL2.initWithDefaultProvider(types.Network.Sepolia);
const account = new SmartAccount(
  {address: ADDRESS, secret: PRIVATE_KEY},
  l2
);

const withdrawTx = await account.withdraw({
  token: constants.ETH_ADDRESS,
  amount: 10_000_000n,
  paymasterParams: paymasterUtils.getPaymasterParams(paymaster, {
    type: "ApprovalBased",
    token: token,
    minimalAllowance: 1,
    innerInput: new Uint8Array(),
  }),
});
Copy