From 36006dc1b421a5c6e17ed6e18677957eb801e811 Mon Sep 17 00:00:00 2001 From: bogdanuch Date: Thu, 28 Mar 2024 19:14:57 +0200 Subject: [PATCH 1/3] feat: created interport adapter --- adapters/interport/.idea/.gitignore | 5 ++ adapters/interport/package.json | 26 ++++++ adapters/interport/src/index.ts | 81 +++++++++++++++++ adapters/interport/src/utils/client.ts | 7 ++ adapters/interport/src/utils/constants.ts | 10 +++ adapters/interport/src/utils/vault-abi.ts | 34 ++++++++ adapters/interport/tsconfig.json | 101 ++++++++++++++++++++++ 7 files changed, 264 insertions(+) create mode 100644 adapters/interport/.idea/.gitignore create mode 100644 adapters/interport/package.json create mode 100644 adapters/interport/src/index.ts create mode 100644 adapters/interport/src/utils/client.ts create mode 100644 adapters/interport/src/utils/constants.ts create mode 100644 adapters/interport/src/utils/vault-abi.ts create mode 100644 adapters/interport/tsconfig.json diff --git a/adapters/interport/.idea/.gitignore b/adapters/interport/.idea/.gitignore new file mode 100644 index 00000000..b58b603f --- /dev/null +++ b/adapters/interport/.idea/.gitignore @@ -0,0 +1,5 @@ +# Default ignored files +/shelf/ +/workspace.xml +# Editor-based HTTP Client requests +/httpRequests/ diff --git a/adapters/interport/package.json b/adapters/interport/package.json new file mode 100644 index 00000000..c7da51a7 --- /dev/null +++ b/adapters/interport/package.json @@ -0,0 +1,26 @@ +{ + "name": "ledgityyield-calculator", + "version": "1.0.0", + "description": "", + "main": "index.js", + "scripts": { + "start": "node dist/index.js", + "compile": "tsc", + "watch": "tsc -w", + "clear": "rm -rf dist", + "test": "node " + }, + "keywords": [], + "author": "", + "license": "ISC", + "dependencies": { + "csv-parser": "^3.0.0", + "fast-csv": "^5.0.1", + "tsx": "^4.7.1", + "viem": "^2.9.4" + }, + "devDependencies": { + "@types/node": "^20.11.17", + "typescript": "^5.3.3" + } +} diff --git a/adapters/interport/src/index.ts b/adapters/interport/src/index.ts new file mode 100644 index 00000000..b683d39e --- /dev/null +++ b/adapters/interport/src/index.ts @@ -0,0 +1,81 @@ +import {client} from "./utils/client"; +import {searchStartBlock, vaultsAddresses} from "./utils/constants"; +import {vaultAbi} from "./utils/vault-abi" + +interface BlockData { + blockNumber: number; + blockTimestamp: number; +} + +type OutputDataSchemaRow = { + block_number: number; + timestamp: number; + user_address: string; + token_address: string; + token_balance: bigint; + token_symbol: string; //token symbol should be empty string if it is not available + usd_price: number; //assign 0 if not available +}; + +const getBlockTimestamp = async (blockNumber: bigint) => { + const data = await client.getBlock({ + blockNumber: blockNumber + }) + return Number(data.timestamp); +} + +const collectEvents = async (events: any[], token_symbol: string, isDeposit: boolean) => { + const csvRows: OutputDataSchemaRow[] = []; + for (let i = 0; i < events.length; i++) { + const { + args: {caller: user_address, assetAmount: token_balance}, + blockNumber, + address: token_address + } = events[i] + const timestamp = await getBlockTimestamp(blockNumber) + csvRows.push({ + block_number: Number(blockNumber), + timestamp, + user_address, + token_address, + token_balance: isDeposit ? token_balance : -token_balance, + token_symbol, + usd_price: 0 + }) + } + return csvRows; +} + +export const getUserTVLByBlock = async ( + blocks: BlockData +): Promise => { + const {blockNumber, blockTimestamp} = blocks + const allCsvRows: OutputDataSchemaRow[] = []; + for (let i = 0; i < vaultsAddresses.length; i++) { + const {address, token_symbol} = vaultsAddresses[i]; + let currentStartingBlock = searchStartBlock; + while (currentStartingBlock < blockNumber) { + const endBlock = currentStartingBlock + 799 > blockNumber ? blockNumber : currentStartingBlock + 799 + const depositEvents = await client.getContractEvents({ + address, + abi: vaultAbi, + eventName: "Deposit", + fromBlock: BigInt(currentStartingBlock), + toBlock: BigInt(endBlock), + }); + const depositCsvRows = await collectEvents(depositEvents, token_symbol, true); + + const withdrawEvents = await client.getContractEvents({ + address, + abi: vaultAbi, + eventName: "Withdraw", + fromBlock: BigInt(currentStartingBlock), + toBlock: BigInt(endBlock), + }); + const withdrawCsvRows = await collectEvents(withdrawEvents, token_symbol, false); + allCsvRows.push(...depositCsvRows, ...withdrawCsvRows) + currentStartingBlock = endBlock + } + } + return allCsvRows +} diff --git a/adapters/interport/src/utils/client.ts b/adapters/interport/src/utils/client.ts new file mode 100644 index 00000000..91ea0cbe --- /dev/null +++ b/adapters/interport/src/utils/client.ts @@ -0,0 +1,7 @@ +import { createPublicClient, http } from "viem"; +import { linea } from "viem/chains"; + +export const client = createPublicClient({ + chain: linea, + transport: http("https://linea.decubate.com"), +}); diff --git a/adapters/interport/src/utils/constants.ts b/adapters/interport/src/utils/constants.ts new file mode 100644 index 00000000..e5f5f003 --- /dev/null +++ b/adapters/interport/src/utils/constants.ts @@ -0,0 +1,10 @@ +export const vaultsAddresses: { address: `0x${string}`, token_symbol: string }[] = [ + { + address: "0x5b45B414c6CD2a3341bE70Ba22BE786b0124003F", token_symbol: "iUSDC" + }, + { + address: "0xEc8DDCb498b44C35EFaD7e5e43E0Caf6D16A66E8", token_symbol: "iUSDT" + } +] + +export const searchStartBlock = 3150005; diff --git a/adapters/interport/src/utils/vault-abi.ts b/adapters/interport/src/utils/vault-abi.ts new file mode 100644 index 00000000..5577dc65 --- /dev/null +++ b/adapters/interport/src/utils/vault-abi.ts @@ -0,0 +1,34 @@ +export const vaultAbi = [ + { + type: 'event', + name: 'Deposit', + inputs: [ + { + indexed: true, + name: 'caller', + type: 'address', + }, + { + indexed: false, + name: 'assetAmount', + type: 'uint256', + }, + ], + }, + { + type: 'event', + name: 'Withdraw', + inputs: [ + { + indexed: true, + name: 'caller', + type: 'address', + }, + { + indexed: false, + name: 'assetAmount', + type: 'uint256', + }, + ], + }, +] diff --git a/adapters/interport/tsconfig.json b/adapters/interport/tsconfig.json new file mode 100644 index 00000000..8df9e19a --- /dev/null +++ b/adapters/interport/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 80d793bf4fcd503a2bc93338a73abbcc45918918 Mon Sep 17 00:00:00 2001 From: bogdanuch Date: Tue, 16 Apr 2024 17:23:06 +0300 Subject: [PATCH 2/3] fix: removed idea folder --- adapters/interport/.idea/.gitignore | 5 ----- 1 file changed, 5 deletions(-) delete mode 100644 adapters/interport/.idea/.gitignore diff --git a/adapters/interport/.idea/.gitignore b/adapters/interport/.idea/.gitignore deleted file mode 100644 index b58b603f..00000000 --- a/adapters/interport/.idea/.gitignore +++ /dev/null @@ -1,5 +0,0 @@ -# Default ignored files -/shelf/ -/workspace.xml -# Editor-based HTTP Client requests -/httpRequests/ From 08c07eb62b4a712cad9a2dc214dbb33b000628ec Mon Sep 17 00:00:00 2001 From: bogdanuch Date: Thu, 18 Apr 2024 13:37:48 +0300 Subject: [PATCH 3/3] fix: changed event collection to work by Transfer events --- adapters/interport/src/index.ts | 56 ++++++++++++----------- adapters/interport/src/utils/constants.ts | 5 +- adapters/interport/src/utils/vault-abi.ts | 19 ++------ 3 files changed, 38 insertions(+), 42 deletions(-) diff --git a/adapters/interport/src/index.ts b/adapters/interport/src/index.ts index b683d39e..34a81141 100644 --- a/adapters/interport/src/index.ts +++ b/adapters/interport/src/index.ts @@ -1,5 +1,5 @@ import {client} from "./utils/client"; -import {searchStartBlock, vaultsAddresses} from "./utils/constants"; +import {searchStartBlock, stablecoinFarmAddress, vaultsAddresses, zeroAddress} from "./utils/constants"; import {vaultAbi} from "./utils/vault-abi" interface BlockData { @@ -24,24 +24,37 @@ const getBlockTimestamp = async (blockNumber: bigint) => { return Number(data.timestamp); } -const collectEvents = async (events: any[], token_symbol: string, isDeposit: boolean) => { +const collectTransferEvents = async (events: any[], token_symbol: string) => { const csvRows: OutputDataSchemaRow[] = []; for (let i = 0; i < events.length; i++) { const { - args: {caller: user_address, assetAmount: token_balance}, + args: {from: senderAddress_address, to: receiver_address, amount: token_balance}, blockNumber, address: token_address } = events[i] const timestamp = await getBlockTimestamp(blockNumber) - csvRows.push({ - block_number: Number(blockNumber), - timestamp, - user_address, - token_address, - token_balance: isDeposit ? token_balance : -token_balance, - token_symbol, - usd_price: 0 - }) + if(senderAddress_address !== stablecoinFarmAddress && senderAddress_address !== zeroAddress) { + csvRows.push({ + block_number: Number(blockNumber), + timestamp, + user_address: senderAddress_address, + token_address, + token_balance: -BigInt(token_balance), + token_symbol, + usd_price: 0 + }) + } + if (receiver_address !== stablecoinFarmAddress && receiver_address !== zeroAddress) { + csvRows.push({ + block_number: Number(blockNumber), + timestamp, + user_address: receiver_address, + token_address, + token_balance: BigInt(token_balance), + token_symbol, + usd_price: 0 + }) + } } return csvRows; } @@ -49,31 +62,22 @@ const collectEvents = async (events: any[], token_symbol: string, isDeposit: boo export const getUserTVLByBlock = async ( blocks: BlockData ): Promise => { - const {blockNumber, blockTimestamp} = blocks + const {blockNumber} = blocks const allCsvRows: OutputDataSchemaRow[] = []; for (let i = 0; i < vaultsAddresses.length; i++) { const {address, token_symbol} = vaultsAddresses[i]; let currentStartingBlock = searchStartBlock; while (currentStartingBlock < blockNumber) { const endBlock = currentStartingBlock + 799 > blockNumber ? blockNumber : currentStartingBlock + 799 - const depositEvents = await client.getContractEvents({ - address, - abi: vaultAbi, - eventName: "Deposit", - fromBlock: BigInt(currentStartingBlock), - toBlock: BigInt(endBlock), - }); - const depositCsvRows = await collectEvents(depositEvents, token_symbol, true); - - const withdrawEvents = await client.getContractEvents({ + const transferEvents = await client.getContractEvents({ address, abi: vaultAbi, - eventName: "Withdraw", + eventName: "Transfer", fromBlock: BigInt(currentStartingBlock), toBlock: BigInt(endBlock), }); - const withdrawCsvRows = await collectEvents(withdrawEvents, token_symbol, false); - allCsvRows.push(...depositCsvRows, ...withdrawCsvRows) + const transferCsvRows = await collectTransferEvents(transferEvents, token_symbol); + allCsvRows.push(...transferCsvRows) currentStartingBlock = endBlock } } diff --git a/adapters/interport/src/utils/constants.ts b/adapters/interport/src/utils/constants.ts index e5f5f003..acd793c5 100644 --- a/adapters/interport/src/utils/constants.ts +++ b/adapters/interport/src/utils/constants.ts @@ -5,6 +5,9 @@ export const vaultsAddresses: { address: `0x${string}`, token_symbol: string }[] { address: "0xEc8DDCb498b44C35EFaD7e5e43E0Caf6D16A66E8", token_symbol: "iUSDT" } -] +]; + +export const stablecoinFarmAddress = "0x29d44c17f4f83b3c77ae2eac4bc1468a496e3196"; +export const zeroAddress = "0x0000000000000000000000000000000000000000"; export const searchStartBlock = 3150005; diff --git a/adapters/interport/src/utils/vault-abi.ts b/adapters/interport/src/utils/vault-abi.ts index 5577dc65..d16280c2 100644 --- a/adapters/interport/src/utils/vault-abi.ts +++ b/adapters/interport/src/utils/vault-abi.ts @@ -1,32 +1,21 @@ export const vaultAbi = [ { type: 'event', - name: 'Deposit', + name: 'Transfer', inputs: [ { indexed: true, - name: 'caller', + name: 'from', type: 'address', }, - { - indexed: false, - name: 'assetAmount', - type: 'uint256', - }, - ], - }, - { - type: 'event', - name: 'Withdraw', - inputs: [ { indexed: true, - name: 'caller', + name: 'to', type: 'address', }, { indexed: false, - name: 'assetAmount', + name: 'amount', type: 'uint256', }, ],