Skip to content

Logs for commit order #2237

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

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Logs for commit order #2237

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f0d8f64
logs for commit order
0xjocke Aug 27, 2024
1bc810c
more logs
0xjocke Aug 27, 2024
f2a7ec5
less logs
0xjocke Aug 27, 2024
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
8 changes: 6 additions & 2 deletions markets/bfp-market/contracts/modules/OrderModule.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import {ErrorUtil} from "../utils/ErrorUtil.sol";
import {MathUtil} from "../utils/MathUtil.sol";
import {PythUtil} from "../utils/PythUtil.sol";
import {Flags} from "../utils/Flags.sol";
import "hardhat/console.sol";

contract OrderModule is IOrderModule {
using DecimalMath for int256;
Expand Down Expand Up @@ -252,7 +253,8 @@ contract OrderModule is IOrderModule {
limitPrice,
keeperFeeBufferUsd
);

console.log("tradeParams fillPrice", tradeParams.fillPrice);
console.log("validateTrade");
// Validates whether this order would lead to a valid 'next' next position (plethora of revert errors).
//
// NOTE: `fee` here does _not_ matter. We recompute the actual order fee on settlement. The same is true for
Expand All @@ -267,10 +269,12 @@ contract OrderModule is IOrderModule {
);

runtime.commitmentTime = block.timestamp.to64();
console.log("commitmentTime:", runtime.commitmentTime);
console.log("update order");
market.orders[accountId].update(
Order.Data(sizeDelta, runtime.commitmentTime, limitPrice, keeperFeeBufferUsd, hooks)
);

console.log("update order done");
emit OrderCommitted(
accountId,
marketId,
Expand Down
9 changes: 9 additions & 0 deletions markets/bfp-market/contracts/storage/PerpMarket.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import {Position} from "./Position.sol";
import {MathUtil} from "../utils/MathUtil.sol";
import {ErrorUtil} from "../utils/ErrorUtil.sol";
import {Margin} from "../storage/Margin.sol";
import "hardhat/console.sol";

library PerpMarket {
using DecimalMath for int128;
Expand Down Expand Up @@ -323,6 +324,9 @@ library PerpMarket {
AddressRegistry.Data memory addresses
) internal view returns (uint256) {
PerpMarketConfiguration.Data storage marketConfig = PerpMarketConfiguration.load(self.id);
console.log("getOraclePrice from oracleNodeId:");
console.logBytes32(marketConfig.oracleNodeId);
console.log(addresses.oracleManager);
return
INodeModule(addresses.oracleManager).process(marketConfig.oracleNodeId).price.toUint();
}
Expand Down Expand Up @@ -359,6 +363,11 @@ library PerpMarket {
function getProportionalUtilizationElapsed(
PerpMarket.Data storage self
) internal view returns (uint128) {
console.log("getProportionalUtilizationElapsed block.timestamp", block.timestamp);
console.log(
"getProportionalUtilizationElapsed self.lastUtilizationTime",
self.lastUtilizationTime
);
return
(block.timestamp - self.lastUtilizationTime).divDecimal(AVG_SECONDS_PER_YEAR).to128();
}
Expand Down
69 changes: 65 additions & 4 deletions markets/bfp-market/contracts/storage/Position.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import {Margin} from "./Margin.sol";
import {AddressRegistry} from "./AddressRegistry.sol";
import {MathUtil} from "../utils/MathUtil.sol";
import {ErrorUtil} from "../utils/ErrorUtil.sol";
import "hardhat/console.sol";

library Position {
using DecimalMath for int128;
Expand Down Expand Up @@ -101,19 +102,25 @@ library Position {
int256 newSize
) internal view {
// Allow users to reduce an order no matter the market conditions.

if (
MathUtil.sameSide(currentSize, newSize) &&
MathUtil.abs(newSize) <= MathUtil.abs(currentSize)
) {
console.log("validateMaxOi newSize <= currentSize");
return;
}

// Either the user is flipping sides, or they are increasing an order on the same side they're already on;
// we check that the side of the market their order is on would not break the limit.
int256 newSkew = market.skew - currentSize + newSize;
console.log("validateMaxOi newSkew:");
console.logInt(newSkew);

int256 newMarketSize = (market.size - MathUtil.abs(currentSize) + MathUtil.abs(newSize))
.toInt();

console.log("validateMaxOi newMarketSize:");
console.logInt(newMarketSize);
int256 newSideSize;
if (0 < newSize) {
// long case: marketSize + skew
Expand Down Expand Up @@ -147,8 +154,11 @@ library Position {
sizeDelta,
addresses
);
console.log("validateMinimumCredit validateMinimumCredit", minimumCredit);

int256 delegatedCollateralValueUsd = market.getDelegatedCollateralValueUsd(addresses);
console.log("delegatedCollateralValueUsd:");
console.logInt(delegatedCollateralValueUsd);

if (
delegatedCollateralValueUsd + market.depositedCollateral[addresses.sUsd].toInt() <
Expand Down Expand Up @@ -190,21 +200,37 @@ library Position {
Runtime_validateTrade memory runtime;

// --- Existing position validation --- //

console.log("validateTrade Margin.getMarginUsd");
Margin.MarginValues memory marginValuesForLiqValidation = Margin.getMarginUsd(
accountId,
market,
params.oraclePrice,
addresses
);
console.log(
"marginValuesForLiqValidation.marginUsd",
marginValuesForLiqValidation.marginUsd
);
console.log(
"marginValuesForLiqValidation.discountedMarginUsd",
marginValuesForLiqValidation.discountedMarginUsd
);
console.log(
"marginValuesForLiqValidation.collateralUsd",
marginValuesForLiqValidation.collateralUsd
);
console.log(
"marginValuesForLiqValidation.discountedCollateralUsd",
marginValuesForLiqValidation.discountedCollateralUsd
);

// There's an existing position. Make sure we have a valid existing position before allowing modification.
if (currentPosition.size != 0) {
// Position is frozen due to prior flagged for liquidation.
if (market.flaggedLiquidations[accountId] != address(0)) {
revert ErrorUtil.PositionFlagged();
}

console.log("existing position exists check if liquidatable");
// Determine if the current (previous) position can be immediately liquidated.
if (
isLiquidatable(
Expand All @@ -217,9 +243,11 @@ library Position {
) {
revert ErrorUtil.CanLiquidatePosition();
}
console.log("existing position is not liquidatable");
}

// --- New position validation (as though the order settled) --- //
console.log("getOrderFees");

// Derive fees incurred and next position if this order were to be settled successfully.
runtime.orderFee = Order.getOrderFee(
Expand All @@ -229,14 +257,20 @@ library Position {
params.makerFee,
params.takerFee
);
console.log("orderFee", runtime.orderFee);
console.log("getEthPrice");
runtime.ethPrice = INodeModule(addresses.oracleManager)
.process(PerpMarketConfiguration.load().ethOracleNodeId)
.price
.toUint();
console.log("ethPrice", runtime.ethPrice);
console.log("getSettlementKeeperFee");
runtime.keeperFee = Order.getSettlementKeeperFee(
params.keeperFeeBufferUsd,
runtime.ethPrice
);
console.log("keeperFee", runtime.keeperFee);

Position.Data memory newPosition = Position.Data(
currentPosition.size + params.sizeDelta,
market.currentFundingAccruedComputed,
Expand All @@ -245,23 +279,35 @@ library Position {
params.pythPrice,
params.fillPrice
);
console.log("newPositon.size:");
console.logInt(newPosition.size);
console.log("newPositon.entryFundingAccrued:");
console.logInt(newPosition.entryFundingAccrued);
console.log("newPositon.entryUtilizationAccrued", newPosition.entryUtilizationAccrued);
console.log("newPositon.entryPythPrice", newPosition.entryPythPrice);
console.log("newPositon.entryPrice", newPosition.entryPrice);

// Minimum position margin checks. If a position is decreasing (i.e. derisking by lowering size), we
// avoid this completely due to positions at min margin would never be allowed to lower size.
runtime.positionDecreasing =
MathUtil.sameSide(currentPosition.size, newPosition.size) &&
MathUtil.abs(newPosition.size) < MathUtil.abs(currentPosition.size);

console.log("runtime.positionDecreasing", runtime.positionDecreasing);
console.log("getLiquidationMarginUsd");
(runtime.im, runtime.mm) = getLiquidationMarginUsd(
newPosition.size,
params.oraclePrice,
marginValuesForLiqValidation.collateralUsd,
marketConfig,
addresses
);
console.log("im", runtime.im);
console.log("mm", runtime.mm);

// Compute the net size difference as the fillPremium is only applied on the change in size and not total.
runtime.sizeDelta = newPosition.size - currentPosition.size;
console.log("sizeDelta:");
console.logInt(runtime.sizeDelta);
// Delta between oracle and fillPrice (pos.entryPrice) may be large if settled on a very skewed market (i.e
// a high premium paid). This can lead to instant liquidation on the settle so we deduct that difference from
// the margin before verifying the health factor to account for the premium.
Expand All @@ -274,6 +320,8 @@ library Position {
),
0
);
console.log("fillPremium:");
console.logInt(runtime.fillPremium);

// We need discounted margin collateral as we're verifying for liquidation here.
//
Expand All @@ -290,7 +338,14 @@ library Position {
0
)
.toUint();
console.log("discountedNextMarginUsd", runtime.discountedNextMarginUsd);
if (runtime.positionDecreasing) {
if (newPosition.size > 0) {
console.log(
"runtime.discountedNextMarginUsd.divDecimal(runtime.mm)",
runtime.discountedNextMarginUsd.divDecimal(runtime.mm)
);
}
// In some cases a postion can be liquidatable due to fees, even if position is decreasing. This cant happen if the user closes the position completly.
if (
newPosition.size > 0 &&
Expand All @@ -299,6 +354,7 @@ library Position {
revert ErrorUtil.CanLiquidatePosition();
}
} else {
console.log("validateMinimumCredit");
// Check the minimum credit requirements are still met.
validateMinimumCredit(
market,
Expand All @@ -313,6 +369,7 @@ library Position {
revert ErrorUtil.InsufficientMargin();
}

console.log("validateMaxOi");
// Check the new position hasn't hit max OI on either side.
validateMaxOi(
market,
Expand All @@ -325,11 +382,15 @@ library Position {
// Create and return a validated trade struct for downstream processing.
int256 marginUsdForNextMarginUsd = marginValuesForLiqValidation.collateralUsd.toInt() +
Margin.getPnlAdjustmentUsd(accountId, market, params.oraclePrice, params.fillPrice);
console.log("marginUsdForNextMarginUsd");
console.logInt(marginUsdForNextMarginUsd);
uint256 newMarginUsd = getNextMarginUsd(
MathUtil.max(marginUsdForNextMarginUsd, 0).toUint(),
runtime.orderFee,
runtime.keeperFee
);
console.log("newMarginUsd", newMarginUsd);
console.log("end validateTrade");
return
Position.ValidatedTrade(
newPosition,
Expand Down
2 changes: 1 addition & 1 deletion markets/bfp-market/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@synthetixio/bfp-market",
"version": "3.6.0",
"version": "3.6.1-dev.7d60444d",
"description": "L1 perp market implementation",
"scripts": {
"build": "yarn build:contracts",
Expand Down