A Javascript SDK for Perpetual Protocol Curie.
This repo is still in beta.
Install dependencies:
yarn add @perp/sdk-curieSee ./test/ for common use cases.
TRACK
METADATA_URL_CORE_OVERRIDE_OPTIMISM_GOERLI
METADATA_URL_CORE_OVERRIDE_OPTIMISM
METADATA_URL_PERIPHERY_OVERRIDE_OPTIMISM_GOERLI
METADATA_URL_PERIPHERY_OVERRIDE_OPTIMISM
enum TRACK {
dev1 = "dev1"
dev2 = "dev2"
canary = "canary"
rc = "rc"
production = "production"
}yarn
yarn generate-type:[TRACK]In this repo, run:
yarn link
yarn start:[TRACK]METADATA_URL_CORE_OVERRIDE_OPTIMISM_GOERLI="your_url" \
METADATA_URL_PERIPHERY_OVERRIDE_OPTIMISM_GOERLI="your_url" \
yarn start:[TRACK]In the repo that you want to test with, run:
yarn link @perp/sdk-curieWe use commitizen and commitlint to regulate commit message.
yarn commityarn test- Now we only support optimism
const perp = new PerpetualProtocol({
chainId: 10,
providerConfigs: [{ rpcUrl: "https://mainnet.optimism.io" }],
})
await perp.init()- Remember to provide your signer when connecting.
For example:
Open a Long position using quoteToken.
baseToken: ETH
quoteToken: USD
const perp = new PerpetualProtocol({
chainId: 10,
providerConfigs: [{ rpcUrl: "https://mainnet.optimism.io" }],
})
await perp.init()
await perp.connect({ signer })const tickerSymbol = "ETHUSD"
const slippage = new Big(0.02) // remember to transform to Big type
const amountInput = new Big(100) // remember to transform to Big type
const side = PositionSide.LONG
const isAmountInputBase = false // we are not using base token to open a long position here.
const newPositionDraft = perp.clearingHouse.createPositionDraft({
tickerSymbol,
side,
amountInput,
isAmountInputBase,
})
perp.clearingHouse.openPosition(positionDraft, slippage)const tickerSymbol = "ETHUSD"
const position = await perp.positions.getTakerPositionByTickerSymbol(tickerSymbol)
perp.clearingHouse.closePosition(position, slippage)- Remember to provide your signer when connecting.
For example:
Use quoteToken to add liquidity.
baseToken: ETH
quoteToken: USD
const perpParam = {
chainId: 10,
providerConfigs: [{ rpcUrl: "https://mainnet.optimism.io" }],
}
const perp = new PerpetualProtocol(perpParam)
await perp.init()
await perp.connect({ signer })const tickerSymbol = "ETHUSD"
const market = perp.markets.getMarket({ tickerSymbol })
const lowerTick = perp.market.getPriceToTick(lowerTickPrice)
const upperTick = perp.market.getPriceToTick(upperTickPrice)
const slippage = new Big(0.02) // remember to transform to Big type
const rawBaseAmount = undefined
const rawQuoteAmount = new Big(100) // remember to transform to Big type
const liquidityDraft = perp.clearingHouse.createLiquidityDraft({
tickerSymbol,
rawBaseAmount,
rawQuoteAmount,
upperTick,
lowerTick,
})
perp.clearingHouse.addLiquidity(liquidityDraft, slippage)ratiomeans how much ratio you would like to remove. 1 means 100%- Use
filterFnto filter out liquidity you would like to remove.
const ratio = new Big(1) // remember to transform to Big type
const slippage = new Big(0.02) // remember to transform to Big type
const liquidity = perp.liquidities.getTotalLiquidities().filter(filterFn)
perp.clearingHouse.removeLiquidity(liquidity, ratio, slippage)If any features/functionalities described in the Perpetual Protocol documentation, code comments, marketing, community discussion or announcements, pre-production or testing code, or other non-production-code sources, vary or differ from the code used in production, in case of any dispute, the code used in production shall prevail.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent