@defund-protocol/v1-sdk v0.4.10

v1-sdk

DeFund Protocol v1 SDK

Installation

npm install @defund-protocol/v1-sdk

How to use

Base

SDK initialization requires the following parameters

import { UniversalSDK } from '@defund-protocol/v1-sdk';
import { Wallet, providers } from 'ethers';

const chainId = 1;
const provider = new providers.JsonRpcProvider('your json rpc url');
const signer = new Wallet('your signer privateKey', provider);
const sdk = new UniversalSDK(chainId, signer);

Swap

Swap Params

Swap Details

Overrides

You can find out more about the overrides parameter from the ethers document

const maker = signer.address;
const fundAddress = 'your fund address';
const swapDetails = {
  opType: 'exactInput',
  tokenIn: '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2', // WETH Address on mainnet
  tokenOut: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48', // USDC Address on mainnet
  amountIn: BigNumber.from('100000000000000000'), // 0.1 ETH
  amountOut: BigNumber.from('1000000'), // 1 USDC
  useNative: true, // use native token, use ETH in this demo
  expiration: Math.round(new Date().getTime() / 1000 + 30 * 60) // 30 minutes
};

const overrides = {};

const tx = await sdk.executeSwap(maker, fundAddress, swapDetails, overrides);

AssetsConvert

Convert Params

Convert Details

const maker = signer.address;
const fundAddress = 'your fund address';
const convertDetails = {
  opType: 'assetsConvert',
  tokenIn: '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2', // WETH Address on mainnet
  tokenOut: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48', // USDC Address on mainnet
  ratio: 1000, // 10%
  useNative: true
};

const overrides = {};

const tx = await sdk.executeAssetsConvert(
  maker,
  fundAddress,
  convertDetails,
  overrides
);

ApproveToken

Approve Token Params

Approve Details

const maker = signer.address;
const fundAddress = 'your fund address';
const approveDetails = {
  opType: 'fund',
  token: '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2', // WETH Address on mainnet
};

const overrides = {};

const tx = await sdk.executeApproveToken(
  maker,
  fundAddress,
  approveDetails,
  overrides
);

GetFundAssets

You can use this method to get the asset information of the fund

const maker = signer.address;
const fundAddress = 'your fund address';

const assets = await sdk.getFundAssets(fundAddress);

GetFundInfo

You can use this method to get all the on-chain information of the fund

Params

const maker = signer.address;
const fundAddress = 'your fund address';

const lpAddress = 'this address of specific lp';
const witAssets = false;

const assets = await sdk.getFundAssets(fundAddress, lpAddress, withAssets);

Approve Token

const maker = signer.address;
const fundAddress = 'your fund address';

const tx = await sdk.executeApproveToken(maker, fundAddress, {token: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48'});

If approve is not required, tx returns null, otherwise returns the transaction.

Buy Fund

const maker = signer.address;
const fundAddress = 'your fund address';
const amount = BigNumber.from("10000000000000000") // 0.01 ETH

const tx = await sdk.executeBuyFund(
  maker,
  fundAddress,
  amount,
);

Sell Fund

const maker = signer.address;
const fundAddress = 'your fund address';
const amount = BigNumber.from("10000000000000000") // 0.01 ETH

const tx = await sdk.executeSellFund(
  maker,
  fundAddress,
  10, // 10 percent
);

Get Your Funds list

Role

  const managerList = await sdk.getFundList(signer.address, 1);
  const operatorList = await sdk.getFundList(signer.address, 2);
  const investorList = await sdk.getFundList(signer.address, 3);

Get Fund's Lps

const fundAddress = 'your fund address';
const lps = await sdk.getFundInvestors(fundAddress);

Examples

Examples can be found at: Examples