Interface BuildLpRemoveTransactionRequest

Request parameters for buildLpRemoveTransaction operation in DefiTransactionApi. BuildLpRemoveTransactionRequest

interface BuildLpRemoveTransactionRequest {
    address: string;
    investmentId: string;
    nftId: string;
    nonce?: string;
    ratio: string;
    recvWindow?: number | bigint;
    simulate?: boolean;
    slippageBps?: string;
}

Index

Properties

address investmentId nftId nonce? ratio recvWindow? simulate? slippageBps?

Properties

`Readonly`address

address: string

User wallet address (the signer / sender).

Memberof

DefiTransactionApiBuildLpRemoveTransaction

`Readonly`investmentId

investmentId: string

LP investment product ID (chain-agnostic).

Memberof

DefiTransactionApiBuildLpRemoveTransaction

`Readonly`nftId

nftId: string

LP NFT token ID identifying the position to remove, decimal string (e.g. \"7225901\" or \"#7225901\"). The # prefix returned by the position list may be passed as-is — the service strips it automatically.

Memberof

DefiTransactionApiBuildLpRemoveTransaction

`Optional` `Readonly`nonce

nonce?: string

Unique request identifier for anti-replay; falls back to X-OC-SIGN if omitted.

Memberof

DefiTransactionApiBuildLpRemoveTransaction

`Readonly`ratio

ratio: string

Removal ratio in the range (0, 1] as a decimal string (e.g. \"0.04\", \"1\").

Memberof

DefiTransactionApiBuildLpRemoveTransaction

`Optional` `Readonly`recvWindow

recvWindow?: number | bigint

Allowed time deviation in milliseconds (default: 5000, max: 60000).

Memberof

DefiTransactionApiBuildLpRemoveTransaction

`Optional` `Readonly`simulate

simulate?: boolean

When true, the response also includes a preview object. Default false. If the simulated transaction reverts, the request returns 40485 for a specific classified revert reason or 40484 for any other revert (see Error Codes).

Memberof

DefiTransactionApiBuildLpRemoveTransaction

`Optional` `Readonly`slippageBps

slippageBps?: string

Slippage tolerance for the LP leg, in basis points (e.g. 300 = 3%).

Memberof

DefiTransactionApiBuildLpRemoveTransaction