@stake-dao/reader 0.4.112 → 0.5.0

package/src/lockers/fetch/protocols/blackpool.ts

@@ -0,0 +1,151 @@
+import { One, STAKE_DAO_ASSETS_BASE_URL, Zero, tokenWithId } from '@stake-dao/constants'
+import { formatUnits, parseUnits } from 'viem'
+import lockersMulticallAbi from '../../../abis/lockersMulticall.js'
+import { type Call, getRes, multicall } from '../../../utils.js'
+import { parse, parsePeg } from '../parse.js'
+import type { Locker } from '../types.js'
+
+export const locker: Locker = {
+  id: 'bpt',
+  symbol: 'BPT',
+  protocol: 'Blackpool',
+  protocolDescription:
+    'Blackpool is a decentralized autonomous organization (DAO) built solely for NFT gaming and trading.',
+  website: 'https://blackpool.finance/',
+  logoUrl: `${STAKE_DAO_ASSETS_BASE_URL}/assets/archive/bpt.svg`,
+  chainId: 1,
+  rgb: '0, 0, 0',
+  token: tokenWithId('bpt')!,
+  sdToken: tokenWithId('sdbpt')!,
+  rewards: [{ ...tokenWithId('weth')!, distribution: 'streamed', origin: 'native.common' }],
+  delegation: ['sdbpt.eth'],
+  modules: {
+    depositor: '0x219f7496fbD30e1F21A20613F9372d608A279993',
+    locker: '0x0a4dF7809F83e130D8ffa297f03b75318E37B461',
+    veToken: '0x19886A88047350482990D4EDd0C1b863646aB921',
+    gauge: '0xa291faEEf794df6216f196a63F514B5B22244865',
+    accumulator: '0xfAC788261DA6E2aFfCD0e9AB340395378F8CBfBc',
+  },
+  secondaryMarket: {
+    label: 'Curve',
+    poolKey: 'factory-v2-177',
+    vaultKey: '',
+    pool: '0x9d259ca698746586107c234e9e9461d385ca1041',
+    pools: ['0x9d259ca698746586107c234e9e9461d385ca1041'],
+    pegBase: 5000,
+  },
+  fees: [
+    {
+      label: { key: 'liquidity', variable: 'sdBPT/BPT' },
+      value: 10,
+      key: 'liquidityFee',
+      static: true,
+    },
+    {
+      label: { key: 'treasury' },
+      value: 5,
+      key: 'daoFee',
+      static: true,
+    },
+    {
+      label: { key: 'harvester' },
+      value: 0.1,
+      key: 'claimerFee',
+      static: true,
+    },
+  ],
+  extensions: {
+    coingeckoBaseSlug: 'blackpool-token',
+  },
+}
+
+const blackpoolLocker = async ({ provider, common, prices }: { provider; common; prices }) => {
+  const token = locker.token.address
+  const sdToken = locker.sdToken.address
+
+  const gauge = locker.modules.gauge
+  const depositor = locker.modules.depositor
+  const votingEscrow = locker.modules.veToken
+  const lockerAddress = locker.modules.locker
+
+  const secondaryMarket = locker.secondaryMarket!
+  const rewards = locker.rewards
+
+  const pegBase = parseUnits(secondaryMarket?.pegBase?.toString() || '1', 18)
+
+  const format = (value: bigint) => formatUnits(value, locker.token.decimals)
+  const formatRes = (value: any) => format(getRes(value))
+
+  const calls: Call[] = [
+    /*********************************************************************************
+     *** Voting Escrow
+     *********************************************************************************/
+
+    // Token locked by the Locker
+    { address: votingEscrow, name: 'locked', params: [lockerAddress] },
+    // veToken Balance of the Locker
+    { address: votingEscrow, name: 'balanceOf', params: [lockerAddress] },
+    // Total token locked
+    { address: votingEscrow, name: 'supply' },
+    // Total veToken supply
+    { address: votingEscrow, name: 'totalSupply' },
+
+    /*********************************************************************************
+     *** Gauge
+     *********************************************************************************/
+
+    // Total sdToken staked
+    { address: gauge, name: 'totalSupply' },
+    // Gauge working supply
+    { address: gauge, name: 'working_supply' },
+
+    /*********************************************************************************
+     *** Token & sdToken
+     *********************************************************************************/
+
+    // Token balance not locked
+    { address: token, name: 'balanceOf', params: [depositor] },
+    // sdToken in secondary market pool
+    { address: sdToken, name: 'balanceOf', params: [secondaryMarket.pool] },
+
+    /*********************************************************************************
+     *** Peg
+     *********************************************************************************/
+
+    // Return amount when swapping {pegBase} sdToken to token -> get_dy(int128,int128,uint256)
+    { address: secondaryMarket.pool, name: '0x5e0d443f', params: [One, Zero, pegBase] },
+
+    /*********************************************************************************
+     *** Rewards
+     *********************************************************************************/
+
+    // Streaming status for each reward token
+    ...rewards.map((r) => ({ address: gauge, name: 'reward_data', params: [r.address] })),
+  ]
+
+  const res = await multicall(provider, calls, lockersMulticallAbi(locker.id, locker.chainId))
+  const raw = {
+    tokenLocked: getRes(res.shift()),
+    veBalanceOfLocker: formatRes(res.shift()),
+    totalTokenLocked: formatRes(res.shift()),
+    veTotalSupply: formatRes(res.shift()),
+    totalSupplyStaked: formatRes(res.shift()),
+    gaugeWorkingSupply: formatRes(res.shift()),
+    amountTokenNotLock: formatRes(res.shift()),
+    sdTokenInPool: formatRes(res.shift()),
+    peg: getRes(res.shift()),
+    rewards: rewards.map(() => getRes(res.shift())),
+    veTokenRate: '4',
+    _workingSupply: '0',
+    _veBalanceOfLocker: '0',
+  }
+
+  raw.tokenLocked = format(raw.tokenLocked[0])
+  raw.peg = parsePeg(locker, raw.peg)
+  raw._workingSupply = raw.gaugeWorkingSupply
+  raw._veBalanceOfLocker = raw.veBalanceOfLocker
+
+  return parse({ locker, common, prices, raw })
+}
+
+export default blackpoolLocker

package/src/lockers/fetch/protocols/curve.ts

@@ -0,0 +1,229 @@
+import { ONE_WEEK, One, STAKE_DAO_ASSETS_BASE_URL, Zero, contracts, tokenWithId } from '@stake-dao/constants'
+import { range } from 'lodash-es'
+import { formatUnits, parseUnits } from 'viem'
+import lockersMulticallAbi from '../../../abis/lockersMulticall.js'
+import { type Call, getRes, multicall } from '../../../utils.js'
+import { parse, parsePeg, parseVoteBoosterData } from '../parse.js'
+import type { Locker } from '../types.js'
+
+export const locker: Locker = {
+  id: 'crv',
+  symbol: 'CRV',
+  protocol: 'Curve',
+  protocolDescription:
+    'Curve is a decentralized exchange (DEX) focused on efficient stablecoin trading by using liquidity pools.',
+  website: 'https://curve.finance/',
+  logoUrl: `${STAKE_DAO_ASSETS_BASE_URL}/assets/archive/crv.svg`,
+  chainId: 1,
+  rgb: '234, 151, 53',
+  token: tokenWithId('crv')!,
+  sdToken: tokenWithId('sdcrv')!,
+  rewards: [
+    { ...tokenWithId('sdt')!, distribution: 'streamed', origin: 'sdtEmission' },
+    { ...tokenWithId('3crv')!, distribution: 'streamed', origin: 'native.curve' },
+    { ...tokenWithId('crv')!, distribution: 'streamed', origin: 'stratPerf' },
+    { ...tokenWithId('crvusd')!, distribution: 'streamed', origin: 'native.curve' },
+    { ...tokenWithId('sdcrv')!, distribution: 'distributed', origin: 'bounties' },
+  ],
+  delegation: ['sdcrv.eth', 'sdcrv-gov.eth'],
+  modules: {
+    depositor: '0xa50CB9dFFcc740EE6b6f2D4B3CBc3a876b28c335',
+    locker: '0x52f541764E6e90eeBc5c21Ff570De0e2D63766B6',
+    veToken: '0x5f3b5DfEb7B28CDbD7FAba78963EE202a494e2A2',
+    gauge: '0x7f50786A0b15723D741727882ee99a0BF34e3466',
+    accumulator: '0x11F78501e6b0cbc5DE4c7e6BBabaACdb973eb4Cd',
+  },
+  secondaryMarket: {
+    label: 'Curve',
+    poolKey: 'factory-v2-300',
+    vaultKey: '1-0x32c1Cd7c991A1F40f5aF5701CDc7a6A95F900CD4',
+    pool: '0xCA0253A98D16e9C1e3614caFDA19318EE69772D0',
+    pools: ['0xf7b55c3732ad8b2c2da7c24f30a69f55c54fb717', '0xca0253a98d16e9c1e3614cafda19318ee69772d0'],
+    pegBase: 10000,
+  },
+  veBoost: {
+    address: '0xD37A6aa3d8460Bd2b6536d608103D880695A23CD',
+    delegator: '0xe1F9C8ebBC80A013cAf0940fdD1A8554d763b9cf',
+  },
+  voteBooster: {
+    vSdToken: '0xE079ac07463ff375Ce48E8A9D76211C10696F3B8',
+    booster: '0x38d10708Ce535361F178f55E68DF7E85aCc66270',
+  },
+  autoCompounder: {
+    aSdToken: '0x43E54C2E7b3e294De3A155785F52AB49d87B9922',
+  },
+  alternativeYields: {
+    aSdCrvConcentrator: {
+      label: 'asdCRV',
+      platform: 'Concentrator',
+      href: 'https://concentrator.aladdin.club/',
+    },
+    sdCrvCrvConcentrator: {
+      label: 'sdCRV/CRV',
+      platform: 'Concentrator',
+      href: 'https://concentrator.aladdin.club/',
+    },
+    sdCrvCrvStakeDao: {
+      label: 'sdCRV/CRV',
+      platform: 'Stake DAO',
+      href: '/yield?search=0x32c1Cd7c991A1F40f5aF5701CDc7a6A95F900CD4',
+    },
+    spectraAsdToken: {
+      label: 'asdCRV',
+      platform: 'Spectra',
+      href: 'https://app.spectra.finance/pools#mainnet/0xc63dff67fe1b63004ab6c773022ba06847c11335',
+    },
+  },
+  fees: [
+    {
+      label: { key: 'liquidity', variable: 'sdCRV/CRV' },
+      value: 10,
+      key: 'liquidityFee',
+    },
+    {
+      label: { key: 'treasury' },
+      value: 5,
+      key: 'daoFee',
+    },
+    {
+      label: { key: 'harvesterOn', variable: '3CRV, CRV, crvUSD' },
+      value: 0.1,
+      token: 'crv',
+      key: 'claimerFee',
+    },
+  ],
+  extensions: {
+    coingeckoBaseSlug: 'curve-dao-token',
+  },
+}
+
+const curveLocker = async ({ provider, common, prices }: { provider; common; prices }) => {
+  const token = locker.token.address
+  const sdToken = locker.sdToken.address
+
+  const gauge = locker.modules.gauge
+  const depositor = locker.modules.depositor
+  const votingEscrow = locker.modules.veToken
+  const lockerAddress = locker.modules.locker
+
+  const veBoost = locker.veBoost!
+  const secondaryMarket = locker.secondaryMarket!
+  const rewards = locker.rewards
+
+  const now = Math.floor(Date.now() / 1000)
+  const lastWeek = Math.floor(now / ONE_WEEK) * ONE_WEEK
+  const pegBase = parseUnits(secondaryMarket?.pegBase?.toString() || '1', 18)
+
+  const format = (value: bigint) => formatUnits(value, locker.token.decimals)
+  const formatRes = (value: any) => format(getRes(value))
+
+  const calls: Call[] = [
+    /*********************************************************************************
+     *** Voting Escrow
+     *********************************************************************************/
+
+    // Token locked by the Locker
+    { address: votingEscrow, name: 'locked', params: [lockerAddress] },
+    // veToken Balance of the Locker
+    { address: votingEscrow, name: 'balanceOf', params: [lockerAddress] },
+    // Total token locked
+    { address: votingEscrow, name: 'supply' },
+    // Total veToken supply
+    { address: votingEscrow, name: 'totalSupply' },
+
+    /*********************************************************************************
+     *** Gauge
+     *********************************************************************************/
+
+    // Total sdToken staked
+    { address: gauge, name: 'totalSupply' },
+    // Gauge working supply
+    { address: gauge, name: 'working_supply' },
+
+    /*********************************************************************************
+     *** Token & sdToken
+     *********************************************************************************/
+
+    // Token balance not locked
+    { address: token, name: 'balanceOf', params: [depositor] },
+    // sdToken in secondary market pool
+    { address: sdToken, name: 'balanceOf', params: [secondaryMarket.pool] },
+
+    /*********************************************************************************
+     *** Peg
+     *********************************************************************************/
+
+    // Return amount when swapping {pegBase} sdToken to token -> get_dy(int128,int128,uint256)
+    { address: secondaryMarket.pool, name: '0x5e0d443f', params: [One, Zero, pegBase] },
+
+    /*********************************************************************************
+     *** Rewards
+     *********************************************************************************/
+
+    // Streaming status for each reward token
+    ...rewards.map((r) => ({ address: gauge, name: 'reward_data', params: [r.address] })),
+
+    /*********************************************************************************
+     *** veBoost
+     *********************************************************************************/
+
+    // Total veBoost delegated through delegator
+    { address: veBoost.delegator, name: 'totalSupply' },
+    // veBoost 5 last weeks rewards
+    ...range(0, 5).map((i) => ({
+      address: veBoost.delegator,
+      name: 'weeklyRewards',
+      params: [token, lastWeek - i * ONE_WEEK],
+    })),
+
+    /*********************************************************************************
+     *** Vote Booster (vsdToken)
+     *********************************************************************************/
+
+    // Token balance in Vote Booster contract
+    { address: token, name: 'balanceOf', params: [contracts.voteBoosterStrategy![1]] },
+    // sdToken balance in Vote Booster contract
+    { address: sdToken, name: 'balanceOf', params: [contracts.voteBoosterStrategy![1]] },
+    // Staked sdToken balance in Vote Booster contract
+    { address: gauge, name: 'balanceOf', params: [contracts.voteBoosterStrategy![1]] },
+    // Working balances of the Vote Booster contract
+    { address: gauge, name: 'working_balances', params: [contracts.voteBoosterStrategy![1]] },
+  ]
+
+  const res = await multicall(provider, calls, lockersMulticallAbi(locker.id, locker.chainId))
+  const raw = {
+    tokenLocked: getRes(res.shift()),
+    veBalanceOfLocker: formatRes(res.shift()),
+    totalTokenLocked: formatRes(res.shift()),
+    veTotalSupply: formatRes(res.shift()),
+    totalSupplyStaked: formatRes(res.shift()),
+    gaugeWorkingSupply: formatRes(res.shift()),
+    amountTokenNotLock: formatRes(res.shift()),
+    sdTokenInPool: formatRes(res.shift()),
+    peg: getRes(res.shift()),
+    rewards: rewards.map(() => getRes(res.shift())),
+    veBoost: {
+      delegated: formatRes(res.shift()),
+      weeklyRewards: range(0, 5).map(() => getRes(res.shift())),
+    },
+    voteBooster: {
+      token: formatRes(res.shift()),
+      sdToken: formatRes(res.shift()),
+      staked: formatRes(res.shift()),
+      working: formatRes(res.shift()),
+    },
+    veTokenRate: '4',
+    _workingSupply: '0',
+    _veBalanceOfLocker: '0',
+  }
+
+  raw.tokenLocked = format(raw.tokenLocked[0])
+  raw.voteBooster = parseVoteBoosterData(locker, raw.voteBooster) as any
+  raw.peg = parsePeg(locker, raw.peg)
+  raw._workingSupply = raw.gaugeWorkingSupply
+  raw._veBalanceOfLocker = raw.veBalanceOfLocker
+
+  return parse({ locker, common, prices, raw })
+}
+
+export default curveLocker

package/src/lockers/fetch/protocols/frax-fpis.ts

@@ -0,0 +1,139 @@
+import { STAKE_DAO_ASSETS_BASE_URL, tokenWithId } from '@stake-dao/constants'
+import { formatUnits } from 'viem'
+import lockersMulticallAbi from '../../../abis/lockersMulticall.js'
+import { type Call, getRes, multicall } from '../../../utils.js'
+import { parse, parsePeg } from '../parse.js'
+import type { Locker } from '../types.js'
+
+export const locker: Locker = {
+  id: 'fpis',
+  symbol: 'FPIS',
+  protocol: 'Frax',
+  protocolDescription:
+    'FPI is the first stablecoin pegged to a basket of real-world consumer items as defined by the US CPI-U average.',
+  website: 'https://frax.finance/',
+  logoUrl: `${STAKE_DAO_ASSETS_BASE_URL}/assets/archive/fpis.svg`,
+  chainId: 1,
+  rgb: '0, 0, 0',
+  token: tokenWithId('fpis')!,
+  sdToken: tokenWithId('sdfpis')!,
+  rewards: [{ ...tokenWithId('fpis')!, distribution: 'streamed', origin: 'native.common' }],
+  modules: {
+    depositor: '0x0000000000000000000000000000000000000000',
+    locker: '0x1ce5181124c33Abc281BF0F07eF4fB8573556aA5',
+    veToken: '0x574C154C83432B0A45BA3ad2429C3fA242eD7359',
+    gauge: '0xE58101D3848E12dAD6d7B5981dC11411bb267D2f',
+    accumulator: '0x644a15E85Aa4A56Afe1461e7ff4F75D733B26322',
+    redeem: '0x3e88f78D4e961366117EBC015e1EE8944EfbC574',
+  },
+  secondaryMarket: {
+    label: 'Curve',
+    poolKey: 'factory-v2-288',
+    vaultKey: '',
+    pool: '0x06c21b5d004604250a7f9639c4a3c28e73742261',
+    pools: ['0x06c21b5d004604250a7f9639c4a3c28e73742261'],
+    pegBase: 500,
+  },
+  fees: [
+    {
+      label: { key: 'liquidity', variable: 'sdFPIS/FPIS' },
+      value: 10,
+      key: 'liquidityFee',
+    },
+    {
+      label: { key: 'treasury' },
+      value: 5,
+      key: 'daoFee',
+    },
+    {
+      label: { key: 'harvester' },
+      value: 0.1,
+      key: 'claimerFee',
+    },
+  ],
+  extensions: {
+    coingeckoBaseSlug: 'frax-price-index-share',
+  },
+}
+
+const fraxFpisLocker = async ({ provider, common, prices }: { provider; common; prices }) => {
+  const token = locker.token.address
+  const sdToken = locker.sdToken.address
+
+  const gauge = locker.modules.gauge
+  const depositor = locker.modules.depositor
+  const votingEscrow = locker.modules.veToken
+  const lockerAddress = locker.modules.locker
+
+  const secondaryMarket = locker.secondaryMarket!
+  const rewards = locker.rewards
+
+  const format = (value: bigint) => formatUnits(value, locker.token.decimals)
+  const formatRes = (value: any) => format(getRes(value))
+
+  const calls: Call[] = [
+    /*********************************************************************************
+     *** Voting Escrow
+     *********************************************************************************/
+
+    // Token locked by the Locker
+    { address: votingEscrow, name: 'locked', params: [lockerAddress] },
+    // veToken Balance of the Locker
+    { address: votingEscrow, name: 'balanceOf', params: [lockerAddress] },
+    // Total token locked
+    { address: votingEscrow, name: 'supply' },
+    // Total veToken supply
+    { address: votingEscrow, name: 'totalSupply' },
+
+    /*********************************************************************************
+     *** Gauge
+     *********************************************************************************/
+
+    // Total sdToken staked
+    { address: gauge, name: 'totalSupply' },
+    // Gauge working supply
+    { address: gauge, name: 'working_supply' },
+
+    /*********************************************************************************
+     *** Token & sdToken
+     *********************************************************************************/
+
+    // Token balance not locked
+    { address: token, name: 'balanceOf', params: [depositor] },
+    // sdToken in secondary market pool
+    { address: sdToken, name: 'balanceOf', params: [secondaryMarket.pool] },
+
+    /*********************************************************************************
+     *** Rewards
+     *********************************************************************************/
+
+    // Streaming status for each reward token
+    ...rewards.map((r) => ({ address: gauge, name: 'reward_data', params: [r.address] })),
+  ]
+
+  const res = await multicall(provider, calls, lockersMulticallAbi(locker.id, locker.chainId))
+  const raw = {
+    tokenLocked: getRes(res.shift()),
+    veBalanceOfLocker: formatRes(res.shift()),
+    totalTokenLocked: formatRes(res.shift()),
+    veTotalSupply: formatRes(res.shift()),
+    totalSupplyStaked: formatRes(res.shift()),
+    gaugeWorkingSupply: formatRes(res.shift()),
+    amountTokenNotLock: formatRes(res.shift()),
+    sdTokenInPool: formatRes(res.shift()),
+    peg: '-',
+    rewards: rewards.map(() => getRes(res.shift())),
+    veTokenRate: '4',
+    _workingSupply: '0',
+    _veBalanceOfLocker: '0',
+  }
+
+  raw.tokenLocked = format(raw.tokenLocked[0])
+  raw.peg = parsePeg(locker, raw.peg)
+  raw._workingSupply = raw.gaugeWorkingSupply
+  raw._veBalanceOfLocker = raw.veBalanceOfLocker
+
+  return parse({ locker, common, prices, raw })
+}
+
+export default fraxFpisLocker