bitcraft 0.1.0__tar.gz

bitcraft-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

bitcraft-0.1.0/NOTICE

@@ -0,0 +1,28 @@
+BitCraft
+Copyright 2026 The BitCraft Authors
+
+  Rohan Pattanayak
+  Jagadish Pattnaik
+  Shreya Mishra
+  Shreya Mohanty
+  Ashutosh Badapada
+  Rosalin Nayak
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this software except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+This product includes data derived from the Elliptic Data Set
+(Elliptic, MIT-IBM Watson AI Lab), distributed separately and not
+covered by this License.
+
+IP geolocation by DB-IP (https://db-ip.com), licensed under CC BY 4.0.
+The DB-IP databases are downloaded separately and not included here.

bitcraft-0.1.0/PKG-INFO

@@ -0,0 +1,79 @@
+Metadata-Version: 2.4
+Name: bitcraft
+Version: 0.1.0
+Summary: Bitcoin transaction intelligence in your terminal: ranked alerts, evidence and link analysis.
+Author: Rohan Pattanayak, Jagadish Pattnaik, Shreya Mishra, Shreya Mohanty, Ashutosh Badapada, Rosalin Nayak
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/RohanOnKeys/bitcraft
+Project-URL: Source, https://github.com/RohanOnKeys/bitcraft
+Project-URL: Documentation, https://github.com/RohanOnKeys/bitcraft/blob/main/docs/user_manual.md
+Project-URL: Issues, https://github.com/RohanOnKeys/bitcraft/issues
+Keywords: bitcoin,aml,fraud-detection,graph,tui,textual
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: MacOS
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Security
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: textual>=5.0
+Requires-Dist: httpx>=0.27
+Requires-Dist: pillow>=10.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.3; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.23; extra == "dev"
+Dynamic: license-file
+
+# BitCraft
+
+Bitcoin transaction intelligence in your terminal: ranked alerts,
+provenance-tagged evidence, SHAP reasons, wallet clustering and an animated
+link-analysis view.
+
+![BitCraft dashboard](https://raw.githubusercontent.com/RohanOnKeys/bitcraft/main/docs/images/dashboard.png)
+
+## Install
+
+```text
+pipx install bitcraft         # recommended: isolated install of the CLI
+pip install bitcraft          # any OS, Python 3.10+
+choco install bitcraft        # Windows, via Chocolatey
+```
+
+## Use
+
+```text
+bitcraft                 open BitCraft in a new, large terminal window
+bitcraft demo            same, with built-in demo data
+bitcraft here            run inside the current terminal
+bitcraft status          check the API and the last pipeline run
+bitcraft --help          everything else
+```
+
+BitCraft connects to a BitCraft API at `http://localhost:8000` (change it
+with `--api-url` or `BITCRAFT_API_URL`) and falls back to demo data when
+none is running. The API and ML pipeline live in the
+[source repository](https://github.com/RohanOnKeys/bitcraft).
+
+Best in Windows Terminal, a modern Linux terminal or iTerm2, at 160x46 or
+larger.
+
+| Wallets | Alert detail |
+| --- | --- |
+| ![Wallets](https://raw.githubusercontent.com/RohanOnKeys/bitcraft/main/docs/images/wallets.png) | ![Alert detail](https://raw.githubusercontent.com/RohanOnKeys/bitcraft/main/docs/images/detail.png) |
+
+## License
+
+Apache License 2.0. Copyright 2026 The BitCraft Authors: Rohan Pattanayak,
+Jagadish Pattnaik, Shreya Mishra, Shreya Mohanty, Ashutosh Badapada and
+Rosalin Nayak.

bitcraft-0.1.0/README.md

@@ -0,0 +1,237 @@
+![BitCraft](docs/images/splash.png)
+
+# BitCraft
+
+AI Powered Monitoring & Analysis of Bitcoin Transaction Traffic Software
+
+BitCraft is an offline Bitcoin intelligence platform that correlates blockchain transactions with network metadata to generate explainable investigative leads. It ingests bulk transaction datasets, builds an entity graph linking wallets, IPs, and transactions, applies AI and graph analysis to detect suspicious behavior, and presents prioritized alerts through a terminal-based investigation dashboard (TUI).
+
+The project is designed for Linux and operates entirely offline on synthetic datasets modeled after real Bitcoin transaction and P2P network activity.
+
+---
+
+## Background
+
+Bitcoin's pseudonymous peer to peer architecture enables legitimate financial activity, but it also allows ransomware payments, darknet market proceeds, extortion, and money laundering to move across the network with limited traditional financial oversight.
+
+BitCraft addresses this challenge by combining blockchain layer data with network layer observations. Instead of analyzing transactions in isolation, it reconstructs relationships between wallets, IP addresses, and transaction timing to uncover suspicious patterns that would otherwise remain hidden.
+
+---
+
+## Features
+
+- Bulk ingestion of CSV, JSON, and XML datasets
+- Bitcoin transaction and metadata parsing
+- Entity graph connecting wallets, IPs, ports, and transactions
+- AI powered anomaly detection
+- Wallet and transaction clustering
+- Explainable alerts with confidence scores
+- Terminal-based investigation dashboard (TUI) for link analysis
+- Fully offline Linux compatible workflow
+
+![Dashboard: KPIs, filters, ranked alerts and a live preview of the selected alert](docs/images/dashboard.png)
+
+---
+
+## Dataset
+
+BitCraft works with synthetic datasets modeled on real Bitcoin transaction fields.
+
+![Wallets: address clusters with their IPs, ports, GeoIP country and ASN](docs/images/wallets.png)
+
+### Supported Fields
+
+- `timestamp`
+- `src_ip`
+- `dst_ip`
+- `src_port`
+- `dst_port`
+- `txid`
+- `input_addresses[]`
+- `output_addresses[]`
+- `input_amounts[]`
+- `output_amounts[]`
+- `fee`
+- `script_type`
+- `geo_country`
+- `asn`
+
+GeoIP enrichment uses downloadable open source GeoIP databases.
+
+---
+
+## Objectives
+
+- Ingest and parse bulk Bitcoin transaction metadata.
+- Correlate network layer and blockchain layer data.
+- Build relationships between wallets, IP addresses, and transactions.
+- Detect suspicious behavior using AI and machine learning.
+- Generate explainable alerts with confidence scores.
+- Provide investigators with a clear view of suspicious entities through a terminal-based dashboard.
+
+![Threats: posture, top-25 queue with drivers, riskiest communities and coverage gaps](docs/images/threats.png)
+
+---
+
+## AI and Graph Analysis
+
+BitCraft combines graph analytics with machine learning rather than relying solely on rule based detection.
+
+Planned capabilities include:
+
+- Entity clustering
+- Transaction anomaly detection
+- Suspicious transaction chain identification
+- Temporal behavior analysis
+- Wallet relationship discovery
+- Network correlation between blockchain activity and observed IP metadata
+
+Every alert includes supporting evidence and a confidence score.
+
+![Graph explorer: live connectivity graph with timestep, severity, driver and community charts](docs/images/graph.png)
+
+---
+
+## Project Structure
+
+```text
+bitcraft/
+├── datasets/
+├── docs/
+├── plans/
+├── src/
+├── tests/
+└── README.md
+```
+
+---
+
+## Getting Started
+
+### Install and run
+
+```text
+pip install bitcraft          # any OS, Python 3.10+
+choco install bitcraft        # Windows (Chocolatey)
+bitcraft                      # opens BitCraft in a new, large terminal window
+```
+
+![Boot: data source, pipeline and alert checks while BitCraft starts](docs/images/boot.png)
+
+From a clone, `pip install -e .` gives you the same `bitcraft` command, or
+run `bitcraft.bat` / `./bitcraft.sh` / `./bitcraft.ps1` straight from the repo
+root without installing anything.
+
+| Command | What it does |
+| --- | --- |
+| `bitcraft` | New window (Windows Terminal, else Command Prompt; gnome-terminal, konsole, kitty, alacritty or xterm on Linux; Terminal.app on macOS) |
+| `bitcraft demo` | Same, with built-in demo data |
+| `bitcraft here` | Run inside the current terminal |
+| `bitcraft status` | Check the API and the last pipeline run |
+| `bitcraft run --api-url URL --size 200x60` | Pick a backend and window size |
+
+Inside a source checkout with a loaded database, `bitcraft` also starts the
+API in the background and stops it when you quit. Release builds:
+`python packages/build_package.py` (wheel, sdist and the Chocolatey
+package).
+
+### Model and backend (live data)
+
+The dataset is the private Kaggle dataset
+`rosalinnayak/bitcoin-transaction-traffic`. Put its five CSVs in
+`datasets/` (git-ignored), then:
+
+```text
+pip install -r requirements.txt -r backend/requirements.txt
+python -m ml.geoip download               # one-time: DB-IP Lite country + ASN databases
+python -m ml.metadata_generator           # challenge-format metadata (CSV, JSON, XML)
+python -m ml.pipeline                     # ~5 min first run, writes ml/artifacts/
+cd backend && python -m app.loader        # loads artifacts into backend/bitcraft.db
+bitcraft                                  # starts the API and opens the TUI
+```
+
+The metadata layer carries the challenge's minimum fields (timestamp,
+src/dst IP and port, txid, input/output addresses and amounts, fee, script
+type). `python -m ml.ingest FILE` validates any CSV, JSON or XML file in
+that shape; GeoIP adds country and ASN offline.
+
+With no `DATABASE_URL` the API uses a local SQLite file, and Redis is
+optional. For the full PostgreSQL + Redis stack, use `docker compose up --build`:
+the `ml` service runs the pipeline, then `backend` loads the results and
+serves on port 8000.
+
+API: `/alerts`, `/alerts/{tx_id}`, `/graph/{tx_id}?depth=`, `/communities`,
+`/communities/{id}`, `/entities`, `/entities/{id}`, `/entities/{id}/graph`,
+`/addresses/{address}`, `/ips/{ip}`, `/metadata/{tx_id}`, `/stats/summary`,
+`/threats/overview`, `/pipeline/status`, `/pipeline/metrics`. Interactive docs
+at `http://localhost:8000/docs`.
+
+Full instructions: [docs/user_manual.md](docs/user_manual.md). Approach,
+model choice and explainability: [docs/technical_writeup.md](docs/technical_writeup.md).
+Model details and held-out metrics: [docs/model_card.md](docs/model_card.md).
+
+### Terminal UI (demo mode)
+
+```text
+pip install -r bitcraft/requirements.txt
+python -m bitcraft.app --demo
+```
+
+Other data sources:
+
+```text
+python -m bitcraft.app --api
+python -m bitcraft.app
+```
+
+`--demo` forces synthetic data. `--api` talks to FastAPI at
+`http://localhost:8000` (override with `--api-url`). Default `auto`
+probes `/health` and falls back to demo.
+
+Keys: Enter (boot/detail), d dashboard, t threats, g graph, Esc home, q quit.
+
+Demo mode always shows a `DEMO DATA` badge. It is not live pipeline output.
+
+Minimum terminal size: 100 columns by 30 rows.
+
+---
+
+## Expected Output
+
+BitCraft produces:
+
+- Parsed and correlated transaction data
+- Entity relationship graphs
+- Ranked suspicious wallets and transactions
+- Explainable AI generated alerts
+- Terminal-based investigation dashboard (TUI)
+
+![Alert detail: composite score, drivers, network and blockchain metadata, evidence and SHAP reasons](docs/images/detail.png)
+
+---
+
+## Tech Stack
+
+Planned technologies include:
+
+- Python
+- NetworkX
+- FastAPI
+- PostgreSQL
+- Redis
+- GeoIP databases
+- Machine learning libraries
+- Textual (terminal UI framework)
+
+---
+
+## License
+
+BitCraft is open source under the [Apache License 2.0](LICENSE).
+
+Copyright 2026 The BitCraft Authors: Rohan Pattanayak, Jagadish Pattnaik,
+Shreya Mishra, Shreya Mohanty, Ashutosh Badapada and Rosalin Nayak.
+See [NOTICE](NOTICE).
+
+The Elliptic-derived dataset is distributed separately and is not covered
+by this license.

bitcraft-0.1.0/bitcraft/__init__.py

@@ -0,0 +1,3 @@
+"""BitCraft terminal interface package. Built with Textual."""
+
+__version__ = "0.1.0"