@nftperp/sdk

nftperp sdk ✨

SDK to interact with the nftperp protocol (docs).

tldr; nftperp is a derivates platform for nfts. for the first time ever, short nfts with leverage

The protocol is currently in BETA on arbitrum mainnet (dapp). it uses fake eth for paper trading, which can be obtained from faucet on website/sdk

For any queries, hop in the community discord and ask away invite link

---

• Installation
• Terminology
• Usage

---

Installation

npm i @nftperp/sdk

Also requires ethers library

npm i ethers

Terminology

• asset the nft collection to trade. synonymous to market pair, amm.
• direction direction of trade. long or short.
• margin collateral amount. this is the amount you risk on liquidation.
• notional total value of position margin x leverage.
• mark price nftperp's price of the asset.
• index price actual price of the asset. floor from marketplaces.
• margin ratio margin to notional ratio.
• maintenance margin ratio minimum margin ratio to be maintained to avoid liquidation.

Usage

Setup

import { ethers } from "ethers";
import { SDK } from "@nftperp/sdk";

/**
the general rpc url for arb mainnet is "https://arb1.arbitrum.io/rpc"
you can also use a personal one from alchemy (https://www.alchemy.com/)
*/
const provider = new ethers.providers.JsonRpcProvider("<your-rpc-url>");
const wallet = new ethers.Wallet("<your-private-key>", provider);
const nftperp = new SDK(wallet);

Obtaining paper ETH from faucet

await nftperp.useFaucet(); // grants 5 eth

Open a position

const hash = await nftperp.openPosition({
    asset: "bayc",
    direction: "long",
    margin: 0.1, // this means 0.1 eth
    leverage: 3,
});

note: currently limited nft collections are supported. to get a list of supported assets do:

console.log(nftperp.getSupportedAssets());
/**
[ 'bayc', 'moonbirds', 'mayc', 'doodles', 'clonex' ]
*/

Get postion info

const position = await nftperp.getPosition({
    asset: "bayc",
});
console.log(position);
/**
{
  size: 0.003,
  margin: 0.1,
  leverage: 3,
  pnl: 0,
  funding: 0,
  entryPrice: 82.981,
  liquidationPrice: 63.224
}
*/

Close a position

const hash = await nftperp.closePosition({
    asset: "bayc",
});

Get asset info

const assetInfo = await nftperp.getAssetInfo("bayc");
console.log(assetInfo);
/**
{
  asset: 'BAYC',
  markPrice: 82.795,
  indexPrice: 84,
  maxLeverage: 5,
  maintenanceMarginPercent: 12.5,
  fullLiquidationPercent: 10,
  previousFundingPercent: -0.662,
  nextFundingTime: 1660194024,
  openInterest: 3583.484,
  openInterestLongs: 2581.935,
  openInterestShorts: 1001.548
}
*/

Changelog

1.0.1 (2022-08-15)

⚠ BREAKING CHANGES

• cannot default import or require. its a regular export now

Features

• add asset info method (0f96640)
• add margin (fe1fc63)
• add method to get all supported assets (e583764)
• add methods for mark price, index price and funding details (c5b0490)
• add typechain and generate types (c0c2380)
• close position and get position (1228d48)
• get position with details (4a080d4)
• implement nftperp class with open position (ef29706)
• init git, and setup linting (b507515)
• partial close (b3292f2)
• remove margin (aeb367d)
• update mock weth abi and implement faucet (0cbb504)

Bug Fixes

• add balance check in close position (a6f9e48)

• facuet method (1ca8ef5)

• make export instead of default export (73ad70f)