Skip to content
forked from delvtech/elf-sdk

SDK for interacting with Element Core Contracts

License

Notifications You must be signed in to change notification settings

stark6969/elf-sdk

 
 

Repository files navigation

ELF SDK

Build Status License

⚠️ 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
  1. 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]
  1. Source the env file
source elf.env

Run Example Script:

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

About

SDK for interacting with Element Core Contracts

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 99.6%
  • Shell 0.4%