![Logo](https://xend.finance/assets-2/logo.svg)

# XendFinance SDK

Build applications on-top of the Xend Finance Smart Contract Protocols.


## Authors

- [@kayalbertus](https://github.com/KayAlbertus)
- [@nCally](https://github.com/nCally)



# Installation
Using npm:
```bash
npm install @xend-finance/web-sdk
```
Using yarn:
```bash
yarn add @xend-finance/web-sdk
```

Xend Finance has different saving strategies that helps you save your money in stable currencies;
- Personal Savings
- Esusu
- Cooperative Savings
- Yield Aggregator(xAuto,xVault) 

You can make use of one or all of these strategies

# Setup Video
Follow this [youtube link](https://youtu.be/V6VoFne7Kzw) for an example of how you can setup this SDK for local development.

# Scenario
You can use Xend Finance in as many scenario's you can come up with, but there are 2 examples
1. Use one general address for all your transactions
2. Create a new address for each of your users and use for their transactions

# Example Personal Flexible Deposit 

```js
import XF from '@xend-finance/web-sdk';


const makeDeposit = async () => {
  const { Personal } = await XF(chainId, privateKey, { env:"mainnet" });

  const depositAmount = "100";

  const response = await Personal.flexibleDeposit(depositAmount);

  return response;
}
```


# Example xAuto Deposit 

```js
import XF from '@xend-finance/web-sdk';


const makeDeposit = async () => {
  const { xAuto } = await XF(chainId, privateKey, { env:"mainnet" });

  const depositAmount = "100";
  let approval = await xAuto.approve("USDC", depositAmount);

	if (approval && approval.status) {

  const response = await xAuto.deposit("USDC",depositAmount);
  }

  return response;
}
```

# Example xAuto Deposit BNB 

```js
import XF from '@xend-finance/web-sdk';


const makeDeposit = async () => {
  const { xAuto } = await XF(chainId, privateKey, { env:"mainnet" });

  const depositAmount = "100";

  const response = await xAuto.depositNative("BNB",depositAmount);

  return response;
}
```

# Withdraw xAuto | xVault  

```js
import XF from '@xend-finance/web-sdk';
const withdraw = async () => {
const { xAuto,xVault } = await XF(chainId, privateKey, { env:"mainnet" });

const receiptXauto = await xAuto.withdraw("USDC", totalBUSDAdmount)
const receiptXvault = await xVault.withdraw("BUSD", totalBUSDAdmount)


}
```

# Parameters
These parameters are used to create an instance of any of the saving strategies exported from the SDK

Name | Description
--- | ---
**chainId** | Chain ID of the network in use. 56 represents the BSC Mainnet, 1 is for Ethererum Mainnet, 97 is for BSC Testnet
**privateKey** | Private key of address
**options** | *Optional*



# Options
When any of Xend Finance strategy is initialized without *options*, the SDK defaults to use the addresses for the testnet.

Properties | Values | Description
--- | --- | ---
`env` | local, testnet, mainnet | Required 
`protocols` | Array of protocols objects | This can only be used when the `env` is `local`. 
`protocolName` | | Used in the case of multiple protocols available

Note: whenever you use the *options* argument you have to provide value for the `env` property even if it is "testnet"


# Protocol Type
This is the structure of a protocol to be used by the SDK and will be helpful when using the SDK on your local machine with an instance of tools like ganache.

```json
{
  "name":"",
  "code":"",
  "addresses": {
    "PROTOCOL_ADAPTER": "",
    "PROTOCOL_SERVICE": "",
    "GROUPS": "",
    "CYCLES": "",
    "ESUSU_SERVICE": "",
    "ESUSU_STORAGE": "",
    "ESUSU_ADAPTER": "",
    "COOPERATIVE": "",
    "PERSONAL": "",
    "CLIENT_RECORD": "",
    "XEND_TOKEN": "",
    "TOKEN": "",
    "PROTOCOL_CURRENCY": "",
  }
}
```

# Some Available Methods
## General
Name | Parameters | Description
--- | --- | ---
`getClientAddress` | | address of account used to initialize SDK
`apys` | | will only return values if you are on mainnet


## Personal Savings
Name | Parameters | Description
--- | --- | ---
`flexibleDeposit` | depositAmount | 
`fixedDeposit` | | 
`fixedInfo` | | 
`flexibleInfo` | | 
`withdrawFixed` | recordId | 
`withdrawFlexible` | amount |
`walletBalance` | |

## Esusu
Name | Parameters | Description
--- | --- | ---
`create` | |
`walletBalance` | |

## Cooperative Savings
Name | Parameters | Description
--- | --- | ---
`create` | |
`walletBalance` | |

## xAuto ,xVault
​​Name | Parameters | Description
--- | --- | ---
`deposit` | |
`withdraw` | |

## 🔗 Social Media Links
[![gitbook](https://img.shields.io/badge/gitbook-0A66C2?style=for-the-badge&logo=gitbook&logoColor=white)](https://docs.xend.finance/)
[![linkedin](https://img.shields.io/badge/linkedin-0A66C2?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/company/xend-finance/mycompany/)
[![twitter](https://img.shields.io/badge/twitter-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white)](https://twitter.com/xendfinance)
[![discord](https://img.shields.io/badge/discord-0A66C2?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/QPH2M3nbku)
[![telegram](https://img.shields.io/badge/telegram-0A66C2?style=for-the-badge&logo=telegram&logoColor=white)](https://t.me/xendFinance)