npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

abcdefasdasddasadsdas

v0.0.1

Published

SDK for use any functions of forbitswap v1 Protocol

Downloads

1

Readme

forbitswap v1 Protocol SDK

Installation

yarn add "@forbitswapamm/sdk"

Usage Example

Init SDK

import { SDK } from "@forbitswapamm/sdk"

const sdk = new SDK("https://fullnode.devnet.aptoslabs.com", NetworkType.Devnet)

Is pair exist

;(async () => {
	const APTOS = "0x1::aptos_coin::AptosCoin"
	const BTC = "0xa3b854a301bf4d44b6bbeb3354e50c94ab1b5cc82dd1e03a325cbd06a24e94b9::SpaceCoin::BTC"

	const output = await sdk.swap.isPairExist(APTOS, BTC)
})()

Add liquidity rate calculation and tx payload.

If pair not exists, tx will create pair first

;(async () => {
	const APTOS = "0x1::aptos_coin::AptosCoin"
	const BTC = "0xa3b854a301bf4d44b6bbeb3354e50c94ab1b5cc82dd1e03a325cbd06a24e94b9::SpaceCoin::BTC"

	const isPairExist = await sdk.swap.isPairExist(APTOS, BTC)

	if (isPairExist) {
		// Add liqudity with a given rate
		const amountIn = 1e8
		const output = await sdk.swap.addLiquidityRates({
			coinX: APTOS,
			coinY: BTC,
			fixedCoin: "X", // 'X' | 'Y'
			amount: amountIn, // fixedCoin amount
		})

		/**
      output type:
      {
        amount: Decimal
        coinXDivCoinY: Decimal
        coinYDivCoinX: Decimal
        shareOfPool: Decimal
      }
    */

		const txPayload = sdk.swap.addLiquidityPayload({
			coinX: APTOS,
			coinY: BTC,
			amountX: amountIn,
			amountY: output.amount,
			slippage: 0.05, // 5%
		})

		/**
      output type: tx payload
    */
	} else {
		// Create pair and add initial liquidity
		const txPayload = sdk.swap.addLiquidityPayload({
			coinX: APTOS,
			coinY: BTC,
			amountX: 1e8, // any amount you want
			amountY: 1e7, // any amount you want
			slippage: 0.05, // 5%
		})

		/**
      output type: tx payload
    */
	}
})()

Remove liquidity rate calculation and tx payload for existed pairs

;(async () => {
	const APTOS = "0x1::aptos_coin::AptosCoin"
	const BTC = "0xa3b854a301bf4d44b6bbeb3354e50c94ab1b5cc82dd1e03a325cbd06a24e94b9::SpaceCoin::BTC"
	const lpAmount = 1e6

	const output = await sdk.swap.removeLiquidityRates({
		coinX: APTOS,
		coinY: BTC,
		amount: lpAmount, // lp amount
	})

	/**
    output type:
    {
      amountX: Decimal
      amountY: Decimal
    }
   */

	const txPayload = sdk.swap.removeLiquidityPayload({
		coinX: APTOS,
		coinY: BTC,
		amount: lpAmount,
		amountXDesired: output.amountX,
		amountYDesired: output.amountY,
		slippage: 0.05, // 5%
		deadline: 30, // 30 seconds
	})

	/**
    output type: tx payload
   */
})()

Swap (exact in) rate calculation and tx payload.

Swap exact coin to coin mode

;(async () => {
	const APTOS = "0x1::aptos_coin::AptosCoin"
	const BTC = "0xa3b854a301bf4d44b6bbeb3354e50c94ab1b5cc82dd1e03a325cbd06a24e94b9::SpaceCoin::BTC"
	const aptosAmount = 1e6

	const trades = await sdk.route.getRouteSwapExactCoinForCoin({
		fromCoin: APTOS,
		toCoin: BTC,
		amount: aptosAmount,
	})
	if (trades.length == 0) throw "No route error"
	const bestTrade = trades[0]
	/**
    bestTrade type:
    {
      coinPairList: LiquidityPoolResource[]
      amountList: string[]
      coinTypeList: string[]
      priceImpact: Decimal
    }
   */

	const output = sdk.route.swapExactCoinForCoinPayload({
		trade: bestTrade,
		slippage: 0.05, // 5%
	})

	/**
    output type: tx payload
   */
})()

Swap (exact out) rate calculation and tx payload.

Swap coin to exact coin mode

;(async () => {
	const APTOS = "0x1::aptos_coin::AptosCoin"
	const BTC = "0xa3b854a301bf4d44b6bbeb3354e50c94ab1b5cc82dd1e03a325cbd06a24e94b9::SpaceCoin::BTC"
	const btcAmount = 1e6

	const trades = await sdk.route.getRouteSwapCoinForExactCoin({
		fromCoin: APTOS,
		toCoin: BTC,
		amount: btcAmount,
	})
	if (trades.length == 0) throw "No route error"
	const bestTrade = trades[0]
	/**
    bestTrade type:
    {
      coinPairList: LiquidityPoolResource[]
      amountList: string[]
      coinTypeList: string[]
      priceImpact: Decimal
    }
   */

	const output = sdk.route.swapCoinForExactCoinPayload({
		trade: bestTrade,
		slippage: 0.05, // 5%
	})

	/**
    output type: tx payload
   */
})()

Get all LPCoin by address

;(async () => {
	const queryAddress = "0xfo11b11"
	const output = await sdk.swap.getAllLPCoinResourcesByAddress(queryAddress)

	/**
    output type:
    [{
      coinX: AptosResourceType
      coinY: AptosResourceType
      lpCoin: AptosResourceType
      value: string
    }]
   */
})()

Get LPCoin amount

;(async () => {
	const APTOS = "0x1::aptos_coin::AptosCoin"
	const BTC = "0xa3b854a301bf4d44b6bbeb3354e50c94ab1b5cc82dd1e03a325cbd06a24e94b9::SpaceCoin::BTC"
	const queryAddress = "0xfo11b11"

	const output = await sdk.swap.getLPCoinAmount({
		address: queryAddress,
		coinX: APTOS,
		coinY: BTC,
	})

	/**
    output type:
    {
      coinX: AptosResourceType
      coinY: AptosResourceType
      lpCoin: AptosResourceType
      value: string
    }
   */
})()

Get LPCoin apr

;(async () => {
	const APTOS = "0x1::aptos_coin::AptosCoin"
	const BTC = "0xa3b854a301bf4d44b6bbeb3354e50c94ab1b5cc82dd1e03a325cbd06a24e94b9::SpaceCoin::BTC"

	const output = await sdk.swap.getLPCoinAPY({
		coinX: APTOS,
		coinY: BTC,
	})

	/**
    output type:
    {
      apr: Decimal
      windowSeconds: Decimal
    }
   */
})()