@d8x/perpetuals-sdk 0.8.17 → 0.8.18

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -762,6 +762,19 @@
762
762
  "name": "SettleState",
763
763
  "type": "event"
764
764
  },
765
+ {
766
+ "anonymous": false,
767
+ "inputs": [
768
+ {
769
+ "indexed": true,
770
+ "internalType": "uint24",
771
+ "name": "perpetualId",
772
+ "type": "uint24"
773
+ }
774
+ ],
775
+ "name": "SettlementComplete",
776
+ "type": "event"
777
+ },
765
778
  {
766
779
  "anonymous": false,
767
780
  "inputs": [
@@ -3975,6 +3988,35 @@
3975
3988
  "stateMutability": "view",
3976
3989
  "type": "function"
3977
3990
  },
3991
+ {
3992
+ "inputs": [
3993
+ {
3994
+ "internalType": "uint24",
3995
+ "name": "_perpetualId",
3996
+ "type": "uint24"
3997
+ },
3998
+ {
3999
+ "internalType": "uint256",
4000
+ "name": "start",
4001
+ "type": "uint256"
4002
+ },
4003
+ {
4004
+ "internalType": "uint256",
4005
+ "name": "count",
4006
+ "type": "uint256"
4007
+ }
4008
+ ],
4009
+ "name": "getSettleableAccounts",
4010
+ "outputs": [
4011
+ {
4012
+ "internalType": "address[]",
4013
+ "name": "",
4014
+ "type": "address[]"
4015
+ }
4016
+ ],
4017
+ "stateMutability": "view",
4018
+ "type": "function"
4019
+ },
3978
4020
  {
3979
4021
  "inputs": [],
3980
4022
  "name": "getShareTokenFactory",
@@ -475,6 +475,7 @@ export interface IPerpetualManagerInterface extends utils.Interface {
475
475
  "getPoolIdByPerpetualId(uint24)": FunctionFragment;
476
476
  "getPoolStaticInfo(uint8,uint8)": FunctionFragment;
477
477
  "getPriceInfo(uint24)": FunctionFragment;
478
+ "getSettleableAccounts(uint24,uint256,uint256)": FunctionFragment;
478
479
  "getShareTokenFactory()": FunctionFragment;
479
480
  "getShareTokenPriceD18(uint8)": FunctionFragment;
480
481
  "getTargetCollateralM1(int128,int128,(int128,int128,int128,int128,int128),int128)": FunctionFragment;
@@ -548,7 +549,7 @@ export interface IPerpetualManagerInterface extends utils.Interface {
548
549
  "withdrawFromDefaultFund(uint8,int128)": FunctionFragment;
549
550
  "withdrawLiquidity(uint8,uint256)": FunctionFragment;
550
551
  };
551
- getFunction(nameOrSignatureOrTopic: "activatePerpetual" | "addLiquidity" | "adjustSettlementPrice" | "calculateBoundedSlippage" | "calculateDefaultFundSize" | "calculatePerpetualPrice" | "calculateRiskNeutralPD" | "chargePostingFee" | "countActivePerpAccounts" | "createLiquidityPool" | "createPerpetual" | "decreasePoolCash" | "deposit" | "depositBrokerLots" | "depositMarginForOpeningTrade" | "depositToDefaultFund" | "determineExchangeFee" | "distributeFees" | "distributeFeesLiquidation" | "executeCancelOrder" | "executeLiquidityWithdrawal" | "executeTrade" | "getAMMPerpLogic" | "getAMMState" | "getActivePerpAccounts" | "getActivePerpAccountsByChunks" | "getBrokerDesignation" | "getBrokerInducedFee" | "getCollateralTokenAmountForPricing" | "getCurrentBrokerVolume" | "getCurrentTraderVolume" | "getDepositAmountForLvgPosition" | "getFeeForBrokerDesignation" | "getFeeForBrokerStake" | "getFeeForBrokerVolume" | "getFeeForTraderStake" | "getFeeForTraderVolume" | "getLastPerpetualBaseToUSDConversion" | "getLiquidatableAccounts" | "getLiquidityPool" | "getLiquidityPools" | "getMarginAccount" | "getMaxSignedOpenTradeSizeForPos" | "getNextLiquidatableTrader" | "getOracleFactory" | "getOraclePrice" | "getOrderBookAddress" | "getOrderBookFactoryAddress" | "getPerpetual" | "getPerpetualCountInPool" | "getPerpetualId" | "getPerpetualStaticInfo" | "getPerpetuals" | "getPoolCount" | "getPoolIdByPerpetualId" | "getPoolStaticInfo" | "getPriceInfo" | "getShareTokenFactory" | "getShareTokenPriceD18" | "getTargetCollateralM1" | "getTargetCollateralM2" | "getTargetCollateralM3" | "getTokenAmountToReturn" | "getTraderState" | "getTreasuryAddress" | "getWithdrawRequests" | "holdingPeriodPenalty" | "increasePoolCash" | "isActiveAccount" | "isMarketClosed" | "isOrderCanceled" | "isOrderExecuted" | "isPerpMarketClosed" | "isTraderMaintenanceMarginSafe" | "liquidateByAMM" | "pauseLiquidityProvision" | "preTrade" | "queryExchangeFee" | "queryMidPrices" | "queryPerpetualPrice" | "rebalance" | "rebatePostingFee" | "reduceMarginCollateral" | "runLiquidityPool" | "setAMMPerpLogic" | "setBlockDelay" | "setBrokerTiers" | "setBrokerVolumeTiers" | "setEmergencyState" | "setFeesForDesignation" | "setInitialVolumeForFee" | "setNormalState" | "setOracleFactory" | "setOracleFactoryForPerpetual" | "setOrderBookFactory" | "setPerpetualBaseParams" | "setPerpetualOracles" | "setPerpetualParam" | "setPerpetualParamPair" | "setPerpetualPoolFactory" | "setPerpetualRiskParams" | "setPoolParam" | "setTraderTiers" | "setTraderVolumeTiers" | "setTreasury" | "setUtilityTokenAddr" | "settle" | "settleNextTraderInPool" | "splitProtocolFee" | "togglePerpEmergencyState" | "tradeViaOrderBook" | "transferBrokerLots" | "transferBrokerOwnership" | "transferEarningsToTreasury" | "transferValueToTreasury" | "updateAMMTargetFundSize" | "updateDefaultFundTargetSize" | "updateDefaultFundTargetSizeRandom" | "updateFundingAndPricesAfter" | "updateFundingAndPricesBefore" | "updatePriceFeeds" | "updateVolumeEMAOnNewTrade" | "validateStopPrice" | "volatilitySpread" | "withdraw" | "withdrawAll" | "withdrawDepositFromMarginAccount" | "withdrawFromDefaultFund" | "withdrawLiquidity"): FunctionFragment;
552
+ getFunction(nameOrSignatureOrTopic: "activatePerpetual" | "addLiquidity" | "adjustSettlementPrice" | "calculateBoundedSlippage" | "calculateDefaultFundSize" | "calculatePerpetualPrice" | "calculateRiskNeutralPD" | "chargePostingFee" | "countActivePerpAccounts" | "createLiquidityPool" | "createPerpetual" | "decreasePoolCash" | "deposit" | "depositBrokerLots" | "depositMarginForOpeningTrade" | "depositToDefaultFund" | "determineExchangeFee" | "distributeFees" | "distributeFeesLiquidation" | "executeCancelOrder" | "executeLiquidityWithdrawal" | "executeTrade" | "getAMMPerpLogic" | "getAMMState" | "getActivePerpAccounts" | "getActivePerpAccountsByChunks" | "getBrokerDesignation" | "getBrokerInducedFee" | "getCollateralTokenAmountForPricing" | "getCurrentBrokerVolume" | "getCurrentTraderVolume" | "getDepositAmountForLvgPosition" | "getFeeForBrokerDesignation" | "getFeeForBrokerStake" | "getFeeForBrokerVolume" | "getFeeForTraderStake" | "getFeeForTraderVolume" | "getLastPerpetualBaseToUSDConversion" | "getLiquidatableAccounts" | "getLiquidityPool" | "getLiquidityPools" | "getMarginAccount" | "getMaxSignedOpenTradeSizeForPos" | "getNextLiquidatableTrader" | "getOracleFactory" | "getOraclePrice" | "getOrderBookAddress" | "getOrderBookFactoryAddress" | "getPerpetual" | "getPerpetualCountInPool" | "getPerpetualId" | "getPerpetualStaticInfo" | "getPerpetuals" | "getPoolCount" | "getPoolIdByPerpetualId" | "getPoolStaticInfo" | "getPriceInfo" | "getSettleableAccounts" | "getShareTokenFactory" | "getShareTokenPriceD18" | "getTargetCollateralM1" | "getTargetCollateralM2" | "getTargetCollateralM3" | "getTokenAmountToReturn" | "getTraderState" | "getTreasuryAddress" | "getWithdrawRequests" | "holdingPeriodPenalty" | "increasePoolCash" | "isActiveAccount" | "isMarketClosed" | "isOrderCanceled" | "isOrderExecuted" | "isPerpMarketClosed" | "isTraderMaintenanceMarginSafe" | "liquidateByAMM" | "pauseLiquidityProvision" | "preTrade" | "queryExchangeFee" | "queryMidPrices" | "queryPerpetualPrice" | "rebalance" | "rebatePostingFee" | "reduceMarginCollateral" | "runLiquidityPool" | "setAMMPerpLogic" | "setBlockDelay" | "setBrokerTiers" | "setBrokerVolumeTiers" | "setEmergencyState" | "setFeesForDesignation" | "setInitialVolumeForFee" | "setNormalState" | "setOracleFactory" | "setOracleFactoryForPerpetual" | "setOrderBookFactory" | "setPerpetualBaseParams" | "setPerpetualOracles" | "setPerpetualParam" | "setPerpetualParamPair" | "setPerpetualPoolFactory" | "setPerpetualRiskParams" | "setPoolParam" | "setTraderTiers" | "setTraderVolumeTiers" | "setTreasury" | "setUtilityTokenAddr" | "settle" | "settleNextTraderInPool" | "splitProtocolFee" | "togglePerpEmergencyState" | "tradeViaOrderBook" | "transferBrokerLots" | "transferBrokerOwnership" | "transferEarningsToTreasury" | "transferValueToTreasury" | "updateAMMTargetFundSize" | "updateDefaultFundTargetSize" | "updateDefaultFundTargetSizeRandom" | "updateFundingAndPricesAfter" | "updateFundingAndPricesBefore" | "updatePriceFeeds" | "updateVolumeEMAOnNewTrade" | "validateStopPrice" | "volatilitySpread" | "withdraw" | "withdrawAll" | "withdrawDepositFromMarginAccount" | "withdrawFromDefaultFund" | "withdrawLiquidity"): FunctionFragment;
552
553
  encodeFunctionData(functionFragment: "activatePerpetual", values: [BigNumberish]): string;
553
554
  encodeFunctionData(functionFragment: "addLiquidity", values: [BigNumberish, BigNumberish]): string;
554
555
  encodeFunctionData(functionFragment: "adjustSettlementPrice", values: [BigNumberish, BigNumberish, BigNumberish]): string;
@@ -673,6 +674,7 @@ export interface IPerpetualManagerInterface extends utils.Interface {
673
674
  encodeFunctionData(functionFragment: "getPoolIdByPerpetualId", values: [BigNumberish]): string;
674
675
  encodeFunctionData(functionFragment: "getPoolStaticInfo", values: [BigNumberish, BigNumberish]): string;
675
676
  encodeFunctionData(functionFragment: "getPriceInfo", values: [BigNumberish]): string;
677
+ encodeFunctionData(functionFragment: "getSettleableAccounts", values: [BigNumberish, BigNumberish, BigNumberish]): string;
676
678
  encodeFunctionData(functionFragment: "getShareTokenFactory", values?: undefined): string;
677
679
  encodeFunctionData(functionFragment: "getShareTokenPriceD18", values: [BigNumberish]): string;
678
680
  encodeFunctionData(functionFragment: "getTargetCollateralM1", values: [
@@ -827,6 +829,7 @@ export interface IPerpetualManagerInterface extends utils.Interface {
827
829
  decodeFunctionResult(functionFragment: "getPoolIdByPerpetualId", data: BytesLike): Result;
828
830
  decodeFunctionResult(functionFragment: "getPoolStaticInfo", data: BytesLike): Result;
829
831
  decodeFunctionResult(functionFragment: "getPriceInfo", data: BytesLike): Result;
832
+ decodeFunctionResult(functionFragment: "getSettleableAccounts", data: BytesLike): Result;
830
833
  decodeFunctionResult(functionFragment: "getShareTokenFactory", data: BytesLike): Result;
831
834
  decodeFunctionResult(functionFragment: "getShareTokenPriceD18", data: BytesLike): Result;
832
835
  decodeFunctionResult(functionFragment: "getTargetCollateralM1", data: BytesLike): Result;
@@ -931,6 +934,7 @@ export interface IPerpetualManagerInterface extends utils.Interface {
931
934
  "SetUtilityToken(address)": EventFragment;
932
935
  "Settle(uint24,address,int256)": EventFragment;
933
936
  "SettleState(uint24)": EventFragment;
937
+ "SettlementComplete(uint24)": EventFragment;
934
938
  "TokensDeposited(uint24,address,int128)": EventFragment;
935
939
  "TokensWithdrawn(uint24,address,int128)": EventFragment;
936
940
  "Trade(uint24,address,bytes16,tuple,bytes32,int128,int128,int128,int128,int128)": EventFragment;
@@ -981,6 +985,7 @@ export interface IPerpetualManagerInterface extends utils.Interface {
981
985
  getEvent(nameOrSignatureOrTopic: "SetUtilityToken"): EventFragment;
982
986
  getEvent(nameOrSignatureOrTopic: "Settle"): EventFragment;
983
987
  getEvent(nameOrSignatureOrTopic: "SettleState"): EventFragment;
988
+ getEvent(nameOrSignatureOrTopic: "SettlementComplete"): EventFragment;
984
989
  getEvent(nameOrSignatureOrTopic: "TokensDeposited"): EventFragment;
985
990
  getEvent(nameOrSignatureOrTopic: "TokensWithdrawn"): EventFragment;
986
991
  getEvent(nameOrSignatureOrTopic: "Trade"): EventFragment;
@@ -1342,6 +1347,13 @@ export interface SettleStateEventObject {
1342
1347
  }
1343
1348
  export type SettleStateEvent = TypedEvent<[number], SettleStateEventObject>;
1344
1349
  export type SettleStateEventFilter = TypedEventFilter<SettleStateEvent>;
1350
+ export interface SettlementCompleteEventObject {
1351
+ perpetualId: number;
1352
+ }
1353
+ export type SettlementCompleteEvent = TypedEvent<[
1354
+ number
1355
+ ], SettlementCompleteEventObject>;
1356
+ export type SettlementCompleteEventFilter = TypedEventFilter<SettlementCompleteEvent>;
1345
1357
  export interface TokensDepositedEventObject {
1346
1358
  perpetualId: number;
1347
1359
  trader: string;
@@ -1691,6 +1703,7 @@ export interface IPerpetualManager extends BaseContract {
1691
1703
  _oracleFactoryAddress: string;
1692
1704
  }>;
1693
1705
  getPriceInfo(_perpetualId: BigNumberish, overrides?: CallOverrides): Promise<[string[], boolean[]]>;
1706
+ getSettleableAccounts(_perpetualId: BigNumberish, start: BigNumberish, count: BigNumberish, overrides?: CallOverrides): Promise<[string[]]>;
1694
1707
  getShareTokenFactory(overrides?: CallOverrides): Promise<[string]>;
1695
1708
  getShareTokenPriceD18(_poolId: BigNumberish, overrides?: CallOverrides): Promise<[BigNumber] & {
1696
1709
  price: BigNumber;
@@ -1976,6 +1989,7 @@ export interface IPerpetualManager extends BaseContract {
1976
1989
  _oracleFactoryAddress: string;
1977
1990
  }>;
1978
1991
  getPriceInfo(_perpetualId: BigNumberish, overrides?: CallOverrides): Promise<[string[], boolean[]]>;
1992
+ getSettleableAccounts(_perpetualId: BigNumberish, start: BigNumberish, count: BigNumberish, overrides?: CallOverrides): Promise<string[]>;
1979
1993
  getShareTokenFactory(overrides?: CallOverrides): Promise<string>;
1980
1994
  getShareTokenPriceD18(_poolId: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>;
1981
1995
  getTargetCollateralM1(_fK2: BigNumberish, _fL1: BigNumberish, _mktVars: AMMPerpLogic.MarketVariablesStruct, _fTargetDD: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>;
@@ -2225,6 +2239,7 @@ export interface IPerpetualManager extends BaseContract {
2225
2239
  _oracleFactoryAddress: string;
2226
2240
  }>;
2227
2241
  getPriceInfo(_perpetualId: BigNumberish, overrides?: CallOverrides): Promise<[string[], boolean[]]>;
2242
+ getSettleableAccounts(_perpetualId: BigNumberish, start: BigNumberish, count: BigNumberish, overrides?: CallOverrides): Promise<string[]>;
2228
2243
  getShareTokenFactory(overrides?: CallOverrides): Promise<string>;
2229
2244
  getShareTokenPriceD18(_poolId: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>;
2230
2245
  getTargetCollateralM1(_fK2: BigNumberish, _fL1: BigNumberish, _mktVars: AMMPerpLogic.MarketVariablesStruct, _fTargetDD: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>;
@@ -2367,6 +2382,8 @@ export interface IPerpetualManager extends BaseContract {
2367
2382
  Settle(perpetualId?: BigNumberish | null, trader?: string | null, amount?: null): SettleEventFilter;
2368
2383
  "SettleState(uint24)"(perpetualId?: BigNumberish | null): SettleStateEventFilter;
2369
2384
  SettleState(perpetualId?: BigNumberish | null): SettleStateEventFilter;
2385
+ "SettlementComplete(uint24)"(perpetualId?: BigNumberish | null): SettlementCompleteEventFilter;
2386
+ SettlementComplete(perpetualId?: BigNumberish | null): SettlementCompleteEventFilter;
2370
2387
  "TokensDeposited(uint24,address,int128)"(perpetualId?: BigNumberish | null, trader?: string | null, amount?: null): TokensDepositedEventFilter;
2371
2388
  TokensDeposited(perpetualId?: BigNumberish | null, trader?: string | null, amount?: null): TokensDepositedEventFilter;
2372
2389
  "TokensWithdrawn(uint24,address,int128)"(perpetualId?: BigNumberish | null, trader?: string | null, amount?: null): TokensWithdrawnEventFilter;
@@ -2500,6 +2517,7 @@ export interface IPerpetualManager extends BaseContract {
2500
2517
  getPoolIdByPerpetualId(_perpetualId: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>;
2501
2518
  getPoolStaticInfo(_poolFromIdx: BigNumberish, _poolToIdx: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>;
2502
2519
  getPriceInfo(_perpetualId: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>;
2520
+ getSettleableAccounts(_perpetualId: BigNumberish, start: BigNumberish, count: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>;
2503
2521
  getShareTokenFactory(overrides?: CallOverrides): Promise<BigNumber>;
2504
2522
  getShareTokenPriceD18(_poolId: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>;
2505
2523
  getTargetCollateralM1(_fK2: BigNumberish, _fL1: BigNumberish, _mktVars: AMMPerpLogic.MarketVariablesStruct, _fTargetDD: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>;
@@ -2775,6 +2793,7 @@ export interface IPerpetualManager extends BaseContract {
2775
2793
  getPoolIdByPerpetualId(_perpetualId: BigNumberish, overrides?: CallOverrides): Promise<PopulatedTransaction>;
2776
2794
  getPoolStaticInfo(_poolFromIdx: BigNumberish, _poolToIdx: BigNumberish, overrides?: CallOverrides): Promise<PopulatedTransaction>;
2777
2795
  getPriceInfo(_perpetualId: BigNumberish, overrides?: CallOverrides): Promise<PopulatedTransaction>;
2796
+ getSettleableAccounts(_perpetualId: BigNumberish, start: BigNumberish, count: BigNumberish, overrides?: CallOverrides): Promise<PopulatedTransaction>;
2778
2797
  getShareTokenFactory(overrides?: CallOverrides): Promise<PopulatedTransaction>;
2779
2798
  getShareTokenPriceD18(_poolId: BigNumberish, overrides?: CallOverrides): Promise<PopulatedTransaction>;
2780
2799
  getTargetCollateralM1(_fK2: BigNumberish, _fL1: BigNumberish, _mktVars: AMMPerpLogic.MarketVariablesStruct, _fTargetDD: BigNumberish, overrides?: CallOverrides): Promise<PopulatedTransaction>;
@@ -612,6 +612,16 @@ export declare class IPerpetualManager__factory {
612
612
  }];
613
613
  readonly name: "SettleState";
614
614
  readonly type: "event";
615
+ }, {
616
+ readonly anonymous: false;
617
+ readonly inputs: readonly [{
618
+ readonly indexed: true;
619
+ readonly internalType: "uint24";
620
+ readonly name: "perpetualId";
621
+ readonly type: "uint24";
622
+ }];
623
+ readonly name: "SettlementComplete";
624
+ readonly type: "event";
615
625
  }, {
616
626
  readonly anonymous: false;
617
627
  readonly inputs: readonly [{
@@ -3118,6 +3128,28 @@ export declare class IPerpetualManager__factory {
3118
3128
  }];
3119
3129
  readonly stateMutability: "view";
3120
3130
  readonly type: "function";
3131
+ }, {
3132
+ readonly inputs: readonly [{
3133
+ readonly internalType: "uint24";
3134
+ readonly name: "_perpetualId";
3135
+ readonly type: "uint24";
3136
+ }, {
3137
+ readonly internalType: "uint256";
3138
+ readonly name: "start";
3139
+ readonly type: "uint256";
3140
+ }, {
3141
+ readonly internalType: "uint256";
3142
+ readonly name: "count";
3143
+ readonly type: "uint256";
3144
+ }];
3145
+ readonly name: "getSettleableAccounts";
3146
+ readonly outputs: readonly [{
3147
+ readonly internalType: "address[]";
3148
+ readonly name: "";
3149
+ readonly type: "address[]";
3150
+ }];
3151
+ readonly stateMutability: "view";
3152
+ readonly type: "function";
3121
3153
  }, {
3122
3154
  readonly inputs: readonly [];
3123
3155
  readonly name: "getShareTokenFactory";
@@ -769,6 +769,19 @@ const _abi = [
769
769
  name: "SettleState",
770
770
  type: "event",
771
771
  },
772
+ {
773
+ anonymous: false,
774
+ inputs: [
775
+ {
776
+ indexed: true,
777
+ internalType: "uint24",
778
+ name: "perpetualId",
779
+ type: "uint24",
780
+ },
781
+ ],
782
+ name: "SettlementComplete",
783
+ type: "event",
784
+ },
772
785
  {
773
786
  anonymous: false,
774
787
  inputs: [
@@ -3982,6 +3995,35 @@ const _abi = [
3982
3995
  stateMutability: "view",
3983
3996
  type: "function",
3984
3997
  },
3998
+ {
3999
+ inputs: [
4000
+ {
4001
+ internalType: "uint24",
4002
+ name: "_perpetualId",
4003
+ type: "uint24",
4004
+ },
4005
+ {
4006
+ internalType: "uint256",
4007
+ name: "start",
4008
+ type: "uint256",
4009
+ },
4010
+ {
4011
+ internalType: "uint256",
4012
+ name: "count",
4013
+ type: "uint256",
4014
+ },
4015
+ ],
4016
+ name: "getSettleableAccounts",
4017
+ outputs: [
4018
+ {
4019
+ internalType: "address[]",
4020
+ name: "",
4021
+ type: "address[]",
4022
+ },
4023
+ ],
4024
+ stateMutability: "view",
4025
+ type: "function",
4026
+ },
3985
4027
  {
3986
4028
  inputs: [],
3987
4029
  name: "getShareTokenFactory",