Skip to content

README.md

Latest commit

 

History

History
145 lines (96 loc) · 5.09 KB

README.md

File metadata and controls

145 lines (96 loc) · 5.09 KB

Auki Network - Experimental Modules

⚠️ EXPERIMENTAL: This repository contains experimental modules for the Auki Network. These modules are under active development and subject to rapid changes, including breaking changes to the API. Use with caution in production environments and expect frequent updates. We recommend pinning to specific versions and reviewing changelogs before upgrading.

This repository houses experimental SDKs and libraries for building applications on the Auki Network and Posemesh. Each module is designed to be a standalone component that can be integrated into your applications.

Available Modules

🔐 Authentication

Multi-platform authentication library for the Auki Network with support for Rust, JavaScript/TypeScript, Python, and React Native/Expo.

View Authentication Module Documentation →

Key Features:

  • Sans-I/O core architecture written in Rust
  • Automatic token management and refresh
  • Multi-domain access support
  • Cross-platform bindings (JavaScript, Python, React Native/Expo)

Quick Links:

📐 PnP (Perspective-n-Point)

Pure Rust PnP pose estimation. Estimates the 6-DoF pose (position + orientation) of a calibrated camera from known 3D landmarks and their 2D image observations. No OpenCV dependency.

View PnP Module Documentation →

Key Features:

  • Three solver methods: EPnP, Iterative (Levenberg-Marquardt), and SQPnP
  • no_std compatible core library (with alloc)
  • WASM Component Model interface via WIT
  • C FFI with auto-generated header for iOS/Android/desktop embedding
  • Numerically validated against OpenCV reference output

Quick Links:

Repository Structure

modules/
├── authentication/              # Authentication module
│   ├── src/                    # Rust core library
│   ├── pkg/                    # Language bindings
│   ├── examples/               # Examples
│   ├── README.md               # Module documentation
│   └── ARCHITECTURE.md         # Technical details
├── pnp/                        # PnP pose estimation module
│   ├── crates/
│   │   ├── pnp-core/          # Pure Rust solver (no_std + alloc)
│   │   ├── pnp-wasm/          # WASM Component Model guest
│   │   └── pnp-ffi/           # C FFI layer
│   └── README.md              # Module documentation
├── CONTRIBUTING.md             # Contribution guidelines
└── README.md                   # This file

Getting Started

Each module has its own documentation and setup instructions. See the individual module READMEs for details.

Building from Source

Prerequisites

Quick Build

# Clone the repository
git clone https://github.com/aukilabs/experimental-modules.git
cd modules/authentication

# Install build tools (first time only)
make install-tools

# Build JavaScript bindings
make javascript

# Build Python bindings
make python

# Build all
make all

See individual module documentation for detailed build instructions.

Contributing

We welcome contributions! Please see CONTRIBUTING.md for guidelines.

Before contributing:

  1. Check existing issues
  2. For major changes, open an issue first to discuss
  3. Follow the coding standards for each language
  4. Test all language bindings after API changes

Documentation

Module Documentation:

Versioning

Each module and language binding is independently versioned. Due to the experimental nature, expect:

  • Frequent patch releases for bug fixes
  • Minor version bumps for new features
  • Major version bumps for breaking changes (which may happen often)

Support

License

MIT License - See LICENSE for details

Note: This is an experimental project. APIs will change. Documentation may be incomplete. Use at your own risk, and please report any issues you encounter!