delvtech / elf-sdk

SDK for interacting with Element Core Contracts

ELF SDK

⚠️ This is a work in progress! ⚠️

This repo provides an SDK for developers to use when interacting with and building on Element smart contracts.

Install

npm install git+https://github.com/element-fi/elf-sdk.git
npm run generate-interfaces

Since this repo is not an npm package, it can be helpful to include this simple script to upgrade your project to the latest commit:

 "scripts": {
    "update-elf-sdk": "npm install git+https://github.com/element-fi/elf-sdk.git"
  },

Build

npm run build

Configure

To use the Element SDK you need to configure some env variables. For linux and mac run the following:

1. Copy elf.default.env

cp elf.default.env elf.env

2. Update elf.env with your private key and alchemy api key

export MAINNET_PROVIDER_URL=[MAINNET_PROVIDER_URL_HERE]
export GOERLI_PROVIDER_URL=[GOERLI_PROVIDER_URL_HERE]
export PRIVATE_KEY=[PRIVATE_KEY_HERE]

3. Source the env file

source elf.env

Run Example Script:

npx hardhat run examples/poolDetails.ts --network goerli

elf-sdk's Issues

SDK support to return the underlying vault's current apy

The endpoint used for Yearn vaults is:

https://api.yearn.finance/v1/chains/1/vaults/all

It would be nice to have a method that accepts, for example, the token symbol (PT or YT) and returns the vault APY. Something like:

getVaultAPYByTokenSymbol(termAddresses, tokenSymbol)

calcTotalValueLockedForTerm param should be tokenInfo not lists

it might be better for this method to accept the tokenInfos need rather than passing the list and having it search.

export async function calcTotalValueLockedForTerm(
  trancheInfo: PrincipalTokenInfo,
  balancerVaultAddress: string,
  ptPoolInfo: PoolInfo,
  ytPoolInfo: PoolInfo,
  // etc etc
  assetProxyTokenInfo: AssetProxyTokenInfo,
  signerOrProvider: Signer | Provider
): Promise<Money> {

Originally posted by @jrhea in #37 (comment)

typescript error of `decimals` in getReserves.ts file

I found typescript error at this code line:
https://github.com/element-fi/elf-sdk/blob/1d85370eda22d4526799281ca4b5b291990d87a1/src/helpers/getReserves.ts#L56

it should be fixed like this
const decimals: number[] = [];

Optional GasPrice in swap/mint/etc

Goerli was slow to confirm txs without bumping the gas price for the swap example (PR #14). as a result, i added a quick hack to just pass a configurable gasPrice to the overrides. This should be optional and needs to be fixed properly.

normalize decimals for calcSpotPricePt()

It's easy to mess up PT spot price calcs for USDC bc it only has 6 decimals and totalSupply has 18.

filter by token symbol

create a helper method to filter addresses by token symbol

• getTermByTokenSymbol (PR #14)
• getPoolByTokenSymbol

helper for open terms

Create a helper method that only returns addresses of open terms

Finish implementing the stubbed out getTokenPrice method

Finish implementing the stubbed out getTokenPrice method

Originally posted by @jrhea in #37 (comment)