@undefiorg/defarm
TypeScript icon, indicating that this package has built-in type declarations

0.28.0 • Public • Published

DeFarm

Decode Defi Farm for human readable.

Features

  • [x] ALPACA: fetchLendsBySymbols
  • [x] CAKE: fetchFarmsWithAPRBySymbols
  • [x] CAKE: fetchTokenUSDPricesBySymbols
  • [x] ALPACA: USER Get user's active position with addition info.
  • [x] CAKE: USER fetchPoolReward

TODO

  • [x] ALPACA: USER Get account tx to get investment information.

Installation

npm

Development

npm dev

Test

npm test
npm test-dev

Release

npm login
npm run release

Example: USD Price

CAKE price from pancakeswap

import { pancakeswap } from '@undefiorg/defarm'
const results = await pancakeswap.fetchTokenUSDPricesBySymbols(['CAKE'])
console.log(results)

ALPACA, ETH, BNB prices from pancakeswap

import { pancakeswap } from '@undefiorg/defarm'
const results = await pancakeswap.fetchTokenUSDPricesBySymbols(['ALPACA', 'ETH', 'BNB'])
console.log(results)

ibALPACA price from pancakeswap

import { alpaca } from '@undefiorg/defarm'

// It's a good idea to check for supported symbols before calling fetchTokenUSDPricesBySymbols
const supportedSymbols = alpaca.getSupportedUSDSymbols()
console.log(supportedSymbols)

// Better use to fetch only supported `ibToken` prices
const [ibALPACA] = await alpaca.fetchTokenUSDPricesBySymbols(['ibALPACA'])
console.log(results)

Example: Farm's info

ALPACA lend info w/ price

import { alpaca } from '@undefiorg/defarm'
const results = await alpaca.fetchLendsBySymbols(['ALPACA'])
console.log(results)

CAKE-BNB pool info w/ price + APR

import { pancakeswap } from '@undefiorg/defarm'
const results = await pancakeswap.fetchFarmsWithAPRBySymbols(['CAKE-BNB LP'])
console.log(results)

Example: User's info

Get user balance

import { alpaca } from '@undefiorg/defarm'
const balances = await alpaca.fetchUserBalance('0x8155430e4860e791aeddb43e4764d15de7e0def1')
console.log(results)

Get user related farm info

import { alpaca } from '@undefiorg/defarm'
const lends = await alpaca.fetchUserLends('0x8155430e4860e791aeddb43e4764d15de7e0def1')
const stakes = await alpaca.fetchUserStakes('0x8155430e4860e791aeddb43e4764d15de7e0def1')

TODO

Readme

Keywords

none

Package Sidebar

Install

npm i @undefiorg/defarm

Weekly Downloads

0

Version

0.28.0

License

MIT

Unpacked Size

1.77 MB

Total Files

520

Last publish

Collaborators

  • katopz