{"_id":"@dfk-tools/transaction-history-report-generator","_rev":"2-54c78852aad5e5f5c7a86bf50f36fb8b","name":"@dfk-tools/transaction-history-report-generator","dist-tags":{"latest":"0.1.1"},"versions":{"0.1.0":{"name":"@dfk-tools/transaction-history-report-generator","version":"0.1.0","description":"JavaScript library used to collect and generate reports on historical transactions across multiple EVM chains for Defi Kingdoms.","license":"MIT","keywords":["harmony","harmony-one","defikingdoms"],"homepage":"https://github.com/dfk-tools/transaction-history-report-generator#readme","bugs":{"url":"https://github.com/dfk-tools/transaction-history-report-generator/issues"},"author":{"name":"Matthew Downs","email":"matthew.downsc@gmail.com"},"repository":{"type":"git","url":"git+https://github.com/dfk-tools/transaction-history-report-generator.git"},"main":"index.js","scripts":{"prebuild":"rimraf ./dist","build":"tsc -p .","postbuild":"node ./scripts/postbuild.js","lint":"eslint .","test":"jest","wizard":"ts-node ./scripts/wizard.ts"},"dependencies":{"@harmony-js/core":"^0.1.57","axios":"^0.24.0","bignumber.js":"^9.0.2","exceljs":"^4.3.0","moment":"^2.29.1","uuid":"^8.3.2"},"devDependencies":{"@babel/core":"^7.15.8","@babel/preset-env":"^7.16.4","@babel/preset-typescript":"^7.15.0","@types/jest":"^27.0.3","@types/node":"^16.11.11","@types/prompts":"^2.0.14","@types/rimraf":"^3.0.2","@types/uuid":"^8.3.3","@typescript-eslint/eslint-plugin":"^5.5.0","@typescript-eslint/parser":"^5.5.0","babel-jest":"^27.3.1","concurrently":"^6.4.0","eslint":"^8.3.0","jest":"^27.4.3","nodemon":"^2.0.15","prompts":"^2.4.2","rimraf":"^3.0.2","ts-jest":"^27.0.7","ts-node":"^10.4.0","typescript":"^4.5.2"},"engines":{"node":">=14 <=16"},"private":false,"types":"./index.d.ts","gitHead":"4e134d6c2d400530b083bf15df3c7fdba9d49fd6","_id":"@dfk-tools/transaction-history-report-generator@0.1.0","_nodeVersion":"16.13.0","_npmVersion":"8.1.0","dist":{"integrity":"sha512-5rudfQElofUZz6v445hEc2//Mk2Fxbf/NM3Tk/ipgOUEY1u0wy2LXdJjOm6EpMJXiYSYBqR3AoBohYdZN29WPg==","shasum":"62b400cce29c7c0a7b75c832c7ebbd95568074d3","tarball":"https://registry.npmjs.org/@dfk-tools/transaction-history-report-generator/-/transaction-history-report-generator-0.1.0.tgz","fileCount":58,"unpackedSize":34149,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhulVVCRA9TVsSAnZWagAAlnEQAIB3wS6jsl6SM8JHYibA\nYG4OLcOUascwkB2AJywtfSM2VvT3+oiVtj6nzWS2cDs+FSG4Ok4LvGH6vKG9\ngDsnhtdzCfCtrriVzHDe7/9in1kbMZaC9mRAeijFmLtRyTtqgGl0mlmeBPH8\n89cO31MoAQQ5Fzqr0XIidFihrf1B+aGX71u2w2YA155ha+HX1WL5uE+evbLB\nxSWLtlbxAsc/62BPmBrqms9gE/YUlKSpxXr3Wo7XEFWOpbnkZRKzMRzU6GG0\nQtI45fZ35RpZ56yedG24TGQJtdRZhfbCtiwm7AeHnh7D7ImZeCPtTJclpiol\nFXKplUAfRG2DWNS/YJDPpecsMULhrO/g/zS/FWUXv+Y/eEb0RzsnvajPYwlq\nVMJWinBwyZB7cLLifP8HfDRiVx5/X4jOJ1wb+EU0WRyyoYofqRgOOr4DHsc9\nyB4BiOcPXWlIPSPQJoYtBwrOiP5Xm8ny5SVwt2GtdH8/6sGO8HEMTLGOJW/S\nlep2H9JgwckVYGkxKEITwCu2VH3Sn30/MTBmSe91o0yIA4ubRXEb+kKGlcL0\nLuGYp4PY7qqefRzbOowMH6AWj+qiah4pqnD+6XXDXJE2ma6beVkgWU5fL7re\nomMQyQ9/zBSrQuNER48Hdx8rFlX0ZV8X0+E9bltz8Y514FbOicPtOay4f93G\nH0R4\r\n=t6yI\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIFKkPhZ44MTndYRUwBolfWYw5xbSPqTU06qMBo8cpuJvAiEAwSTrKgpH+t+xIW+St0tjjtW12IasrWd6m3YuBx1e7sI="}]},"_npmUser":{"name":"matthewdowns","email":"matthew.downsc@gmail.com"},"directories":{},"maintainers":[{"name":"matthewdowns","email":"matthew.downsc@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/transaction-history-report-generator_0.1.0_1639601492713_0.16540375437695798"},"_hasShrinkwrap":false},"0.1.1":{"name":"@dfk-tools/transaction-history-report-generator","version":"0.1.1","description":"JavaScript library used to collect and generate reports on historical transactions across multiple EVM chains for Defi Kingdoms.","license":"MIT","keywords":["harmony","harmony-one","defikingdoms"],"homepage":"https://github.com/dfk-tools/transaction-history-report-generator#readme","bugs":{"url":"https://github.com/dfk-tools/transaction-history-report-generator/issues"},"author":{"name":"Matthew Downs","email":"matthew.downsc@gmail.com"},"repository":{"type":"git","url":"git+https://github.com/dfk-tools/transaction-history-report-generator.git"},"main":"index.js","scripts":{"prebuild":"rimraf ./dist","build":"tsc -p .","postbuild":"node ./scripts/postbuild.js","lint":"eslint .","test":"jest","wizard":"ts-node ./scripts/wizard.ts"},"dependencies":{"@harmony-js/core":"^0.1.57","axios":"^0.24.0","bignumber.js":"^9.0.2","exceljs":"^4.3.0","moment":"^2.29.1","uuid":"^8.3.2"},"devDependencies":{"@babel/core":"^7.15.8","@babel/preset-env":"^7.16.4","@babel/preset-typescript":"^7.15.0","@types/jest":"^27.0.3","@types/node":"^16.11.11","@types/prompts":"^2.0.14","@types/rimraf":"^3.0.2","@types/uuid":"^8.3.3","@typescript-eslint/eslint-plugin":"^5.5.0","@typescript-eslint/parser":"^5.5.0","babel-jest":"^27.3.1","concurrently":"^6.4.0","eslint":"^8.3.0","jest":"^27.4.3","nodemon":"^2.0.15","prompts":"^2.4.2","rimraf":"^3.0.2","ts-jest":"^27.0.7","ts-node":"^10.4.0","typescript":"^4.5.2"},"engines":{"node":">=14 <=16"},"private":false,"types":"./index.d.ts","gitHead":"1781eb0c9c3e4dfd83779f4770a6c238a3b3d108","_id":"@dfk-tools/transaction-history-report-generator@0.1.1","_nodeVersion":"16.13.0","_npmVersion":"8.1.0","dist":{"integrity":"sha512-2aWvb7AyehiKokiZfD7dvGgjOZqWaNtsrMjg47CD+TDmyJbRAqw+3OUuQ4t4VjNa3VNnnKqtgBDzAn808kiRxg==","shasum":"6683bfe102a7f55432a417568482d3d77e62567f","tarball":"https://registry.npmjs.org/@dfk-tools/transaction-history-report-generator/-/transaction-history-report-generator-0.1.1.tgz","fileCount":58,"unpackedSize":34287,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhvBuZCRA9TVsSAnZWagAASwoP/3H+yT1V9A7NhT3d1RCD\nMsmQM/q9VRuu9F7Zewl+zECucwm+ZAKi9PKzoJegicCdFkE3jzLj+kiJGkEe\nizqPYhOSGgXCydVcuZV/YVRPLOegzfJCeiYVb1JJJJgTuRqjvTwIZPNfhH4i\n4+olzuQmmDXeZbWAlVFlEVdpqfuPtveyR7jfsjdgWmjSJE2e1s53u/doU0GQ\nDtqgZe8egAiRcbVzCetvdal1S7qFvoJXs2uDg7QHRmoCAdmTe5y0azWEky26\nnBv1stdWY12Uz0v9DY5fZ5ol+2lOj8u8A1x5iBmfG+HF06YFgLfDDZca8HCq\n5A64uZ211jEPBai5cCSlhefxPQmvu+ZiMJAzCVGH7YHVmTdkEmdDkZa510Vp\nw5sjxQW3kp76xVbWqtbSvbY1hrLqcRsaCaXUet0Dwd3buw+Uj4afbEAQ+wWj\nXa2cw7mBWw/4OlCiDHPOHIi8nLwi7sDNOOHhV2xPgCGJK1BMAehkkhpoRgKn\nof0Y0nio3igB5u1fsACEaQnJb5hXgXY0s8Dre18GdskRYcR0wmPuHo+hpigJ\nzo2SCGcj1M08fg5VGvpi855JeDiKT/08dNCVkLNMHlX4SaBnZoN7cwz0t18u\nsWBVv7lqsgol49VoMFDAxkbNkrSrdEw6qYLykmILUgAOEILUg9sk4iI1JdIM\nhemT\r\n=9tJX\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIF6lv2YgW2s6rxMVu8M3EAQHTQyuJ34JMWi4oMHAUmC/AiAY2wjxlWTCeL6MoMeL1LcrWsh1kW6ZHAmJ3cd66yKjQA=="}]},"_npmUser":{"name":"matthewdowns","email":"matthew.downsc@gmail.com"},"directories":{},"maintainers":[{"name":"matthewdowns","email":"matthew.downsc@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/transaction-history-report-generator_0.1.1_1639717784975_0.9449908657228181"},"_hasShrinkwrap":false}},"time":{"created":"2021-12-15T20:51:32.607Z","0.1.0":"2021-12-15T20:51:33.051Z","modified":"2022-04-05T04:17:08.894Z","0.1.1":"2021-12-17T05:09:45.148Z"},"maintainers":[{"name":"matthewdowns","email":"matthew.downsc@gmail.com"}],"description":"JavaScript library used to collect and generate reports on historical transactions across multiple EVM chains for Defi Kingdoms.","homepage":"https://github.com/dfk-tools/transaction-history-report-generator#readme","keywords":["harmony","harmony-one","defikingdoms"],"repository":{"type":"git","url":"git+https://github.com/dfk-tools/transaction-history-report-generator.git"},"author":{"name":"Matthew Downs","email":"matthew.downsc@gmail.com"},"bugs":{"url":"https://github.com/dfk-tools/transaction-history-report-generator/issues"},"license":"MIT","readme":"# Transaction History Report Generator\n\nJavaScript library used to collect and generate reports on historical transactions across multiple EVM chains for Defi Kingdoms.\n\n## About the Project\n\nThis library serves as a package that can be used to collect transaction histories of users and contracts, and generate a report in various formats.\nThe [bounty](https://docs.google.com/document/d/1jwoIYrnyJGm31YdLyC3F5yNwUva0EIDrwJqVO9jTnCY/edit) for this project provides more detailed information about its uses.\n\n## Getting started\n\nInstall the package into your project\n\n```sh\nnpm install --save @dfk-tools/transaction-history-report-generator\n```\n\n## Usage\n\n### Generating reports\n\n```tsx\nimport { Generator } from '@dfk-tools/transaction-history-report-generator';\n\n// Create a new instance of the report generator with default settings\nconst generator = new Generator();\n\n// Generate a report for a player for all time, including all DFK interactions\nconst playerReport = await generator.report('[PLAYER ADDRESS]');\n\n// Generate a report for a player, including transactions starting after a certain date\nconst startDate = new Date('2021-12-13');\nconst contractSince2021Dec13Report = await generator.report('[PLAYER ADDRESS]', {\n    start: startDate\n});\n\n// Generate a report for a player for all time, including only hero purchase transactions\nconst playerHeroPurchasesReport = await generator.report('[PLAYER ADDRESS]', {\n    contract: contracts.Hero\n});\n```\n\n### Exporting\n\n```tsx\nimport { resolve } from 'path';\n\n// ...\n\n// Save a report to a path with default options\nconst savePath = resolve(__dirname, './reports');\nawait report.exportAsCsv(savePath);\n```\n\n### Accessing report data\n\n```tsx\n// ...\n\nconst transactions = report.transactions;\nconsole.log(transactions);\n```\n","readmeFilename":"README.md"}