Skip to content

API ReferenceLOC lifecycleType Alias

ModifyLOCCollateralParams

type ModifyLOCCollateralParams = object;

Properties

byAmount

byAmount: bigint;

The signed amount by which the collateral should be modified (add if positive, remove if negative).


collateralizableAllowanceSignature?

optional collateralizableAllowanceSignature?: Bytes;

The signature to allow this collateralizable to reserve the specified additional amount of the calling account’s collateral within the ICollateral contract.


creator?

optional creator?: Address;

The LOC’s creator. This will be populated by the configured signer’s address if empty.


locId

locId: bigint;

The ID of the LOC for which collateral should be modified.


oraclePriceUpdate?

optional oraclePriceUpdate?: OraclePriceUpdateSource;

The oracle source to use when removing collateral. Supply an update to forward its bytes and fee, 'auto' to resolve one when the final transaction is built, or null/omit the field to use the current on-chain price without a network request or transaction value.