# @jup-ag/lifinity-sdk-v2

> ## Installation ```bash yarn install @lifinity/sdk-v2 ```

Latest version **1.0.8** (published 2022-11-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install @jup-ag/lifinity-sdk-v2
pnpm add @jup-ag/lifinity-sdk-v2
yarn add @jup-ag/lifinity-sdk-v2
bun add @jup-ag/lifinity-sdk-v2
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.8 |
| Published | 2022-11-29 |
| First published | 2022-11-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 7 |
| Unpacked size | 116.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | hjchan, arowana, siong, dicksonp, zhengyutay |

## Links

- npm: https://www.npmjs.com/package/@jup-ag/lifinity-sdk-v2
- npm.io page: https://npm.io/package/@jup-ag/lifinity-sdk-v2

## Dependencies (7)

- [decimal.js](https://npm.io/package/decimal.js.md) ^10.3.1
- [@solana/web3.js](https://npm.io/package/@solana/web3.js.md) ^1.31.0
- [@solana/spl-token](https://npm.io/package/@solana/spl-token.md) ^0.1.8
- [@pythnetwork/client](https://npm.io/package/@pythnetwork/client.md) ^2.5.1
- [@project-serum/borsh](https://npm.io/package/@project-serum/borsh.md) ^0.2.5
- [@project-serum/serum](https://npm.io/package/@project-serum/serum.md) ^0.13.61
- [@project-serum/anchor](https://npm.io/package/@project-serum/anchor.md) 0.24.2

## Recent versions

- 1.0.8 (latest) — 2022-11-29
- 1.0.5 — 2022-11-06
- 1.0.4 — 2022-11-06

## README

# lifinity-sdk-v2

## Installation
```bash
yarn install @lifinity/sdk-v2
```

## Usage
- Get pools
```typescript
import { getPoolList } from '@lifinity/sdk-v2';

const pools = getPoolList();

console.log("pools =", pools);
```

- Get swap amount
```typescript
import { Connection, PublicKey } from '@solana/web3.js';
import { getAmountOut, AmountOut } from '@lifinity/sdk-v2';

const connection: Connection = new Connection("https://api.mainnet-beta.solana.com");
const amountIn: number = 1; // Input amount
const fromMint: PublicKey = new PublicKey("---Mint address of the input token---");
const toMint: PublicKey = new PublicKey("---Mint address of the output token---");
const slippage: number = 1; // Slippage (%)

const res : AmountOut = await getAmountOut(
    connection,
    amountIn,
    fromMint,
    toMint,
    slippage
);

console.log("amountIn: number =", res.amountIn);
console.log("amountOut: number =", res.amountOut);
console.log("amountOutWithSlippage: number =", res.amountOutWithSlippage);
console.log("priceImpact: number =", res.priceImpact);
console.log("fee: number =", res.fee);
console.log("feePercent: number =", res.feePercent);
```
  
- Breakdown of get swap amount<br>
Please use the SDK for calculating amount out (*getCurveAmount*) as the protocol is still in beta and the math may be updated
```typescript
import { Connection, PublicKey } from '@solana/web3.js';
import Decimal from 'decimal'
import { getPool, getMultipleAccounts, getParsedData, getCurveAmount, TradeDirection } from '@lifinity/sdk-v2'


const connection: Connection = new Connection("https://api.mainnet-beta.solana.com");
const amountIn: number = 1; // Input amount
const fromMint: PublicKey = new PublicKey("---Mint address of the intput token---");
const toMint: PublicKey = new PublicKey("---Mint address of the output token---");
const slippage: number = 1; // Slippage (%)

const poolInfo = getPool(fromMint.toString(), toMint.toString());
if (poolInfo) {

    let amount = new Decimal(amountIn);
    let tradeDirection: string;
    let inDecimal: number;
    let outDecimal: number;

    if (poolInfo.poolCoinMint === fromMint.toString()){
        amount = amount.times(new Decimal(10).pow(poolInfo.poolCoinDecimal));
        inDecimal = poolInfo.poolCoinDecimal;
        outDecimal = poolInfo.poolPcDecimal;
        tradeDirection = TradeDirection.AtoB;
    }else{
        amount = amount.times(new Decimal(10).pow(poolInfo.poolPcDecimal));
        inDecimal = poolInfo.poolPcDecimal;
        outDecimal = poolInfo.poolCoinDecimal
        tradeDirection = TradeDirection.BtoA;
    }

    const publicKeys = [
        new PublicKey(poolInfo.amm),
        new PublicKey(poolInfo.poolCoinTokenAccount),
        new PublicKey(poolInfo.poolPcTokenAccount),
    ];

    if (poolInfo.oracleMainAccount !== poolInfo.oracleSubAccount){
        publicKeys.push(new PublicKey(poolInfo.oracleMainAccount));
        publicKeys.push(new PublicKey(poolInfo.oracleSubAccount));
    }else{
        publicKeys.push(new PublicKey(poolInfo.oracleMainAccount));
    }

    if (poolInfo.oracleSubAccount !== poolInfo.oraclePcAccount){
        publicKeys.push(new PublicKey(poolInfo.oraclePcAccount));
    }

    try {
        const multipleInfo = await getMultipleAccounts(connection, publicKeys);

        const data: IAmmData = getParsedData(
            multipleInfo,
            poolInfo
        );

        const slot = await connection.getSlot();

        const curveAmount: ICurveAmount = getCurveAmount(
            amount,
            slot,
            data.amm,
            data.fees,
            data.coinBalance,
            data.pcBalance,
            data.config,
            data.oracleMain,
            data.oracleSub,
            data.oraclePc,
            tradeDirection,
        );
        console.log("amountSwapped: Decimal =", curveAmount.amountSwapped);
        console.log("priceImpact: Decimal =", curveAmount.priceImpact);
        console.log("fee: Decimal =", curveAmount.fee);
        console.log("feePercent: Decimal =", curveAmount.feePercent);

        const slippagePercent = new Decimal(slippage).div(100);
        const amountOutWithSlippage = new Decimal(Math.floor(curveAmount.amountSwapped.times(new Decimal(1).minus(slippagePercent)).toNumber()));
        const amountOutWithSlippageTokenAmount = amountOutWithSlippage.div(new Decimal(10).pow(outDecimal)).toNumber();
        const amountOutTokenAmount = curveAmount.amountSwapped.div(new Decimal(10).pow(outDecimal)).toNumber();
        const feeTokenAmount = curveAmount.fee.div(new Decimal(10).pow(inDecimal)).toNumber();

        console.log("slippagePercent: Decimal =", slippagePercent);
        console.log("amountOutWithSlippage: Decimal =", amountOutWithSlippage);
        console.log("amountOutWithSlippageTokenAmount: Decimal =", amountOutWithSlippageTokenAmount);
        console.log("amountOutTokenAmount: Decimal =", amountOutTokenAmount);
        console.log("feeTokenAmount: Decimal =", feeTokenAmount);

    }catch (error) {
        console.log(error)
        // Errors include failures to obtain accurate price feed from the oracle
    }
}
```
  
- Get swap instruction
```typescript
import { Connection, PublicKey } from '@solana/web3.js';
import { getSwapInstruction } from '@lifinity/sdk-v2'

const connection: Connection = new Connection("https://api.mainnet-beta.solana.com");
const ownerAccount: PublicKey = new PublicKey("---User's Solana address---")
const amountIn: number = 1; // Input amount
const minimumOut: number = 100; // Output amount
const fromMint: PublicKey = new PublicKey("---Mint address of the input token---");
const toMint: PublicKey = new PublicKey("---Mint address of the output token---");
const fromUserAccount: PublicKey = new PublicKey("---User's input token account---");
const toUserAccount: PublicKey = new PublicKey("---User's output token account---");
const approve = true; // Set false to skip approve instruction

const { approveInstruction, swapInstruction, signers } = await getSwapInstruction(
    connection,
    ownerAccount,
    amountIn, 
    minimumOut,
    fromMint,
    toMint,
    fromUserAccount,
    toUserAccount,
    approve,
);

console.log("approveInstruction: TransactionInstruction =", approveInstruction);
console.log("swapInstruction: TransactionInstruction =", swapInstruction);
console.log("signers: any[] =", signers);
```
  
- Swap
```typescript
import { Lifinity } from '@lifinity/sdk-v2'

const connection: Connection = new Connection("https://api.mainnet-beta.solana.com");
const wallet: any = "---User wallet---"
const amountIn: number = 1; // Input amount
const minimumOut: number = 100; // Output amount
const fromMint: PublicKey = new PublicKey("---Mint address of the input token---");
const toMint: PublicKey = new PublicKey("---Mint address of the output token---");

const lifinitySdk = await Lifinity.build(
    connection,
    wallet
);

const transactionId: string = await lifinitySdk.swap(
    amountIn,
    minimumOut,
    fromMint,
    toMint
);

console.log("transactionId: string =",transactionId)
```

- Deposit
```typescript
import { Lifinity } from '@lifinity/sdk-v2'

const connection: Connection = new Connection("https://api.mainnet-beta.solana.com");
const wallet: any = "---User wallet---"

const coinAmountIn: number = 1; // input coin token amount
const pcAmountIn: number = 0; 
const coinMint: PublicKey = new PublicKey("---Mint address of the pool coin token---");
const pcMint: PublicKey = new PublicKey("---Mint address of the pool pc token---");
const slippage: number = 1; // Slippage (%)

// If pcAmountIn = 0, calculate pcAmountIn from coinAmountIn
const depositAmount : IDepositAmountOut = await getDepositAmountOut(
  connection,
  coinAmountIn,
  pcAmountIn,
  coinMint,
  pcMint,
  slippage
);

const lifinitySdk = await Lifinity.build(
    connection,
    wallet
);

const transactionId: string = await lifinitySdk.deposit(
    depositAmount.coinMaximumIn,
    depositAmount.pcMaximumIn,
    depositAmount.lpRecive,
    coinMint,
    pcMint,
);

console.log("transactionId: string =",transactionId)
```
If you only want to get the deposit instruction, use getDepositInstruction ().


- Withdraw
```typescript
import { Lifinity } from '@lifinity/sdk-v2'

const connection: Connection = new Connection("https://api.mainnet-beta.solana.com");
const wallet: any = "---User wallet---"

const lpAmountIn: number = 1; // input lp token amount
const coinMint: PublicKey = new PublicKey("---Mint address of the pool coin token---");
const pcMint: PublicKey = new PublicKey("---Mint address of the pool pc token---");
const slippage: number = 1; // Slippage (%)

const withdrawAmount : IWithdrawAmountOut = await getWithdrawAmountOut(
  connection,
  lpAmountIn,
  coinMint,
  pcMint,
  slippage
);

const lifinitySdk = await Lifinity.build(
    connection,
    wallet
);

const transactionId: string = await lifinitySdk.withdraw(
    withdrawAmount.lpAmountIn,
    withdrawAmount.coinMinimumOut,
    withdrawAmount.pcMinimumOut,
    coinMint,
    pcMint,
);

console.log("transactionId: string =",transactionId)
```
If you only want to get the withdraw instruction, use getWithdrawInstruction ().


Copyright © 2022 LIFINITY FOUNDATION All Rights Reserved.

---
_Source: https://npm.io/package/@jup-ag/lifinity-sdk-v2 · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
