Deposit Methods

DepositClient communicates directly with on-chain contracts through the configured RPC URL.

Use it to read deposit state, inspect token balances and allowances, submit approvals, sign permits, and deposit settlement tokens.

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 verifies that the RPC network matches the configured chainId before performing contract reads or transactions.

On-chain integers are returned as TypeScript bigint values rather than JSON numbers.

`getSettlementToken`

Returns the settlement-token contract address.

const settlementToken =
  await deposit.getSettlementToken();

SDK response:

"0x1111111111111111111111111111111111111111"

`getPermit2`

Returns the Permit2 contract address used by the deposit system.

const permit2 = await deposit.getPermit2();

SDK response:

"0x2222222222222222222222222222222222222222"

`getAccountLedger`

Returns the account-ledger contract address.

const accountLedger =
  await deposit.getAccountLedger();

SDK response:

"0x3333333333333333333333333333333333333333"

`getPendingBalance`

Returns the connected account’s pending deposit balance.

const pendingBalance =
  await deposit.getPendingBalance();

SDK response:

100250000n

With six settlement-token decimals, this represents 100.25 tokens.

`getProcessedBalance`

Returns the connected account’s processed deposit balance.

const processedBalance =
  await deposit.getProcessedBalance();

SDK response:

50000000n

With six settlement-token decimals, this represents 50 tokens.

`getPendingDepositCount`

Returns the number of pending deposits.

const pendingCount =
  await deposit.getPendingDepositCount();

SDK response:

3n

`getNextPendingDepositId`

Returns the next pending deposit ID.

const nextDepositId =
  await deposit.getNextPendingDepositId();

SDK response:

42n

`getProcessedDepositIndex`

Returns the processed-deposit index.

const processedIndex =
  await deposit.getProcessedDepositIndex();

SDK response:

38n

`getMinBlockWait`

Returns the minimum number of blocks that must pass before the next deposit can be processed.

const minBlockWait =
  await deposit.getMinBlockWait();

SDK response:

5n

`canProcessNext`

Checks whether the next pending deposit can be processed.

const canProcess =
  await deposit.canProcessNext();

SDK response:

true

If processing requirements have not been met:

false

`getSettlementTokenBalance`

Returns a settlement-token balance.

When no owner is supplied, the configured wallet address is used.

const balance =
  await deposit.getSettlementTokenBalance();

SDK response:

250000000n

With six settlement-token decimals, this represents 250 tokens.

An owner address can also be supplied:

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

SDK response:

100250000n

`getSettlementTokenAllowance`

Returns the settlement-token allowance for a spender.

const allowance =
  await deposit.getSettlementTokenAllowance();

SDK response:

1000000000n

Optional spender and owner addresses can be supplied:

const allowance =
  await deposit.getSettlementTokenAllowance(
    "0x2222222222222222222222222222222222222222",
    "0x4444444444444444444444444444444444444444",
  );

SDK response:

500000000n

`approveDepositLedger`

Approves the deposit ledger to spend settlement tokens.

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

This method submits an on-chain transaction.

The supplied SDK documentation does not publish its complete input fields or return type. The exact response object should be copied from the SDK’s exported TypeScript definition before publishing a response example.

`approvePermit2`

Approves Permit2 to spend settlement tokens.

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

This method submits an on-chain transaction.

`deposit`

Submits an on-chain deposit transaction.

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

The method logs the deposit transaction ID by default.

To suppress the log:

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

The SDK confirms that the method submits the transaction and logs the deposit txId by default.

`signDepositPermit`

Creates a signed Permit2 deposit authorization without submitting an on-chain transaction.

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

`depositWithPermit`

Submits an on-chain deposit using a signed Permit2 authorization.

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

`parseAmount`

Converts a human decimal amount into settlement-token base units.

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

SDK response:

100250000n

The settlement token uses six decimals.

Additional examples:

deposit.parseAmount("1");

Response:

1000000n

deposit.parseAmount("0.01");

Response:

10000n

Invalid precision, zero amounts, negative values, and out-of-range values are rejected before a transaction is submitted.

Available methods

Method

Operation

getSettlementToken

Read settlement-token address

getPermit2

Read Permit2 address

getAccountLedger

Read account-ledger address

getPendingBalance

Read pending deposit balance

getProcessedBalance

Read processed deposit balance

getPendingDepositCount

Read pending-deposit count

getNextPendingDepositId