@bloxchain/contracts 1.0.0-alpha.6 → 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog — @bloxchain/contracts
+
+All notable changes to this package are documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.0] - 2026-06-03
+
+### Added
+
+- First **stable** documented release on npm (`latest`).
+- Publishable Solidity artifacts: `core`, `abi`, `standards`, `components`.
+
+### Note
+
+Prior `1.0.0-alpha.N` publishes were experimental and are not listed in this changelog.

package/README.md

@@ -2,17 +2,16 @@
 
 [![npm version](https://img.shields.io/npm/v/@bloxchain/contracts.svg)](https://www.npmjs.com/package/@bloxchain/contracts)
 [![License: MPL-2.0](https://img.shields.io/badge/License-MPL--2.0-blue.svg)](https://opensource.org/licenses/MPL-2.0)
-[![Solidity](https://img.shields.io/badge/Solidity-0.8.33-blue.svg)](https://soliditylang.org/)
+[![Solidity](https://img.shields.io/badge/Solidity-0.8.34-blue.svg)](https://soliditylang.org/)
 
 Bloxchain Protocol smart contracts – state abstraction and core components for building on the Bloxchain Protocol.
 
-> **⚠️ EXPERIMENTAL SOFTWARE WARNING**  
-> This package contains experimental smart contract code. 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 core protocol (`contracts/core/`) has been independently audited by **Nethermind**. Report and scope: [audits/nethermind](https://github.com/PracticalParticle/Bloxchain-Protocol/tree/main/audits/nethermind) on GitHub. Pre-mainnet today; mainnet deployment coming soon. Review release notes and pin an exact version before production use.
 
 ## Requirements
 
 - **Node.js**: >= 18.0.0 (for tooling; Solidity has no runtime dependency)
-- **Solidity**: 0.8.x (0.8.33 recommended)
+- **Solidity**: 0.8.x (0.8.34 recommended)
 - **Compilers**: Foundry, Hardhat, or Truffle
 
 ## Installation
@@ -50,25 +49,25 @@ import "@bloxchain/contracts/core/lib/interfaces/IDefinition.sol";
 
 ### Templates and examples
 
-Templates (e.g. BareBlox, SecureBlox, AccountBlox) and example applications (SimpleVault, SimpleRWA20) live in the main repository under `contracts/examples/`. They are not included in this npm package. See the [main repo](https://github.com/PracticalParticle/Bloxchain-Protocol) for full documentation and examples.
+Templates (e.g. AccountBlox, CopyBlox) and example applications (SimpleVault, SimpleRWA20) live in the main repository under `contracts/examples/`. They are not included in this npm package. See the [main repo](https://github.com/PracticalParticle/Bloxchain-Protocol) for full documentation and examples.
 
 ## Dependencies
 
 This package declares:
 
-- `@openzeppelin/contracts`: ^5.4.0
-- `@openzeppelin/contracts-upgradeable`: ^5.4.0
+- `@openzeppelin/contracts`: 5.6.1
+- `@openzeppelin/contracts-upgradeable`: 5.6.1
 
 Install them in your project if your tooling does not resolve transitive dependencies.
 
 ## 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/). Stable releases publish to npm **`latest`**; see [CHANGELOG.md](./CHANGELOG.md). 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**: Not yet audited. Do not use with mainnet assets without an independent security review.
+- **Audit status**: Core protocol (`contracts/core/`) audited by [Nethermind](https://github.com/PracticalParticle/Bloxchain-Protocol/tree/main/audits/nethermind) ([PDF](https://github.com/PracticalParticle/Bloxchain-Protocol/blob/main/audits/nethermind/Nethermind-Bloxchain-Core-NM_0828.pdf)). This npm package does not include the PDF; verify the audited commit in the engagement README. Follow your own deployment, upgrade, and operational review before production use.
 
 ## Support and links