ZKBase Wiki (English)
  • ZKBase Introduction
    • How to convert your ZKS to ZKB
  • ZKSpace Documents Archive
    • Introduction
    • Definition
    • ZKSpace Trading Rules
  • Governance
    • Community Governance Policy
    • Proposal Requirement and Template
  • FAQ
  • Technology
  • Tutorials
    • ZKSwap V2 Tutorials
    • Token/Token pair listing Tutorials
    • ZKSpace Tutorials
    • ZKSea Tutorials
    • Banxa-ZKSpace Tutorial
    • Step to Step Tutorial of Using ZKSwap (Bitcoin) Testnet Version
  • Interact with ZKSwap
    • Definition
    • RESTful API
    • Make Transaction
Powered by GitBook
On this page

Last updated 1 year ago

In the following article, we will use this wallet as example:

Layer-1

The only transaction that made on Layer-1 is deposit. It has two sub-types which are DepositETH and DepositERC20.

ABIs

Deposit ETH

Example Code:

Deposit ERC20

Example code:

Layer-2

When submitting transaction to ZKSwap, the API requires 3 fields: tx, signature and fastProcessing.In the following docs, Signed Transaction refers to the tx field and ETH Signature refers to the signature field.

Private Key

Public Key Hash

After getting private key, you will need to register you publick key hash to ZKSwap so that it can verify transations that you sent.

Signature

Before submit transaction to ZKSwap, you need to sign the the transaction data.

Change Public Key

After the account has been "registered" on ZKSwap (via transfer or deposit), you can change the account's pubKeyHash in order to make any transaction on Layer-2. This is a special transaction that you don't need to sign it with Layer-2's private key.

Transaction Fields

Signed Transaction Example

ETH Signature

NOTE: The {pubKeyHash} in the above message doesn't contain 0x as prefix. The {hexlifiedNonce} and {hexlifiedAccountId} has 4-bytes length with 0 padding in the start and 0x as prefx. See example for reference.

Transfer

Transaction Fields

Full Bytes Example

Signed Transaction Example

ETH Signature

Withdraw

Transaction Fields

Full Bytes Example

Signed Transaction Example

ETH Signature

Swap

Fee

Let's take swap token A for token B as example. There are two cases:

  1. If A is a fee token, the fee token of swap is A. The number of fee is calculated by amountIn * 5 / 9995

  2. If A is not a fee token, the fee token of swap is B. The number of fee is amountOut * 5 /10000. It's not amountOutMin. amountOut equals amountOutMin then slipplage is 0.

Transaction Fields

Full Bytes Example

Signed Transaction Example

ETH Signature

Add Liquidity

Transaction Fields

Full Bytes Example

Signed Transaction Example

ETH Signature

Remove Liquidity

Transaction Fields

Full Bytes Example

Signed Transaction Example

ETH Signature

Like other projects, you must approve ZKSwap's main contract address to spend your ERC20 tokens in order to deposit. Be careful for those tokens that has limit on changing allowance (See ).

Sign the following message with Layer-1's private key to get Layer-2's seed. And use to get private key.

Here's a full example of getting private key using in JavaScript.