@stake-dao/reader 0.4.27 → 0.4.29

package/src/votemarket/generateProofs/getGaugeProof.ts

@@ -0,0 +1,75 @@
+import { http, createPublicClient, encodeAbiParameters, fromRlp, keccak256, toHex, toRlp } from 'viem'
+import { mainnet } from 'viem/chains'
+import { GaugeControllerConstants } from './config.js'
+
+type Rpcs = {
+  [chainId: number]: string
+}
+
+// Helper function to encode gauge time
+function _encodeGaugeTime(gauge: `0x${string}`, time: bigint, baseSlot: number): `0x${string}` {
+  const gaugeEncoded = keccak256(
+    encodeAbiParameters([{ type: 'uint256' }, { type: 'address' }], [BigInt(baseSlot), gauge]),
+  )
+  return keccak256(encodeAbiParameters([{ type: 'bytes32' }, { type: 'uint256' }], [gaugeEncoded, time]))
+}
+
+// Function to get storage slot for non-Curve protocols
+function getGaugeTimeStorageSlot(gauge: `0x${string}`, time: bigint, baseSlot: number): bigint {
+  const finalSlot = _encodeGaugeTime(gauge, time, baseSlot)
+  return BigInt(finalSlot)
+}
+
+// Function to get storage slot for Curve protocol (pre-Vyper 0.3)
+function getGaugeTimeStorageSlotPreVyper03(gauge: `0x${string}`, time: bigint, baseSlot: number): bigint {
+  const intermediateHash = _encodeGaugeTime(gauge, time, baseSlot)
+  const finalSlot = keccak256(encodeAbiParameters([{ type: 'bytes32' }], [intermediateHash]))
+  return BigInt(finalSlot)
+}
+
+// Main function to generate gauge proof
+export async function generateGaugeProof(
+  rpc: Rpcs,
+  protocol: string,
+  gaugeAddress: `0x${string}`,
+  currentPeriod: bigint,
+  blockNumber: bigint,
+): Promise<[string, string]> {
+  const publicClient = createPublicClient({
+    chain: mainnet,
+    transport: http(rpc[mainnet.id]),
+  })
+
+  const pointWeightsBaseSlot = GaugeControllerConstants.GAUGES_SLOTS[protocol].pointWeights
+
+  const positionFunctions: Record<string, any> = {
+    curve: getGaugeTimeStorageSlotPreVyper03,
+    default: getGaugeTimeStorageSlot,
+  }
+
+  const getPosition = positionFunctions[protocol] || positionFunctions.default
+  const pointWeightsPosition = getPosition!(gaugeAddress, currentPeriod, pointWeightsBaseSlot)
+
+  const slots = [toHex(pointWeightsPosition)]
+
+  const proof = await publicClient.getProof({
+    address: GaugeControllerConstants.GAUGE_CONTROLLER[protocol] as `0x${string}`,
+    storageKeys: slots,
+    blockNumber,
+  })
+
+  const decodedAccountProof = proof.accountProof.map((p) => fromRlp(p))
+  const accountProof = toRlp(decodedAccountProof)
+
+  const decodedStorageProof = proof.storageProof[0]!.proof.map((p) => fromRlp(p))
+  let storageProof = toRlp(decodedStorageProof)
+
+  // Add length prefix to match Python output for storage proof
+  const storageProofLength = (storageProof.length - 2) / 2 // subtract 2 for '0x' prefix
+  const storageProofLengthHex = storageProofLength.toString(16).padStart(4, '0')
+
+  // 0xf9 is the RLP prefix for a list longer than 55 bytes, followed by the length of the length (2 bytes), and then the length itself
+  storageProof = `0xf9${storageProofLengthHex}${storageProof.slice(2)}`
+
+  return [accountProof, storageProof]
+}

package/src/votemarket/generateProofs/getUserProof.ts

@@ -0,0 +1,74 @@
+import { http, createPublicClient, encodeAbiParameters, fromRlp, keccak256, toHex, toRlp } from 'viem'
+import { mainnet } from 'viem/chains'
+import { GaugeControllerConstants } from './config.js'
+
+type Rpcs = {
+  [chainId: number]: string
+}
+
+// Helper function to encode user gauge data
+function _encodeUserGaugeData(user: `0x${string}`, gauge: `0x${string}`, baseSlot: number): `0x${string}` {
+  const userEncoded = keccak256(
+    encodeAbiParameters([{ type: 'uint256' }, { type: 'address' }], [BigInt(baseSlot), user]),
+  )
+  return keccak256(encodeAbiParameters([{ type: 'bytes32' }, { type: 'address' }], [userEncoded, gauge]))
+}
+
+// Function to get storage slot for non-Curve protocols
+function getUserGaugeStorageSlot(user: `0x${string}`, gauge: `0x${string}`, baseSlot: number): bigint {
+  const finalSlot = _encodeUserGaugeData(user, gauge, baseSlot)
+  return BigInt(finalSlot)
+}
+
+// Function to get storage slot for Curve protocol (pre-Vyper 0.3)
+function getUserGaugeStorageSlotPreVyper03(user: `0x${string}`, gauge: `0x${string}`, baseSlot: number): bigint {
+  const intermediateHash = _encodeUserGaugeData(user, gauge, baseSlot)
+  const finalSlot = keccak256(encodeAbiParameters([{ type: 'bytes32' }], [intermediateHash]))
+  return BigInt(finalSlot)
+}
+
+// Main function to generate user proof
+export async function generateUserProof(
+  rpc: Rpcs,
+  protocol: string,
+  gaugeAddress: `0x${string}`,
+  user: `0x${string}`,
+  blockNumber: bigint,
+): Promise<[string, string]> {
+  const publicClient = createPublicClient({
+    chain: mainnet,
+    transport: http(rpc[mainnet.id]),
+  })
+
+  const lastUserVoteBaseSlot = GaugeControllerConstants.GAUGES_SLOTS[protocol].lastUserVote
+  const voteUserSlopeBaseSlot = GaugeControllerConstants.GAUGES_SLOTS[protocol].voteUserSlope
+
+  const lastUserVoteSlot = getUserGaugeStorageSlot(user, gaugeAddress, lastUserVoteBaseSlot)
+
+  const positionFunctions: Record<string, any> = {
+    curve: getUserGaugeStorageSlotPreVyper03,
+    default: getUserGaugeStorageSlot,
+  }
+
+  const getPosition = positionFunctions[protocol] || positionFunctions.default
+  const voteUserSlopeSlot = getPosition(user, gaugeAddress, voteUserSlopeBaseSlot)
+
+  const voteUserSlopeSlope = voteUserSlopeSlot
+  const voteUserSlopeEnd = voteUserSlopeSlot + 2n
+
+  const slots = [toHex(lastUserVoteSlot), toHex(voteUserSlopeSlope), toHex(voteUserSlopeEnd)]
+
+  const proof = await publicClient.getProof({
+    address: GaugeControllerConstants.GAUGE_CONTROLLER[protocol] as `0x${string}`,
+    storageKeys: slots,
+    blockNumber,
+  })
+
+  const decodedAccountProof = proof.accountProof.map((p) => fromRlp(p))
+  const accountProof = toRlp(decodedAccountProof)
+
+  const decodedStorageProof = proof.storageProof.map((sp) => sp.proof.map((p) => fromRlp(p)))
+  const storageProof = toRlp(decodedStorageProof)
+
+  return [accountProof, storageProof]
+}

package/src/votemarket/types.ts

@@ -1,7 +1,15 @@
+export type Period = {
+  rewardPerPeriod: string
+  rewardPerVote: string
+  leftover: string
+  updated: boolean
+}
+
 export type Campaign = {
   id: number
   chainId: number
   gauge: string
+  gaugeChainId: number
   manager: string
   rewardToken: {
     name: string
@@ -10,6 +18,7 @@ export type Campaign = {
     decimals: number
     chainId: number
   }
+  rewardTokenPrice: number
   numberOfPeriods: number
   maxRewardPerVote: string
   totalRewardAmount: string
@@ -17,17 +26,12 @@ export type Campaign = {
   startTimestamp: number
   endTimestamp: number
   hook: string
-  isKilled: boolean
+  isClosed: boolean
   addresses: string[]
   isWhitelist: boolean
   isBlacklist: boolean
-  currentPeriod: {
-    rewardPerPeriod: string
-    rewardPerVote: string
-    leftover: string
-    updated: boolean
-  }
-  totalPeriods: number
+  previousPeriod: Period
+  currentPeriod: Period
   periodLeft: number
   status: {
     voteOpen: boolean
@@ -36,4 +40,28 @@ export type Campaign = {
     claimClosed: boolean
     expired: boolean
   }
+  claimableAmount?: string
+}
+
+// RAW
+
+export type RawPeriod = {
+  rewardPerPeriod: bigint
+  rewardPerVote: bigint
+  leftover: bigint
+  updated: boolean
+}
+
+export type RawCampaign = {
+  chainId: bigint
+  endTimestamp: bigint
+  gauge: string
+  hook: string
+  manager: string
+  maxRewardPerVote: bigint
+  numberOfPeriods: number
+  rewardToken: bigint
+  startTimestamp: bigint
+  totalDistributed: bigint
+  totalRewardAmount: bigint
 }