From 00fbcda33e76f9a6f36b91d4255fdd2787ae635b Mon Sep 17 00:00:00 2001 From: Joey <5688912+bachstatter@users.noreply.github.com> Date: Fri, 7 Jul 2023 13:06:02 +1000 Subject: [PATCH] Remove duplicated getOrder (#1707) * Remove duplicated getOrder * fix lint * fix doc naming --------- Co-authored-by: Leonardo Massazza --- .../contracts/interfaces/IAccountModule.sol | 11 ------- .../interfaces/IAsyncOrderModule.sol | 6 ++-- .../contracts/modules/PerpsAccountModule.sol | 14 -------- .../Orders/OffchainAsyncOrder.commit.test.ts | 32 +++++++++---------- 4 files changed, 19 insertions(+), 44 deletions(-) diff --git a/markets/perps-market/contracts/interfaces/IAccountModule.sol b/markets/perps-market/contracts/interfaces/IAccountModule.sol index 2c141e738d..c34a6edc87 100644 --- a/markets/perps-market/contracts/interfaces/IAccountModule.sol +++ b/markets/perps-market/contracts/interfaces/IAccountModule.sol @@ -72,17 +72,6 @@ interface IAccountModule { uint128 marketId ) external view returns (int pnl, int accruedFunding, int size); - /** - * @notice Get async order claim details - * @param accountId id of the account. - * @param marketId Id of the market used for the trade. - * @return asyncOrderClaim claim details (see AsyncOrder.Data struct). - */ - function getAsyncOrderClaim( - uint128 accountId, - uint128 marketId - ) external view returns (AsyncOrder.Data memory); - /** * @notice Gets the available margin of an account. It can be negative due to pnl. * @param accountId Id of the account. diff --git a/markets/perps-market/contracts/interfaces/IAsyncOrderModule.sol b/markets/perps-market/contracts/interfaces/IAsyncOrderModule.sol index c176a85573..a3478f0d8f 100644 --- a/markets/perps-market/contracts/interfaces/IAsyncOrderModule.sol +++ b/markets/perps-market/contracts/interfaces/IAsyncOrderModule.sol @@ -70,10 +70,10 @@ interface IAsyncOrderModule { function cancelOrder(uint128 marketId, uint128 accountId) external; /** - * @notice Get an order details via this function + * @notice Get async order claim details + * @param accountId id of the account. * @param marketId Id of the market used for the trade. - * @param accountId Id of the account used for the trade. - * @return order order details (see AsyncOrder.Data struct). + * @return order async order claim details (see AsyncOrder.Data struct). */ function getOrder( uint128 marketId, diff --git a/markets/perps-market/contracts/modules/PerpsAccountModule.sol b/markets/perps-market/contracts/modules/PerpsAccountModule.sol index 452297fe9d..2f04d7e763 100644 --- a/markets/perps-market/contracts/modules/PerpsAccountModule.sol +++ b/markets/perps-market/contracts/modules/PerpsAccountModule.sol @@ -106,20 +106,6 @@ contract PerpsAccountModule is IAccountModule { return (pnl, accruedFunding, position.size); } - /** - * @inheritdoc IAccountModule - */ - function getAsyncOrderClaim( - uint128 accountId, - uint128 marketId - ) external view override returns (AsyncOrder.Data memory) { - PerpsMarket.Data storage perpsMarket = PerpsMarket.loadValid(marketId); - - AsyncOrder.Data storage asyncOrder = perpsMarket.asyncOrders[accountId]; - - return asyncOrder; - } - /** * @inheritdoc IAccountModule */ diff --git a/markets/perps-market/test/integration/Orders/OffchainAsyncOrder.commit.test.ts b/markets/perps-market/test/integration/Orders/OffchainAsyncOrder.commit.test.ts index 0f579da9ef..0228219f71 100644 --- a/markets/perps-market/test/integration/Orders/OffchainAsyncOrder.commit.test.ts +++ b/markets/perps-market/test/integration/Orders/OffchainAsyncOrder.commit.test.ts @@ -196,14 +196,14 @@ describe('Commit Offchain Async Order test', () => { }); it('identifies the pending order', async () => { - const ayncOrderClaim = await systems().PerpsMarket.getAsyncOrderClaim(2, ethMarketId); - assertBn.equal(ayncOrderClaim.accountId, 2); - assertBn.equal(ayncOrderClaim.marketId, ethMarketId); - assertBn.equal(ayncOrderClaim.sizeDelta, bn(1)); - assertBn.equal(ayncOrderClaim.settlementStrategyId, 0); - assertBn.equal(ayncOrderClaim.settlementTime, startTime + 5); - assertBn.equal(ayncOrderClaim.acceptablePrice, bn(1050)); - assert.equal(ayncOrderClaim.trackingCode, ethers.constants.HashZero); + const order = await systems().PerpsMarket.getOrder(ethMarketId, 2); + assertBn.equal(order.accountId, 2); + assertBn.equal(order.marketId, ethMarketId); + assertBn.equal(order.sizeDelta, bn(1)); + assertBn.equal(order.settlementStrategyId, 0); + assertBn.equal(order.settlementTime, startTime + 5); + assertBn.equal(order.acceptablePrice, bn(1050)); + assert.equal(order.trackingCode, ethers.constants.HashZero); }); it('reverts if attempt to commit another order for same account and market', async () => { @@ -272,14 +272,14 @@ describe('Commit Offchain Async Order test', () => { }); it('identifies the pending order', async () => { - const ayncOrderClaim = await systems().PerpsMarket.getAsyncOrderClaim(2, ethMarketId); - assertBn.equal(ayncOrderClaim.accountId, 2); - assertBn.equal(ayncOrderClaim.marketId, ethMarketId); - assertBn.equal(ayncOrderClaim.sizeDelta, bn(1)); - assertBn.equal(ayncOrderClaim.settlementStrategyId, 0); - assertBn.equal(ayncOrderClaim.settlementTime, startTime + 5); - assertBn.equal(ayncOrderClaim.acceptablePrice, bn(1050)); - assert.equal(ayncOrderClaim.trackingCode, ethers.constants.HashZero); + const order = await systems().PerpsMarket.getOrder(ethMarketId, 2); + assertBn.equal(order.accountId, 2); + assertBn.equal(order.marketId, ethMarketId); + assertBn.equal(order.sizeDelta, bn(1)); + assertBn.equal(order.settlementStrategyId, 0); + assertBn.equal(order.settlementTime, startTime + 5); + assertBn.equal(order.acceptablePrice, bn(1050)); + assert.equal(order.trackingCode, ethers.constants.HashZero); }); }); });