Feat: Migrate to Prebuilt libstorage Binaries & Rebrand to Storage

.gitignore

@@ -32,7 +32,6 @@ src/ffi/bindings.rs
 
 # Test output
 /tests/output/
-/examples/output/
 
 # Environment files
 .env
@@ -47,4 +46,4 @@ src/ffi/bindings.rs
 *.debug
 
 # LLM
-.kilocode
+.kilocode

Cargo.toml

@@ -1,26 +1,30 @@
 [package]
-name = "codex-bindings"
-version = "0.1.3"
+name = "storage-bindings"
+version = "0.2.0"
 edition = "2021"
-description = "Rust bindings for Codex, the Decentralized Durability Engine"
+description = "Rust bindings for Storage, the Decentralized Durability Engine"
 license = "MIT"
-repository = "https://github.com/nipsysdev/codex-rust-bindings"
-homepage = "https://codex.storage"
-keywords = ["codex", "storage", "p2p", "distributed"]
+repository = "https://github.com/nipsysdev/storage-rust-bindings"
+homepage = "https://logos.co/tech-stack"
+keywords = ["storage", "p2p", "distributed"]
 categories = ["api-bindings", "network-programming"]
 
+# Prebuilt binary version pinning
+# Set this to a specific version from https://github.com/nipsysdev/logos-storage-nim-bin/releases
+# Format: <branch>-<commit-hash> (e.g., "master-60861d6a")
+# Leave empty or comment out to use the latest release
+[package.metadata.prebuilt]
+libstorage = "master-1acedcf"
+
 [lib]
-name = "codex_bindings"
+name = "storage_bindings"
 crate-type = ["cdylib", "rlib"]
 
 [dependencies]
 libc = "0.2"
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
 thiserror = "2.0"
-log = "0.4"
-chrono = { version = "0.4", features = ["serde"] }
-once_cell = "1.21"
 bytesize = "2.1"
 futures = "0.3"
 
@@ -31,16 +35,25 @@ optional = true
 
 [build-dependencies]
 bindgen = "0.72"
-pkg-config = "0.3"
+reqwest = { version = "0.12", features = ["blocking", "json"] }
+flate2 = "1.0"
+tar = "0.4"
+serde = { version = "1.0", features = ["derive"] }
+serde_json = "1.0"
+sha2 = "0.10"
+hex = "0.4"
 cc = "1.2"
+dirs = "6.0"
 
 [dev-dependencies]
 tempfile = "3.23"
-tokio-test = "0.4"
 env_logger = "0.10"
-tokio = { version = "1", features = ["macros", "io-util", "rt-multi-thread"] }
+tokio = { version = "1", features = [
+    "macros",
+    "io-util",
+    "rt-multi-thread",
+    "time",
+] }
 
 [features]
 default = ["tokio"]
-static-linking = []
-dynamic-linking = []

README.md

@@ -1,87 +1,152 @@
-# Codex Rust Bindings
+# Storage Rust Bindings
 
-This repository provides Rust bindings for the Codex library, enabling seamless integration with Rust projects.
+This repository provides Rust bindings for the Storage library, enabling seamless integration with Rust projects.
 
 ## Usage
 
 Include in your Cargo project:
 
 ```toml
 [dependencies]
-codex-bindings = "0.1.3"
+storage-bindings = "0.2.0"
 ```
 
-To learn how to use those bindings, take a look at the [example project](https://github.com/nipsysdev/example-codex-rust-bindings) or the [integration tests](./tests/).
+To learn how to use those bindings, take a look at the [example project](https://github.com/nipsysdev/example-storage-rust-bindings) or the [integration tests](./tests/) directory.
 
 ## Building
 
-### Requirements
+Building will automatically:
 
-This crate automatically builds the required libcodex library during compilation, so you don't need to install nim-codex separately. However, you will need:
+1. Fetch the latest prebuilt libstorage binary for your platform from GitHub
+2. Generate Rust bindings and compile the crate
 
-- **Rust and Cargo**
-- **Git**
-- **Make**
-- **C compiler**
+**Note**: The first build will download the prebuilt binary (~50MB). Subsequent builds will use the cached version.
 
-Building will automatically:
+## Caching
 
-1. Clone the nim-codex repository and it's submodules
-2. Build the Nim compiler from source
-3. Build libcodex with the Nim compiler
-4. Generate Rust bindings and compile the crate
+Prebuilt binaries are automatically cached to improve build performance and reduce network usage.
 
-**Note**: The first build may take 10-20 minutes as it needs to build the Nim compiler from source. Subsequent builds will be much faster.
+### Cache Location
 
-### Building from source
+Prebuilt binaries are cached in a platform-specific location:
+
+- **Linux**: `~/.cache/storage-bindings/`
+- **macOS**: `~/Library/Caches/storage-bindings/`
+- **Windows**: `%LOCALAPPDATA%\storage-bindings\cache\`
+
+The cache is organized by version and platform:
+
+```
+~/.cache/storage-bindings/
+├── master-1acedcf/
+│   ├── linux-amd64/
+│   │   ├── libstorage.a
+│   │   ├── libstorage.h
+│   │   └── SHA256SUMS.txt
+│   └── darwin-arm64/
+│       └── ...
+└── master-2b3d4e5/
+    └── ...
+```
+
+### Managing the Cache
+
+#### Force Re-download
+
+To force a fresh download without clearing the cache:
 
 ```bash
-cargo build --release
-# or, for debug
-cargo build
+STORAGE_BINDINGS_FORCE_DOWNLOAD=1 cargo build
 ```
 
-### Other Cargo Commands
+#### Clean Entire Cache
+
+To remove all cached binaries:
 
 ```bash
-# Run all tests
-cargo test
+# Linux/macOS
+rm -rf ~/.cache/storage-bindings/
+
+# Windows
+rmdir /s /q %LOCALAPPDATA%\storage-bindings\cache
 
-# Run unit tests
-cargo test-unit
+# Or using the build script
+STORAGE_BINDINGS_CLEAN_CACHE=1 cargo build
+```
 
-# Run integration tests
-cargo test-integration
+### Supported Platforms
 
-# Run doctests
-cargo test-doc
+- Linux x86_64 (x86_64-unknown-linux-gnu)
+- Linux ARM64 (aarch64-unknown-linux-gnu)
+
+### Libstorage Version Pinning
+
+**Option 1: Cargo.toml metadata**
+
+Add to your `Cargo.toml`:
+
+```toml
+[package.metadata.prebuilt]
+libstorage = "master-60861d6a"
 ```
 
-## Linking Modes
+**Option 2: Environment variable (for local overrides)**
 
-This crate supports two linking modes via Cargo features:
+```bash
+export LOGOS_STORAGE_VERSION=master-60861d6a
+cargo build
+```
 
-### Dynamic Linking (Default)
+Available versions can be found at: https://github.com/nipsysdev/logos-storage-nim-bin/releases
+
+### Building from source
 
 ```bash
+cargo build --release
+# or, for debug
 cargo build
-# or explicitly
-cargo build --features dynamic-linking
 ```
 
-### Static Linking
+### Building using local libraries
+
+To use locally built libraries instead of downloading from GitHub, set the `STORAGE_BINDINGS_LOCAL_LIBS` environment variable to the path of the dist folder:
 
 ```bash
-cargo build --features static-linking
+export STORAGE_BINDINGS_LOCAL_LIBS=/path/to/logos-storage-nim-bin/dist/master-50bd1839-linux-amd64
+cargo build
 ```
 
-### In your Cargo.toml
+### Testing
 
-```toml
-[dependencies]
-codex-bindings = { version = "0.1.3", features = ["static-linking"] }
+The library includes comprehensive integration tests that demonstrate all major functionality.
+
+#### Running All Tests
+
+```bash
+# Run all tests (unit tests + integration tests)
+cargo test
 ```
 
+#### Running Specific Tests
+
+```bash
+# Run only unit tests
+cargo test --lib
+
+# Run only integration tests
+cargo test --test $test_name
+```
+
+#### Available Integration Tests
+
+- **basic_usage**: Demonstrates basic upload/download functionality
+- **chunk_operations**: Shows chunk-based upload and download operations
+- **debug_operations**: Demonstrates debug operations and logging
+- **p2p_networking**: Shows P2P networking operations
+- **storage_management**: Demonstrates storage management operations
+- **two_node_network**: Shows two-node network setup and data transfer
+- **thread_safe_tests**: Tests thread-safe node lifecycle and concurrent operations
+
 ## License
 
 [MIT](./LICENSE)