Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.ostium.com/llms.txt

Use this file to discover all available pages before exploring further.

const allowance = await client.checkUsdcAllowance('100');

Returns

  • current
  • required
  • sufficient

Use when

  • validating a trade before openTrade()
  • validating a top-up before updateCollateral()
This helper uses the connected trader address and is not for read-only clients.

Response schema

interface Response {
  current: bigint;
  required: bigint;
  sufficient: boolean;
}