Skip to content

Add batch size limits information to API reference #91

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
signature18632 merged 1 commit into from
Dec 12, 2025
Merged

Add batch size limits information to API reference #91

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 20 additions & 1 deletion developers-hub/intmax-client-sdk/api-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -511,9 +511,28 @@ const claim = await client.claimWithdrawal(withdrawals.need_claim);
## Technical Terms

- **Nullifier**: A unique identifier used to prevent the same deposit/withdrawal from being used more than once.
- **Salt**: A random value added during encryption or hashing to ensure different outputs from identical inputs. Used to conceal the recipient’s deposit address.
- **Salt**: A random value added during encryption or hashing to ensure different outputs from identical inputs. Used to conceal the recipient's deposit address.
- **Token index**: A numerical ID uniquely identifying tokens within the INTMAX network.

## Batch Size Limits

The INTMAX Client SDK enforces batch size limits for certain operations to ensure optimal performance and prevent resource exhaustion:

### Transaction Broadcasting

- **Maximum transactions per `broadcastTransaction` call**: 63 transactions
- This limit applies when batching multiple transfers in a single transaction broadcast

### Data Fetching Operations

- **Maximum items per internal API request**: 64 items
- This limit applies to internal pagination used by:
- `fetchDeposits()`
- `fetchTransfers()`
- `fetchTransactions()`
- The SDK automatically handles pagination, so you don't need to manage this limit when using high-level APIs
- Specifying a value greater than 64 will result in an error: `Limit exceeds max batch size` or `Batch size exceeds maximum limit of 64`

## Fee

Please refer to the following for details about the fees.
Expand Down
11 changes: 10 additions & 1 deletion developers-hub/intmax-client-sdk/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,9 +146,18 @@ IntMaxClient.init({ environment: "testnet" });

The INTMAX privacy model ensures that **only the wallet owner with the private key can view their balance and transaction history**.

- Unlike public blockchains, third parties cannot directly check an address’s balance or history.
- Unlike public blockchains, third parties cannot directly check an address's balance or history.
- Transfer data uses `salt` and `nullifier` values to hide recipient addresses and prevent linking transactions to each other.

### Batch Size Limits

The SDK enforces batch size limits for optimal performance:

- **Transaction broadcasting**: Maximum 63 transactions per `broadcastTransaction` call
- **Data fetching**: Maximum 64 items per internal API request. The SDK automatically handles pagination for high-level APIs like `fetchDeposits()`, `fetchTransfers()`, and `fetchTransactions()`.

For more details, see the [API Reference](./api-reference.md#batch-size-limits).

## Tips

### How to Run a Local Balance Prover
Expand Down