Class LiquidityPoolSingle

An interface for liquidity pools within the synths platform.

Implements

Constructors

constructor

Properties

adapter id onUpdate? pairStates pairTradeability pairTradeabilityListeners priceFeed tradePairs underlyingToken

Methods

getAvailableLiquidity getLpTokenPrice getOpenInterest getPairAvailability getPairState getPrice getTradePair getTradePairs getTradePrice getUnderlyingToken handleLpPublication listenToLpPairTradeability placeOrder placeOrders replaceOrder shouldUsePriceImpact subscribeToMarketPrice tryGetPairState unsubscribeFromMarketPrice

Constructors

constructor

Properties

Private adapter

adapter: TradeAdapter

id

id: string

Optional onUpdate

onUpdate?: ((pairState) => void)

Type declaration

    • (pairState): void

    • Parameters

      • pairState: PairState

      Returns void

Private pairStates

pairStates: Record<string, undefined | PairState> = {}

Private pairTradeability

pairTradeability: Record<string, undefined | boolean> = {}

Private pairTradeabilityListeners

pairTradeabilityListeners: LpPairTradeabilityListener[] = []

Private priceFeed

priceFeed: TradeLpPriceFeed

Private Readonly tradePairs

tradePairs: TradePair[]

Private Readonly underlyingToken

underlyingToken: TokenInfo

Methods

getAvailableLiquidity

getLpTokenPrice

getOpenInterest

getPairAvailability

getPairState

getPrice

getTradePair

getTradePairs

getTradePrice

getUnderlyingToken

Private handleLpPublication

listenToLpPairTradeability

placeOrder

  • placeOrder(args): Promise<{
        accountId: number;
        accountUser: string;
        createdTimestampUnixMillis: number;
        expiryTimestampUnixMillis: number;
        id: string;
        kind: {
            kind: "market";
        } | {
            args: {
                limitPrice: BigNumber;
            };
            kind: "limit";
        } | {
            args: {
                stopLoss?: null | {
                    kind: "position";
                } | {
                    id: string;
                    kind: "order";
                };
                triggerPrice: BigNumber;
            };
            kind: "stopMarket";
        } | {
            args: {
                limitPrice: BigNumber;
                triggerPrice: BigNumber;
            };
            kind: "stopLimit";
        } | {
            args: {
                takeProfit?: null | {
                    kind: "position";
                } | {
                    id: string;
                    kind: "order";
                };
                triggerPrice: BigNumber;
            };
            kind: "limitTrigger";
        } | {
            kind: string;
        };
        lpId: string;
        nonce: string;
        pair: Pair;
        signature: string;
        size: {
            amount: BigNumber;
            unit: "lpc" | "lot";
        };
        status: {
            content: {
                status: "placed";
            } | {
                content: {
                    timestampUnixMillis: number;
                    triggerPrice: BigNumber;
                };
                status: "triggered";
            };
            status: "open";
        } | {
            content: {
                price: BigNumber;
                settlementStatus: {
                    status: "queued";
                } | {
                    status: "beforeTx";
                } | {
                    status: "indexing";
                } | {
                    content: {
                        txHash: string;
                    };
                    status: "settled";
                };
                timestampUnixMillis: number;
            };
            status: "filled";
        } | {
            content: {
                reason: string;
                timestampUnixMillis: number;
                userCancellation?: null | {
                    address: string;
                    nonce: string;
                    signature: {
                        r: string;
                        s: string;
                        v: number;
                    };
                };
            };
            status: "cancelled";
        };
    }>

  • Parameters

    Returns Promise<{
        accountId: number;
        accountUser: string;
        createdTimestampUnixMillis: number;
        expiryTimestampUnixMillis: number;
        id: string;
        kind: {
            kind: "market";
        } | {
            args: {
                limitPrice: BigNumber;
            };
            kind: "limit";
        } | {
            args: {
                stopLoss?: null | {
                    kind: "position";
                } | {
                    id: string;
                    kind: "order";
                };
                triggerPrice: BigNumber;
            };
            kind: "stopMarket";
        } | {
            args: {
                limitPrice: BigNumber;
                triggerPrice: BigNumber;
            };
            kind: "stopLimit";
        } | {
            args: {
                takeProfit?: null | {
                    kind: "position";
                } | {
                    id: string;
                    kind: "order";
                };
                triggerPrice: BigNumber;
            };
            kind: "limitTrigger";
        } | {
            kind: string;
        };
        lpId: string;
        nonce: string;
        pair: Pair;
        signature: string;
        size: {
            amount: BigNumber;
            unit: "lpc" | "lot";
        };
        status: {
            content: {
                status: "placed";
            } | {
                content: {
                    timestampUnixMillis: number;
                    triggerPrice: BigNumber;
                };
                status: "triggered";
            };
            status: "open";
        } | {
            content: {
                price: BigNumber;
                settlementStatus: {
                    status: "queued";
                } | {
                    status: "beforeTx";
                } | {
                    status: "indexing";
                } | {
                    content: {
                        txHash: string;
                    };
                    status: "settled";
                };
                timestampUnixMillis: number;
            };
            status: "filled";
        } | {
            content: {
                reason: string;
                timestampUnixMillis: number;
                userCancellation?: null | {
                    address: string;
                    nonce: string;
                    signature: {
                        r: string;
                        s: string;
                        v: number;
                    };
                };
            };
            status: "cancelled";
        };
    }>

placeOrders

  • placeOrders(args): Promise<{
        accountId: number;
        accountUser: string;
        createdTimestampUnixMillis: number;
        expiryTimestampUnixMillis: number;
        id: string;
        kind: {
            kind: "market";
        } | {
            args: {
                limitPrice: BigNumber;
            };
            kind: "limit";
        } | {
            args: {
                stopLoss?: null | {
                    kind: "position";
                } | {
                    id: string;
                    kind: "order";
                };
                triggerPrice: BigNumber;
            };
            kind: "stopMarket";
        } | {
            args: {
                limitPrice: BigNumber;
                triggerPrice: BigNumber;
            };
            kind: "stopLimit";
        } | {
            args: {
                takeProfit?: null | {
                    kind: "position";
                } | {
                    id: string;
                    kind: "order";
                };
                triggerPrice: BigNumber;
            };
            kind: "limitTrigger";
        } | {
            kind: string;
        };
        lpId: string;
        nonce: string;
        pair: Pair;
        signature: string;
        size: {
            amount: BigNumber;
            unit: "lpc" | "lot";
        };
        status: {
            content: {
                status: "placed";
            } | {
                content: {
                    timestampUnixMillis: number;
                    triggerPrice: BigNumber;
                };
                status: "triggered";
            };
            status: "open";
        } | {
            content: {
                price: BigNumber;
                settlementStatus: {
                    status: "queued";
                } | {
                    status: "beforeTx";
                } | {
                    status: "indexing";
                } | {
                    content: {
                        txHash: string;
                    };
                    status: "settled";
                };
                timestampUnixMillis: number;
            };
            status: "filled";
        } | {
            content: {
                reason: string;
                timestampUnixMillis: number;
                userCancellation?: null | {
                    address: string;
                    nonce: string;
                    signature: {
                        r: string;
                        s: string;
                        v: number;
                    };
                };
            };
            status: "cancelled";
        };
    }[]>

  • Parameters

    Returns Promise<{
        accountId: number;
        accountUser: string;
        createdTimestampUnixMillis: number;
        expiryTimestampUnixMillis: number;
        id: string;
        kind: {
            kind: "market";
        } | {
            args: {
                limitPrice: BigNumber;
            };
            kind: "limit";
        } | {
            args: {
                stopLoss?: null | {
                    kind: "position";
                } | {
                    id: string;
                    kind: "order";
                };
                triggerPrice: BigNumber;
            };
            kind: "stopMarket";
        } | {
            args: {
                limitPrice: BigNumber;
                triggerPrice: BigNumber;
            };
            kind: "stopLimit";
        } | {
            args: {
                takeProfit?: null | {
                    kind: "position";
                } | {
                    id: string;
                    kind: "order";
                };
                triggerPrice: BigNumber;
            };
            kind: "limitTrigger";
        } | {
            kind: string;
        };
        lpId: string;
        nonce: string;
        pair: Pair;
        signature: string;
        size: {
            amount: BigNumber;
            unit: "lpc" | "lot";
        };
        status: {
            content: {
                status: "placed";
            } | {
                content: {
                    timestampUnixMillis: number;
                    triggerPrice: BigNumber;
                };
                status: "triggered";
            };
            status: "open";
        } | {
            content: {
                price: BigNumber;
                settlementStatus: {
                    status: "queued";
                } | {
                    status: "beforeTx";
                } | {
                    status: "indexing";
                } | {
                    content: {
                        txHash: string;
                    };
                    status: "settled";
                };
                timestampUnixMillis: number;
            };
            status: "filled";
        } | {
            content: {
                reason: string;
                timestampUnixMillis: number;
                userCancellation?: null | {
                    address: string;
                    nonce: string;
                    signature: {
                        r: string;
                        s: string;
                        v: number;
                    };
                };
            };
            status: "cancelled";
        };
    }[]>

replaceOrder

shouldUsePriceImpact

subscribeToMarketPrice

tryGetPairState

unsubscribeFromMarketPrice

Settings

Member Visibility

Theme

On This Page

constructoradapteridonUpdatepairStatespairTradeabilitypairTradeabilityListenerspriceFeedtradePairsunderlyingTokengetAvailableLiquiditygetLpTokenPricegetOpenInterestgetPairAvailabilitygetPairStategetPricegetTradePairgetTradePairsgetTradePricegetUnderlyingTokenhandleLpPublicationlistenToLpPairTradeabilityplaceOrderplaceOrdersreplaceOrdershouldUsePriceImpactsubscribeToMarketPricetryGetPairStateunsubscribeFromMarketPrice