Pledge In Position

The pledgeInPosition function allows users to add more collateral to an existing position.

Function Signature

pledgeInPosition(
  pcpId: string,
  collateralToken: string,
  indexToken: string,
  amount: number,
  coinObjects: string[],
  long: boolean
): Promise<TransactionBlock>

Parameters

  • pcpId: The ID of the position to pledge into

  • collateralToken: The token used as collateral (e.g., "USDC")

  • indexToken: The token used as the market index (e.g., "BTC")

  • amount: The amount of collateral to add

  • coinObjects: Array of coin object IDs to use for the transaction

  • long: Boolean indicating if this is a long (true) or short (false) position

Return Value

Returns a Promise that resolves to a TransactionBlock object.

Usage Example

const tx = await sudoAPI.pledgeInPosition(
  '0x123...', // pcpId
  'USDC',     // collateralToken
  'BTC',      // indexToken
  1000000,    // amount (1 USDC if USDC has 6 decimals)
  ['0x456...', '0x789...'], // coinObjects
  true        // long position
);

Last updated