diff --git a/adapters/pancakeswap/package.json b/adapters/pancakeswap/package.json new file mode 100644 index 00000000..f7969400 --- /dev/null +++ b/adapters/pancakeswap/package.json @@ -0,0 +1,26 @@ +{ + "name": "pancakeswap", + "version": "1.0.0", + "description": "", + "main": "index.js", + "type": "commonjs", + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1", + "start": "node dist/index.js", + "compile": "tsc", + "watch": "tsc -w", + "clear": "rm -rf dist" + }, + "keywords": [], + "author": "", + "license": "UNLICENSED", + "dependencies": { + "csv-parser": "^3.0.0", + "fast-csv": "^5.0.1", + "viem": "^2.8.13" + }, + "devDependencies": { + "@types/node": "^20.11.17", + "typescript": "^5.3.3" + } +} \ No newline at end of file diff --git a/adapters/pancakeswap/src/index.ts b/adapters/pancakeswap/src/index.ts new file mode 100644 index 00000000..94db28e6 --- /dev/null +++ b/adapters/pancakeswap/src/index.ts @@ -0,0 +1,98 @@ +import { promisify } from 'util'; +import stream from 'stream'; +import csv from 'csv-parser'; +import fs from 'fs'; +import { write } from 'fast-csv'; + +import { BlockData, OutputSchemaRow } from './sdk/types'; +import { + getTimestampAtBlock, + getV3UserPositionsAtBlock, +} from './sdk/lib'; + +const pipeline = promisify(stream.pipeline); + +const readBlocksFromCSV = async ( + filePath: string, +): Promise => { + const blocks: number[] = []; + await pipeline( + fs.createReadStream(filePath), + csv(), + async function* (source) { + for await (const chunk of source) { + // Assuming each row in the CSV has a column 'block' with the block number + if (chunk.block) blocks.push(parseInt(chunk.block, 10)); + } + }, + ); + return blocks; +}; + +const getData = async () => { + const blocks = [3759558]; //await readBlocksFromCSV('src/sdk/mode_chain_daily_blocks.csv'); + + const csvRows: OutputSchemaRow[] = []; + + for (const block of blocks) { + const timestamp = await getTimestampAtBlock(block); + + csvRows.push( + ...(await getUserTVLByBlock({ + blockNumber: block, + blockTimestamp: timestamp, + })), + ); + } + + // Write the CSV output to a file + const ws = fs.createWriteStream('outputData.csv'); + write(csvRows, { headers: true }) + .pipe(ws) + .on('finish', () => { + console.log('CSV file has been written.'); + }); +}; + +export const getUserTVLByBlock = async ({ + blockNumber, + blockTimestamp, +}: BlockData): Promise => { + const result: OutputSchemaRow[] = []; + + const v3Positions = await getV3UserPositionsAtBlock(blockNumber); + + const combinedPositions = v3Positions; + const balances: Record> = {}; + for (const position of combinedPositions) { + balances[position.user] = balances[position.user] || {}; + + if (position.token0.balance > 0n) + balances[position.user][position.token0.address] = + (balances?.[position.user]?.[position.token0.address] ?? 0n) + + position.token0.balance; + + if (position.token1.balance > 0n) + balances[position.user][position.token1.address] = + (balances?.[position.user]?.[position.token1.address] ?? 0n) + + position.token1.balance; + } + + for (const [user, tokenBalances] of Object.entries(balances)) { + for (const [token, balance] of Object.entries(tokenBalances)) { + result.push({ + block_number: blockNumber, + timestamp: blockTimestamp, + user_address: user, + token_address: token, + token_balance: balance, + }); + } + } + + return result; +}; + +getData().then(() => { + console.log('Done'); +}); diff --git a/adapters/pancakeswap/src/sdk/config.ts b/adapters/pancakeswap/src/sdk/config.ts new file mode 100644 index 00000000..507994f2 --- /dev/null +++ b/adapters/pancakeswap/src/sdk/config.ts @@ -0,0 +1,10 @@ +import { createPublicClient, http } from 'viem'; +import { linea } from 'viem/chains'; + +export const V3_SUBGRAPH_URL = + 'https://api.studio.thegraph.com/query/45376/exchange-v3-linea/version/latest'; + +export const client = createPublicClient({ + chain: linea, + transport: http('https://rpc.linea.build'), +}); diff --git a/adapters/pancakeswap/src/sdk/lib.ts b/adapters/pancakeswap/src/sdk/lib.ts new file mode 100644 index 00000000..b81a2923 --- /dev/null +++ b/adapters/pancakeswap/src/sdk/lib.ts @@ -0,0 +1,157 @@ +import { V3_SUBGRAPH_URL, client } from './config'; +import { UserPosition } from './types'; + +type V3Position = { + id: string; + liquidity: string; + owner: string; + pool: { + sqrtPrice: string; + tick: string; + token0: { + id: string; + symbol: string; + }; + token1: { + id: string; + symbol: string; + }; + token0Price: string; + token1Price: string; + }; + tickLower: { + tickIdx: string; + }; + tickUpper: { + tickIdx: string; + }; +}; + +const getV3PositionReserves = (position: V3Position) => { + const liquidity = +position.liquidity; + const _sqrtPrice = +position.pool.sqrtPrice; + const currentTick = +position.pool.tick; + const tickLower = +position.tickLower.tickIdx; + const tickUpper = +position.tickUpper.tickIdx; + + let reserve0 = 0n; + let reserve1 = 0n; + + if (liquidity === 0) { + return { + reserve0, + reserve1, + }; + } + + const sqrtRatioA = Math.sqrt(1.0001 ** tickLower); + const sqrtRatioB = Math.sqrt(1.0001 ** tickUpper); + const sqrtPrice = _sqrtPrice / 2 ** 96; + + if (currentTick >= tickLower && currentTick < tickUpper) { + reserve0 = BigInt( + Math.floor( + liquidity * + ((sqrtRatioB - sqrtPrice) / (sqrtPrice * sqrtRatioB)), + ), + ); + reserve1 = BigInt( + Math.floor(liquidity * (sqrtPrice - sqrtRatioA)), + ); + } + + return { + reserve0, + reserve1, + }; +}; + +export const getV3UserPositionsAtBlock = async ( + blockNumber: number, +): Promise => { + const result: UserPosition[] = []; + + let skip = 0; + let fetchNext = true; + while (fetchNext) { + const query = `query { + positions( + first: 1000, + where: { liquidity_gt: 0, id_gt: ${skip} }, + block: { number: ${blockNumber} }, + orderBy: id + ) { + id + liquidity + owner + pool { + sqrtPrice + tick + token0 { + id + symbol + } + token1 { + id + symbol + } + token0Price + token1Price + } + tickLower { + tickIdx + } + tickUpper { + tickIdx + } + } + }`; + + const response = await fetch(V3_SUBGRAPH_URL, { + method: 'POST', + body: JSON.stringify({ query }), + headers: { 'Content-Type': 'application/json' }, + }); + + const { data } = await response.json(); + + const { positions } = data; + + result.push( + ...positions.map((position: V3Position) => { + const { reserve0, reserve1 } = + getV3PositionReserves(position); + return { + user: position.owner, + token0: { + address: position.pool.token0.id, + balance: reserve0, + symbol: position.pool.token0.symbol, + usdPrice: +position.pool.token0Price, + }, + token1: { + address: position.pool.token1.id, + balance: reserve1, + symbol: position.pool.token1.symbol, + usdPrice: +position.pool.token1Price, + }, + }; + }), + ); + + if (positions.length < 1000) { + fetchNext = false; + } else { + skip = positions[positions.length - 1].id; + } + } + + return result; +}; + +export const getTimestampAtBlock = async (blockNumber: number) => { + const block = await client.getBlock({ + blockNumber: BigInt(blockNumber), + }); + return Number(block.timestamp * 1000n); +}; diff --git a/adapters/pancakeswap/src/sdk/types.ts b/adapters/pancakeswap/src/sdk/types.ts new file mode 100644 index 00000000..8f9ba2d8 --- /dev/null +++ b/adapters/pancakeswap/src/sdk/types.ts @@ -0,0 +1,26 @@ +export interface BlockData { + blockNumber: number; + blockTimestamp: number; +} + +export type OutputSchemaRow = { + block_number: number; + timestamp: number; + user_address: string; + token_address: string; + token_balance: bigint; + token_symbol?: string; + usd_price?: number; +}; + +export type UserPosition = { + user: string; + token0: { + address: string, + balance: bigint, + } + token1: { + address: string, + balance: bigint, + } +} \ No newline at end of file diff --git a/adapters/pancakeswap/tsconfig.json b/adapters/pancakeswap/tsconfig.json new file mode 100644 index 00000000..8df9e19a --- /dev/null +++ b/adapters/pancakeswap/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