Class Perps

constructor

• new Perps(synthetixSdk): Perps

• Parameters

  • synthetixSdk: SynthetixSdk

  Returns Perps

accountIds

OptionaldefaultAccountId

isErc7412Enabled

isMulticollateralEnabled

marketMetadata

marketsById

marketsByName

marketsBySymbol

sdk

commitOrder

• commitOrder(size, settlementStrategyId?, marketId, marketName, accountId, desiredFillPrice, maxPriceImpact, submit?): Promise<string | CallParameters>

• Submit an order to the specified market. Keepers will attempt to fill the order according to the settlement strategy. If desired_fill_price is provided, the order will be filled at that price or better. If max_price_impact is provided, the desired_fill_price is calculated from the current market price and the price impact.

  Parameters

  • size: number

    The size of the order to submit
  • settlementStrategyId: number = 0

    The id of the settlement strategy to use
  • marketId: undefined | number

    The id of the market to submit the order to. If not provided, marketName must be provided
  • marketName: undefined | string

    The name of the market to submit the order to. If not provided, marketId must be provided.
  • accountId: undefined | bigint

    The id of the account to submit the order for. Defaults to defaultAccountId.
  • desiredFillPrice: undefined | number

    The max price for longs and minimum price for shorts. If not provided, one will be calculated based on maxPriceImpact
  • maxPriceImpact: undefined | number

    The maximum price impact to allow when filling the order as a percentage (1.0 = 1%). If not provided, it will inherit the default value from snx.max_price_impact
  • submit: boolean = false

    If true, submit the transaction to the blockchain

  Returns Promise<string | CallParameters>

createAccount

• createAccount(accountId?, submit?): Promise<string | CallParameters>

• Create a perps account. An account NFT is minted to the sender, who owns the account.

  Parameters

  • accountId: undefined | bigint = undefined

    Id of the account. If not passed, default Perps account ID is used
  • submit: boolean = false

    Executes the transaction if true

  Returns Promise<string | CallParameters>

  Transaction hash or transaction data

createIsolatedAccountOrder

• createIsolatedAccountOrder(collateralAmount, collateralMarketId, size, marketId?, marketName?, settlementStrategyId?, accountId?, desiredFillPrice?, maxPriceImpact?, submit?): Promise<string | CallParameters>

• Parameters

  • collateralAmount: number
  • collateralMarketId: number
  • size: number
  • OptionalmarketId: number
  • OptionalmarketName: string
  • settlementStrategyId: number = 0
  • OptionalaccountId: bigint
  • OptionaldesiredFillPrice: number
  • OptionalmaxPriceImpact: number
  • submit: boolean = false

  Returns Promise<string | CallParameters>

getAccountIds

• getAccountIds(address?, defaultAccountId?): Promise<bigint[]>

• Fetch a list of perps account_id owned by an address. Perps accounts are minted as an NFT to the owner's address. The account_id is the token id of the NFTs held by the address.

  Parameters

  • address: undefined | string = undefined

    The address to get accounts for. Uses connected address if not provided.
  • defaultAccountId: undefined | bigint = undefined

    The default account ID to set after fetching.

  Returns Promise<bigint[]>

  A list of account IDs owned by the address

getCanLiquidate

• getCanLiquidate(accountId?): Promise<boolean>

• Check if an accountId is eligible for liquidation.

  Parameters

  • accountId: undefined | bigint = undefined

    The id of the account to check. If not provided, the default account is used.

  Returns Promise<boolean>

getCanLiquidates

• getCanLiquidates(accountIds?): Promise<{
      accountId: bigint;
      canLiquidate: boolean;
  }[]>

• Check if a batch of accountId's are eligible for liquidation.

  Parameters

  • accountIds: undefined | bigint[] = undefined

    An array of account ids

  Returns Promise<{
      accountId: bigint;
      canLiquidate: boolean;
  }[]>

getCollateralBalances

• getCollateralBalances(accountId?): Promise<void>

• Fetch the balance of each collateral type for an account.

  Parameters

  • accountId: undefined | bigint = undefined

    The id of the account to fetch the collateral balances for. If not provided, the default account is used.

  Returns Promise<void>

getDebt

• getDebt(accountId?): Promise<number>

• Returns the debt of the account id

  Parameters

  • accountId: undefined | bigint = undefined

    The id of the account to get the debt for. If not provided, the default account is used.

  Returns Promise<number>

  debt Account debt in ether

getFundingParameters

• getFundingParameters(marketIds): Promise<FundingParameters[]>

• Fetch funding parameters for an array of market ids.

  Parameters

  • marketIds: number[]

    Array of marketIds to fetch settlement strategy

  Returns Promise<FundingParameters[]>

  Funding Parameters array for markets

getMarginInfo

• getMarginInfo(accountId?): Promise<CollateralData>

• Fetch information about an account's margin requirements and balances. Accounts must maintain an available_margin above the maintenance_margin_requirement to avoid liquidation. Accounts with available_margin below the initial_margin_requirement can not interact with their position unless they deposit more collateral.

  Parameters

  • accountId: undefined | bigint = undefined

    The id of the account to fetch the margin info for. If not provided, the default account is used

  Returns Promise<CollateralData>

getMarkets

• getMarkets(): Promise<{
      marketsById: Map<number, MarketData>;
      marketsByName: Map<string, MarketData>;
  }>

• Fetch the ids and summaries for all perps markets. Market summaries include information about the market's price, open interest, funding rate, and skew

  Returns Promise<{
      marketsById: Map<number, MarketData>;
      marketsByName: Map<string, MarketData>;
  }>

getMarketSummaries

• getMarketSummaries(marketIds): Promise<MarketSummary[]>

• Fetch the market summaries for an array of marketIds

  Parameters

  • marketIds: number[]

    Array of market ids to fetch

  Returns Promise<MarketSummary[]>

  Summary of market ids data fetched from the contract

getMarketSummary

• getMarketSummary(marketId?, marketName?): Promise<MarketSummary>

• Fetch the market summary for a single market, including information about the market's price, open interest, funding rate, and skew. Provide either the marketId or marketName.

  Parameters

  • marketId: undefined | number = undefined

    Market id to fetch the summary
  • marketName: undefined | string = undefined

    Name of the market to fetch summary

  Returns Promise<MarketSummary>

  Summary of market data fetched from the contract

getMaxMarketValues

• getMaxMarketValues(marketIds): Promise<MaxMarketValue[]>

• Gets the max size (in value) of an array of marketIds.

  Parameters

  • marketIds: number[]

    Array of market ids.

  Returns Promise<MaxMarketValue[]>

  Max market size in market USD value for each market

getOpenPosition

• getOpenPosition(marketId?, marketName?, accountId?): Promise<OpenPositionData>

• Fetch the position for a specified account and market. The result includes the unrealized pnl since the last interaction with this position, any accrued funding, and the position size. Provide either a marketId or a marketName::

  Parameters

  • marketId: undefined | number = undefined

    The id of the market to fetch the position for.
  • marketName: undefined | string = undefined

    The name of the market to fetch the position for.
  • accountId: undefined | bigint = undefined

    The id of the account to fetch the position for. If not provided, the default account is used.

  Returns Promise<OpenPositionData>

getOpenPositions

• getOpenPositions(marketIds?, marketNames?, accountId?): Promise<OpenPositionData[]>

• Fetch positions for an array of specified markets. The result includes the unrealized pnl since the last interaction with this position, any accrued funding, and the position size. Provide either an array of marketIds or a marketNames::

  Parameters

  • marketIds: undefined | number[] = undefined

    Array of market ids to fetch the position for.
  • marketNames: undefined | string[] = undefined

    Array of market names to fetch the position for.
  • accountId: undefined | bigint = undefined

    The id of the account to fetch the position for. If not provided, the default account is used.

  Returns Promise<OpenPositionData[]>

getOrder

• getOrder(accountId?, fetchSettlementStrategy?): Promise<OrderData>

• Fetches the open order for an account. Optionally fetches the settlement strategy, which can be useful for order settlement and debugging.

  Parameters

  • accountId: undefined | bigint = undefined

    The id of the account. If not provided, the default account is used
  • fetchSettlementStrategy: boolean = true

    Flag to indicate whether to fetch the settlement strategy

  Returns Promise<OrderData>

getOrderFees

• getOrderFees(marketIds): Promise<OrderFees[]>

• Gets the order fees of a market.

  Parameters

  • marketIds: number[]

    Array of market ids.

  Returns Promise<OrderFees[]>

  Order fees array for markets

getQuote

• getQuote(size, price?, marketId?, marketName?, accountId?, settlementStrategyId?, includeRequiredMargin?): Promise<OrderQuote>

• Get a quote for the size of an order in a specified market. The quote includes the provided price and the fill price of the order after price impact. If a price is not provided, a price will be fetched from Pyth. Provide either a marketId or marketName.

  Parameters

  • size: number

    The size of the order to quote.
  • Optionalprice: number

    The price to quote the order at. If not provided, the current market price is used
  • marketId: undefined | number = undefined

    The id of the market to quote the order for
  • marketName: undefined | string = undefined

    The name of the market to quote the order for
  • accountId: undefined | bigint = undefined

    The id of the account to quote the order for. If not provided, the default account is used
  • settlementStrategyId: number = 0

    The id of the settlement strategy to use for the settlement reward calculation
  • includeRequiredMargin: boolean = true

    If true, include the required margin for the account in the quote.

  Returns Promise<OrderQuote>

getSettlementStrategies

• getSettlementStrategies(marketIds): Promise<SettlementStrategy[]>

• Fetch the settlement strategies for an array of market ids. Settlement strategies describe the conditions under which an order can be settled.

  Parameters

  • marketIds: number[]

    Array of marketIds to fetch settlement strategy

  Returns Promise<SettlementStrategy[]>

  Settlement strategy array for markets

getSettlementStrategy

• getSettlementStrategy(settlementStrategyId, marketId?, marketName?): Promise<SettlementStrategy>

• Fetch the settlement strategy for a market. Settlement strategies describe the conditions under which an order can be settled. Provide either a marketId or marketName

  Parameters

  • settlementStrategyId: number
  • marketId: undefined | number = undefined

    Id of the market to get settlement strategy
  • marketName: undefined | string = undefined

    Name of the market to get settlement strategy

  Returns Promise<SettlementStrategy>

  Settlement strategy for market

initPerps

• initPerps(): Promise<void>

• Returns Promise<void>

liquidate

• liquidate(accountId?, submit?, staticCall?): Promise<string | number | CallParameters>

• Submit a liquidation for an account, or static call the liquidation function to fetch the liquidation reward. The static call is important for accounts which have been partially liquidated. Due to the throughput limit on liquidated value, the static call returning a nonzero value means more value can be liquidated (and rewards collected). This function can not be called if submit and staticCall are true.

  Parameters

  • accountId: undefined | bigint = undefined

    The id of the account to liquidate. If not provided, the default account is used.
  • submit: boolean = false

    If true, submit the transaction to the blockchain.
  • staticCall: boolean = false

    If true, static call the liquidation function to fetch the liquidation reward.

  Returns Promise<string | number | CallParameters>

modifyCollateral

• modifyCollateral(amount, marketId?, marketName?, accountId?, submit?): Promise<string | CallParameters>

• Move collateral in or out of a specified perps account. The market_id or market_name must be provided to specify the collateral type. Provide either a market_id or a market_name. Note that the market_id here refers to the spot market id, not the perps market id. Make sure to approve the market proxy to transfer tokens of the collateral type before calling this function.

  Parameters

  • amount: number

    The amount of collateral to move. Positive values deposit collateral, negative values withdraw collateral
  • marketId: undefined | number = undefined

    The id of the market to move collateral for
  • marketName: undefined | string = undefined

    The name of the market to move collateral for.
  • accountId: undefined | bigint = undefined

    The id of the account to move collateral for. If not provided, the default account is used.
  • submit: boolean = false

    If True, submit the transaction to the blockchain.

  Returns Promise<string | CallParameters>

payDebt

• payDebt(amount?, accountId?, submit?): Promise<string | CallParameters>

• Pay the debt of a perps account. If no amount is provided, the full debt of the account is repaid. Make sure to approve the proxy to transfer sUSD before calling this function.

  Parameters

  • amount: undefined | number = undefined

    The amount of debt to repay. If not provided, the full debt is repaid.
  • accountId: undefined | bigint = undefined

    The id of the account to repay the debt for. If not provided, the default account is used.
  • submit: boolean = false

    If true, submit the transaction to the blockchain. If not provided, transaction object is returned

  Returns Promise<string | CallParameters>

prepareOracleCall

• prepareOracleCall(marketIds?): Promise<Call3Value[]>

• Prepare a call to the external node with oracle updates for the specified market names. The result can be passed as the first argument to a multicall function to improve performance of ERC-7412 calls. If no market names are provided, all markets are fetched. This is useful for read functions since the user does not pay gas for those oracle calls, and reduces RPC calls and runtime.

  Parameters

  • marketIds: number[] = []

    An array of market ids to fetch prices for. If not provided, all markets are fetched

  Returns Promise<Call3Value[]>

resolveMarket

• resolveMarket(marketId?, marketName?): {
      resolvedMarketId: number;
      resolvedMarketName: string;
  }

• Look up the market_id and market_name for a market. If only one is provided, the other is resolved. If both are provided, they are checked for consistency.

  Parameters

  • marketId: undefined | number = undefined

    Id of the market to resolve
  • marketName: undefined | string = undefined

    Name of the market to resolve

  Returns {
      resolvedMarketId: number;
      resolvedMarketName: string;
  }

  • resolvedMarketId: number

  • resolvedMarketName: string

settleOrder

• settleOrder(accountId?, submit?, maxTxTries?, txDelay?): Promise<undefined | string | CallParameters>

• Settles an order using ERC7412 by handling OracleDataRequired errors and forming a multicall. If the order is not yet ready to be settled, this function will wait until the settlement time. If the transaction fails, this function will retry until the max number of tries is reached with a configurable delay.

  Parameters

  • accountId: undefined | bigint = undefined

    The id of the account to settle. If not provided, the default account is used.
  • submit: boolean = false

    If true, submit the transaction to the blockchain.
  • maxTxTries: number = 3

    The max number of tries to submit the transaction
  • txDelay: number = 2

    The delay in seconds between transaction submissions.

  Returns Promise<undefined | string | CallParameters>