Deposits

Deposits are submitted directly to on-chain contracts through DepositClient.

Unlike orders and other exchange actions, deposits do not use the Exchange HTTP API.

A deposit integration requires:

• An EVM wallet

• A JSON-RPC provider

• The correct chain ID

• A configured or discoverable deposit-ledger contract

• Settlement tokens in the connected wallet

Create a deposit client

import { createDepositClient } from "@gammaswap/v2-exchange-sdk";
import { Wallet } from "ethers";

const wallet = new Wallet(
  process.env.PRIVATE_KEY!,
);

const deposit = createDepositClient({
  rpcUrl: process.env.RPC_URL!,
  wallet,
  chainId: "84532",
});

The client connects the wallet to the configured RPC provider.

Before performing reads or transactions, it checks that the RPC network matches chainId.

Contract configuration

The deposit-ledger address can be resolved from the SDK’s default contracts for the selected chain.

It can also be supplied directly:

const deposit = createDepositClient({
  rpcUrl: process.env.RPC_URL!,
  wallet,
  chainId: "84532",
  depositLedger:
    "0x1111111111111111111111111111111111111111",
});

Custom contract overrides can be supplied with contracts:

const deposit = createDepositClient({
  rpcUrl: process.env.RPC_URL!,
  wallet,
  chainId: "84532",
  contracts: {
    // Chain-specific contract overrides
  },
});

Settlement-token decimals are currently required to be six:

const deposit = createDepositClient({
  rpcUrl: process.env.RPC_URL!,
  wallet,
  chainId: "84532",
  settlementTokenDecimals: 6,
});

Discover deposit contracts

Read the settlement-token address:

const settlementToken =
  await deposit.getSettlementToken();

Response:

"0x2222222222222222222222222222222222222222"

Read the Permit2 address:

const permit2 = await deposit.getPermit2();

Response:

"0x3333333333333333333333333333333333333333"

Read the account-ledger address:

const accountLedger =
  await deposit.getAccountLedger();

Response:

"0x4444444444444444444444444444444444444444"

Parse a deposit amount

Deposit amounts use human decimal strings.

const amount = deposit.parseAmount("100.25");

Response:

100250000n

The settlement token uses six decimal places.

Additional examples:

deposit.parseAmount("1");

Response:

1000000n

deposit.parseAmount("0.01");

Response:

10000n

Check the token balance

Read the connected wallet’s settlement-token balance:

const balance =
  await deposit.getSettlementTokenBalance();

Response:

250000000n

This represents 250 settlement tokens when the token uses six decimals.

Read another owner’s balance:

const balance =
  await deposit.getSettlementTokenBalance(
    "0x5555555555555555555555555555555555555555",
  );

Check token allowance

const allowance =
  await deposit.getSettlementTokenAllowance();

Response:

1000000000n

An owner and spender can also be supplied explicitly.

const allowance =
  await deposit.getSettlementTokenAllowance(
    "0x3333333333333333333333333333333333333333",
    wallet.address,
  );

Approve the deposit ledger

The deposit ledger must have sufficient token allowance before it can transfer settlement tokens.

const result =
  await deposit.approveDepositLedger({
    // Approval input
  });

This method submits an on-chain token-approval transaction.

The exact approval input and returned transaction type are not included in the supplied SDK documentation. These fields should be copied from the SDK’s exported TypeScript definitions.

Approve Permit2

Permit-based deposits require an appropriate Permit2 token allowance.

const result =
  await deposit.approvePermit2({
    // Approval input
  });

This method submits an on-chain token-approval transaction.

The exact approval input and returned transaction type are not included in the supplied SDK documentation.

Submit a deposit

const result = await deposit.deposit({
  // Deposit input
});

The method logs the deposit txId by default.

Disable transaction-ID logging with:

const result = await deposit.deposit({
  // Deposit input
  logTxId: false,
});

The exact deposit input and return type are not included in the supplied SDK documentation. They should be documented from the SDK’s exported TypeScript definitions.

Sign a deposit permit

signDepositPermit creates a signed Permit2 authorization without submitting a transaction.

const permit =
  await deposit.signDepositPermit({
    // Permit input
  });

Keep the signed permit with the deposit request that will consume it.

The exact returned permit structure is not included in the supplied SDK documentation.

Deposit with a permit

const result =
  await deposit.depositWithPermit({
    // Deposit and signed permit input
  });

This method submits an on-chain deposit using the signed Permit2 authorization.

The exact input and return type should be copied from the SDK’s exported TypeScript definitions.

Check deposit state

Read the pending balance:

const pendingBalance =
  await deposit.getPendingBalance();

Read the processed balance:

const processedBalance =
  await deposit.getProcessedBalance();

Read the number of pending deposits:

const pendingCount =
  await deposit.getPendingDepositCount();

Read the next pending deposit ID:

const nextDepositId =
  await deposit.getNextPendingDepositId();

Read the processed-deposit index:

const processedIndex =
  await deposit.getProcessedDepositIndex();

Read the minimum required block wait:

const minBlockWait =
  await deposit.getMinBlockWait();

Check whether the next deposit can be processed:

const canProcess =
  await deposit.canProcessNext();

Response:

true

Recommended deposit flow

1. Create DepositClient.

2. Verify the RPC network and chain ID.

3. Read the settlement-token and deposit-ledger addresses.

4. Parse the human deposit amount.

5. Check the wallet’s settlement-token balance.

6. Check the required token allowance.

7. Approve the deposit ledger or Permit2 if necessary.

8. Submit deposit or depositWithPermit.

9. Record the transaction hash or deposit ID returned by the SDK.

10. Monitor pending and processed deposit state.

Error handling

Deposit operations can fail because of:

• RPC connection failures

• Incorrect chain ID

• Insufficient token balance

• Insufficient allowance

• Invalid amount precision

• Wallet signature rejection

• Contract reverts

• Permit expiration or invalid permit data

Handle transaction failures through the error objects returned by the configured EVM provider and wallet.