@bloxchain/sdk 1.0.0-alpha.20 → 1.0.0-alpha.22

package/README.md

@@ -2,18 +2,17 @@
 
 [![npm version](https://img.shields.io/npm/v/@bloxchain/sdk.svg)](https://www.npmjs.com/package/@bloxchain/sdk)
 [![License: MPL-2.0](https://img.shields.io/badge/License-MPL--2.0-blue.svg)](https://opensource.org/licenses/MPL-2.0)
-[![TypeScript](https://img.shields.io/badge/TypeScript-5.x-blue.svg)](https://www.typescriptlang.org/)
+[![TypeScript](https://img.shields.io/badge/TypeScript-6.x-blue.svg)](https://www.typescriptlang.org/)
 [![Node](https://img.shields.io/badge/Node-%3E%3D18.0.0-green.svg)](https://nodejs.org/)
 
 A comprehensive TypeScript SDK for interacting with the Bloxchain Protocol smart contracts, providing type-safe interfaces for secure multi-phase operations, dynamic role-based access control, and state abstraction.
 
-> **⚠️ EXPERIMENTAL SOFTWARE WARNING**  
-> This package contains experimental smart contract code and SDK support. While the framework is feature-complete and tested, it is not yet audited for production use. Use at your own risk and do not deploy with real assets without proper security review.
+The SDK mirrors the audited core protocol and is intended for production integrations. Pin an exact package version and review release notes before upgrading.
 
 ## Requirements
 
 - **Node.js**: >= 18.0.0
-- **TypeScript**: 5.x (recommended)
+- **TypeScript**: 6.x (recommended)
 - **Peer dependency**: `viem` ^2.0.0 (required for all SDK usage)
 - **Optional peer**: `@bloxchain/contracts` ^1.0.0-alpha (for Solidity/ABI alignment when building apps that use both)
 
@@ -38,25 +37,25 @@ Bloxchain Protocol implements a **state machine architecture** with `SecureOpera
 
 ## 📚 Documentation
 
-Comprehensive documentation is available in the [`docs/`](./docs/) directory:
+Comprehensive documentation is available in the repository root [`docs/`](../../docs/) folder:
 
 ### **🏗️ Architecture & Design**
-- **[Protocol Architecture](./docs/bloxchain-architecture.md)** - Bloxchain protocol overview and design principles
-- **[State Machine Engine](./docs/state-machine-engine.md)** - SecureOperationState engine and state management
-- **[Architecture Patterns](./docs/architecture-patterns.md)** - Design patterns and best practices
+- **[Protocol Architecture](../../docs/bloxchain-architecture.md)** - Bloxchain protocol overview and design principles
+- **[State Machine Engine](../../docs/state-machine-engine.md)** - SecureOperationState engine and state management
+- **[Architecture Patterns](../../docs/architecture-patterns.md)** - Design patterns and best practices
 
 ### **🚀 Getting Started**
-- **[Getting Started](./docs/getting-started.md)** - Quick setup and basic usage
-- **[API Reference](./docs/api-reference.md)** - Complete API documentation
-- **[SecureOwnable Guide](./docs/secure-ownable.md)** - Ownership management
-- **[RuntimeRBAC Guide](./docs/runtime-rbac.md)** - Role-based access control
+- **[Getting Started](../../docs/getting-started.md)** - Quick setup and basic usage
+- **[API Reference](../../docs/api-reference.md)** - Complete API documentation
+- **[SecureOwnable Guide](../../docs/secure-ownable.md)** - Ownership management
+- **[RuntimeRBAC Guide](../../docs/runtime-rbac.md)** - Role-based access control
 
 ### **🔍 Development Tools**
-- **[Best Practices](./docs/best-practices.md)** - Development guidelines
-- **[Examples](./docs/examples-basic.md)** - Practical code samples
-- **[Types & Interfaces](./docs/types-interfaces.md)** - Type definitions
+- **[Best Practices](../../docs/best-practices.md)** - Development guidelines
+- **[Examples](../../docs/examples-basic.md)** - Practical code samples
+- **[Types & Interfaces](../../docs/types-interfaces.md)** - Type definitions
 
-**📖 [View All Documentation](./docs/README.md)**
+**📖 [View All Documentation](../../docs/README.md)**
 
 ## Installation
 
@@ -166,7 +165,7 @@ const metaTx = await secureOwnable.generateUnsignedMetaTransactionForNew(
 
 ## RuntimeRBAC Usage
 
-RuntimeRBAC uses batch-based configuration for all role management operations. See the [RuntimeRBAC Guide](./docs/runtime-rbac.md) for complete examples.
+RuntimeRBAC uses batch-based configuration for all role management operations. See the [RuntimeRBAC Guide](../../docs/runtime-rbac.md) for complete examples.
 
 ### Query Functions
 
@@ -193,7 +192,7 @@ const permissions = await runtimeRBAC.getActiveRolePermissions(roleHash);
 
 ### Batch Configuration
 
-All role management (create role, add wallet, add permissions, etc.) is done via batch operations. See the [RuntimeRBAC Guide](./docs/runtime-rbac.md) for detailed batch configuration examples.
+All role management (create role, add wallet, add permissions, etc.) is done via batch operations. See the [RuntimeRBAC Guide](../../docs/runtime-rbac.md) for detailed batch configuration examples.
 
 ## Definitions Usage
 
@@ -312,10 +311,11 @@ import { TxStatus } from '@bloxchain/sdk';
 
 TxStatus.UNDEFINED
 TxStatus.PENDING
+TxStatus.EXECUTING
+TxStatus.PROCESSING_PAYMENT
 TxStatus.CANCELLED
 TxStatus.COMPLETED
 TxStatus.FAILED
-TxStatus.REJECTED
 ```
 
 ## Error Handling
@@ -343,16 +343,16 @@ try {
 
 ## Versioning and stability
 
-This package follows [Semantic Versioning](https://semver.org/). Current versions are **alpha** (`1.0.0-alpha.x`). Pre-1.0 releases may introduce breaking changes; we recommend pinning the exact version until the protocol is audited and stable.
+This package follows [Semantic Versioning](https://semver.org/). Published versions use the **alpha** channel (`1.0.0-alpha.x`) while we finalize the 1.0.0 release line. Pin the exact version in production and review release notes before upgrading.
 
 ## Security
 
 - **Vulnerability reporting**: Do not open public GitHub issues for security vulnerabilities. See the [Security Policy](https://github.com/PracticalParticle/Bloxchain-Protocol/blob/main/SECURITY.md) for reporting instructions (e.g. security@particlecs.com).
-- **Audit status**: The underlying protocol is not yet audited. Do not use with mainnet assets without an independent security review.
+- **Audit status**: The underlying core protocol smart contracts have completed an independent security audit. Follow your own deployment, upgrade, and operational review processes before production use.
 
 ## Support and links
 
-- **Documentation**: [SDK docs](./docs/) in this package; [Bloxchain Protocol README](https://github.com/PracticalParticle/Bloxchain-Protocol#readme) for protocol details
+- **Documentation**: [SDK and protocol guides](../../docs/) in the repository `docs/` folder; [Bloxchain Protocol README](https://github.com/PracticalParticle/Bloxchain-Protocol#readme) for protocol details
 - **Issues and feature requests**: [GitHub Issues](https://github.com/PracticalParticle/Bloxchain-Protocol/issues)
 - **Homepage**: [bloxchain.app](https://bloxchain.app/)
 - **Author**: [Particle Crypto Security](https://particlecs.com/)