From 18c93fcf0586aab425e2a1fe9ddae7a60c046a1b Mon Sep 17 00:00:00 2001 From: loc Date: Wed, 31 Jul 2024 13:53:41 +0000 Subject: [PATCH 1/6] Initial gamma strategies adapter --- adapters/gammastrategies/package.json | 25 +++ adapters/gammastrategies/src/config.ts | 20 ++ adapters/gammastrategies/src/index.ts | 258 +++++++++++++++++++++++++ adapters/gammastrategies/src/types.ts | 23 +++ adapters/gammastrategies/tsconfig.json | 101 ++++++++++ 5 files changed, 427 insertions(+) create mode 100644 adapters/gammastrategies/package.json create mode 100644 adapters/gammastrategies/src/config.ts create mode 100644 adapters/gammastrategies/src/index.ts create mode 100644 adapters/gammastrategies/src/types.ts create mode 100644 adapters/gammastrategies/tsconfig.json diff --git a/adapters/gammastrategies/package.json b/adapters/gammastrategies/package.json new file mode 100644 index 00000000..a5ba3bb6 --- /dev/null +++ b/adapters/gammastrategies/package.json @@ -0,0 +1,25 @@ +{ + "name": "gammastrategies", + "version": "1.0.0", + "description": "", + "main": "index.js", + "type": "commonjs", + "scripts": { + "start": "node dist/index.js", + "compile": "tsc", + "watch": "tsc -w", + "clear": "rm -rf dist", + "test": "node " + }, + "keywords": [], + "author": "", + "license": "UNLICENSED", + "dependencies": { + "csv-parser": "^3.0.0", + "fast-csv": "^5.0.1" + }, + "devDependencies": { + "@types/node": "^20.11.17", + "typescript": "^5.3.3" + } +} diff --git a/adapters/gammastrategies/src/config.ts b/adapters/gammastrategies/src/config.ts new file mode 100644 index 00000000..5bbf52d4 --- /dev/null +++ b/adapters/gammastrategies/src/config.ts @@ -0,0 +1,20 @@ +export const PAGE_SIZE = 1000; + +export const enum PROTOCOLS { + UNISWAP = 0, + LYNEX = 1, + LINEHUB = 2, + NILE = 3, + } + +export const SUBGRAPH_URLS = { + [PROTOCOLS.UNISWAP]: + "https://api.goldsky.com/api/public/project_clols2c0p7fby2nww199i4pdx/subgraphs/gamma-uniswap-linea/latest/gn", + [PROTOCOLS.LYNEX]: + "https://api.goldsky.com/api/public/project_clols2c0p7fby2nww199i4pdx/subgraphs/gamma-lynex-linea/latest/gn", + [PROTOCOLS.LINEHUB]: + "https://api.goldsky.com/api/public/project_clols2c0p7fby2nww199i4pdx/subgraphs/gamma-linehub-linea/latest/gn", + [PROTOCOLS.NILE]: + "https://api.goldsky.com/api/public/project_clols2c0p7fby2nww199i4pdx/subgraphs/gamma-nile-linea/latest/gn", + }; + diff --git a/adapters/gammastrategies/src/index.ts b/adapters/gammastrategies/src/index.ts new file mode 100644 index 00000000..aac8ed7f --- /dev/null +++ b/adapters/gammastrategies/src/index.ts @@ -0,0 +1,258 @@ +import csv from "csv-parser"; +import fs from "fs"; +import { write } from "fast-csv"; +import { PAGE_SIZE, PROTOCOLS, SUBGRAPH_URLS } from "./config"; +import { AccountBalances, BlockData, OutputDataSchemaRow } from "./types"; + + +const post = async (url: string, data: any): Promise => { + const response = await fetch(url, { + method: "POST", + headers: { + "Content-Type": "application/json", + Accept: "application/json", + }, + body: JSON.stringify(data), + }); + return await response.json(); +}; + +const getAccountData = async ( + protocol: PROTOCOLS, + lastId = "0" +): Promise => { + const ACCOUNTS_QUERY = `query { + accounts( + first: ${PAGE_SIZE}, + where: { id_gt: "${lastId}" }, + orderBy: id, + orderDirection: asc, + ){ + id + hypervisorShares( + first: 1000, + where: { shares_gt:0 }, + ) { + hypervisor { + id + pool { + token0 { + id + symbol + }, + token1 { + id + symbol + }, + }, + totalSupply, + tvl0, + tvl1, + tvlUSD, + }, + shares, + initialToken0, + initialToken1, + initialUSD, + } + } + }`; + + const responseJson = await post(SUBGRAPH_URLS[protocol], { + query: ACCOUNTS_QUERY, + }); + + let accountHoldings: AccountBalances = {}; + for (const account of responseJson.data.accounts) { + for (const hypeShare of account.hypervisorShares) { + accountHoldings[account.id] ??= {}; + + const shareOfPool = hypeShare.shares / hypeShare.hypervisor.totalSupply; + const tvl0Share = Math.round(shareOfPool * hypeShare.hypervisor.tvl0); + const tvl1Share = Math.round(shareOfPool * hypeShare.hypervisor.tvl1); + + const token0Address: string = hypeShare.hypervisor.pool.token0.id; + const token1Address: string = hypeShare.hypervisor.pool.token1.id; + + if (token0Address in accountHoldings) { + accountHoldings[account.id][token0Address].balance += tvl0Share; + } else { + accountHoldings[account.id][token0Address] = { + symbol: hypeShare.hypervisor.pool.token0.symbol, + balance: tvl0Share, + }; + } + + if (token1Address in accountHoldings) { + accountHoldings[account.id][token1Address].balance += tvl1Share; + } else { + accountHoldings[account.id][token1Address] = { + symbol: hypeShare.hypervisor.pool.token1.symbol, + balance: tvl1Share, + }; + } + } + } + + if (responseJson.data.accounts.length == PAGE_SIZE) { + const lastRecord = responseJson.data.accounts[ + responseJson.data.accounts.length - 1 + ] as any; + accountHoldings = { + ...accountHoldings, + ...(await getAccountData(protocol, lastRecord.id)), + }; + } + + return accountHoldings; +}; + +export const main = async (blocks: BlockData[]) => { + const allCsvRows: any[] = []; // Array to accumulate CSV rows for all blocks + const batchSize = 10; // Size of batch to trigger writing to the file + let i = 0; + + for (const block of blocks) { + try { + // Retrieve data using block number and timestamp + const csvRows = await getUserTVLByBlock(block); + + // Accumulate CSV rows for all blocks + allCsvRows.push(...csvRows); + + i++; + console.log(`Processed block ${i}`); + + // Write to file when batch size is reached or at the end of loop + if (i % batchSize === 0 || i === blocks.length) { + const ws = fs.createWriteStream(`outputData.csv`, { + flags: i === batchSize ? "w" : "a", + }); + write(allCsvRows, { headers: i === batchSize ? true : false }) + .pipe(ws) + .on("finish", () => { + console.log(`CSV file has been written.`); + }); + + // Clear the accumulated CSV rows + allCsvRows.length = 0; + } + } catch (error) { + console.error(`An error occurred for block ${block.blockNumber}:`, error); + } + } +}; + +export const getUserTVLByBlock = async (blocks: BlockData) => { + const { blockNumber, blockTimestamp } = blocks; + // Retrieve data using block number and timestamp + + const protocolData: AccountBalances[] = await Promise.all([ + getAccountData(PROTOCOLS.UNISWAP), + getAccountData(PROTOCOLS.LYNEX), + getAccountData(PROTOCOLS.LINEHUB), + getAccountData(PROTOCOLS.NILE), + ]); + + const allProtocolHoldings: AccountBalances = {}; + + // // Aggregate data from all protocols + protocolData.forEach((protocol) => { + Object.entries(protocol).forEach(([userAddress, tokens]) => { + allProtocolHoldings[userAddress] ??= {}; + Object.entries(tokens).forEach(([tokenAddress, token]) => { + if (tokenAddress in allProtocolHoldings[userAddress]) { + allProtocolHoldings[userAddress][tokenAddress].balance += + token.balance; + } else { + allProtocolHoldings[userAddress][tokenAddress] = { + symbol: token.symbol, + balance: token.balance, + }; + } + }); + }); + }); + + // Transform to required output + const csvRows: OutputDataSchemaRow[] = []; + + Object.entries(allProtocolHoldings).forEach( + ([userAddress, tokenBalances]) => { + Object.entries(tokenBalances).forEach(([tokenAddress, token]) => { + csvRows.push({ + block_number: blockNumber, + timestamp: blockTimestamp, + user_address: userAddress, + token_address: tokenAddress, + token_balance: token.balance, + token_symbol: token.symbol, + usd_price: 0, // Not available + }); + }); + } + ); + + return csvRows; +}; + +const readBlocksFromCSV = async (filePath: string): Promise => { + const blocks: BlockData[] = []; + + await new Promise((resolve, reject) => { + fs.createReadStream(filePath) + .pipe(csv()) // Specify the separator as '\t' for TSV files + .on("data", (row) => { + const blockNumber = parseInt(row.number, 10); + const blockTimestamp = parseInt(row.timestamp, 10); + if (!isNaN(blockNumber) && blockTimestamp) { + blocks.push({ blockNumber: blockNumber, blockTimestamp }); + } + }) + .on("end", () => { + resolve(); + }) + .on("error", (err) => { + reject(err); + }); + }); + + return blocks; +}; + +readBlocksFromCSV("hourly_blocks.csv") + .then(async (blocks: any[]) => { + const allCsvRows: any[] = []; // Array to accumulate CSV rows for all blocks + const batchSize = 1000; // Size of batch to trigger writing to the file + let i = 0; + + for (const block of blocks) { + try { + console.log(block); + const result = await getUserTVLByBlock(block); + allCsvRows.push(...result); + } catch (error) { + console.error( + `An error occurred for block ${block.blockNumber}:`, + error + ); + } + } + await new Promise((resolve, reject) => { + // const randomTime = Math.random() * 1000; + // setTimeout(resolve, randomTime); + const ws = fs.createWriteStream(`outputData.csv`, { flags: "w" }); + write(allCsvRows, { headers: true }) + .pipe(ws) + .on("finish", () => { + console.log(`CSV file has been written.`); + resolve; + }); + }); + + // Clear the accumulated CSV rows + // allCsvRows.length = 0; + }) + .catch((err) => { + console.error("Error reading CSV file:", err); + }); diff --git a/adapters/gammastrategies/src/types.ts b/adapters/gammastrategies/src/types.ts new file mode 100644 index 00000000..d78e45b2 --- /dev/null +++ b/adapters/gammastrategies/src/types.ts @@ -0,0 +1,23 @@ +export type OutputDataSchemaRow = { + block_number: number; + timestamp: number; + user_address: string; + token_address: string; + token_balance: number; + token_symbol: string; + usd_price: number; + }; + + export interface BlockData { + blockNumber: number; + blockTimestamp: number; + } + + export interface AccountBalances { + [userAddress: string]: { + [tokenAddress: string]: { + symbol: string; + balance: number; + }; + }; + } \ No newline at end of file diff --git a/adapters/gammastrategies/tsconfig.json b/adapters/gammastrategies/tsconfig.json new file mode 100644 index 00000000..8df9e19a --- /dev/null +++ b/adapters/gammastrategies/tsconfig.json @@ -0,0 +1,101 @@ +{ + "compilerOptions": { + /* Visit https://aka.ms/tsconfig to read more about this file */ + /* Projects */ + // "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */ + // "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */ + // "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */ + // "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */ + // "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */ + // "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */ + /* Language and Environment */ + "target": "es2022", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */ + // "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */ + // "jsx": "preserve", /* Specify what JSX code is generated. */ + // "experimentalDecorators": true, /* Enable experimental support for legacy experimental decorators. */ + // "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */ + // "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */ + // "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */ + // "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */ + // "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */ + // "noLib": true, /* Disable including any library files, including the default lib.d.ts. */ + // "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */ + // "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */ + /* Modules */ + "module": "commonjs", /* Specify what module code is generated. */ + "rootDir": "src/", /* Specify the root folder within your source files. */ + // "moduleResolution": "node10", /* Specify how TypeScript looks up a file from a given module specifier. */ + // "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */ + // "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */ + // "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */ + // "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */ + // "types": [], /* Specify type package names to be included without being referenced in a source file. */ + // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */ + // "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */ + // "allowImportingTsExtensions": true, /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */ + // "resolvePackageJsonExports": true, /* Use the package.json 'exports' field when resolving package imports. */ + // "resolvePackageJsonImports": true, /* Use the package.json 'imports' field when resolving imports. */ + // "customConditions": [], /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */ + // "resolveJsonModule": true, /* Enable importing .json files. */ + // "allowArbitraryExtensions": true, /* Enable importing files with any extension, provided a declaration file is present. */ + // "noResolve": true, /* Disallow 'import's, 'require's or ''s from expanding the number of files TypeScript should add to a project. */ + /* JavaScript Support */ + // "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */ + // "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */ + // "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */ + /* Emit */ + // "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */ + // "declarationMap": true, /* Create sourcemaps for d.ts files. */ + // "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */ + // "sourceMap": true, /* Create source map files for emitted JavaScript files. */ + // "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */ + // "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */ + "outDir": "dist/", /* Specify an output folder for all emitted files. */ + // "removeComments": true, /* Disable emitting comments. */ + // "noEmit": true, /* Disable emitting files from a compilation. */ + // "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */ + // "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */ + // "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */ + // "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */ + // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ + // "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */ + // "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */ + // "newLine": "crlf", /* Set the newline character for emitting files. */ + // "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */ + // "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */ + // "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */ + // "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */ + // "declarationDir": "./", /* Specify the output directory for generated declaration files. */ + // "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */ + /* Interop Constraints */ + // "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */ + // "verbatimModuleSyntax": true, /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */ + // "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */ + "esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */ + // "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */ + "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */ + /* Type Checking */ + "strict": true, /* Enable all strict type-checking options. */ + // "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */ + // "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */ + // "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */ + // "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */ + // "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */ + // "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */ + // "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */ + // "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */ + // "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */ + // "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */ + // "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */ + // "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */ + // "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */ + // "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */ + // "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */ + // "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */ + // "allowUnusedLabels": true, /* Disable error reporting for unused labels. */ + // "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */ + /* Completeness */ + // "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */ + "skipLibCheck": true /* Skip type checking all .d.ts files. */ + } +} \ No newline at end of file From c36de824ac9481ad5b037f34e1d4e3f46037eddf Mon Sep 17 00:00:00 2001 From: loc Date: Wed, 31 Jul 2024 14:01:11 +0000 Subject: [PATCH 2/6] remove unneeded logging --- adapters/gammastrategies/src/index.ts | 1 - 1 file changed, 1 deletion(-) diff --git a/adapters/gammastrategies/src/index.ts b/adapters/gammastrategies/src/index.ts index aac8ed7f..520798a3 100644 --- a/adapters/gammastrategies/src/index.ts +++ b/adapters/gammastrategies/src/index.ts @@ -228,7 +228,6 @@ readBlocksFromCSV("hourly_blocks.csv") for (const block of blocks) { try { - console.log(block); const result = await getUserTVLByBlock(block); allCsvRows.push(...result); } catch (error) { From 254750aa2ac8889c6dc4919b711523286f28bfc0 Mon Sep 17 00:00:00 2001 From: loc Date: Sat, 3 Aug 2024 09:47:13 +0000 Subject: [PATCH 3/6] simplify query --- adapters/gammastrategies/src/index.ts | 4 ---- 1 file changed, 4 deletions(-) diff --git a/adapters/gammastrategies/src/index.ts b/adapters/gammastrategies/src/index.ts index 520798a3..8ec0c528 100644 --- a/adapters/gammastrategies/src/index.ts +++ b/adapters/gammastrategies/src/index.ts @@ -48,12 +48,8 @@ const getAccountData = async ( totalSupply, tvl0, tvl1, - tvlUSD, }, shares, - initialToken0, - initialToken1, - initialUSD, } } }`; From 0000c4b525177d5855c4bc55966e03e7c8af88e7 Mon Sep 17 00:00:00 2001 From: loc Date: Sun, 11 Aug 2024 09:29:35 +0000 Subject: [PATCH 4/6] Exclude positions if out of range --- adapters/gammastrategies/src/index.ts | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/adapters/gammastrategies/src/index.ts b/adapters/gammastrategies/src/index.ts index 8ec0c528..b31255e4 100644 --- a/adapters/gammastrategies/src/index.ts +++ b/adapters/gammastrategies/src/index.ts @@ -4,7 +4,6 @@ import { write } from "fast-csv"; import { PAGE_SIZE, PROTOCOLS, SUBGRAPH_URLS } from "./config"; import { AccountBalances, BlockData, OutputDataSchemaRow } from "./types"; - const post = async (url: string, data: any): Promise => { const response = await fetch(url, { method: "POST", @@ -48,6 +47,11 @@ const getAccountData = async ( totalSupply, tvl0, tvl1, + tick, + baseLower, + baseUpper, + limitLower, + limitUpper, }, shares, } @@ -61,6 +65,18 @@ const getAccountData = async ( let accountHoldings: AccountBalances = {}; for (const account of responseJson.data.accounts) { for (const hypeShare of account.hypervisorShares) { + const isBaseInRange = + hypeShare.hypervisor.tick >= hypeShare.hypervisor.baseLower && + hypeShare.hypervisor.tick <= hypeShare.hypervisor.baseUpper; + const isLimitInRange = + hypeShare.hypervisor.tick >= hypeShare.hypervisor.limitLower && + hypeShare.hypervisor.tick <= hypeShare.hypervisor.limitUpper; + + // Exclude position if not in range + if (!isBaseInRange && !isLimitInRange) { + continue; + } + accountHoldings[account.id] ??= {}; const shareOfPool = hypeShare.shares / hypeShare.hypervisor.totalSupply; From a07dc5439e22218cbb82dd02dff8490b344dd0d0 Mon Sep 17 00:00:00 2001 From: matveyb Date: Mon, 12 Aug 2024 15:14:19 +0200 Subject: [PATCH 5/6] env var added --- adapters/overnight/src/sdk/config.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/adapters/overnight/src/sdk/config.ts b/adapters/overnight/src/sdk/config.ts index 701104c4..18955c62 100644 --- a/adapters/overnight/src/sdk/config.ts +++ b/adapters/overnight/src/sdk/config.ts @@ -47,7 +47,7 @@ export const SNAPSHOTS_BLOCKS = [ export const CHUNKS_SPLIT = 30; export const BLOCK_STEP = 10000; -export const LINEA_RPC = "https://lb.drpc.org/ogrpc?network=linea&dkey=AsCWb9aYukugqNphr9pEGw5L893HadYR7ooVbrjxQOzW" +export const LINEA_RPC = `https://lb.drpc.org/ogrpc?network=linea&dkey=${process.env.OVERNIGHT_RPC}` export const LP_LYNEX_SYMBOL = "oLYNX"; export const LP_LYNEX = "0x63349BA5E1F71252eCD56E8F950D1A518B400b60" From 7603743ba98ab2a8dacb217e4d8bf1d5a848cd5f Mon Sep 17 00:00:00 2001 From: Zypher Penguin <171915078+web3-penguin@users.noreply.github.com> Date: Mon, 19 Aug 2024 09:50:24 +0800 Subject: [PATCH 6/6] feat: add Zypher Restaking TVL --- adapters/zypher/package.json | 23 ++ adapters/zypher/src/index.ts | 221 ++++++++++++++++++ adapters/zypher/test/sample.hourly_blocks.csv | 5 + adapters/zypher/test/sample.outputData.csv | 4 + adapters/zypher/tsconfig.json | 101 ++++++++ 5 files changed, 354 insertions(+) create mode 100644 adapters/zypher/package.json create mode 100644 adapters/zypher/src/index.ts create mode 100644 adapters/zypher/test/sample.hourly_blocks.csv create mode 100644 adapters/zypher/test/sample.outputData.csv create mode 100644 adapters/zypher/tsconfig.json diff --git a/adapters/zypher/package.json b/adapters/zypher/package.json new file mode 100644 index 00000000..81bbe1d7 --- /dev/null +++ b/adapters/zypher/package.json @@ -0,0 +1,23 @@ +{ + "name": "zypher-restaking", + "version": "1.0.0", + "description": "", + "main": "index.js", + "type": "commonjs", + "scripts": { + "start": "node dist/index.js", + "compile": "tsc", + "watch": "tsc -w", + "clear": "rm -rf dist", + "test": "if [ ! -f hourly_blocks.csv ]; then ln -s test/sample.hourly_blocks.csv hourly_blocks.csv; fi && npm run compile && npm run start" + }, + "license": "UNLICENSED", + "dependencies": { + "fast-csv": "^5.0.1", + "csv-parser": "^3.0.0" + }, + "devDependencies": { + "@types/node": "^20.11.17", + "typescript": "^5.3.3" + } +} diff --git a/adapters/zypher/src/index.ts b/adapters/zypher/src/index.ts new file mode 100644 index 00000000..01b991d3 --- /dev/null +++ b/adapters/zypher/src/index.ts @@ -0,0 +1,221 @@ +import csv from 'csv-parser'; +import fs from 'fs'; +import { write } from 'fast-csv'; + +/** + * The objective is to quantify: + * - Zypher Restaking TVL on Linea (currently only on Linea Sepolia) + * - List all users deposited balances in Zypher Restaking + * + * Currently, because the `linea-testnet` provided by Goldsky still points to Linea Goerli, + * we use our own deployment of graph-node to query the relevant data. + * + * After the product is launched on mainnet, we will try to use the services provided by Goldsky. + */ + +type OutputDataSchemaRow = { + block_number: number; + timestamp: number; + user_address: string; + token_address: string; + token_balance: number; + token_symbol: string; + usd_price: number; +} + +interface BlockData { + blockNumber: number; + blockTimestamp: number; +} + +const ZypherRestakingSubgraphEndpoints: Record = { + GoldskyAPI: 'https://api.goldsky.com/api/public/project_clzbcvp9w9t5k011f7hbvc17s/subgraphs/zypher-restaking/linea-mainnet/gn', + SelfHostedGraphNode: 'https://linea-mainnet-graph.zypher.game/subgraphs/name/restaking/public', +} + +const ChainlinkPriceFeeds: Record = { + ETH_USD: '0x0635163285c6ef5692167f18b799fb339df064f8', +} + +const DEFAULT_PAGE_SIZE = 1_000 + +const post = async (url: string, data: any): Promise => { + const response = await fetch(url, { + method: 'POST', + headers: { + 'Content-Type': 'application/json', + Accept: 'application/json', + }, + body: JSON.stringify(data), + }); + return response.json(); +}; + +const getAllDepositBalances = async ( + blockNumber: number, + blockTimestamp: number, + limit: number = DEFAULT_PAGE_SIZE, + offset: number = 0, + list: OutputDataSchemaRow[] = [] +): Promise => { + const QUERY_USER_ASSETS = ` + query ZypherRestakingBalances { + users( + first: ${limit}, + skip: ${offset}, + block: { number: ${blockNumber} } + ) { + id + assets(where: { balance_gt: 0 }) { + token { + id + symbol + } + balance + } + } + dataFeed( + id: "${ChainlinkPriceFeeds.ETH_USD}", + block: { number: ${blockNumber} } + ) { + value + decimals + } + } + `; + + const responseJson = await post(ZypherRestakingSubgraphEndpoints.GoldskyAPI, { + query: QUERY_USER_ASSETS, + }); + + if (responseJson.errors) { + throw new Error(responseJson.errors[0].message); + } + + const { + decimals, + value: valueETH, + } = responseJson.data.dataFeed; + const priceETH = parseInt(valueETH.slice(0, 3 - decimals), 10) / 1000; + + for (const user of responseJson.data.users) { + for (const asset of user.assets) { + list.push({ + block_number: blockNumber, + timestamp: blockTimestamp, + user_address: user.id, + token_address: asset.token.id, + token_balance: asset.balance, + token_symbol: asset.token.symbol, + usd_price: priceETH, + }); + } + } + + return responseJson.data.users.length === limit + // recursively fetch the next page + ? getAllDepositBalances(blockNumber, blockTimestamp, limit, offset + limit, list) + : list; +}; + +export const main = async (blocks: BlockData[]) => { + const allCsvRows: any[] = []; // Array to accumulate CSV rows for all blocks + const batchSize = 10; // Size of batch to trigger writing to the file + let i = 0; + + for (const { blockNumber, blockTimestamp } of blocks) { + try { + // Retrieve data using block number and timestamp + const csvRows = await getAllDepositBalances( + blockNumber, + blockTimestamp + ); + + // Accumulate CSV rows for all blocks + allCsvRows.push(...csvRows); + + i++; + console.log(`Processed block ${i}`); + + // Write to file when batch size is reached or at the end of loop + if (i % batchSize === 0 || i === blocks.length) { + const ws = fs.createWriteStream(`outputData.csv`, { + flags: i === batchSize ? 'w' : 'a', + }); + write(allCsvRows, { headers: i === batchSize }) + .pipe(ws) + .on("finish", () => { + console.log(`CSV file has been written.`); + }); + + // Clear the accumulated CSV rows + allCsvRows.length = 0; + } + } catch (error) { + console.error(`An error occurred for block ${blockNumber}:`, error); + } + } +}; + +export const getUserTVLByBlock = async (block: BlockData) => { + const { blockNumber, blockTimestamp } = block; + + // Retrieve data using block number and timestamp + const csvRows = await getAllDepositBalances( + blockNumber, + blockTimestamp + ); + + return csvRows; +}; + +const readBlocksFromCSV = async (filePath: string): Promise => { + const blocks: BlockData[] = []; + + await new Promise((resolve, reject) => { + fs.createReadStream(filePath) + .pipe(csv()) // Specify the separator as '\t' for TSV files + .on('data', (row) => { + const blockNumber = parseInt(row.number, 10); + const blockTimestamp = parseInt(row.timestamp, 10); + if (!isNaN(blockNumber) && blockTimestamp) { + blocks.push({ blockNumber: blockNumber, blockTimestamp }); + } + }) + .on('end', () => { + resolve(); + }) + .on('error', (err) => { + reject(err); + }); + }); + + return blocks; +}; + +readBlocksFromCSV('hourly_blocks.csv').then(async (blocks: BlockData[]) => { + console.log(blocks); + const allCsvRows: OutputDataSchemaRow[] = []; + + for (const block of blocks) { + try { + const result = await getUserTVLByBlock(block); + allCsvRows.push(...result); + } catch (error) { + console.error(`An error occurred for block ${block.blockNumber}:`, error); + } + } + + await new Promise((resolve, reject) => { + const ws = fs.createWriteStream(`outputData.csv`, { flags: 'w' }); + write(allCsvRows, { headers: true }) + .pipe(ws) + .on('finish', () => { + console.log(`CSV file has been written.`); + resolve(true); + }); + }); + +}).catch((err) => { + console.error('Error reading CSV file:', err); +}); diff --git a/adapters/zypher/test/sample.hourly_blocks.csv b/adapters/zypher/test/sample.hourly_blocks.csv new file mode 100644 index 00000000..ca143e54 --- /dev/null +++ b/adapters/zypher/test/sample.hourly_blocks.csv @@ -0,0 +1,5 @@ +number,timestamp +8064000,1723503539 +8065000,1723505539 +8066000,1723507539 +8314100,1724005251 diff --git a/adapters/zypher/test/sample.outputData.csv b/adapters/zypher/test/sample.outputData.csv new file mode 100644 index 00000000..dcab34d1 --- /dev/null +++ b/adapters/zypher/test/sample.outputData.csv @@ -0,0 +1,4 @@ +block_number,timestamp,user_address,token_address,token_balance,token_symbol,usd_price +8065000,1723505539,0xcaa8ffac90954ed16b1024ba1cd451b73f9ff13d,0xe5d7c2a44ffddf6b295a15c148167daaaf5cf34f,1000000000000000,WETH,2645.06 +8066000,1723507539,0xcaa8ffac90954ed16b1024ba1cd451b73f9ff13d,0xe5d7c2a44ffddf6b295a15c148167daaaf5cf34f,1000000000000000,WETH,2645.06 +8314100,1724005251,0xcaa8ffac90954ed16b1024ba1cd451b73f9ff13d,0xe5d7c2a44ffddf6b295a15c148167daaaf5cf34f,900000000000000,WETH,2636.761 diff --git a/adapters/zypher/tsconfig.json b/adapters/zypher/tsconfig.json new file mode 100644 index 00000000..51232c53 --- /dev/null +++ b/adapters/zypher/tsconfig.json @@ -0,0 +1,101 @@ +{ + "compilerOptions": { + /* Visit https://aka.ms/tsconfig to read more about this file */ + /* Projects */ + // "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */ + // "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */ + // "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */ + // "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */ + // "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */ + // "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */ + /* Language and Environment */ + "target": "es2022", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */ + // "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */ + // "jsx": "preserve", /* Specify what JSX code is generated. */ + // "experimentalDecorators": true, /* Enable experimental support for legacy experimental decorators. */ + // "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */ + // "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */ + // "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */ + // "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */ + // "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */ + // "noLib": true, /* Disable including any library files, including the default lib.d.ts. */ + // "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */ + // "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */ + /* Modules */ + "module": "commonjs", /* Specify what module code is generated. */ + "rootDir": "src/", /* Specify the root folder within your source files. */ + // "moduleResolution": "node10", /* Specify how TypeScript looks up a file from a given module specifier. */ + // "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */ + // "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */ + // "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */ + // "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */ + // "types": [], /* Specify type package names to be included without being referenced in a source file. */ + // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */ + // "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */ + // "allowImportingTsExtensions": true, /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */ + // "resolvePackageJsonExports": true, /* Use the package.json 'exports' field when resolving package imports. */ + // "resolvePackageJsonImports": true, /* Use the package.json 'imports' field when resolving imports. */ + // "customConditions": [], /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */ + // "resolveJsonModule": true, /* Enable importing .json files. */ + // "allowArbitraryExtensions": true, /* Enable importing files with any extension, provided a declaration file is present. */ + // "noResolve": true, /* Disallow 'import's, 'require's or ''s from expanding the number of files TypeScript should add to a project. */ + /* JavaScript Support */ + // "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */ + // "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */ + // "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */ + /* Emit */ + // "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */ + // "declarationMap": true, /* Create sourcemaps for d.ts files. */ + // "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */ + // "sourceMap": true, /* Create source map files for emitted JavaScript files. */ + // "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */ + // "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */ + "outDir": "dist/", /* Specify an output folder for all emitted files. */ + // "removeComments": true, /* Disable emitting comments. */ + // "noEmit": true, /* Disable emitting files from a compilation. */ + // "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */ + // "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */ + // "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */ + // "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */ + // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ + // "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */ + // "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */ + // "newLine": "crlf", /* Set the newline character for emitting files. */ + // "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */ + // "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */ + // "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */ + // "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */ + // "declarationDir": "./", /* Specify the output directory for generated declaration files. */ + // "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */ + /* Interop Constraints */ + // "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */ + // "verbatimModuleSyntax": true, /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */ + // "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */ + "esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */ + // "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */ + "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */ + /* Type Checking */ + "strict": true, /* Enable all strict type-checking options. */ + // "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */ + // "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */ + // "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */ + // "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */ + // "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */ + // "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */ + // "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */ + // "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */ + // "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */ + // "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */ + // "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */ + // "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */ + // "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */ + // "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */ + // "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */ + // "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */ + // "allowUnusedLabels": true, /* Disable error reporting for unused labels. */ + // "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */ + /* Completeness */ + // "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */ + "skipLibCheck": true /* Skip type checking all .d.ts files. */ + } +}